From 7b8c07837097ea52b77286646973f84629ffeab3 Mon Sep 17 00:00:00 2001 From: Tyler Mairose Date: Mon, 24 Feb 2025 09:58:10 -0500 Subject: [PATCH 01/82] Clarifications to the API versioning strategy --- docs/api/api-versioning-strategy.md | 8 ++++---- docs/api/beta/api-versioning-strategy.md | 6 +++--- docs/api/img/api-versioning-timeline.jpg | Bin 644899 -> 0 bytes docs/api/img/api-versioning-timeline.png | Bin 0 -> 185242 bytes docs/api/v2024/api-versioning-strategy.md | 8 ++++---- docs/api/v3/api-versioning-strategy.md | 8 ++++---- 6 files changed, 15 insertions(+), 15 deletions(-) delete mode 100644 docs/api/img/api-versioning-timeline.jpg create mode 100644 docs/api/img/api-versioning-timeline.png diff --git a/docs/api/api-versioning-strategy.md b/docs/api/api-versioning-strategy.md index 77e645ebb..1439d89a3 100644 --- a/docs/api/api-versioning-strategy.md +++ b/docs/api/api-versioning-strategy.md @@ -88,17 +88,17 @@ If you attempt to invoke an experimental API without specifying the `X-SailPoint ## Release schedule -SailPoint will introduce an annual release which includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. +SailPoint will introduce an annual release that includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. -Each annual release will be accompanied by an experimental release if there is at least one breaking change introduced in the current annual release. This experimental release will be named after the next year. For example, if the current year is 2025, the experimental version will be named v2026. Any breaking changes to public endpoints in a public version throughout the year will be introduced in the experimental version. +Each annual release may be accompanied by an experimental release if it introduces at least one breaking change. For example, if the annual release is v2025 and includes breaking changes, those changes will be introduced as experimental APIs in v2026. When a new annual release is introduced, non-deprecated endpoints will generally be transferred to the new release without modifications. As a result, the same endpoint will usually be able to be accessed via both the old and new versions. Only the latest public release will receive new functionality. If at anytime throughout the year a experimental API is deemed ready for production, it will be released into the current year’s public version, but not previous years. Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represent experimental releases which are available for one year in the preview state before being changed to a production release. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represent an experimental release that introduces breaking changes, if any exist. -![Versioning Timeline](./img/api-versioning-timeline.jpg) +![Versioning Timeline](./img/api-versioning-timeline.png) ## Deprecations diff --git a/docs/api/beta/api-versioning-strategy.md b/docs/api/beta/api-versioning-strategy.md index 7ebdacfdc..822f8f42c 100644 --- a/docs/api/beta/api-versioning-strategy.md +++ b/docs/api/beta/api-versioning-strategy.md @@ -90,15 +90,15 @@ If you attempt to invoke an experimental API without specifying the `X-SailPoint SailPoint will introduce an annual release which includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. -Each annual release will be accompanied by an experimental release if there is at least one breaking change introduced in the current annual release. This experimental release will be named after the next year. For example, if the current year is 2025, the experimental version will be named v2026. Any breaking changes to public endpoints in a public version throughout the year will be introduced in the experimental version. +Each annual release may be accompanied by an experimental release if there is at least one breaking change introduced in the current annual release. For example, if the annual release is v2025 and breaking changes would be introduced, those breaking changes will be introduced as v2026 experimental APIs. When a new annual release is introduced, non-deprecated endpoints will generally be transferred to the new release without modifications. As a result, the same endpoint will usually be able to be accessed via both the old and new versions. Only the latest public release will receive new functionality. If at anytime throughout the year a experimental API is deemed ready for production, it will be released into the current year’s public version, but not previous years. Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represent experimental releases which are available for one year in the preview state before being changed to a production release. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represents an experimental release that introduces breaking changes, if any exist. -![Versioning Timeline](../img/api-versioning-timeline.jpg) +![Versioning Timeline](../img/api-versioning-timeline.png) ## Deprecations diff --git a/docs/api/img/api-versioning-timeline.jpg b/docs/api/img/api-versioning-timeline.jpg deleted file mode 100644 index 870fc6c5294cb1a2138c0e6ab8155a41f6df1180..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 644899 zcmeEvXIN9q+IA2@MNttVN>f2VLK7iWk*zcV0|E)51r($u^xgzT=|uqp5(W}bCt*38_`dS-Fhe>es@ ztEr};2BM<_f#_%-(BTAKzlO51`F%YdHH~|!f6ZtF(ZbQ|AdrKjyQ`l1oy&$s#+Q$c z{q>BWc@Hh!oPWmuBGBsH>itJ9(Z2qLZkK6U zTr|C$XdfGpJ;(}l8KePn1X+T_XsH{Z>mUh`^x+^#8AN~NXZZO|PYXvGkNynD85tQE zPaJ1rI&u8O38qtLPBEQ4ee%Q!W)|ktXU?8wIm>kF9P7EWthDsmpOw)4Jd^(DaoUMz zPo6kQJNiEiho3+!$4`u3D5j_51s!3bqi3NztOfDV;HIfX_p>YhEgU<}c;W~>!%?Q6 z`5tFMbo4*fK6Q%m)QJ-ebSxmcBlJfZ7>}_WKX--og2V~7i@Y~(>mpsS3EklH?D~ce zpT@oF?CRmWqX$PA$jDlFc*efVDEv?}epS-dEhr>Dzd#Bqt?V9*ul~%hX8A0wRz>xB z(dr|wiAe$L#Pqdm>Q=O7xoP_RMXP_Pb>t`=10(&h<0oj@S}e5NhVJN58gxgFGSbt5 z=>Mt}%M}UT*mG>)+j{Vaah;5;G<{s&jq~2P^Aw+7J+W%xDg_NHIL3EX^7ERsvYREp zO4lJ3bc%NV5f*wDkP?U*sSvVzcFM)Zd6bvy$=?C_75_ru7Xp7rV4{7zQbmr-Xh^0p z^zz>i{)&Gg@C$*zBOqJ&(JA({`gt$r^(%i_#r-|wSNscsUkLm};Izmx=ah16U22Vg znCmY{ej)G+fj=Wa|BH8+}pAq>b|3cso2>c== ze}Lnc@C$)IBk+ri{27s7@-GDbh`=v0@<%*=Nxu;I69T`;$e#fDCH_L-j|luCBY(u> zm-GvPKOyjojQk0ZU*azW{)E6UGV&)teu=*j_#*=UzsZQa9tqo>D~z@n}q^TNX=`<;Y9fBXz}7*%v+IdL48+~0!KdGb26Cm9+F~`zs|(@ zzL{Oc-#FEdx)c^;C^iXN4WMdxb&`4qioL3Q9Mu;zZZoF`D~+ zHx$LMFvzV6mykPXG5dxtYs%9Y`g`mDgP2>tr@JfvYBnL}Jg}UW?hA#kqO&Yb`=DGD zRaKa-{=55UX8%zgZz@5u5|z4cv5EV(^Ek28!Bty# z9=?Bvx_<}~B+%P_0!&yP@;#`%bCIHbT$LF$b|GWwNijha^KVQN+zA9ieuW#x#m$SK7) zMVyS1b)8cz#k!8XWzC!#F00JBi{K=sa%8_4e?$BsP9n{vw2d~^!knpLPNIo7|0_<5g7H$jANxl`x_cTJ>kdfcBPvEeMFOA8r zC_l4PV)e*z_e=-(V`eK789(Tp8TST=Lss9sArKRz1{AfyS0E6`HO`m)UQP<_J+B+i zKJd2;b~vvPT{+T%t;*rYHr;fHcYWllh>Q@PfOl(S#UAdi4_HD+<4O;LHco7wj);hu zY7~Ru4nd8X`)uFw?z0W0R4)o4AZRj9F745m#=iQkG~8DbVahC6b>;WJ?c!jzn=wZ` zyD)aIuTEB&e)=m{>43e=MTefvBDap_9ucilzCI6K7Vzu=t9CSW0u@atL?sEn^zM*I z)@#H#Y|Yd;BHhWwR(F3_(LMx?^H6qT!N?$?-Sq?`8|+30UwWLn@W{3p$qnm)K$u~V z9D=qiHvHE6PRroH>zt!EyD>OUAV?#l?3)1Y_ljq`I_Qfz8ugsaJi`U z<1G#Ad7-&z+h~hp~DQqx$PMH(lU zj<$%~P#&czEtYSrqF~MsX5wM#{CMeOnfTg*?Z}==F*Q;v3ytodzbFogcHJ&X<^{aH zxX0+tzr7y4_{B`0<;%nZMR9=LM;M=nE#g?n+o|>3)~R$D z5*=3p2F$W9Eg)RN3E-XNbUDID5h_BbxD8XXaNZN1dKUG3Bhg5Ywj0a%JniI9_Q$z+ zv4tv4NuGX$~Uu&FSZE<_Rl3y*ik+zf9X2<*>xZ4uTeRL9NlHV=VM%?PZJ{| zfFk3t`DQyqQV?>k=G79v#cYZfOG{m|oeH%|x9`}T-e*>{J^zFFX_WEPr4QSpN`CW7 zx$TBGD(&g^bX>c)E7QIYO+N$OPPVnFtFf_vS~0o6X8(BIj<<+rnXU@N{g;7#gzu zq`MN*n)0cEeLzB5ygo6xqRYs@0|0VkS1^5*!^jUiv1DGsqtf&}<3QT8oh&US2rsZ8xHgA#rq&VELC7EL(mVVVi^IaD@M0~5(_kwI(an2 z!DAEA4Tw#iGvq$%(3j?efvXHHDZV)ek%WB}32&9dyea)K zOLpyoRz0)G^Woa0U01A!oBFX=V&0qH_lufBIzSEDybf+ZJAk)6hcyrlHjU%N9qnwEP(rhZxl$c2fzTsxtAk0I- z;K&e&Eg`)vKl5z)B#N-!HE5OTU!ZFtFPt+U2E=xEH4jX?0`3BfXxt8hwUY7h=QS%u z5W)Z={_>?S_lNW;Zq24L;iP^~k%HPjM&pGnyn`uJYL07;E23SOKg>GoK*#jlI793u1RW10}oP54VZeXrlgz7|{8P8eCpWA%FmVn)!j)d0%Y2d(> z@2>TVeCFE^8|;D9rMG>&QXz~DFg%VtFBRBj+I0wePpwMNmX7$- z&+ zz+X2F^8MAX{lC<#a|P~ojT6hMJqp+g?J5{tw{&6ViSEqxZ_d8ov*MgoAb$F}A8ee> z66kn!re2N@)5ht*p@DjeIRt$+>sk8#IopJDpAeURaF$n!T`qU_6b!p||^gtq$ z84-QXBsT&4eu#o1Cip&5D_Y(eJy*NAGg2|B{I&Y~%TjW}&Dz>sN!J{MZVO{6@?e@< znOS)j>?%foJ@sTs;za1gZ_*!s>P@$gP{WrthlST6e(NnUI4RQw5xErGJFw?7w5aTk zR(KaZ5|ISFI(ZGpK?3| zVdpE>FGmOo#J>F8a7%+L8e@zjV!e4UbIQ!$nx@C6*I%4=&Fr*sb6(1xPeDWvCuB6O zLDrddqDiZq5Z<=LbsSf0qdj+`&=GZ{Q^^gJh`GAW!hrK0=07Zl!pBrpR?g98@&7K+ zbF|+3SbZ`7`NDOzhYzV*l!Q`NY$m~x5Th;X$CYCE&FtD&0OEb`6&;N5{gnwsZ{mz~ zhP4=wt^uAy(JimW_t=XnwS2%b@(^pg8uru~f z?Fz480|0yj0AL;fe1HEhbvm|@_50u0{TXrA@hHXU>jwegx&*XV5q{=m_QJLKG!0%H zbOj>bNT|3*h`>R>VpZAd1sT?tx6s$tJoq7vFHGR)Fgd2~R*EM#(bJyl9 z)l^T}ji~6nKp^H22m}RAd*Q;r4IJt74FSz^kN2u|4<5q&l8^sEd|Ju;M9FU1IAFUc z&?M!(m483|)|=_9mB;Fvr7eu0IbwSHM?KhWb1g6ode1S$*4pBhoTaPn*HU72BLRqr ztk%^YWB9F}TZQJ>=8t` zKM4H}f$-4xH#ri}z5n50DfxR(eJE_r{=}ZndiQp*(}F(TgWqTkB4V<$mTuOKZk5?= zHb!4bE}zE*bhn}oL73t|)3B}!oIHP8P@oqGorfR|H?1Ev=pS+E)N6l3=KmqO^p=~b zWS?n$2x1bu)Gb?EP`IW2`BGKyA!y;$jp2WpMgPt7KWvPCW38xRDYcbG-W9#R0S^W+ zd%WZ3qvT6-{Wc1w0RuxFKUn($H8YtLstUxw2Yc^+q&^9F`5#vPtJwc41pfN=j+nn} zF#RuoLVE7jd#vczlw)Dn8J3hjxiA;whvo6;T>Bh@6~X!lLiXCbSdfzR>jtJ_XKB&$ zv6e+)aD9WhVr6y&&Q3(fKp_-+>KWe#q)c$b?Zj8a5#iK_;m*wm9z|6u;8zQ z8eYY4X3ugPSN$jDtQQEj)=WI34FPkj{eGRw-s4F1Xb@B2^ zEu-DBejJgbhC?X`wxZu?1IH!DQ-h8$`;I7ytE@R*!qMXI6WZ8Sjd8h_6!y>cB5{H5 z#s!}t4v_mpk2@|tyqQp9z}r1whw?40ZNTK-J4hD|d}_jJHl@ua&{z2c^FDuAXXtm+ zF{;`=Ci?=RkT}#EgJ3$y>9~^skl?p{O3MZ4xfINf*aW)6eSzyp3$W5b1D$%&iDi4v%;A{G3jFZn*Laf5*M~plYSr4womrBX47`s9IUz94#PHOG(a^}2$=s{J5HI;N56 z-XC-j{IH_muCpCCXNg7QpGNQ78Ij}EhGkcTz4X&in)AozgpXTtiN08!J}p+ANY$#t zO`n5l8EFaZyFvr8V0kbRkDreS%PO!fv^aR5f2;Mvh&-AazOc$a;aR+ip_s;E@E$!v zBiQh+@aiQPWs;mb!XL3~Tia{QrTQQ*ggoe$6+?>4WJfpQ{dC)0#h>clKT{4m3M&c` zt@UQL;rdj!qqZPgyoN5+&{apCfB=-*%~>> zPI|XjExr$vy1=+BpPW=0vk`AIU#|Xo2aiASNuya5gb}(Q<6MQ<&RB@e3m!G%#?NZ+ zmZZq}#O}xwxxQ*&3F>pmQnk089>Haz6b#=*%QkMV3aV=YypW8e^QK?x&o&>tm9%7? z#B|#(y++S4H)kPvOZogcb1)nLu42V{(qyL{uDz>SoJvJ8akLPzlj2> z?)N&UOvG5vthyqVx8ggRNL!r$_IB&ZeAbM>Lj$<+jmK}ktbSK)i+LB;MDh?>kz0od zKcvVm*W)tDP9F*0FC;cjviIe7gC}!t`{cOt8Tjs{bXTd&!e&YlEH}B2i5yGl-;)xD z)s*@?TmBd_L5O&7GM5U;C+>8>VHZY+<#cb|Xfu+>?ir&9mN_|v<3yD>0V2%A$D+AI zoOgh8U;92J$}s2ww}mHJZED7 zF@Tl72#Toqb{|m4C{N*xHrO||Rf%o5+9iGM^-RV5Um2Y*3u|Qt&}^2O(4CZVo8fD5 z-R)<&6rl>Xk3n9_l7m^tTu)&#(BghRxqU(3T#n?oh2=A7VK>qPN;}D8f_XEZl9EAGX4C%Um}$gd``oF|6Pt-V7uy$qWek?>W6%6=EF^S z>HL;v4^pC7_u0;TawUerL>OFg^SoHE)$E)a#NW!j+{o#I?<5p|2(rs5?&~Hk_7uIm zbukSE?QHesiw_M3jTE;e+fI`xijSQ>8(@}z4Z930#OD}tvhOwH89seaPe?ws4Aq0` zgFulUQYeuVdcL@e9HknCbv*p!t{kr+->nhAD;Zya)z>uKT*(qB&q_dOZxJ1yumu9) zsk_9ueiOQ$X-BEtnnIK#IJQ?qGin5z69dH{eTdcI=JJ!DFv&!rLy$6UdE7jH!1kNo z$m3+woy}UMgG=ungtI%6K5k1FyIYI4`s*MA%5v9>lS%VlUb_NU{c@LdSyd>3QJr(8 zl^N_yx-WLrT@FF+znMOvy-yBXl0f~C41JjJ@D!L|(d?o51Gj9$1D+O?{OUqBM@1Jf zPg}gxy1s`RaP6+2`ch=PpX7ZZP9sK z>4J3#q@3?f-cU|ihlm3Lh4hG6>dmSR3$wh{X6Dg1fFAb0S@xq~)M`dA%Pz-CnY)2y z&%C-7o4gbS`&x;zlsPTV-4AoLsS7Tgm{! zwtDMdQ3xYHrd2fXd6yb2_l9)OBukL7d)g0hLXNV&C(qvqIln>{R<$Td)0Us(TC!fx zOl78#S}9e%^wAvlR&lTF_ZC`;R-|dQAKLi1f@8{3+H;+)uDn^y?9=p*733W};*;;0 zaP2euc!(~)xusW7XP)lyUhr{a4?^Q&-ef*P9@^>6YP4JM`E}vBF?(g@h}Gcbf=;jE z=6JncJAhR)ZQCV92B;a1gTYh`RqSHN(mph@@^ zUS2cI%3m948-^oIK;}mEf6E}XFn@Fr&|Zu-iu2|LGLz3E&C$aQO{~GieIhQULvcW0 zw0k)za;L1_i(#1l!JfW{@(rR5IwFPtQRrZZWOQl~InLby%DFk4odg~B(p-jeEk8#M zdqAsk!@A7blA8E;(G6YWCidjCYu6Wi+b)b;+H53BCWdNOWuaJDpPB@I#-IZi1mAe= zJNmzHJp^$8Kmt$HDtyv-3`yLU(71kQrAdWz^Xa7Q9(^2xplm zIVbO_n(()rwb&bOFF^EaMzlOHyt}zdd^3%>g|^oUo1N0IUD>|I6A8%6mvRs);d%k|Mdk+Vu7MH5H;Os903R3>mUZ8wwJPQ9uU<7(Z%=={DHQWj?%f?>WR z14FUpQsM;JCi=v1nVIL0&7p@~N`_~JmJ@(k;cN4g_Fv$)c{R9lT+uO@_#k}N<1^_L zb-fleG58s{(1y#-H4Y=X@GAbahH%k>d@W@qOLgT2d<3p7ugI#hM1c{Xfau`9=}CpJ zjTB$LGK?2>QG|ue=>}$|KStevKAK99GtH&-E*K(vWQF7NKd-cEzULl-iZc85uciM8 zank`g%47$o?53sc9OD?;P`}t`0U>%!ym^ygT+wC`{bfa1-y^#k8SWA7>%paDd9&u= zAmazgUW9IK1j3*Gp_lS$Y2Zp$oSGPJb_xvyLM}a=nYgqYG<^uNO#Z<@uZl?aTymUm z8X8)wQj6rnUZ@S`=;?c>pdGZhDejrvc5|}s_2e<@;+v#e1Y7UC3APAAZJT{Pfa3Zt ztSgJTdXw3J64*?$FUYQJ$CK*HejAjwZ)b|CsZiHfJedRirjzjug?{A5vRYet)X4Hh z#H#k2RnE5^uy^ZuHumC6X*bqR3Y|llsNZI~ipA#X)J2HuBDMDt)v_Mz!=W!yD-h+2 z4XkjJ8*hT*k5Iw$u|0g82$$H@rJ0KJvYTT-lp~=kDw|YfF1L})JyU<{qczV16bfl> zIBkEu2yrFtDH!qc4#lijdY&w(Ni!J%0C8#RYs$hF}z(RzdxlnVp! zE=U2rrTS*m0IA!I3)J9Z?e=x~Cbnx*q`gii)vVyEN21+Sbc|VQuW*UsTUOn(^~wGf z(8jId1>L4m&CrD(>ude;FE6f`YjJHa20jzjlS2la*U-KHRS?Ukmbdn%qMI;{yWdb@ z-L@}k@XfKTNXp|ZdPyFNRtl+D70Nu@k+Sd!Dgsmwcm}QOUjIs!{9RXX~6Z zP#5*Jm%B0}%zfWLCmNhl3e73H2ryemM@K@N!X1m@WH+_p7tT}bE$WpoQA_3cV#s$@ zvk@6Vwh`?)Qnx`Vi~qHnYScxN~1;`$+f|Y}l4~UA6ub9s-Ci zW^%EnS`HNgSxb0ep()J$COBdajZPm{MS*proZPobk!c(e(<{7hDyR#N`Nj+4UcQZU z*F?XqBM>@}*+#r2qQft-Jgf&{egzN9_XKK_b-v!)R&Rrfohxh+xe(A##H*j)N+}N? z#i^(u#kpmnvVvy|O4lgP_3XwGWjw!)dyBZkTV_z~orcBn8XXDrxnj`W7%Ncb0rilXR(7zmT;X6?``Q8h^{Hm*u1dIeqD zvIYQe)o-rSyX=BNlsu^QmVGH2#fd`%5o5HPs+I-;Zh!ekEEXsH*Z<+$3 zExaqz{$d_^uUIZ^P+tZg=MoKlkNDAq#x=O&3cQ9d2^(+S60KERxAz4W#=D>1^E+d- zGAT$$n*wq+LAo5x)Rt(|qHU&906_B;Xi0SmPsO%$&B%EJdBNJ5rN&ckNL5t|Tg!%@ zNZv(g5_122Ex5-c@suK>x3EKvWcbK)0Y#LF<<5-Jex=M}d0xFJdd?MpnYH9r1&Q^U zTl_1^UVkYh3TV|YPnNGbGFyw zpB#dyy}nN_-+Ju#f0yuH*#}9oqtGqu{7J6QwX7p~l1OB==%d*lzX7gg42zd8i@P=h z&!VDDRaDBcAH9V=ob>%0d@elg0~ayPi%5^+Au%Z^7JKH+$Q(CQu~EtvUYOd4!Dp7s z`zv0C1#`~hZ4xk3#oV9tt$wnMf?*8C#E73)($^qAmZ<9$>&;uL)rfialVhkAwEP%$ z`4Mwg=KntZs!9b)m4GjFoe=VaIw}t!1meCJeabUAyTbugS@9l3G|5ir!5rzZ{L!9%uy0 zy^NQ@%=S#hMw1Ivh$Fi4RB`;cYgs-D(f!VRO;wKbKw%l4?qd;!JU z60V1l%bV<4byP1nh0?w>)4aK|uQ8&ceLO5I1ypdcio#EIlEU!Ev_+T%Ihcux69S{#}sXgC`XBVX_hLGBL<&$H?9cN)`5biZ|5H` z$)qGu{SJtX>JJMME+LhB_g{qzdwaG6rPaZ9L(xlm zZ({I|5UY^Vi+F$k-`+{RPCj>EyBXlR?V5>$jy#G*G&Vr}uMx=aB&REf2KA<+P4$f> z9oIZEEjw4zDw|8LJ%Z^Qd^=At-dBH`T&kJp8)VI+5985bW`0;m$#G1f-w)RHwo=jK)z;3yuFK zLtkJHe?f0k*B%eD<|m)J5(T8h>dryPK~o2^(t>4Cu8@Uvr@66cH>|r>N`OsT+}(8h ze8pBjFjpVc9S)y`>)RSBQ^d3K7o%M&EPV;2(!>yfhz4btWS{SBfrP;uK>K@|30De! zdziyTHCF1R%LmV1BlSXlEcW&M{P)NTQ^&`ZO{!@NkPqV(cv5Vk8RrUIhmrWHSK7rx z*E71+ILYok%t3&zkVI&7h_a_RYOhyjsx9R078hn!B62)p@~y2V%3@?1*vXMa^9wiH z5D58slG!@1AY&1$idtsa&+t4vE}3s;Ij~6h#sXbW8+v5;F|}wZ1MlSbJPzWDgV<(s z$mv%;dGI=3N>cbDJcCBlxioxJ34}hHX*SjP&CyZU*|+DMZ+ho#&+^16`{hM9)p1c1 zY4!--L~=`yce{M%oxLr)hbIH}bRSvW^ni-JFncvo&kOi#W!3xlrx6Z8sasSZ!OsK1 z&z*G8TQA#Mx)kTu^V?JpL3f#Io=WFXWkj*jpD#9r&;1_F!Uj;^2 zv==r{`}>u`-$9^b7q7-#7#1mjMp+`--4a#Mf||hg%PF)UaH+(jh7+|c#~$BTDzw^m za#ZUvSx<|+klsWzr{|#@g5pcw1&Vsip#|P4ED2FyE#)7G#Lq?&4$nBv?S}HTT>ODS zltOowN81trW?u*At}6O6(Y@YtchE{I(r@u>E2{u-HY?H*4ZMTz!WG)kHE9&qv|=}` z-+VfgmeG}hO7EqUdS9nWOoZ%`S~ARo=&FCemOM)+RC+d?H&N&_d>}>nEk;=47XL?@ z$JoBITQ*L0#6KRcr76Zha(%lp{&v#xWL6TIp$@* zsy=e5IzPk1T_pTE#_gIzw*irRSFsSUx=!mS7iTPa(w1GQzsLE5lMF3>HTEH16~-W@&CI6ZA##i7XF^2OfC>J6dY zV2KW?^(-Hy;A|~PFw^Fc58s{>emfRqrLvSbG7?rXh2)5Ci+a_@^`iDpU<=io~y8Pf%Q|C{WwPPzki><#>G79sJYp77QomogGS0 zxNkX)Lw)3&oq|E_yh78jUQX_r7M`7VD|XY+nDTP79*T#XDXH=k2!xI&a_?Q6-d+w=WFWZaPk9b}c-?TzXlIJ#D2Hy)g!`X#)r*u2y`BXZ#g%b*UoMNaWRGN+{o zt9Js$x1{UyhoV?s;c+Bfjbbn#ft#Jyj@gv~cL3~rIvXc{w7?F~m!Y>i3NdeaK87BG z(zZ_K_Eb^X<=x(1vNSQXwFbAa=$Yhv+hof}r2DG!Wey_+7IZzjpAuOgqSVg}$Xu`T zwyVmaD|!i{*BDqTuIwomnQJgm;Bgrti1scjn`>xj(OcXdkB}RwhZ1tkj)#RT>U1!6 z1{Q8v(jGRG-u9*+nfH+QENw4upbCgE;F1zut4#9F`_`sq67A99$aB(gxIqz^J^oQ< zgPXea4cZLsj5UyH_1Dm{DbmYKUN18e2=tYGo%-R0*@kgM#gFF*no;h&&Hbs~$7AKq z0W5FiB^QX^{hvg8?Yg18_;Q6|KP}^EmO{CW2TsKw7Y$qq-x$ioh zt+`y*T_i?D)o*X1CWue>NT*E|BJa8cv#M1*@Ab`F9L10vm*HiJVtl3A4}D9NMWlH& z4_RDOTveey`Swi0!zRi6Ob3gybhlEj?>>%k8MnxGz@5IUcI(j7<%Gtlk&cteOL9g} zmXW&_hahedQG55*)xOpE#@y()=QrZb*3ixkdcw9Q6}<2X5u;~0dXTKKOZrfiu!z*n z7{y`zG_v_MwzmUi?PVh^y$j=fpM zD>}Sd_kI~RRsB?}l>+zel-Cw^6a`P%ZCzFtn)A~LLg$6b<($cR9|y^J&$&FxN4--T zwogq9dLQm4WLsDSNKP0O!_isXxlA+_!;Vaak{0@fAfdV-S@b3_Dtc_laKfRmn~ai5xR zlYn?Q)LGLQm078GwcvJD`3DL!!u|`eN-^Ry9d?Jgt9FN{(w69a`*R)s`HiOp1;krh z)tSkuUddY8sTDB$@Iw&tlwIBO1a7XH#=rzw$EcD@&M|Gf4_#XA;ZsR#0Y?U%Fx!vv zh^}H&q9}HiF<{2FELYV$++8QtXyC=h26yk|;^%S=BcuD%4mXdJZ>ut{6CVVpGFy7A z|MaT@0EU7NF(QwnB@-^$;GVJ2dqgV2h}%KM9w@y#A_NeNB1H9LqA^(ZcL$r<-VKTy zS=X)NOzm(Vf#o=*#}?V-*7s@UqT$>hM`O>{T)QSrDtd3?;I7|`pxo{MJu65?<7ytF zlcTo?YzkBy5B}I(nbF&|8|su*Za$ZLK`bI8C5_XE;7Soj!oUy0Np4{OGX{WHCn)>P zKiP^4#i~nJQsw+4`KyhH5e~;2oYLWaMsZ;CVHMJlS964!;3kKQvB^0Do4O1~?w#{> zyvjfN5=IU|pYD`a^t4gUg&im|Ee^nF)Y7Z$Dv^YXsr<@Dqh2Nzxv`C@2eqCl$al~q zw;S7u0+@#o97fw?AbSn_j;r?;IYC-)$in6*(vz$z7T%z$2FcUfnNL<|zBkp9vi6y6 zXHe8d6iOYI!3Z0c73wvOM%eZhN6+C`;S)FrIwGPfRpVX48``!OofyNR96uh4I<%4I zGAw=vALrS=r#wkBKO9NsdVuSb=QpTxD{kCe@C%l%_@E~kTG{7bK^p}m{U$*4H;9E3nFu6X#GvzHZx3 zlBXT4O8@Qi@ok&(YSW&kQ!KB~DUt}~141?cZ9C6LH9l(?Yfu17-uTGX%d{J0`1cKH zl3d*Dh8tCkh5bwVu)BSv=*N1QQ_SW}A~6;|%)+GMG86VbFcPKG)ZNS>of8x z?U81ZXYzpn{9Y<962OdHz*QB*t%9ik`o4b1F}EYek6iwrcg(w%6_ zZ-d%`3Z*7`M1P`F8z9ynGw1%n2D~+R8)ih(7VPT&<=y&lyGHb@z1cY|G+G}Xod@sx1jny!^539Hs0E{7)k?;i|(YSXG%Zb7Iz z$D!q4MY=3oNe9#;xpvNZ0U#{s2n+OOtrd={npLBxH=V`cM%uTOst37HJY3b_UmM$FNJ z;~RKaggIvH(!jF3YjAqgfoY0e>!RU&vb4rH)&G*cFY%&lE(T4~u?gm^zlP8+58Kq< zD1vD!MM}hoGU z=9z{+d~G#suu4H;s(0G=Y{&>yZj)<>iDibn!;4q`z6!4_k$wi^elV$tqq15%N|=iD zRmO|ISNF@vh)XAnlAsYWF-OBMo&+~ft56~;#1IoSpImd`T z$B$z=It=z$AxVw_uDTI5m9Gm#_IJo9ELAjP$lr`yT;I3;{%q&1!atc}=-+R?`EkSf z(w=e0{i7>Ar5!_~?MaeH5~cDh9C;nGi+8UL8$^u+Kbnr6jp)%n`EhhYyjs`uWd9_$ zeTLZeWR3|FFr`2IgG1Jq=!V>dmpNsF`|0-GWiY8eGer)UlHdNVm*C}j$$TV>b$aR) z{zKMUW!AiCNRNW&^!YYXT#deDzQB#Cl8O8;cX6MIL%H|L_1Mf(rI3J&+AJAYIFM(z z7t&_rk)-|k98@CYx&wI_6Wd8lR%WxiUx*MZ2QN+YsmZ*s2LPOm>QhIgFm`!b-?Pl1 z$Dq%kb#5La82c!}&Xiob?7HTLrTJX`_Tge71wswHu^?cT%vKkatF4N;mZQtZ6OHl% zLKlQn@!#-8vI1c#9(l;cw$>EHeXRG}>n@@b?r11~UYXAQZ)kUcJYUlDx>sdKmXuPY z*tW}fKpyxG`0%VFdvi#qIO3JARr-m`j!{ebZ(=axTpRFHEN5 zGT*iBa`o~af-bNbJmawBgoi`(&YRiN{3_(%R2oul8I+z-KDzX_hzI0%zB<)A!LWbI zRoOLr>khP2N@bX!zPdv`$sYFo#lW~zW}H9t_3Jxpe8>+WW*;-$x|?&{^mm$5Qxue} zf7}`F>ckleklPC?j9>vdWdIm4ck^a zmXp1hQ&aH)W=G&#&jJxgnL|pnWKGR=<|{zIc858@OIn!Q6UH4$;f4ALea!)y$Mvk6 z>9DSTV*pyKqo;*hzmRw_SUuLeesR}1211w;4ZoS1TRgG3#De>F!$xerB*>|hqzze8 zc6#!276UPe%;PLi?KZbEhZHIaZZOU~EbcO>9Q4gf!$={Lpg}gmxN??OH})6zqE}bR z)+gT>ncKHVrPs+>d7xdr2HoE)3xwxDk0*a=#%&Ms8Lq@@KaooPXY#PpQ%f!3n30rl zG_$T0BUD;&x;A(g_aON6G=#X*UF#!y@eqkQj)HzbPH zqj|XTA-LH(D-5@2lX)7BPO6jADX&43%2@J2@>;Ef=glHjNB?8Kc2E z87;5>p4hhl zU-Duz?6nJrUattdy zUIpXxktqx4-?Q$PTuxU9R7OM)h#@r~?=b?t_P%$(&&Fa%74x}RWU&^(E?oCWitQy{ zH78#4ns|CE<2~sPw zjN{kqDktq~43ZHO3(&60h!7@UU@kVBAKn_B>rYZ!RhMfdp=8nJXYPTHGJL3{`Y06g zLpm+cyW$t#7?x_9Dml8L^rqlT=8}oeS@Nb8BG!g6AK=%Q%D0*`2i_j53wa;)vd3~? zl|EsVGnQ-6oy)k$6{@c~2}lsTrVuDyATlHQ;Kz1^6XIhe%P^XR)QV~+0L1K{w>KA= zNb^|$7_!@zv)j7{Vi6)2%r;<89hhjlvWzBG2?lH30eBT8Fk2P=@$LC?&4I8&Nr|<` zI%XE-fnh6>Sx4h4=M{UB@&b0F#Q;4vQp(pW0hgS)EPMdg?n5 zoxCeVT~v5uU_7wxT~OR6DokTVU$r1}YqJI-oBfftu(yO%|N0BCqAdYp327_bcOG|D zd!NjEOI(;5K8E;m(yy=qk&pFo|A?_|RbZBU1b;EejTdy3@RiBRoS+dyGIXrsRHwJS zXI(&ng`cXx<(foag^YsAtGI-M80)rEt!AMTO9*wrm;022hKGtDR!n3kX0L~cf7C%H zB7x@)4hluSgZy4cfnexZc+D%c7Yyc(*79g0xlNf(~8EUFU%Ou zwB5?#k@`r^3>7Ts8nu2(E#M4ZMgWBF2&Z)kqNODn%wqaYRa-ub{`h>(RN<5^>NavC5m3AtX-_w_cy~Bx zmc0G2qa9IO53$sfu1BhO6M62w3B6cqGD&t#>FKt)TuT~9t;fDN9n^UEZ%hQ zE0VwGc&4bkq-g!KQ0A8_^PR;e*u(v9#deWtScNFs1r~ZA`DNJFZrQWB z5j_W)u>YcSvU9D4Gv0tUv@=D}Lg?3*1A==t z#exIDZR&S>#=>%a18!XARQmZpK@ps{HoW-ppUzr2O6S&8Hj^thU!-GXGN*R0T0lzK zgPde5tqbJ~hI^5_VuAg1dKXJP`$Sz8hTDHEf!S5>x|{DaetYjh*&gD1RMB+f-d->n zm)*t7%h!7sH*LlxJ0IY{{K*nlu*9jjsEX~wD8iAaoWidMS0=RRK%CM9VsNrE*;w|B z*fO(AQA<6ul>7X-Kryv>DRJpX!w^s6{zHA91OA}6M;aUvDOU-BJZeyi6b0PA4@ZIZ z4U(!UN2qQxm`tSQe7P{jZ!=^t^pOXvCEA_0l`{RNlG_|VU(O~pXb7sx_ z_neuv=G&~Z*5ng!vck$+pXa%+>-yb$`822C)Dq+%ZqwJ)1^%!Dqej1xPDz4LFRwz-oCIeQdDH+maFhO!sJs-ddCds8O zjWL|Tn{}DidSQ)rWK#fvE!C8u(8IBUq%3J6^Pom>W;B6vS8w!G~T z`nS^yDU&H=3d=y?v7{g{sUV8noS*SbPHDk6nxw6)Bir<-&d2#cQf^Y^`WEaDQrCaq zIaf8?4!7Wr;MCh^!Hry+BcxqrwdyefJ3Ode%?>y-**x!7H(6w-TB`h6e)=dQcIae z{UqX^q+%@`?*jF2}R zm&Bg3KV-HTVlZ)m^tYGmNIcT7=hIpx)GOAPXyb53ccHa6{jy9Y=}zM=eZkeY%Fyqt zf$mIDDJP=0T_S3&qRWFoj??A1TFgNw7#pJ+%1xBQ)2dpZ=f^6P2K^3eiaG;H%@jif z?2iBE?{d+B`t8iLIK$GQ3l+R6B9>v7Pa!t};Fs#LNvEAhNIE00Ur$^lZli%5!yx&@+?SgIJl4t$12){| zZ--vrp)pO&FC2_Y#G8m+)He6Ma?7OAwU!N=boX>!^WDvJGr3m_n*25|_Y6st?YQ+L zs9Kb!J)X2(MZ?!%R)nFtI^yaopH*sE-LA9md(w;Hr2!KMAU~(NZj|;{MDLs!0nC$% zK(H!7xm}z}a~0^3yzMW(>gl_FkKZ>N7Q);-;$vM`kB38gHY=3#d`m}l|2l*39wTBH zfD@vwxaMkDR1B+)%gOd7QDxf3R4(mB#Dp;?eV3kgMyi?jsS8Wu>c`=*7uJLpJBViA zo#~q#jO0aZJz%FfQnxTpOknis8#( zTa(6A;;4~!*q{XGoe~%#&y!On%6QsRd{mb6J~F1udi$1q)OQX~GxxNRYfZQ7c(aXe z5%~4s%gUWmwi*>)tAg9B!h~~;A64MNnHwtvC9^=7cJ$I=Ya7HJ^*kRHc$B8@0w`3H z;Hr0e^FY?`iEKSHw@(Q}PzuvibbIQzz}?7}Qp zCDrOk%OSsXWZu?@;JEm=m+T`T9+3DG0@+AUx3s@Ojpm{RFIsRiqv}&Q zdRB@E$XSF^t#3fz?(U}lMgHF^b@_iz4EW>V0r0drQS7uqta|)jZ6UnW_5R{Vczcy_ z6dM}!Yo1ZL=NfNp>j91_#1krhM+4Z+pRksMBHYeAM^o~}KMVu}nR~tJiZZ2|rViV> z>Rx}XLAak4Rb3>``vXUUOj;;?4)h$A4f_Q$|HN(X8=LaSu&@^=6~1avu;N2P6RNlh z==dztAKTCws)AQGNSFI`)Or)4oW#w50!KuCsL8~RK z3oxZ>hNFbMA?63u_sHgE`(o*HzqQILEtp`LdUrvlH?h5gOMq@dh^{ib_NnACj^a4P z-vpt`!7+UJ@gJo|p1AQu@QcztvXaD=X2oRUEf-INmC6n8z$v{?Oq`BQdwrLvMUz&I zG@=U}MHI>Us?ChCWKxWRJPK|j;o|!%ED@))qO%))21`)$G8Y1tul27%zuWpY*Y@>B z{?Pu~jX#|hAK)bBZt>hINIltOA5EB zzBYIVCs}>3akM%$R$&*4c%UFyR13c#=JO$$Puv}IJ4((o&=l%CKTkx+QJw62*dSAp ztpvdXFHJ#2V~(nvTq&TW$r$Lvwa%zt(h`VQ5VvR+U_?Q5Z{eyp-H&yTOLMyed1egk zMp*Y&n)TXX)Y{jh^YrjYfjtL@>62$-%IMWwTtJj|zMvqh{F%0;J25Oi`K&~2r(AfG zM*o7LqMtwz(l>Fy?zy&x!_3Kz_VyM0!|;N>;apFcq0CL|(rX#K2>sS|>>oy(?F9eg z9fX!j*4b|P=VMqZkv|u1$Kj^C$w)=hM4EYR*W9Ob#5+iYrryLRL$x=&wsmr1=#&yT z9`W=iyiXIVq{yzjQTX0MygBPh0>&M)2(msL_^aWmhk`Pv*T6xU$RllbD&XhbSRe#F z2{iVO9V$%m#$el>t81*!DIO)aYCfKM6*XD6DHT(kx1Rbk@M@k@L1tlgcM1?axkH%Y z!FWL{JDJ4*VW}R|=@6Qyb`IBgH<_esLS{7=jtRZ?q?NC>iC`wd-Je7^ye#w48Wqp^ zeaVxxogd*zutT0a$!78N{sq$3dmrmW!Cb}kiwoI@m|Exe{iAQSaQ#Z{O#ZUv(ce!y zR8#zk|Lj&1?d`>jR~KqNaU~~v`6j$rAh+r58&f6d(Nf5TA>YOiHsWSaB7`_M(#U}+ zb$8)1ykb%jb%-uKCefH#-)DJ_N0;1il~yK^*T8vs)-7L5?Y$7L$Pk@pSiuBc!9ThAPIsM&$PoO)73FCMF?yxfN#I=yN9uJFtvlcl4K6kmm&8^u(N8=-|b zO)XLr=Q5}Ocn!Rap-YZpF4;v-dZK3@TURxZ%EuP4P+m^w$0>}6F%-QZrdmmGYXPEu z9zc+U`Jn0DB0Kh_n)=aXHa#CA#ui)j6f9JLS3h#0!kwLIVVhL;IzsL{TB&^Su)KR~ z%787RkslJ|_{j&Yxdo?b5!9*2ZH{x5yAnRBUUH&QFS^7#QjI;D_UM}`1KU1H4g^Ay zUq$BL_JiEIPAQd2!map1PG4JCh=w{kmO zhS=BmwBTyF$|mvJUK%DB6xqM#~t_? z1}G@}0$skW@z-z)a^%!rb$AzQ##vwNR1V0JZBE0aI+e1+r*gEoCEvi;%eAs?lGT!y_Dqn+S%{YMVR~r zyRg?hO!fjHH=Q+BrQfyz^{sIPVl{ma#Honm=hZ7X3A zo)FoQ84au-{9;E-$H@6le$U7}v%)vCi%f3ym8WMOh>v3l8cli5zg@{DXyTZfiT@_m zt;rCLP7&_jL-MkmLh-sOIHu?ui>yq)d;cQH^a#7qtU>;hpbTABj4n%U{%HLkfe@0+ zOhQnu6w>(ums`>*oW5y1a3ZPy02MwcksUk+5nD+z~5|A@^rQPo17cU z-1aBpUz^1Q?x)cdZSu^OR8KWJ2mb=K-bPegAbjJOO^A~w?~d(~TE}u{`?$;9@@hJ* zvc6wQCeg*-KNSBQw{(=9hcXuv*@wDP)+QU$oB}X+3wP#P&C_=hi9O0j)`i+P#cKH? zWz8~V9$<|O6*etT!-aHNI#TuQ0>l&p+7|CYeIf~NU{Vi2M-jV{Aw(hg@4iG@Wp;eU ztuH5WvMxRy=rb&=K5m_MU99c1NytLqSO=a*(}#q`Rn)NIL@ClWF{4pTGN6sXsS>a%CXi{xpW(HwF33E*1bK35V2 zU%v77xX7-0Unu@hb#fUTt7-aZTitxfhU)iXVuw)ZhgC#yvgxZTCh4VIofeX5tiA1V zuqjlt=oTP_Z&I8_EMw!UFWCUDEx?q96|F8v+~pIv7qAUN)OBb1*iy}C z09&2TY0ZeTsa%GyVzGY~0kfa~`}#kB1pasU^te%2ex_ObP;Mpb4_JPJ84J9syMsev|oWE^G75klhJ;!!>VMI*P5$KvATxRi_?8JPjdA*&d4b7_bWD(*gPvow|4 z+oMgVr;*#mC(5ATYB6=|aglITtZ=1K_Qrj%O-}$P-%FE|>=U=jGjpXr#v@`1E`y9$ z9d9XXPY!I21uWyiX*K+aTJEoEoBj!dUCRkZjJjwEm;_=kWJd2r9(nZF)#z0hnOaxfg0 zU(&AcUWurOXtQ~>%8`NUgLvw@`3%vbo#8lchcJ(^K1#`;&(Ikrm4cp|fjlW2{$|H> z(xHYgz%2c>Z5$n#>;)M_uu?1Pn-{4{tG?75RvMK={OLha{{;e1^pD;Kfv$zzsHM9X zgiS|~srlJubi7?YG3~g+y@~2MQlk!0Rpr%m2tIT)8?BkOTkpN2H000gEuQdJh@JD< z)fo0L+?W)wX1CZc)g>4>!JqRdi_~ACM`@JvjtG>9VRu@ejM`=Bs%+U9RWA>5)!>|h zE`@?7oVAk@ySiVx2Uk<>@ z3uAdQ}Pq&%@3J&UrvfA?GI)=_!U734b@ zR+vCfOlkYJwbyGP69NStZKfD8wB|;2h3a-Y-Zg+%0CkZWbfFdVf z1_wptY%+C`z`v_pL$6_7-nL%e?9cWPbWV?_cgT(a&hg*2=pcC8j6UCE`fU7>_RkX#t zap=Gn+7(3orHH)CE7?VmpD&H;RyWS|Aahb%v8W#drFR7!&y~mdt0nl0zZG4xH?=}* ztCXG1{RO%?YKIFDPR;I>b`hj)q!OxE&VTE8094pc4YzX|J|B(Q6j*mfXw8&0x@ro> z5eBGmh|aD+UNEn0+`X_c=qg}Ac_+TE(ZU_$QdS(|=qS3vlpIR!L)70(4hoF9+XLbS zF&_WSz1oyG$6?j8pp5@77NmiZF*+xUvTSO%hjZI!QK?Lk|t-l-`0xeATWth2e zhTVB1OZE@NtlTzrxyw+phtYJG2Pes|EL&w(ELfZ|$r_9*g_wx($*+LXoXQ1%s`?pp z_IjefN?b*u2A#R(o4gK$oz;|=i08f;gFR7Cb}K&SRJ#rGhQVMxeGpBp3pZY$mA{*1 z?KmKV$Aa0b!Xq;2pwnif#(D?W<1=auFU@1+@B9z3ZDjw*__N3zT=S9O*IyutpibEA z!6(a74b@5h=Hs3}JU}2D#f0c3W5buy`;ifO&ITi@4<)@0DtO2vx&!iyy>rUm1-fyb zG3*G~=6DKsN<{HT8R?3INCumB+D-xW4wz8+p*S-}*5X!^3{O+uE1b(Y!g4a(WJg+k zlGVfeOM8_0QgC<_G@v(*b(oMQS`7e=Eu!lxSRTLnFtc*1VJHieKNS4N@k-HVFu_hp z!u)(ywUoz+I8VQ!;^=HCa9?ZMVLldZ+8yz-kQz15ga{Mg)^v<#M<@p10WqveY(0tt z4jt_Anj|om;d%UzB@%LR8JrG{^rY)T;vX*!Q9D-n3be#*A!{oXVd1nnRf|vZzw5ED zc8Ei~((>uw*?UJFpO;UyJ?4uK+8UW}W&-_3kt};zb4gQ{y zD|=jArWtB}MTk~S!_z&1hJ{{K&Hxj9R`SYQ05x_-<$X%0vtF!moOMTs(9=R74sI&e zM5MzXRSCUa7)K3~kb7Y2U94yzg`6a=_t5M6(5ih|nW}A^vmxF_cg4QcQfK!F+0@p# zdirYGPnzlHkPjZ4{6@0Mr;RqxUFeq>ARaR#`nxO^cy<^C9=@qmDv+Om+z|-#7TDCy zW4B!qXut4QPh6O#LOwvAtSu_Gn~vGIS=dp#;3p@Ycq-Z3NEKOr(E9Kfh&iWSG!OA+ zhZvgw>H1pR*`zN0=9@+TBcvgZtz}!qBR4}{KKpyWub4W%%&IZuMggXC43z@KHbkwu z=6Aj2()UJr zsUy6*fm6VILD|Fbw8NOCna3{wumCP6AJYznwU*jv;zr@NYZZYB<(6?^$OIwmrKhH} zo4;OS;ycN8UIo{y0W~Jv<`i74pkZkYt`@yRG)w33xSmxEJvPu0(t5X(np@MG?cyU; zUlP}sWs1#@sWAyQtKJ@cn;{_J`x1B6kj?zIk4VW>yO8$6$`$0G_=27F{H!*6&obOn z{OK|8#FCcg`!8`HxlB`O&&HPfcdv313F5*SvTNk{#7|ZEuw!|_>V9jMk3}^#MCjhq zwG}wLn7bw&zl$de>Gs>z9t|fCzYD=P%HySNny8U!YH& zCojfVm7?h6eVy?+{*!fWZGBS&3#Wwk&22XMTZ3s*feGsB8-!P$l=KvKeV5Z-8M4Jv z=c}^@8L@vk_8A;X8jSMIQ%CPbvcdv&r3?kVp?t1as7|GW1tkM0AxiS=*J$B-Jt&mj z27Q&D3@!l989>&)YVpV}?uxGM*yVPlF!)Lxo()43fWrP-z=gojKSnhHK^N4d}sHhN=<4SdApSHx<*6{IiqE}=pb{C zXJfv0{*PRCkKiXd%^$BW4N0-)*i8kT1-BD&Byb-aYT4ZG8|3YuO=0=8%|rIg zX_j51%P4ZyJCh83cVqer+4oXwTPIFCJOGI{BUI%wUhbem*fa4#-h)#!oa7R7t^%7Q zxkd6TUqS1<;G1hmr}smK1_t|2ONXq&%6VJl#nXIts(h)>?ISlt4m**r3N5mmx^~_} z{i>G#Ks$27J5-;>SN`cy?EgOBKyVhf<|Y$uV>&UzSA7fZa+gr8W9rR$vDxn#Ha;z; z-O|(xkN1SVFA}mX%t~8d(P-M|c}oC>Hs$W6_Vz8`WRjgDfSUl~meI`iHg4(Oql+=2d zo$>-#bDl44(>HH+5k%8NH5+-%XbWZ~$1ZE$b3@J-c-kYe*gbExt^dZ^J^R*Y<+$89 z{j!|==F-qYirz!#Ty#|Yl`TyU7mY&vPo%&fJ1;?;rwPi% zXFlHD2$)OUF@^DBZkr1(PT<1iW>Ah<5U>93zQ`EfsvX~+&K~6)$^AZKtuw(lx4=5% zVORx-pf`}>mV=)No!(TxWWznwcX9f{%5{|Qvmpf_j;zZ=92~nvQs7imgE(VfkGf=s#mC0W*Z+CB zkeg2j={Qh|uLBrDte4;W7`M%PxH%lLzBD}rfkBYyfUQ1=N$W2V%l+D;R=#xgM+o40 zm7{YB-1h0=w)1LVGKMg<-jfP0tG3pJx)Id}6tfUhsrsxf=#~aG~yPjv!K&M-Ng!i&=1fx0cnu;WBE7ft40DbH9rH1yku0On~*)IysD6rAT(OPvI zLfgnTsl;)^TbD`NHuNP@Xa0>ugZ+I`2?exCGiisRB;1lphT>hUQ&#%VDNGNmz8N|t_sgL3SBp-~cVA`*@x#vL-v>pV zM6DlBg~{iJ|DH9oMzwJ(tHt=A|K|$_htnC)TgIk7=IjAa_LHO2%&L$1DkBc#!Ah4C zfEjaLafD~mgdC6mJ7>RR)2J^IDpe}NhTz0J8YVQ@Gc0r`;|_;dDV zi%wt7Oo)hjFeEqh8(iTlAve^8xpObI5z<#h!LF-qJw}NTxf9^}(3hSTu?aqeOfd;? zQEAn+ffJrTJ@#M$!S|&F9C;XZdqu}D*P%r2$$;G+^Ze2m20dMkaDyk!0(qKGq>=#@ z9&zbM?i2f9qGC}Vv%Pm3>xc2>9(e1;osGKt$=Yn>U}FIl%I;SG(L#zV3B_0nL&#D%#LYUl|Y}_2K_U zx)RH!<3vDyC+2PAFa6lxpP)XBKi*cUuxRL4f@)eRO4k&Wersj9NjJWHK2Zk zcmI4;p>KHgRQL&|VF~1^Qea7JkQEqs%1&JoTC{Wdb1X}H+)2jpnZ~wJPCJ5nAZuuA zWUN~p0pI)Q@SEGZ?Cn)x$eT6j>!?nLa*Y_+vu923ZP@E44W*w{cq1&t2zh0o)BAmO zdh@5@=J0|~Oa8$gpS!DSN}APBwTNxZ4m$a!^HV?-m}l_xuRK#n^^7iWxdqSGKzCd^ z-z>Z!weEj(C5%8m7q$9DbU}S>v*9@CeemPB+65l=(~i}eX3fDC{LM-F#?OdL-cXf| zFtG2GP9(>Hh(Bx3cj9{0;Ch~GHfAL-q<2?Y#~ETrV@5O!ko^UdxpFhaVf#VCQx8Du zyk@}A>gjOLGim{8z{Eh=;BQ@{_H+_)9uL`5^7u^_SjVq0$bKxk-j96Vg(ER=5U6Z?N)ecV120w zFQo%*xBiw^%Dq1Nqxj>1T&)5>o;WuWDj7|qX3^VhEzd?HV(#CqfnS*WlG~6N=ujmB ziF#3*%T(1$>D!2t)y|G^#LU-D{BZ9fjl#9AB@;*+0xMXQD{!-&wn&4iV3u}|BrQvH zO@~aOAtiaz5l;A|EEHaqhv==kXtNN2_35OxH&RIW?%wLDKDSyEl(R3=zW?cn)6Z=D z+fg=%AcBlMdV{k>YtX1QRxMfs?LK*QO5Wh=*Ai_UYkQ``_A~9n2Gq--NBtl$z7- zhAco|ScAO`J)VKvMg!?sv7o&9sj#y6X^5UXHti#fs@|Fz6G;TbNO7~saR>x*x(XPh z0U~qBL1B`|Ztruxp`1Kwp_cx;MO$@U-q!X9=xXtie*gP0 z`8(azth}ij-F08gqisRiGwwTq<6oFJSNf)g1*+d03J4OM_-newvfVP?HPxJUdjOJQ z9`E3hz_%^I5_kX9guE+2aLzZHD{5VBG#WbjxNExcDmMx@<|ORkq8DMEgEMv+gceTH zAvE{^i$U+gc_^?B+R`@BoVaqxX=#-M@}Y9gqgOYG!XH3k7?7#S_tA&Guiaiao+ zt|+N`N{%wJ=w|q&y|c?Zxv0ip3@PNR{WCDG%VQsb&>ro7(_S{V8ObpVLENd~ld*rI z4@gQmBaiztd~+w|nxQd*hKO-LY@?k7)$Wc)Y; z@OHUgitY2nR@3KKq6JdEB4C;~Jxb?NA z-C!!vgHjwJStk6$xAZd*!>-!-8$~vn=FgZLbn58M9L;(H_oJDc^`7TWu1XBJ_^ltw zeH5fPl8T9upx0n;-v8#?Jnk6>}w~08+n$G~q_z(n|6%ikj{d1o9Zd z;($O7V*b(SX}TlTq*}#wiLrVoi?h>hu=483nwcuG>Qa{s>LBrY`32^aU2|2!W5g-i z_H9+yE8NE`lu-Bw7CH#T^NCS^(sfmO?^Xs)M1BAXBVIbZ`@D7n8)}xybkQyHxgI?f z2n831nk4>MsF8f7>U3ffveS8td@k`9aHlX8Qss{G5-U$=&L8ptIQKldf-`uDpYJ?Zzd)Z+YnOUlA5ZTU z!*1R7vDTO+7M_WZEwj~YNbAWH>)x^*cWbe4v|>1qi&QTKzwWgc433Vid7CUnDUI`( zCvHaG`!CNS(Agv<+`jaRONn@4V_6!vWAoNntAe+jhCy?dnCS*tM7W0AunrIH9NT_; z$8^-!zOwrJsQSmTHP~@R<|tAkDoUOJZ;I^0ekb`byeRVS2z9xC&hGe}>5`w5>e#ae zqTEHJYfB-tmB1BhyQGq!O~5WKL@0v3hZs8}p^xjzF7s4AZ+|>|OUgUEJp`O>JfFBd zk-%hMu~0c-sMfYPIRX@oeP)3l+i!><-wiHv5XulO=)?Y)AV`@Mu#SSMk7)$4kXepM zy^YazUaQ8tvD7zTI)|@}BTe-HyQH3_p?JcZ8xiPT@;X?rtH!~mGS>l+K|7TDql4{l zRP>wO95Y8m2vSWN)&xzn^ndew|GrvRc|SK^S5{o!sdOCWl*T{K*H(Uzph8g;9qV_I zRc-y594oR<1#^8cHZ@OEZ2qUH>n$;7WrhPG4F~|7PpISRdRx{g+B95!H6yd#y9V9o zmQ!l#G^D2mxga_b5s_ts!Dy7?(*IOfKRqvV6pG3BcX=(Hc*xd&Q@;JopVVzB8pJ?@ zYTmyF^o{5Tumm?gaKH$o$$H<1ZrHXz;dyr_k7rbY!9!ih${vkrsS4bnu&~0S7<(Y< zn8$3HP}fL%t-X&#lDTCd-uRiE2hnL#eH48KwU=)V#{Z<%c-u)COm)n6h)bDF5bl4a zj1ky`#Y=xqV%P(;vMn~RHh9Jbov%mqFh8JQe|AoI{__{>{Ot;uI1$O$57t%~i@^ve|c7<10j*cObmHE0X zkTn9KZ33i3aKaOvX0r10qWnZ`vf@RJqHN#8drW=;iV=_kPy5Uw@2%RCdSv zs;UAWST+FjLlK_G~t+npAfXt~5P3Ued- zTC4dw0k@@%9>$G3+alNJe!`zFcJCxtaF6ja2rwcx%m1*zd~d)gCP=KPo=3nB!7>V9 zmAIBq7nhkYi@d#cJH+OpL5a`ed*54jS#bhsWRw|A<{FLy?)1p2fh?%QXl*0WZDw($ zhpcgX7pc$Rc4}w|-7}@K3wU`Hs~Bjh_If1!?#TAMg7z^{L1lxnm~fT;T5*1bRr-cf zQ&c=Ulht1-JT5Sy)UdiY8M}s1QvwREFJ>=R+RcJ%CbTydT(4aCXNQ4d)#qGS0eS;e zd6|RtBJ>P}3maWc01k0;$)x~o>#AM@MIMUyv~$4>H_%Y2bC%pN<-tg>N_3y44VEGO zhWUJx11_X5@>0U*`edRlF^Hauwi+%`gB}DIU}py%-)_F?(KKWoXwi&SBq0Hh)jZtd zfbV^vR8G)-aF}omouUn9Pp#oJx|;h4G~i%hN@@EA66!uYZU3JZ{rpX8%~bxwh|JQy zajB1pM%zrgqH$hYXQ4-Q3_4dm&Qk&304z#Y#~Dc_8o~72jbl+-Uq*9?zBLPV zq?`!Y6 zkX_%Rj*`NcvwxV*OTwQ55%s6~y)X?RqMnB-Y-VQ#KwSmu8d#A>H@aeDlV8X4@Z1u7 zot`e=$e~}#1BeM(CgEuSStyzR^Y4deNRUtdaZysr(XFqcI@4@z-9yTMh5Q1U0(O?$ z?f>hKF7*t8n7FB^R`13nZHF#igrKG6YX*g0(dp*87_1#b*+XzE2vdAxHOc?<`yW7> z6YsPqCW;-tlHoWn37DPT(np_-vLd*}ISD`46v0%kDqQ54sljXi?{o>D+DH0W4_9$F5b#M;#UhI@}}iAMf8UJBPxbp#9I|) z#}(D-^V&r$o9lOYAki6Y*jGS`2X>zj;;t&~EH7qC}tz7L7-_kHV>ILXZ6XP*hfcQpbt#6Sz^!g7)yQ z5GoE~{T?T`z&TJBC$;O!qfBCW#dKO?Fb0|@VV`xM|2~hPGa`(#kO9-swe;u%(a0~) zLWmB_cICf7=jVTcu!$^6*9z=KYiX11u582#Z6R!r3Ixh8Kz8CNUhyESuT=ofp(o8I!WbUWHR6t7t=4_1T|{y@UME|5vD1ma84 zuqnevOD~u5rQEQIS9D`9g#`#J-YvVbr7}-hq?bpLTqkeWaMT+KH)@5sW6)vU$V_WZ zJuS@()@ZrC80E!YLKTptpz7vxz4@|YF{x~D{=328@=l3LfhC_8%n_wuz0 zh+O#Lmw)fp7K5@kvW!`cH| zTqfbGUY!~%aJZMeX}`BzOnO9p<(}kgkK=rlXjsM1r?Jn4MPFV zJG-T52x=R?;@cNSNudL>_|v1Vj7(_a`m%7A}w;F_#FK-_jNJ&tiFuZ~{YT9Qp8sXDJX09WT?Z4T^gyX6oU z)5-CVUm)FYs*izdS&EV2!VUYB^zb4e1g~gbp8gphuUUAYrRR)vQts1z8&Dyr7hyRe z6@gvB**mGq`Q$am)<0cv*|XP}Y?D&L$|oU&MyK%Du7!kmx|H2-1vxE@fF-MoKL+E2 zzIQy~HUv#B^n%|Z9Ezy;tO^!bwD15yoXW}Ro7}%(F1pRa4{a(-AJ=4S)klcmhyXnJ z75Y3GVub6NRj=CubsyWEx zAL;?+)eC>;=H_7p|BJAKLAnDcS6%)7XAo;m@K51C=prD*#65pkXH1~k0n;p4X=+?Q z4+UVDCn(5KFAw);k3k_Go;DJN^1AjyyOJ`&szP3c2+4bd@XFY7bzsD`h*yb1#ROec z%aW8m$7-j0ztCQa1NYN4o@sFLZ>pgWl)9W1l8T6S-84(v@<>P_UP$05OZ`@-n5Cvu z;PZERzsX|yz?!j>S+n|_^o-(1F@FK@?74;0QZE`aWN%-&-f`j2g5cWArk}s6WtEq+ zX$Z!lYd=vD$URPumNvuw^yc2Fv}A^R4&u>$=NmydECzjSMt4dc8l?EfSl(>O_=)!h z?$(ztgzHn3r*)<)=ImwbPCCt3oGxTz@o@ol!kF+bV=LDP!I6R7%EL}t)Jm0B7obcT z6|9*^#J6b&vxu|Z6~$XQ>#H}+qm261kwK5&4FLa==ZHacrrFd^{7L6!8Meu*o!q~X zS53JZqqGyT@_6VbI!zkGXwa0NQiNGhan8)q^5OMQr}@GdC7jy<~X^*?(25hePX>Ml3y%7+oWOTjck8r_b4-FJ32#d9pzHA zG5tAl>&upZx_D&S)zhw2+`E+um^rIKBl92@>uuXYyGB<}y_E^pj1S9Q(m`2rhTe&c&879EiIujJSPw29bZ$boMTYWgE&BWur}>sxO5x6wIR ziqP$JBj@RNGUgPtsPrHmlMtB}n3$S1EI_Ddl71rdeiW+2**53ft_yR`_363maA)HY zH4co}D%mSO-B-Xq?^|vOdq4|0n;Bl+D!>pj1m_O)y}IM+LsI!-A~R3 zC{# zqGY7;Jq-Lhh1zasvkF|*DU(wL0ok>|onKWhbgkzA7;b}il1A%o|4NkuKiu1;|xc#`-OC8a- zzii*>YKE1v(vXgQhOm|li~yL^##a|#(a0(H_1$LP>sR|}zw6^rPNk=%X}Wxe_}1!7 z$*&>PmaSG*9<#=-%rSILezk-n9=B6sk8zC_m?3`hLtd9R33C3h64L#;_!fSa8eSq} zKCu9!yz)3KmV|vx;9)4HacphK8)ds`{|?*TLx-PR@VgqKXJcT0 zAO8F(fF@%eF5zW(o;7MrL;I$r*L&J`8Zo(+M>G*QOaJ%vfBXpi(U?{r6z=i=b|Qc9 zKmR!_P;c|1kMteK$*S>k*n$=sXE1IyTmISr=0usX9Br7z`u+m_xf(t!YVLE?cE#ar zhY{g*a&!V^ab~+m*NCY+P(7@ z2O6dA1Pa>D*vhwMCN6_briL9lQ^ByB9WEMoLNhCv8pW8bQ^l8x!R=WFc}I4#wQb|b zri?kmn$NDd(;bah(L?{-9;I=P<^C+#L5eOiG6+6}>WzU3(GAqoFn)v75qs&bb`8T} zh&I!(hP z+E9?)Lb(8<0kl)_Xy-fU*~!;XpX6)rvurO=@z6Em02#9ptwE&TV}Y7g!9KH4ye031 z=un1wzV^;Mi7{J0wjSm3r>NY@8c?z)Ed0R5J|0VF4+;=!xmP9qPSQw~h5jW6o%VOR z@%&_F4o3CLt;F}pAQV=Fy&tH}BZ7^VU|@^qGb_x_?~Nqm(Us^d!)Q@`StH!4pwn>P zzV;+|!t8`7K@RC(Ynl@)yC?ks1N9Rw(#^Sj8l?C^ur}7K*r{m9HO)MH@KU{!!x^l5)duv+x(F2)AvM zk=tT%Zz*(%pkkc);p~3Jf%DtxuI7`rEb80gKHHnn;F0|Q`r*0ZphY)(62F72UEU(z zUzGR9jvI-Q*MQGt%rwr?SFEgp9#&K@+0CMhed}Ahnt|NgKh1gsfJ~{R513N~0XHD% zSOPrUsp$uU9k{0OV+=afNUsFaDfM4v~I|jRxhBD7pH~;rq%Vf(l=< z{E0YGbNl=ET@X}mYF@LC$}bwl3lcKFJ`|GFVG}Nh7b!K_k!~nJ=zaQ8MpM3HZJs2n zTh4;$)05}@sx72@twKz!C^x}eKgzeJnE+mx?18x!CjU6@WM0g}1K?SHoehkKj;M%=t3ZPEbzU=hV{-bBitJwR&QwA^&R^5!9_BaHEN64i%yRy=;oZ$${m zMg^9D`}7IBX%bAtn@*Dk5~+Uk5p~i7mz#`W*9S#k7@Th~I2^^6R{k(}+BIYyk|s(F z04!bDb;tw`eGYKb|JzZh(FFDMwo{!CF$vi>Q^kg}n53jI^h2mufy>MH`mVauhkqFk z|CV|HVtMFoUU;t@nz?k>u9P`g4R^EC$YLis*KM$L){ z0c@!ZenPh>B6N&^c&d=uzgV|EaU647F6g~;`Z_;!%D4EW&>?NbCSm$YHNGP@ zq}yAjl3dg_xL_(G^mch=%5k zqBoB8`Z$bWv^6#n9cGk`Dp@6kZvh=3q4hj>87^i>NBR0XR#>%3Ts}EBLHAIp%W&by zS

P$%*>>m@vL5bnfU*f<$hb!6kaZNzv2L`dd5>^5Xr@MLpe7vf`{-JO$>Qgx6@1 zJ;7wB>jFVUz3b~d4Ec}!sJv);m_0(Ax29a&%W?TG*5er|c~40-oCWiH_jnQ*4KnyN zKcV@wqDdFdkekGmMVQOkT%|(QV%@(^E|9k?UVgUUJ;)d@*^~?oWQ3A*9bW=J z8{iEG=x$P$JBqavFaV_ubR)ZMR=eaG`t5UwGqQF@HZ;}uu$9X`@{GJF{ko+4v9q=i z*hj2PQ<*)-dNE%77ibL|Lp40gb=!;ry2Rac=G1AcCVO;=U>%3^W7pS;(hWs6N?103 z?=WW|!7RLz*T%~-r1TeP?|W*AkOd?Dq|e#yB!Kn{H2oK-XQ9v{%i&m|qjroKy49P^ z_uRK(iG<==4B>k@n!yydiX>^-nZ&E=Ziwj?^zAa`G{`{< z<*D1llJ=%63b#Z^-??^*;tw_17(1l|BEP!Uk0K3{@0pe4IY0sBRIp3%PkHI-z|uFh zL}`R`4I`c)hwye(qw1ZpF#KJ>YX0V zEM~v*qrI)y>;)%kA%j%;qYPn-+B6w^^&F{&*DRi?=b8=H2(-YN4PU(M{Apm}TBACyqNQ_;8o((Sv4ZH!?2ew6 zANzfBf4}~JW*sX^(?v0J9T(o_@P;o+$VrpPJ{jnF+^mKC})sTL6M67XKiRY;I$1U6Y&MMBI( zZO+9w0~PzdDeN zl85kGV=D7)^b7P(i9GyWgg+a9K+yUH+DEw`PXRU8Z_{33z&oL31Cxi1E`Zzg8=&>d z6iY9^XzQM^OE~zXIhT6O?A(56=25)IZFiD$na#LKOE649Tb$k`!}%XXY(Jw7O|@5r z93AHT{J8}!HD?~1otq1lU6(YF?MO9@BzkGB`cfAE0qV>P4uMqmDd_U$gCg&}fO~^= zeb&R-@{1A*bZ%EpPZ@JQx#c8M;7C6Np^lWoMKsh?fks^xf3s`~j|JWka7>!9={uro z68VnhAFa;;{9-$OMkn)2h0g9iTj^^)sym2l`JP)t7n;+ekK;6na(6)E3aZc#RsMs& zKtu3=A{+p(NNBk?*P?8HwcV_}%#yT~m>fS*QnKC_{n%9RS+lZXA^Yn#;L#W~@Brkj zfE)KWlD#hDeljIyFeECjP{sFt#XdvYEc6Ch;9&b&sDrcJ5nJeXo4fo7=rladXmvL@#>AGm}$5A$=ny$E&!La>eK0{)K}UX!_UY z-*Qi##c`8|!n0hfEDGCiEONh7qOKRYT7|6jg&Lhk{S7)d_r|ey=uifDavSO`KD(Z| z`ESP&=-cuZnMBUTVki`>y?Xx|F%^&?k`8o>=(r_=fD1wu=r+?}IrtZ_q50r6pr#!? zem7?$f=@C|@e_zuhdA#=4fB?+N$NQL{+8VDtM-&6J(G1<&K@iMXyT9(dVKTU+}Gp3 zmh}!zJoWaj`<~!$?5~`f-oEt<z_;!YkQ9b1( zS#dt>ONXn&3B4gdW`Ptn^7_2_M(*Y?xy7Q-gx|R0r?aBAPBa{|Qr!YH1SCF-U=3ZD zUVoKeY^9>ZywnmD{oQYNCRs5W^~IcA&SNCHK(LPMmAuEQ=-Xq|2nArK!pU3BJwH%` z|J!rzsQ;Lf+lM{io&Ap~yVEc#2o@$&(|h+9i0gTK1DB~Joxva|wdl9BCeF$r^!dW8 zmGU@NSucY^-pRYxl(Q`zCvY`2%?ep?l~rm=5x=KJ5ca)jGphF-<}cWc(~ILm>r6wp zBu`oWKB}NUHq8pQ5>Vau@I{CgwRo%KnO?)Al34M5DW-N3j!Ky5(v^E zG?m_^gx))$BfWW+d*3mBddA)R?z_(z_uN0u{BMpmvS9T&=kt6&k2x*pV9-9o$xSZX zhi~UY4>EcZrlbmp-$Y}_VV1&{b#sC1&3BN)vyb0Z#{P`&}Fkf@|F_zT=;zHF?Ja zs=p!tHr}i0~Dl~kuxJZSUQhQC&J6}J)`fI z)y6>g;Ab9ZeSKtafzF%745W9eMHob0&c_3aQc2;A`xg8edw}{B6ZQ0Bo9xuN&hG3! z_M8=pX?!Rt1+Gz1z&?f@!T_R(L6aB2nLPF-lAeefJs4cH6} z*x826Yk40fYHATyI${Lng>rgCAj-JeC@^N#82ba>ZP7C8Ea+ zY}V7sYMkaig7=C>+$g_DxM-yyv8_{gv-?qGua(!=$FDKSa>=d4SDT9rf-V=a(*~-K zbrR3d)cjCze0$!`Uq(a~mAma+1eBXONnwqneYO8_AL3-5^6}RCfvcv;&k%boTxXr( zUlQLxyZ`u;Pp0Oyg^52~WvcPnxWGy27oh(iTWd~kp!uF{DR$VGZ>@L_lkC1xF9kJy zkJ8jT?HBkRkr)VZ=s~7iugBW;5`_*8TRhY!IyYKLKWrVV}<)mPip?W$U89i5(q@hoX#af)TmhmNh@<_)@ zG(xv+R|DO*9>ebrl#n}adhmWaWqO2YjWt;mXYB~ny1Q9CcW}aM#D(WRZQ;f=d<}A# zikOP2X6G1gSwecXymf!lP|UUhl+o5RVDFOfa-E9Yl*-iD$295ewg4hp0W;9uND8lQ&%IMoz#k?sW;FkY-+vKa#HxZYu_>Rsj(4|Qr)|rUsbA?9~eT+x)zJTd^5eAX^p4x?y4L>48(7O!9`lnXX9Wpj(%N!-!l85NCD8H~4g$HgY>Vi8+!bh)V{^uRP9`6S zJC*6&>|RlD8@roIoo9#HZ1^QmPCFC8Oqm4Hix!jtnq z{ZJ!}BNX8}A&fh1B|=TG<g1kBpH+^OY4S>=`H4_<_2bO9v5 zur}i@h}D32_Jf>Pvhi{0qNvNFSHayTRrQt}fgW14O1=xkSdwFf15XRhgbPTBXMo(h@qb-kl zQ$K@F>H8ZF$2haJX^OiI5_atKVkAt=SeWq>k9w5da#tp%JDF>kD?*FEogMNL?7Oq= zS|@9Qi7BuU`+fki*MhiFyZI{F$4;d^y}|YqBw5)-7sNP*miZA`R#2cAJ7#LQ;KD98 z+DFn`B*n_&!XEtuVOd$M(QA35j0iPtWc-ZvV9qZBz81?BioZt1Ou&hb0XN!|VXukn z7GGCUE=(EacYWa+3_g#LiLpz0o9pNbyC=f~I`voEQca1iw2_rx6UAAS-Dg12bE;1{ zN~P#IFwpAqDXQY>KU^AfL5OPlmRgClY4jjQ!09=}1RoomDrs~zrX4O_K=o+rU)zR1 zIZXaYg5}i3j0Bo;ni0}j!1yBWb$MH>%!bRmjE_#pJ84CSB^{_expTunBibYjtcWY; zPpoJ!%z*h6E$m4I3Im6JOJ3fCy7e#Q@ zXM_20lZz#bFw)2O8rLoPx&PQ}fj4!r$J}W|o zAnV01ncFL+ij9VFeVRU@(X%YIc5ORo;%o;+a+cC5zep5+u73&I4=;#ig z;)`rdso(ku+R&92|Mj;JBUO2tYvGLv5zk&OsguMy2m8a#S(@N?o+;_jrwaH0D`Q4{ zNn3`(ex|~(`aZBg|Eu8!;UI`_;j#2bj>lrT29~$nGH?8#EQc4EUj05nGeMs2d9M#w z*+~OZ8BJ2XIA)+Kw}$=b31eX0Q+~t0O}H9U}Izzi!s62Rp!_%5eRO1UW3#=PnFze*muxKoc{hsiPpQDGaU8UZJ`RdVWN4?J zemER@{P0KN>6ikz^It`C+b1ffhT0&cOM|&RaUA=USdmGaXNrQIjUmLW87rC8b!_`@ zXYPNVtLFVSrTyOcpI?D+w6uG{VDKG9$|ut7^4m zN(?fqf=j=gvQ1J+9F!(WJ)09E=BpyfV|}l^3_sx<#`*&Hm}_e6X0zq7DVvM8t9|U1 zGTse(gDwPePaR&3m9;8hpBjcjZ3@1Z_&5>?00a|2Fvy$DSeygq>lXi@Ou-J4O0m>jp;MZEY-9XE_U3&3U7rQ2KdTpwT!3in8u zvWhXmt$Z6ugKs$JJ>q5GQju0Fn?O?W(GZJ$%#gp9l=_n3S3Qf};a(cy(rK!0*9(xD zc)IFxe%jG^DNw@mEjf;Xpm*RzQ1TX6TKmlS{RQZs?Jonfi4JD(DUW5-Fbq`5A-B99 zwWMrx9zNA%^^`^5U5Lf@afL^xhfL@iP{>PX#SqL=CyfiU9qdzBATEHfQg+iE=d%dM zGurgO;#C6P)2|oZt=%&&V!V_uV<%r1MtCxvwc6u~Z_Lr2l^Xzz5^SGX^xCLiaESRs zm3}0%6&JT(T5Z4nj;VdQu3A)AZ)fX#M$j>9S%q%(z*(wuo#FL`?5n^#?C7(89!Fi3 ziAf_;k2&4ur3VIT$zZ6&xA?92>1fT~Pf)=jm8JAGy}D1$x*WWuMbg|rt8COGE42F3 zORr95i*ux}h9^#K^1e6Kv$^~H{^gl=Ym-HiO~iY2zJvT|*#`*BNT72u)87P>auv*r zqxT72cp6TOb@&@6%s&++BVq<1>@b)QdV0Py@l63)$z22T{bIRwT6Mif-h$PCr4r#e ztEs|J^~9P_EVQ1(ygYR zjzb*of%Fd5AE#FAR->0k>uq~Wz->ZTBCpf>pnH03(~xs#I%rn2!8$hER@N6B64_@* z-oSgkQN7coa8=P3fuRi%7OZC?fq@C#eQ4!pSGV^s(GGVNFrSP^3=hvvM;=4T?nB?i3PA0~JYY`gb2>j=L-9sj5O?>+}^AVzM| zPx2N|6UV=?Gs<}DZT@1EVVAC%C8W%wlN%~C@ffzDvR&jcL4qsP zqOB^;p3SU`g*a_p%*-vKLX9;=;Cj}vGO2*5IQ6v=INFQM)bF{- zZ}6&&sjFKqKvB+faZII1p}y$e5!a02of5lXlZm%Ag^dvzwbDf7Ydsb=*De*zws_KZ z`E$~Gkwynqtxfrhf)wnDhWx0?Ot=W3;9<>qXodl-pZpXkkhhjUC|(_>2oPLL*apW` z9LpBxRw>`?>;tMNsTVHa!rSmoIq43EbBrbNE3WD7_KVb(!K>6BS&qR*0Y?SH9F$5_ zGhzDawXusix;Jk4`9#S*I5ha+l|59d&!6?ooW8qDZFX&umgdgvHRW_eyozyqSA)w% zf-v!(u~{+x*(AJs!^_DqEQCy-(}_-Ej&ynR4`bL2Lc)*XCU75|(n>P47mRS!cs|A% zCHJh3ZmMvcqAo8UwjMYeBq1$9jr@kbX$=hM#h_?KbbfxWixWrsJ#8tzcnDJU13!{!@U3fo~{^Cp11MWob-K2~k zNiJmWfBl;E-iiO(7CC6odjIxSW2xtgkHWEyv$^@`%IlQOBUkGeytTjFhn;^Nzc|fX zytDkM?b7J^z)6RXH37aZ0X?nXkH+JUg>V;6{@Y5opY0(Nu+nXfs!#KYP%5apeSEHZ zf96*4_`g3)r(F|G6>N&VJ9DI;+HMio!7`rmeX31{4{L&_m%5a-!#M}VLy0%|UqDim z%+;=ch>`L8r=hv7(~>*!FISxnV>l;zYE-r0E2(_pfu!}{1-|?%RkgFhr^^O-W?;d1 zwVj2h-J^4MdDV^Ka3J0IQs<3Xt2>f!T!V0#7bnYE&P?_h)rI53DM`^aB8ZAvIe@p@ z_Wb%ZPnR5_AQl{U*>-u~XkmDJYm4Yrwh3RyIb`DNa%a=11vt#jbA;wJxMs*( zX1Cq3Nxgw8$)h6tWalXG%%Cjd-ogh;S(~G)hcg_e42O0~X}P`JzdX=l&&6FBYy5qd z=d#az{_3wQo^y@iv15iIm|e?GqAL_xs5MIz5B(k$nlYMgff~MP*eTXRK$^wAMMEKy z;}%o7*Rb6Wg=@=mVp4eagdg~}-TDVs`SN`7SCPG!0r zt+uV})sAlizbQl<;H4V>eH3hc%rqQ0@)z4R5M4AS>pipHa$ty~Ahr#K&L6nrNXYo1 zpAbn)<{6X`ZcNvbK0|%;wdjgm?kiW?ZRo32tEhnr!XW=bru(K&gvNXL9%I1E>LV=8 zhBRO;LKO5(-g!cla{mCp`X#mC0S|1zPYq6SLBoo*@=eV3n&D4OgHU)61Z~;{T+mQc z@!`X=V_=l&uO|z{mqS8c`!o;@aRduEq0D$au`CGfk{}Nr*YI14HRrS;1uP;5BdoW;9NqS01z*-|}NPLO2i5?&WZPM9g0KsB> zU1{QdnXMGmn28}dl#sw#hPWfZ zkA7wIlG0y4L9J{O2V7%o*Lf2;{x1N`MgUN~K4F`=8l<|V-bhC}HjvqC2&_mc1|5|e zI~+{t9qB)l`SR;X;41`|W$F5#pt+pDJz?LT8vQF;>&z# z&VeWLRJqKK-fTbgvW$_Kk}2c5Qh+dm@vTFzl2Q7;HrNyMuw0 zz@UdU&YGX`!3P+O(U-NX6N&M~3WI$PkD4>lthd_zv=Hk2a&k8w6BpG4TvqTe*&F<_ z((AHlQj_B5N5~ZE71ifn&ovo#A}g0Y5}^jdd1%g?*+}g}&7>XUP1s^c7K*8^BI&51 zO4T8^p4vTi3PDdK5o4`wxq~DhIylmhOKX~MZb}Mj1JRH5S+rpMc59kd=7f1y;z$jg z4Gv#M*d-YBEDyMVMF=aK@j_hVmi})so9Cm>5J^;4wm9JhakRJtio&(Q;I7K?!y$)hYC2X z>BX-b=~p}Tpxi59D7)=wS7+Y(8qsC%k>yOu(ez@8*D|GbZ0w)o;M?>W0IsO+*fenT z?1IJEPtY}>f4gH>cmGoI?>%5=9OJa+z|QRapP&-6z|?>G_sAEsGmki0Bo5FG`?B|_ z17*kQO3T_A$A1Ch;nj>&f8btjieCerD|gfx97{;~ii`uE6UEGV%|H4d&B*Czm$P-o zsWr#fwOVm@G~Ix~+G9pDrOAJWe~IHD-ej?~KqnRZzzeIEeYSUoqmB~RF0Ca~kDMjD z235Cf?cS`lZyk9Wv^7Z#q=0}@g=Nd$sZ*O4zkciBLd-lsIrCN+j_que7W zD|zQsugTKC2nd$8JtE5)A6@_sPe0`FN6IH`LLf5SFz}RUbr1fe<{eQl=D9Ds!RNXW z>W(C9gKs2;cRM5p#C-`I3jTp(3#l0%u_XG=dXCPHn+Ad!+}@f*v1QJ81^R z?)ayd^mb*3TWNCT4tGB%hHHbvzWUZHCVJ~c$85(|A)C*H2D8X{T4p@S}Rz55gW zOZ}_0Kx+J=zw476guDWk9KPQXS|V?W8$MRc_5$xiKV>Dw#9Utel8dAQc9hvnr+P94S(BL- z^98tn(r66<&2s(+U-gcjX!$0d`=k4^it%@%hppcqxDOE7U$=TNFy3<8#AQ*B_2wVl z6ZqG^^E^1VeusU0;WP#)k#{(u#~lL^hhR#e$-ARVDank0CFto=!!e7wQjXf$lqk!B zyC;sB2di`H1HwAmgVh6CchBzXI3AZ=-Iw@v`v78k%68#w%G%x4BmIXzh6Dcb%sk4G z%RIbP{u2aycer!Hb^m=}F-2m0rr~Iv^Mh1FPwG)oXW&_JrPYw(@lz&>#uVcuo%d8M zw&jXTrSjauSFY()n3f+H>$QF(e==;#{Bz+BD#eK%Sbo>MC=hD941tAv+t^WdqMu*g zAfCv2XkDp=jm>9MbaVe}(y8;yEsK@+>`^A?p8DG=n|>CAD0EU(wlmTEr3<;tW-86{ z;p|&{rL#OnFrA;E>zLRBO^#|U7R=|?tfV8aajNeSVd5lpTR~c3T|sM3e#}haUt?I& z7bi>p7q{rhYSJ6s6lX6Q9~N;zok?!d9(O0!^1p zsyCB9ik3y*c6icDq90|A_2Lsgj3wa2E4RAT@ZDc4R?qvZH8@n1J0q8Vf+B9xKgjQJ z&u=fpYQcSI0yB@znK28ZPUZ?npa35%WsA@Kj4Pdr6<2i@LAC9lRivmMDaKIVvDl^L z&2v_xIScM1SdS?##|;Ry%A$ZJyvzO7o&1+w?8}20lGCr!N#u1f@FT<{vNB)^IAMQ% zsg#J^n<$B?M5wP zR`t`0b}$1ZT5=MDXfC2$Ck!DTJOQwt6UEODr1xtF2WaPVnqMm}hjxyjcqe9HQ)EnD zech`4mi9h}-N_O3&D#X`OAZt+RpXOYL$9u)oQx52eV>fzZ8?erFtcH1x|5$xBPJ>4PRG5wC}AyVof?Vt<-znpnuuTt z4KQyCch*MTfMVfAxi1&6t!W?2wZ!N)Bsk>aVqS-b64QW%LW5v{qT|a@iVa+L;iuQua00DgRZ{RqU4o@EI1nn##|}be!mVITeMciHMq7)5_C}d*klW7LKD&zw zHT|puM7R}05~Ns|A3j79#oBF$*6Bg|rca@hv@43uN(MB~OJ{I5AF4!+(aO!)4*wpk z4I7(auo|yqAlP;U*V%oniPa3?DN+V-8w*zW3@dVZo=UAX^R&vR9ndYa-lMR*h}APS z`{k`!ziaNNe!Tr7WtQb$(b1zzLqWlTzT_0Dz$wocAi8w<&%jz=FvBsu@K#e>5$<=O z#mU!+ll{!wDKnX?PGh|pQu2QQEf`J$57o(Rw3d>?tT@0}8&V=GJ6srqnCOdH5+#nOg$1*FEl`yt3>Q;;w-m05t}hWo%en{nZ0a=PmevDQw|_g z$KZ#iLQRwcr60ur!(7|3TbUf+h zLMk37Oya5A?QDbXF0vE`AF^DlUj7)}t2{tvM?5 zzjv*a>G_>oNV*i~+SHlFkzC6*6nnkeEKh7Uz@%ysA%=pb#EC{ADg&{wr0w%f)t=b& zwK`&PsH5oidH)m&Kr(idYDdO5coq7Qm{}C&XExHkrAK-qo2cIg)P36)W9}|H-_BVy z5p?%3{N4>Nfmx2U<_8wI{KG&4hCysZcTKUo{rwbUe#7F7aH^;yVFYshi5+1h&tO`{ z!%>oW5M)>Kw3w}KQ21}38mA1ctCBX!(gj?s*)Tj(Fuaw`WEyfxJOrda~?dZe$$s5 z--4f?hIV?hvV-U-J{d!H=AS+ComOM|p4*dS{*pG+bj$E5R{J}Wk{=}_%v#n4bEnF# zlx2n0dGw>2DV*jM;+$?)r2f6VX}D(y)*9YI+$sHguc`Gd%A@tems+FaA5u}hz$*p% z4eqlJje@$#yg9851^Apm3IB(`E;z+W`wX~C7su6JHo3jhTKg%@U4OzW8y=3qvZeaZ zW5{k9#J7$jaoSkf$m28L*dBeUFXm#fag?735r_3QqkQDl)0|N7`EkrLBI5o&YqMzf zw*;{`!$-wm->d7O3Je6)NOeD&D{K-L$9zZ0Zn;6;KpMwOt^5W8!+S$nV>r%xat|XS zwM>|ovA@AQIZ-K6QNFyvyu#HlW8-&oJ}tG0liMs0!W=NUfYe)@aJTb~Cmo0Xvk!Xf zux&X|g;fPO7ttrI9Ea|~Fn+R?NqV~p3owmK~FDp4z?K2$%`7eAtk$N|4 zqdRWPUOYe<+)`*T>dCSsF zlGL(K?XEpTBaEmoD^ zsAq%tXJh3H-GiJ%>TvV`(TM)^|o}Y&RDY!jpms4N0+YV9=G<>g8=oK5SC78+JQpY=cv|lJ1_wvHl>qL=3$4B$V{i zfEepMG@1OJQjM<2hX{uvz7ao@nC?iNvifZm`eK7!Lx8YD#hmG4*fmhj|Kb*AIzw9_ zOB*ulc3iCY^J1ioSrekSE!j9aCR%IGMQu(Yoc63wo9;1iP7V)I|MwAQSKIq|i@hWP z+r-vb7vZ&S?owD#V8DD}=3`zUafqEYP`|}I@@fQBhoj2mt)O=(R+(xxr`H@3xWUHZS+QXG6C4$uRoJKV5KQudn_t1y znJWyNoKDXhrTbog(DHKcCaO$|C-l0 z#PO~7B-nl^73KxBL!;b6bTprWmk(X@C>*x~1h)^8)>H7_>EYf9QWB~S{CaI};y~`E zo-X~&zvj}59bxB~*3Sdf{oBdn;f5;s`Gw>UW-Hs}gs+V6(C{Cu<#bE!!w}~z z4}EKqIz=+tI+Clf6`2`%M;=^TPfnV%uVB%V0x84InILd+=XUc)X2b2KisCmL5Nc~e zyxG>a=_oD9j9dcNJ9UUIM{ST$$Fc%7H&B_UBqeF)q~yqze2D2kV9}M%Z;4y~inwyA zJ34ksB&qkHX}7T!qq+c)%_?LS-0s1+7!WL;~R*X(*|kw zp}DFWyKvtPYMixy%+i$+)e*JJhi%4z zYaXZDRoB*V4Dz2CM>=;5MCv(zjRhM&`Q`-=S3`ZzYqcl>Qm$oSd*|arrAx~@`?nvr z$?wzNzk+=80^2G2Z`*TU(b^!5*6!UqJov*gkeU9C1`8Mh>x?o)9EzUuxCT58K+=R6 zrjHK{w$G~E6sdA|x>TTzzKfqif4%V8!jTD0F=Dwsi^!d-3<w-#3KAl2Jz8vw~rQ zMK&&qlCY-58J*76fCuxYUzTt8Psxu{%D($$Hh?LOB7kz!@8xqtzjv$@xzIEuSwT!{ zp2y)|?oEgr)+OnRK8@T-^gPizlmq`EK@@P}=ux!IDoBlCejn6AiWS<-Hs^56>GT#q zQ>*pA9?t!ord^&l!m_OwAv)oE&DGW?;g z%G!R~uA!e^K92BV|kz)s(`|?WXI9nnite{tGZhG&{MdWz@ zD#_Y5r$=L-FfkovOHlm@3iCzxMY(8Ko>~6wDgKnCF6tfcWsf8?B>VTf+G32Rtg4mK zP{}Ae@uV%ay#QX0T<>9amg;}4i~YW~W&`@~Y+y{X!jWJT)(C-!0q;b+W+=5@L%x&fIuOhh0W4)o*mvTASj1?mCsp2 zQ}o0!r_QdCfdvPDa;;x!L?4Y!uyK+SQdoGk>q0~Z{vpMBc__kMM*^8|;a zR2}sSY>rJ_@Y#j)+bkU8V#4HImsRWmnWYu{rp!O3g4$af?zxfArdAORSzT!;9SPv) zsfmw0_{Zh1$qNv7+?Z>o(_0LlMcJ2Az!^J_+cnyeY0Qj29bFI%gFkilnz&H-icS5@ z;ADFh%$(`H>!RSp7~etVhK2QcV3Fj~_aexhEAQ9!4U`){1pzFiTTC3ic>9oFtg_(G z`w;_5eF#6xWSQ%1ZW!r_1JjraR@Idj-DyjD$loqe&|U1uUsw19Tt5A|x*ks9miY>6 z>1ESc#;l0H9*jWTC$L&P}> zoDxO^1C=(`rYva9g_}XRFz|M0c2aNiIb$t{TGww2Hm{`Tduw35w7DW?yfV~{&wkq6 z>z#DeCE*KJt+%jFYgQNj4ng&iY&G>d;oo8T-pMJ<@x(XTpi@Bha%^z224ygwFdixc z44G5eYuAXmr|&7;KW&#htZ-|F%b+2!jnlS%>SE5ebn|8|0g*Xb#z)P|HO=OfzH)9I8CNp%Qs+}r9z?< zDq^ps!&0N**!+zmy$6-~d<%FDQs*e2XbdgdX(;jLS5?1ShLa zgg*+8GEQC)@Qs7J$DrYs@6ShD%~2&CTXRgH7J9CNVDXf9#Zz4MbBHE=E zoiUL&n|dcm2JZeE5`(F{YvEJJ^Vr**f7I@uX#}0n+s`zcADZ|6 zL`;}KgqF#kX^mR6#T|3JP&j=x)v6=RS)q04uFgdBXld$~4wj3f~* zl(M-G*N*UW^ry^Dx6(fI6&3_C-K+>6Q*alLe{No}XA5wleF0^fNF=RC1++dt6XF@( z)}mrDfRB}DQ;U(o%;v!hVPdcu0r+A1czve-ipvAXEKV7kfvxB++tcO`&)qYp7xPBG zQX~0FR0Xfd*Ildt3hr7IWr@y}qzQ4t+{EIURC*&+zxAc>4XRFsU3E}Z9S-~cPuQ$p z$eoZ7AJBgaC-}n;VPGiKO#!^YytjXX{BwSSzBkj=-2aMFhCl(sqJ>9mS;qu95H+yb?k7lgbtiiJ3qX1X3^rgTqBh+wa5NzLN~+jVM*rC1 zR_;$w{a>vAkVf>!22t3bpbnFtpu;C14#hud0tV(Pbw0p(83WFX4{$8q8g$(+K#b>> z%Ww#%zQLzl=42MP7Ik}yj#Y{B9IerTVB?|oR{I}SIdb5|7@u5?#1*BxrtooOvN`H% zytmbY#ym^ut9)_-+dAQCO!vLj2%~AMmkCbiW27IA4F)n8-I8L04WbB&vt*nywdlNd z+pG%Vdse=v4}P-ZYd4t8#=1caG}6 z*t}UF@>#yuz>cNu8!4CjiB(NUOP`zq_ZPf>ups(R_P@#*q@*A4j0kz?v|=c%MG#}~ z5*6hVDPs+{oRl2?yV#<|dp7<0=M}GsH!vWk{O@dniE!i0yo&TEcCuwC zp-N2A4~5gRQ-ks6jfa~!`+>N>Nf^xF`;9RJUxx!$XPct}Q5P?J>w53oF@={hVwKfJ zu3KyUoh)S`K4JxlQ0{{|g6G2@OalMc|0g*$W#$@}hKy3alHMHZCMHO=^?W=k3O(c~ z4Xis~_U_l&QMzNQcHIB=`|;J$YH~Bc3q6n==bca_?GHaqFN|0YX}dI$w79>NnfRM9 zeRlre82*1a7e@Y0uOg-_7nKIAn+A?Q12DP2(*T(E=9C_C-ahW*%08wu4kRd_js@J5 z-0%x&DJPa$OIKn~qjGulfDj0XlnV7*Z=J$jh&g|>=Q4~ctbWE3c^jn?aTFaRLvhsF3=q2tn$@t ztz&YnaTO-hz`W2R=$;H`PyOKSH&PoWDI%+0vVB*^)w-~Jk-#Dnp?Gokyh&KsTj+FB zrpgqHZ<@HnUTd>cU;Th^gjiWv+z$Lx`4Cq*ae6e|ei(Q62Ip=oaIftd0H1{6@YYIQ zuK12cf0pERuk>$5ot=Cz6X(lmt~z|;n8I!al}2F4eg2ScXty_m@})_jG8az^`<}T8 zIva$^8$JJ}P`h->%+l_2R~}|Z%Z-dl2pPMW>-Ox_$QjwTW1>a-^XDzP<7MLP`*R#5 zz2f?fEB4bC3e?-eR~Du?dBSQcYYWTV!=ia-R@fUH9`>q-EcGCqi)Uo^E|$KGT5+*Y z94g;O;*psTPDFx0RAEDfZM~M&QTm8QdgO4w>K|RkHK!8?I&R%NRjK>KGp|Kvzwj3B zh$;EflycgQZk}H z)BD#=%jDbxd;~Iq8Oh6?Kw1=U^3*1OkT1S?9WuQ=5<*j7DBR=*ef&AT1#Z}lLo9O?n#x5V&1Gscz`@anZd`zH_2zJmY z!PR25KGpi^zA&?pkG5Yxpkpu)H%j4SlD1j4EGRa(FS$-eJ=yn(kG9CmAZidx#KZ6c zH&>OyagJG7=mPAd$r)JV#Vpn{gG%xl%^%LcB5!W~HAoX@EFTsMm(j>m#Ez(OR;D5X zVQ!Ud-+IK1eqFa;jW@-dv@uhrS7>qf%bNaHrJ&%X!+h$d{wZgLhXqwQ)FBUhfDC0wH6_st^xg$ab&t2;o=jd98g|F76$SpYS;;kt|?s zhQSg@ZgPVQb!^d?iwvVMi#?U4;;`Ur6}tVXD;)%K8LUoKlYtqbE*hb7D=TRW0Tyny z9hkr&xaQkLW^G5z`Fchz>2t4#gsaq@c7;f3b8&Jodl{I5%@Y#!j8-79!}J2WI-zSs zxHF+yHPvCLGozxQe?@Utp^9$$cIpXTTTkN&zw+XuP&)1+1Jh2E4?Ocz%D(%|aQBiA zq%L5zXZsi=;sTQtK}c;I)jiYia@)BeRX-^&piFI~p$yH(u#Y{OCd@sw!N&Y^rQh{O zP+QWJ`7RB|M$6N!mi0iHrCZ?TEMDA0TSbi}TG}@`&BW4xWms(l{k_uSbLr74*?zAR zr9;P|ufz~LsO#G9Gb48Tv-P4aK0ThtJmoMwl{w+7ea?73e(wVwy zPQ9U-q_D8HHWltb;S5^7!zcHhtwZz1X&sSw7qquL$9gzkamd4cB!Z>DH;V739-9@n z#Tb=KIyw|))yCPGE=(L1bE=oL#GUi zd|v6*t#~Dg0*-SQRds#TK`>A6vym)on~3LQm%kh_?`Y6vx6#lFD}^QI5x2J-h*w1j zHx_T$spLM}Hq;u-ZNL`=7(neB_G378`=50qi@h3TLgo|QvQ3sCQY$0a?n)-1^ihj* zWW&_{unaOHgGlT-W&Z*=ByhtYK8d!`|H((e7=h+cS`c>#>_=I4!4jbmbdUW{P+D0! zz>F^nRM$sc0d@jne1f(MoO2=o77h!g$uvm5Qz8kFOcZQ&j&SQhTEpKt?_{idDvq+) zy>{9cjvQw4!7hJL34ZP5SEDbXay22I(zSVET2L|~K3^lYzdi^VG22$5Y6K&@>sfpY zSIe-wF;XuA;(&yM#T)6Vq@d{g3fx?ImE~=|TsRRpTRIDy)};<|kFlabq}+0t+sNi> zI0jSHJ;Z{B`Cl0O=cV2lHkAttKg=kT*VAQK=<#i{sH&0e5F*XNqxuZEw}&w+@fq6M zo_MdwTpQ=zJ?I*XHSs>Kt@Vg-ixI-2Bj)t&R>KVD)EWA5KF&ZxoA=DmR7FW0I@tQ$sum*E`8EcG=69Slxm_di zY{jA<@8lutGj!&(DPhF<7E^~Mec50cqKXWM$n>N)^)x)+0Ro2DxfVT7;!Q&Oyo%5s z^Yar>%g_%6hdJ8Y8IvzSpeqH$y!SEeJ5QUP(8#nI(r1>hB58(2W}BaqF5l>6QfOR( z(keXEs6G(=g%rk>7RTCH$0bGoPnhBn_l&40G7d(Keh8#MS^Y|ZIy;+1G1ol8XXQuB z5cB6)M)adEPSw}xFi!(00LHekbcL8e7M^eq0B06qah`bp0KT*uBJJ4L5__hsL7s!xN^6;9x(IvDuj)CHaNvC3JDh9_o*qth@@AgXYD#>(XLAA zLkwVsmBg$H7KL&DaS&)ehm0@oYBG1teie(m(yN{s$zCrUWLELlivm*@^SJ!js|jwc zIFYS-vA}IlUN=N5Sxe7^Y_;(SC`RPj&gDJ(m*}-?T2b4di%^z!wY#rcUK5wDcrrv^ zf1*JwZWDXR%d@Z8*o(gv=!RJZNB6S_yXyD$+49JIDki3zt8kS;>5_M84oua}SpjYx zUCZWD=)!2dwp`&m&Y=e+z`)VzaV+^G1}7_2E>^(HJkIc50+V`agqYKgq`>(j+mJ=8 z_#!4f9~KrC`FqjZEdE7_X0~BuVr`I%LeALyOzhRm5^?Vh9oFYvJ|Ff?_^Eq-?T_sa zb7Bzz0uB-PpQXkq(dL5Yw-u({b;qjOhEyLbrsZ#ku}vtv6)Tk%y1ne^fn5yq*AA^} zD9Ln1nD;HDMnl)|rvVJ{jLC7AdvPw)Lwoab}5I#6p`r zR7E0lajJ@XEP%s)J9PSvF6fANCUeO(DDe69z>iO&*hftQ8rTs#QE&F?u3kH3oMi00 zC~_F5w8WTz`^{THSJ2jr7OQp?jNTcYJCes4$Qbt&A7#brjQOT)($19pdQSl(%=N*7 z?PfcdHT=Yp&--Zh(&Y+UDXINAHQ}kMV8Z^^*1K6_((UKdsp_(WczO zNccR>5_1Pz!g~9Wq9KtYv^gkBUwyc({K1E*xpI=a_4tQn_DwQl6UlF16HScTb5$wF zvl~Re#3Y|p+)x1A^T{lbAe-{OCkJh3jtBTujZs8Qei9A0(!$xfY&oSYq*WkU&;9Yo z;7ml8pnHzP{f7^ov2eDi(07myXNvHV`>a}NW^AE^_8`*Gn!Ly}hDK5Pbh37oNzvX;bB15tZJ!}7n(@aZ_UArd~b&&NTYtrVN< zwJ$s$(2e|a->{_Fx|a(_ZJ}iSNnegB9PFWz&edn z?a^V{F*$>%^+*4s)4zen_Qbb|49mpgCUmCLCW8L?4M!_Ca@4;i;Vn!+VRt{Dos*Qk zJ-P7S_)};IZcv2-h+P?3PD8}J{4H(1!tP~WAd_69T#7NZ_VYs?a#Rf48XTF)GQBnI zv%bs{_LZIJ*m$W^96HC!*6}tsZ`Oi^7_KJnv1}60b z*h@=qig~04Os}-=%W`{vLp(QHtV>uO8G}uiWc(^wPh9!5VSZakscwjLk8e1@!9XOIXzeJ8cE ze7!zvL7*FM&K0>+x<29d;=k?8IHfkCpPfc%5zAbSi+7L{F_f`(*>pxC(6)g{{Sn`l z8Qc!hD@tXp)4+TdM{ZzosnoIu8jWgp52bMMZi$6hijzYMFp}Y@z zkW(ruEAmOEP`#&~P}9#dy|ienVde{-zc|twg;31#OLxlDW z)bDc1|6uPu!@-eRDc{lVF9nu9W_-(DD9)tYxe$1_Uwz{Z_W4cPK3iuT~vZ#l&*r();B?Jgte zdu^BWxs6VW$O*0EJx)@bi`_w~Z(VBVCM)Vp1mutn7a{p~JJ6RJf)G_Ln-OVyu3Zv6 z2#Kz%&*)rT%@+BM-){DmqpPeL`>Oe%RpbXOl;m$Mbh-)2)a=|J0bO z%K`X3t1{Ko_91exQ<7@65d&RZ54-OVVvAmEERHH57w=rrXhBvhS9}FD=!S%r1xw{z z=f*W$i*7kl{mrx4o8>1~0cY|W`9;ZXtg`W3!LTiHA*it!t^a((~ z#q!pH6mz?T9JTju`X>$TC9l6Bb@(dv1n`Axh)242tZgE#4 zAAh#d3|J2~SR7xhW}oexx>--j%EQx=@%?Gyw+d zA6%GvYOYNMl(CK@<30k*0T$y*Z4{}aP$GFzbS7C(B%p4*!dLiM7b-elNc^OUz4_jo z{JE}vFg)OPg=0NsL+42Xxi`wy+iC>6Pq5q4sSAT{^Tytc_~7jR+h7s%*%3A!>nf(J9)_xjR{$dO!InCeTf1qwC` zz7WA0glE*uQ&fZ_7iQ>YPsz2cd~phRAdp)%8z!DYA~LM^CX6H^WcTmB9a5-9h#PHU zIe`cMjPs`ir5Pib693kD35VIFXAyAg^jw=5_0)yz0j{waa&UJb1@^nmZxmkg@j$1I zOw>*1KZN1EdqY9kaqk>&zBH3U=5N953PoeV<(UL+kOy-*tsn4@|7`#L7Wl7WGgx=2 zRkO5tdaplhB@I6hO9mW^%$XU;a4v{h_cMONCU`bdOu4*$llCx ziq@t$;`uh^_hj&^ILOINV6*kn$A_|(JM@OxeSpsM8AajJSJU#978AzFderAde5A$_E$vtBx1Tb=Fw7uwtf&a47gv1v<(IuLj6ZZ@JGH_X z7ZdLthGowuV-*-}o&_n;scX9Pgz8jda3B{MTy_=rN1EdkTaLmptL0AgOu@7PEQSf2 zRNXYrm*&*fuYy}ltGNzgH+8p3X0@6P=EA%h!%%LDosX*WB2!&}**3h-%O5nqd|xHz4{Vg1J3l(FO3a`@d){6-GOJt~EU zLZELh8>bn$zVvp(cdk}DQOp39p6ML*71s!c2HY^Zq~0s%Ve9y4+gq&qNR+24XYod0 z8^=pu|dvo+Tk8vul!?d>c_VM2}B6NdR zkqh|KCh;{~pLUcEZd{S@c3MFp*rt*d99bom@rV|Z^uF+c0QkWZkw%%6c-_g|a8?VZ zyEO%vG&bi74On05b}DxmOygs0uH0$c*Ir(QQCxWnm=iTmb+_> z6ZFEJ8zLq25AF#%+&wG14%S^{H0Fvzcw4N3vOI58+%%6Gd==&9DWLc2ovnvgq-|p& z-<@t%N_I9SR*A9+LX!Anymacm0PyDDf0WiBEv)?3)qm13fY04drAu)dTS*w?3lZ&T zM5wAbG-&sCK|8ex&rH2=ApSi~MAnr}zFfQdCQpy{uQjqoy>FZU7Qn%GtDf!BoO0{U zIG-ln8m3oxBI8iQkttV6wI4h(S5cG`r^*I(e>RF+B9I&qaIMu}o9{P$QrdWN>;0cJ z-vCUHc1}{$h((qSMkqTR#U41bAH#UDx|YH^OnX)9?v0zoyJl7^E7T(d$MfKmgee{C z4HSTV_&hb1ajuu?JY?zgdI>k0huTq8E^u9agUb>{&rAmHUD`qkqZ*_6IobX2nb2;S zyNbScH~jVOyZprmkJ`+r=__uBZgnHjSD}kNVm1!;6=XDeeCp|`reRlGpPwv2DuS1-T*4EJ}kq^7cPcK3xpok|$ny%V-8g(Bj4WCM+8A>( zWfh=}^YBYuaU*zfii&rAEHWC>GydKrA&rmwG9U?ey(JzIGuVT9HpiKoTXChn5&Dj> zqu5gG1yv07k!##1%SVupL+V584vhb>S}sP1&d!8ZP#7Udt8k1C@_?h!J7W^J_=Uxy z#Xx*O@)a3p$f3ATU5g*s2T70zrN{0%LMYKd+&H1HsfEE%}r^3;Nz({*EIG%>uBEEE+^qW6%Ctn-MOPQ*$HDizMtYFd`|E~Y+f_tJ#E$5gT>o$b}!@)$hBY9q<_Gv zww!1i+~VZ7;5NF}x_c_v`%v)V$CD|)%m@7gUS?tMPZ`*6EZ~X^gvE!k8z9L3XkNsP zI*$ClzILoW{M%>MYDyQJD^zc5uT*FM>*f|4sw%xmALH#O(LTHarc=w~S5oJ6h9Ap_A#af$%YgvvBwnE+exZ@w`1>~*I9>V1@!o`+L$d#4k%Ti3&TMc<1zalnNjD+$_fBQktxT)ak5{_Wd zk%9Y(@dL-x-|~l;(UpXCmc?1yVD_Zy;u6dYYXQIW_r175FjYt=Pf&&5jMBjt6` zbnV>>6p|-4nmvmNF$;wqvl)_h7qjRdJfyqvZ#_O^xcb+sA>^9;FmhR^xgjt5{;p_) zq(O0MYluX?s*MY-Pa=Y!k%KIPCy=Z&GrrJx?gyN_EPp*P2V{sf9vu*1c!V7;1=SU- zNjs$iabBeuUo-^{u%|QCCn>V553kvo3Il(kEL-l? z@JiVD<7^5iT~49NLGhKRQ|#D!cYQY7rqx50dMKjiTWJI~46b6wS%Fs0#&B-HPH*kn z=wuK6qycXU@8QOOh-bYY@aPo2S;joC?G@Q$bGrcYU{K?l$#9csqpsiDt>4o!GT)Xo z#v|BLy+?4XnxPXFEt#0TuVr7ayg65Wm>DY=vyoT=ssv+VLlolsbP zybiJ|lyLuy9l}YG`h67?nl>EJk&&0sRBDR>yQXr#x(RVBgKEmj5IpVNdlMcpM_@+&V((@Ei`Xi3AN;p!Aw z#_TF4$)4WeK~iKy0ixi6bY38q*WMHj)-ASbs@It@HYH{WW9K(IB_7ztj0ErL+{um7HN*~P2;j6 zaOiLVoQ#=)0l?(!%BwlRmIT_RJj&(4unMb?By&6ZG@F5%^DTFqhFLk+`kv%;ducE3 zcPbOxAxG0lWZ*3H+167*@op%9bDj+%Hv@4$@f!&Q@^F3l{Ot3gC~SX>!P60(NJeD& zz7z|jS%6X;z2YnAl6a3A=z&~KG@_v55QwVO-!hgs4)^?pdi$4UJaUO6+3Bj*)P;E$ zu_xOL&PEg^rALYd-hmx~$LuF$tbYG!A zmg07 zSkfpbHYRCE#(bs^biB(kH|tp5;+!2B#w&Rtrp*)}j9r*_FcHFqE-p-FGo9%_uMIs3 zHIMs2n*PDg(@e&fhPANtAcr5&mrjhRnis1F;ElupoSl|BbxiHlGPVtIqGebfjNF(_5~vtjb?q7j;UiN=7MbpvRgicmSt&|j zO22<1`=i7+G)lu-etpMnC$xq&Upx<19xBIIy`yfi@r&4l$ zyb`z-dN>0d>;fbzz35)K-4bhUvO9Y~NlL%0j(vQDV%V2(0C?^hobS>O)L^&bhsEb* zEg<|&9!86gm%;F=m!+h%*zp+MT=z*%lnc1AKisGK&94pV=TY)EA~pYp_-P%)RH+%x zH4mnQh)`-o?jt04IBQ0Pir3o?tF@%FvVB5O+aI8wtUw(#T%upeC~B^CEWOWp^0Kdg zfw`aQOYC9}kX`&^qwcU;bE97F){I^LA^=NKge&$}C;o1G|5xw-4#@V{jZF2laO;*C zgvOWYuugiLpV_6ViD#9`rtqjVP*j8`rk!079*(EAniothjEAOUlE1bJ@7xQu|5tFv?`b+3Frman?;I)w6P3&ha?TRU8p6p@^Vq1)fKl(%7%` zmhOfY9WQ#I-P4~^A=Rb05@~w@6Dy4H8MB4Jz%clz6DKFmy3*+W`8mRmm({PltKjdi z>+=h`gZP+07_~CQjV=XQplXmaHTnGG!%Lmu*g~jP!fS&$$TffOKO8q<{a#8l{EJbQ zq4AZ5y>R%5m&|9cOAHtVl}hu+;xV2N<4cB#qSV~f>ISOb;DlnVxcBYxsoa-0dQPqI zCYM{QF8iHtAJIetSRGpd_w&`~cu2biRq)*DaYgX+LCL+L6+W%FQPNKB(B|i8wnGnz znZt+CyCUbI!8USdqBzav2rueZdXvUo)8e`JhdSWg0C$7ZWz%@3zGo*IBe!n=clnlf z$<0+?Zn^zFbcDRDLHm2fJV8WTd1Y>g*s_h!Ysz26Wi?b@C|vTaG)9g)R3lJA5?Y}0 zElS5?x>KGS{xc4zi_(Fn*?1Q!?wT$47N}(>?6@OY0P6l#llJOlDJ_$)h-dOkRgnI< za|-pk7I8*{eAm@OesIk3@^mC|jBmVs()oS2<2G?g;Nja6W2)vg3k_G1U7OaMH=P=^ zNo}q!7U)5Hd!@|K*Upf3mYT)2z2fgB;xL%okhEYQ^_jIbpNY-=$Cs_XO@(F$_DNuC zbAPcWP6WPjfAjAlcO#jj71!pjP;{Fwn+UL>*LN~$ISTdp;+*uQ zEJ&3C|2-Q1WSH=7@*MMz*o4Dgr4Y{1EGNuHk{%mcw4~NC?Ms>Q?`UZdKVu6md&{Sj zVMl@+M#78!_15XFk-t$CYWp|;Ox3dF`at;o5_l6!@-WC zd<E~-$euCg zOnBRIk`bmjhkz@s2`?cxPnI4Kyzix|Va_Y)AXZDABlKoMSL{`;BwCM2Q#Dr<{FC|D zn~9Zrrx|4)6qaSk=PCVYd?JF~*d1>=qly|1K=I2v)T<|XL_V8PL>XxE^HLZpal5#@ z7#-*$ez+cmX)a&uWZSlyT{U^88#L1uz)z_4Hqx8Z1#LhF zb#e%VrJ9#ba81*^i=bLP@8WlgTd1y(v zP5A@@;Eq`!Dua9Aur>~zT1P1SHn}zFYVoUG38>D9z4#hMjv912-FW(Yfu3crYsuGr zyqLFS2EI$v>`VRj=O{0aEJHAk0Dz|Izz^=X;14X4Z&eS$`Y2&Oodxkb$ zIn;=ageJ@w&b~v4L;kQCZXN4FS52$)E}j>0aJ}{FCA-R7{ynYaYx=m{JRP3wUJS1o z9CDH{bnKrC&E81z;@P#BP&7IT&)K1Q@!mG^Sq?t@s`VMtjOd|4QE@7zP7uKX$bUfJbe5I8g#5tHcrX zp70rp;TMaqz!W6tD7NH=y1_|{HZrR(`MD)Z83vMi*Vl~`S;|vkNj!h`5@?SMviG*l z{lqVsNhS+$nUoFNmJWlv`9IK^dns_4x*N9W;+o2bfFijr1|@ANqjw>Hb+TQ$=J(zW z-Wo&pP0YV?CN|!hYGu;})?OcdRztJ&=Ssq^on6V5PNgve9im4Ib_xw50 zIf_K$!Qf-OLOvuhJ}FgYaD3adpG$5 zF$eP)=xEgpa`4@|(yh)89knIGG#`N7Sr1H{=@F@*1@x-y@3#}Q`giU>v}3yYW0mw8 z_A!zHFucBF+X!vmfooEF{O(h#i$!L~;F3kVfO@DyM#rdqX3jgL7jy6CQtPArpjv`QDERX8F6RC_qlRLX}$@G4%3Kb zCt^E7Q_}@ze6fZjqvRo3A#3Gh>CG3d_SIcdPUs_hzjpg>j5tc~IXy9&l zDM8dLDnaQL5*_5gSXUo&$3eC+IawOezoGl#dC+b&On`S6=K`ZAA z$iV;;(WlVU z-A^Kp?M$8(^0uAoaTONpmlg|<*r;%py1yokmPK6_t)(+NY-Bi`Wblm03`H*BFsW?Z zd~RR8>8IP{)>z)Nm>z>Iak(`HQz_=vL*WtmTxR1svN~LvI`23+C7@xXz2MZdx>Sr` zPaEPV4XWg|VPN;o!{3Jb?+Pb8onT8QTe*@8Om(*!B_&TX(FDwZmxZ~QIcPUn7x#iZQB_O zfyU{=aUI~Wg_$^n%i@!)-G6h!X?C(eq(~T8n%dhFcsuFk zMJ`KuY_gnl=>_x8;HZz4hNiZtG{}&wGKzau<5c?d*SD{{vF*oJMTL=V<8vr`tlaN5 zLdMG86~R`z`RK35qpSGR?={=)#jGyCwR$+jVJ;zMx(7LBS9zk&lr$<^wsvR$cf6`0-KW2q2Cv>qbQyCksn&P#;#^AW zLI=(O7a5Fn@$<}D%%{dJu@z(Ee`&Ql@9DIFPnYK~?zzn_W- zIr!Le)Oz5&4Q+QhpXienrZo)&MGGjIW9H{~J)jBLcwlP5B&1k7jR6}HMu%)_j2GhN=O2XIl_lqYfTOVOuBAAVK!!{SY^_Fv}PtBEY zVUlVj94X^Wt*mK4d%DxR?vhIEeKUyiOA_H^kD6)0MnCgLQX(j5&D4IHkgsQ`uv>B-hDfnCOvoG z0EU-_8qWEnFDJ+qzUnCv^j`Wn3Ru5t8v&q)M-gC3C2>AreTN+aV-!QT3i_2s3jr}2yjY730y<^N`u9~{SN0C)Jt|Z(p zHq~)~yFE@4-o}ybSnMV*qj8t+UFeGI)RBN%@wOusL&SeSh+!s%GQ$@UtZ1x@s3rEa ziaK1wz0;=F*2cz5p$|pN-lQNcv>YR>=oZ|_$kJfMe!JPf&O!22?Vz>4)wc(=)CFITra}ZjtAT?lB)txwj&IgXnfCp!{1Qn3LZk zOplRXD&32e(%~MZsCe&AHG)`TS7G}w`r3qmoNI}J(6&3$J4OOtd%J~GBF`)YZfZC~ zDFm%UK)t=Gh=7odjl{p?curdZtm*8pjK|b&FR+*eME#M=FnP>xkxx-&k20{`-gbJR z;BL4uje#KnEhtu#({N-2%7&7q>Z8Cu>)JsCQd!!o*i*_M(w`=--(kxw; zJf8^Eb&R)t9%>voY5%1AAU5FI7|2e1og#~mG3E9ur$5Tap_(fJ{Av=@HL9wm1zTgu zb0y7B`^w*a9o&t6eepeNg#UwscK6^1|8=vj2R-Uu z@m-?aT^|(=A3QV2qGQ>U3CdDlO`Q52WjN2JkH+Cs0s7Uq1(5Vx5ZU=)M~DZ451PB2 ze>bvso~ME$#b~2tR5^N!NWA?= z1Yv)$a^N^3)p3#M&0mZL{5Z=?E%EC!c)gw!e#jS`|A-B>ycATDKxXx+s&lU}Cy>~x z6q;kpa)PcGghb$y-=pG;M#U!q7Of)WsPa#mfnkw{ulXM0vDf~}RW0|vu#63rgw+jX zU7Z$qYF?r0TlQG*Ol-4SuBjetf#ygWTXPy%;uN6u^Q$f5)6>he+Mgo8j7kzuIc|I> zH+XZKMk%2%m5hwiAinICQc|KvF#js^Pi$*h$SU#*sAlnZuABS&!(wQ1Y!0{GgM@tQ~inxn5rr_ z5`I*vW4QNOU)t-l>;nDMh@0K+MzYDnF9#WA*SHB$Tv0H6S+ZK*LWWy1-@Mkc6fxJZ z{hdHiL#}h2E0gYYXbt~ofD#q=7Cn`lA^Enc6=V`J-y~7c(GaGq5QmXA8b6(C8WDV~ z=qOOw&Xs{tdA27+aE^n+_bKWsFR2zQ0bV#;1tY^Qy)10SjXLU)Z|&>Rg-clPU9_Gd+(ZtBw&I6Q*tu4%biy; zlI$(~?5B?F3+Jv}O;2f%@(TVSF9E^LrkRE7a6WWnw5#+cS3}wAs-7LM)bA&C`Xz|o zmoFGbEiT<=Gu96CHjN;_z^@h&G(%s3zApV%ng{KE-igocun8}1XoGVKlm>H2nVNTL zGV7%nT^Q{5&qdJxkWC|wQ3U%a&IN`zn?1ZM_^dB`n13oJlUGGRRKf)io$u0we$84m z`>?fUCLb~+6u&vW%=2wc^)~O>&9T)|LNFxM=rgzCaXfv?L{B>1DPjjIq8+ZJL}8TG zRFykx`>tpd6fr1A$=cr z#i6JE8_&GqX;fBsVZvzP<|ySS4NJtMaQ7JZ%l7oPj>U7J&vo|`feOQ}!*Wru?Nt`pXtvI6zpbDQMt z1JYYVf|PpVSjJ8%Dim(3h$grY8Dv$;bu!=`aQFk0lb2W0PV7eK%*sPQmAPMm+6x`K z(6=~b!!%9_^EC9=SCTxKYwQYNW3!5cv`Ml@)wi;n`jxG)ny{r;g=S)`#fr4bgk4NRbdgdmW`I{ugr2#OY7B{O;uIJHq{^{q1{g z@Fk;IbAW{Q$Ms+3Jjer0*!L1j#r>%tpTszQggwIaD;S-VHBBnGUZ2+k=bZyoe(qXi zhua4zK`7twHBroMAq8JO%ReCVjZ7vna-*qO2^Yr86jMKR5VsvLnF1GYwijaymLm zoAd4JuBK%55-e+X+I&_4IBG$*I|owkuh&1_k{wP!j?{nX?H`$~f}aI;1+@HK4Vm8@pyNeQWN zH0fa8%vIsWrJ>IcU*dxdxYr=gB*hbSG%Sm#MK*k$~qxv4*+))sdvKXPh7ZcHz04^dgQ^!E%x23kq?&H?*G35B-0IHTzKl>Nznu<=G-WE(8mN7f|-e2`N^o?7z`Fykb>sMbVy~)P+`Hj?##XraoZ(XrA=(ahxNXLV&!1sf$4E7gVFF2#kFgDjteUyI^cps9qjn2? zw@uF1)Kn2X6wG+rCTLQ-iDE32)fFTgcVwiS)Hj@On|j<2%G@FCKt_A_yWLfeF`p#r zUnvl5qpFj#I5%iVI%2YBEbYH7jLjHFJnFFHfC=XF(`zNO4lcMJk2R{1UKg7NT8fm! zbmk0w*!Fyn8Sr0G;-pe};Utib6)7{nnbd4mbtxO??`S=6+J>#i9Sej&*IyruBJP5I z(%k4Sj&QKoN=6zgN2mt!t&cI8Qh@R=5_h*4Td9A_J?;@-xtXN&K+nyUhrwTR z@R>N`1i#CQLDj5Y1vym+4}OlX-K+pJLSdoIp5y3#qmVc%*zDvYKCNnwz)fhD=%q%= ze&Ae^bE>HfGvQB=ODZb+}b^-&p?@j*gde!L^5zCp~d|%v9U~zHv}O5L?F4K z@jHiy`_;kx#CM|~)_2apBrCuIFqli1l=9Qdw#o(BNoN!l6|T|TzB@#*tsYtuh{Ld; ztc0$qs>8u@^uHMMa=qCpe<7_(zPa;8e6*w#V7@VnA(!4SOd8hn`N|;E(|Q@KhqM89 zS)t<8d|gnNu&4AxFnvcx)?!dQ3XpKs)W@c#W}SVKW!Vfhwj7zoW!LB~WPR;F{NOx; zD-x-)73;6L3))Ro*tG*uNx1dz;<@%^BZ3l+{Xj$})D=DsH>Bl5b4WIfpV{Y^eF-wt9O2cK~zz+|!D)!${bB23RxMqA}Vt*NQ z^Oc!^;t3D(<)=I=pZ%uA7j5v*(sk2xI{Q>lVTSapn+^S357*-p0idEmKV-!z-;!@j&c^YqznHAQs-W^DPzn<>2LxF zX8~R<2JGIEqiFxhDEtS+smr`nvwM~+HK)CDIP2|a#%(56iHOz>LB%0XVNXpi;~@2{ z$b?%qM<4C8^1kX`iMJPDfvHm(M_r9^nP@CmnF)mE)y)+Qc$~DuY-FsFdU$}V`N<0jAsmi`EeK1GeWd5eIP@d= zQ|#DKmM-XekBLn|Y9T1YrnINzZeuJMv)w5P#+H;Q2gkJm@Ch1Vy^YZfh*5%te%y;27_0jZjF@!skiHQU| zxHW%W`X9bT|C0_+Meo3!6M>8NJJy?X{RTk2^AD}=svM(H!F9W8*ZqhN-A~mwyrb$f zC~)P}a)83P5zx&IcKgwZ@!21`wdPPrDe;l>ABvTGI`Cso?c3+doNrZ^!eflGv9>ut{_1x~+f4;<#7*WuHU~cvV~THpF>^C8BQ26~9c0CO zv3gctW|nt7|y>kIHK5x_RXra`|*WYaRVjPyr9kRZ_F!$T~xTck}Cnqpq(jO|kY=j;>0- z+d%kL!du|RPT1H&oF_Z(z#@XYS4FM@5#aF6sHD1b+47#^k{kJyuaWvT0K1^e7+Ak} zn;fnz9N-55C#it;0%?ZbwRE`0|8OE~eU3|b&Fj$QdQsiZyQfs$RW3#Xa>z9|ZXC*G zvTcQ9?)?wb`tyVT6D)9^$(?TV&bO(K$!bNJfB1y>rC=I-{9DfE%a2tp0D}9T%k4~D z=^rp_4|9jMW9S)3Mo(0WA%}~Z_*5pdsa;WJSsB(aRD@>HM4rvEsCC(785U zGN~mbHOYrQXq?%Ybb+$@9VYc2q~AL=w~9*}!r)RlGjXF#s>4~>`JjA`-Ngi%JFhTH zf1r%-n){}PN%-srX^_^lW*)FFMaLyHY=BcrnCY*Dnv| z)NV_NOzeR5gWVY=7LAfG%Dp69quWV_JOT+m4k{!edWBaXw z@9lw7%sJT-6vkI$8ujGFdn6}ooDiW)A4SVNC;8IitOjB_$KJPr!G1IFD6vjIM#VZ4 zTRq$5vd*%=K_L>|K`pDym*PPn91wVd`C~dGRuP8tpbdZt2d-7We77j3-s<@Vv0mrN z-lUmmj zU%({AN8IO#IY^OEWg_-hj2ig*(La29|7RWk_LP+CQOfx0GVv>X0D2uEK)Kq$z%}~? z59|`fEC6C*l8Mdpd{oT~2ZI$j1)pj>a=i&D;I=9V&Fy>l5c)t1?RhEq$)mh zK4Py>>{&032bgg}VND{LUY3%kP}eZ|c6q2@#_?G7l6aR-vz+^Z+*cbh`v=)!9N||D zMNz*CZx}8S9IIou0O|B=~vtpT1;ubtTEK}_K z@2$A~M`?$ah;zCW>)h{o>Ypp6lCpzI4G6>PGfFVp-+HSCOR~hA&C6>8b2|;i-e#y; zCvrVJuLE#_@o?@PaKmC;7K}8Eq8!iNjJ~Pyep5wQ@Fwc*0zhx+p!bNX_-~*ZBdiR?G$}3VrYT z#6yJ=TWm>0{dPf@-c}Dg6xvw(vE<-Ij(r4f_G#iz8f0R6fdYH%(W3wjDxRli=XQtrpSptuMue;|(Z`%Syf zc)q}rx9!2V^d<*p>SVobo zj))Bdu}T|!|CWZ7z~-qDf*N(u1YD)skNlHwOjU6X+%Zz=S-H*9?<5~=>9(^Ex$!b} zKUw>R+;GZrSyi|&Dp2+xjQ{5c|3_Hhzc<9Ap&=af=WDkQPD7y{)f2M?;~=7*P#@p* zNcWn}q;@7gj*W6OesV$J(P>?l&g^l|pw2j9=hUza5~z@^k@%fJT33qXm64S@s=33A z@QNJP{LWMC&VJQtA4}+wczu|Ef8@<+b^09v$x`o9gh{<)CJDJT;^pbV881Zq zRksu?@Ks!-2BIl@g45%I{G>UPH44qc zKfNrzA$rLp{)Q%zwMitqkI0Zh&yaHE<^PX15r5dQ93P@2uQv9wltt5xPkyP5j*(T| z*bJApc#i8u?nEbkFW3I?j|E@paI$yg(hV|Lh~yd9qR32{W<3(W%3yIqBfCRoJd* z>!t37JqOBdIf_y4;;Me55j!-+zT~&oHino1lc@9NC#)$2gA1QR(3n_pBq-Ik-$VIwaJ`hV$C?}$r?|sY(?PAZRNGPr&E#A;6 zO$nu+^X-C_-|u)>E2VEy3iEwV5sxhQVGFtudf?usoq$y*`s`Gp1bG-TgAuZG1|0NR z4EE=M|8KLvfA7Wj|83U(bH4wC7Wgw5`6pboKZpDewZNaj$UoHFe|GlIXMsP1k$=85 z`*XzqPz(I;4Mxt#1&IhoT^Pg(54@|ERRdX2=PNRFD*Lk3KUd8_K#$5$sAv3+iAoPR ziITxrVC7utF@Xe3f<|*3*gawt6uRm?JOs)eF1hVd)dkN8m1%s~mS#iTtJGR@EY9p0 ztIW)sb1szgL$P1M>Enii3f-~T7Z zWm%PN{^Ttzpfz4Vr#)j!$**f?(hm}!Xp*X~`IZRE{$qKWO2pku6^nn;-5t!z)7|Y9 z*e?*sxFlGTl~px$DcDFZGlK}#evW?(Ws8f-QksZpn>~qohs5JJU33*;FrX%gIYq;J zlsq(Td}>JaIL1!;!#I6Wf_jx+18VrT^C1n0@a8|C%I#(uR`fiGlM{)nnt1r7cH@fO zqyc~8S@!VqUMZs+)Xx~F{uOuBYJ>%x6Jo~JRR83OOqo^yVMPa8hl&1dT@=U*svtiRM%{TWKm z4%&#H5qk<{;LVDOY~4FUM{*!0&5<=dXc`3ddfKUhvISHtJ!jIGfKfjkixT-jvj z7GGjf`)%$%8opn0S%1Hs6ATjLrG1qpdkNi$!yy-nx4(ru>+Go$mVD5pVZLaC{-N(eGHwEpx|otgQ>XdrHG^jxEAp2fH#HXfXLqG>g`F$^CIHYo;(B zoxC3bo6D^v)-7j&EO1p_)Au(L8n5O5{?6JtkNInMRK0z+;^O#+cDTm2Ve+bIg^-6H za%>>aZE%562cj+I)Roml;*@!y2pwCRbz}6zzptO@+)*~>5UJJ+_To*v`+n|A*>?nA zf}U-Tf9CmZRfevXnaT0}@bpDK9A*lX=^W%ubL!FGH^6Vla786Jf}ZB&-Gw%ejF&~@ zFH0s!UZ@xe?xDWkXZV(mpjy))=*a^<98Vy&M_{57^{P2mcg>A8aaR~60O{g>`(sx@ zuJt&$8vV;!sR{$h1iQ8f=y8UVjMVTz5`gGvlNS5%Q-cxNdndQ{6eCe|IsE6dM; zQQf9o*N*QxVA7^y69G<~D*-jgPGkvQ&%2xFmi2Pk8pCe#$L58)_9Sg`KneeBrassOqRqUSyH9~C!Zdi&15lOv zYc5y=Yl1(H@z`pV5Ig}}RN9XVsxF(_6Hq^vNQcWwKo-eH(L+!ptnZuCX8(13+TXL! zpWpvK7Wl784*aiKi{(VBnZ;W;N6h51l1|H$j=p>Gsjc!DhcL;#k(!1e8~_u>uFol3 zOtuvk9`Si6L}w>>7Q1NToQT4ZO%GN~CIL{7bHSww-fKSi5Lk3;|7i3i3uc#_nQ4Mk z(zsRC%CJu~idjp@;XO|PB)P9tF*$aY7Rnp$N`>o9MjuotNJh06mH6DYvzQ}rwbRxZ zjVAYPzrgJzp0S6Aoy&V&Rk^cP4h{FD7gwyOkvrlC3ET^olP2HUqV@JxZ%-c@>TrdW zt9x=Km0m8xn)~lBBG+d+DY}V83nTc(jeUK5W7{UqvEOT2e>HZAQcatiSqLJ@W^#XQ zXDG$&=K0>}+u$-k=VB~cJ@Zk)EH}URp+1h$ooT6uTYnwZQ~P~pg5==r!qRk+IcH_{ zkbge3=3#r!!~;#Z6M4n!^YTGfQgYmEdx7WUxmP19=8dsl-aCLlNdjfAi7LCtRrm9% z8zx=~ZoK+@5|?QepP5a5we5w>B$?nWr9aZV`u%@x(f<0cPCaPPnFbt*Qa8A{IW+@K zRXbOK&U&KCJ5vNR4uvx^q`(zyYy^cF8xx}~MK>yq1PCS0wze|Rt2JWIDp$>YBkXi6 zH+P~^OVIvOoT@Ljf6{yi`X9`_c{H1A-!`0Xopn-F&3jYSTqWjVw}hIaDiLE8Ma5L} zOeabd8#N1C3?U(g3N?h5nx_V#sCgdKm?`>R-S_i6_r0E{`~JSQzW4psd;MWuPHSB` zuitq(^Ba!icQpBTeozI&AbIjMo@ud<_1Zxn;eoX2&%fFivMPbsua9p81&j9Kajobw z%UurS!pH0AYAV>XMCYrs3p89xjkR#x;E)R2xcsNJ2_%!(;CwN-r+Rppw_7sV)?|(- zZ1oG~nmb;0r*~89qtNTfkxLfhgL_JxuzGX3vrD4fge(mVAeUO^r?j^5IFjM{(fX2I zaCy3@31#1>$<)2U+yJQ)(PVfBUNKMmHWxs5CZc4=KCH5JQ)m-4-#6Y0zEjKyuy!%qq*FsB$lddyHC2;5!puPgB{_YAW& zmN%UTm@U@f7sE48(^OUtBQjZ$FQEs22+DOuRf@%J{Xr-ck60f(UE;zgbhoXrf2u!Q z-V2WkX2-prh@eSSQlJEvKRwFQiEDOo@(SNUyur-VRHNJvy$Sn zS8(CNw+59!mg3_4!pW9DLGC(}pcC=d7kmRgZ1YaWdu+M+l=rpGeen%5-9^^1m_ zXzsV>ob{FnObX9_p!lvo+jQI~^V$kNsBl8e%R@`dB}s_18o-}6Pb~N$s1=;v{>3!| zwbn?0;>U}hY`xG{=y zqsCoxkF#%mClZfK!0hislIiW?U;D8|A0Nn7!6}qaB%>Eu`v%B24jtG4GgiLD z%mpt(5}ug1a-&~o&NFjv2@Y4(<2{+)W4s&D5%YL-B8#?FYgvT_9^+~c?{lfP|1Ax&}nB@8Rco}&Xzr@-m5>d-&fD5r_FsX!g zMBBb#%HB)^xODk=oI)bDEgE}uZg5ZXmS~))yq3CWqL=o!cCOC-;Mvd_FG-i?!5f3w zHn-&-w~iX8pRvDaQy=Yxj#=U-nJBfjCkB{~Yi(6EjL_W#UOzOWv6<}lAGC%qcs}*l z#;*itc^mB;#2gVcFV9#Ek$779(`KoxY%rJ_?$`DAKeg#U2N_|{GV0oPQs7Cu!{_o1C7YuUaG1<{dt3Y=0e&R-+Vpd(wWatAq_ZS#-Gkt<~=vZ>oaNZ%(rWD6{nGg_jHsHg5xydis^ zz8O>)TFO>5dqLe5Z2~#ZW^6tE<@bNu>}Pi;Hiw2NW{dgnzM!!A`8b<)v2rEvB9s@t zFeMW25$&wkER|7fpT_an%Fs}h4=qR-->v2VaIF9XWKrX8nFBPSGtxgu_{B0WEAF*7 z+=WUcK);z!+&fg+^_Q1S$nYPwj9KQjEo~Q<;Efy+@s%v{ko5WvVo<)YkBEu*TyP+n zaI6oR5T$OYX1>EYIPV-Ik1S3r&9RJ2*IEiKZuX3~tsWkYv^G31BYy{-7&rAV9avX- zVIOu-zhNy0H{El&yRgb2jVh6Geik2$A){;9$=Z4%4yEGdDeFl)INN7c(xE zZkmP@m8Tl4C^_t349?3PF?a})ak~XNb8|Lcm{ZIE2qd(?-IlC)z#SNWVA1*IbI^vm zZS!p`dHHoX$qz-IZ$Dn6&Cm+3ys!(K9?B3L?fDFi@taRsqYs@kw4f+7j{c(DA?6^k z@#Pz9hj*|GgQ0C;^6Njg1nXH*U*TUx0}v0?RmWagt(J+BjhV+ao*B6pyP*1@BN2|CrKKoIR%pPTN+dGc#?*) z8(X?)UZU~NHbkaB-yRvR(z@p+aqIAN6tl6%{kJ6awa4WH+PJebZo!?0_kdH8Pvngj zSlW|$p1d;5*oARZXGkt8rmGl>_>|Dy$VPd~8G&t)SfQqr>ext6+2e0J{P-b#bA7#L zSa_OBV7Sn?p}fF(vEaAuu>#JeW_;rlBE`6@w9K|62cPIrrj4wQS_@QlX=zXT_4x%t zW$3*L-2K$soR2wUOySa(ZO(L?h6{z@dzN+BMCd`tYk0b+GCspwOa0-J0DZQEbpBX>Xy2`|(P`iKcH@bhv94M3S}yWHlRSGg zq_bNA6KBzyx*Ic`M}I{M89#t*fbcG zV^t&Tvp!Pj<|3ucVMT>|{Aj;j2ZtSlf~H^~kP4%~&dMu7`jZNH{W5ake3WP9l~mMYmBl3JF2Y# zsd&Xva3dq8-VTk$Ebb_%C9*Z5Ggy@t^OBq74lMK^<<~t}jFb*N+wE;K3%!KeXWQ$C z(6THx%sb9C7tJ>U8s|P)&78sXUUERo&?|OmRRJKg_-`3HC;ClIwOw=5>ZjnWV6cp9 zl4D+gR9smhzPbk>76DOEYD8*Ac4SIKk7aD2EsDGj5a@trT@jH}%6g(Pw=(6P<8#hi zIT8&i&}IKYHs8w-*dj8Ch%T6&oSjDJL3_J%Mcf;EU*6K&=(j$CC$cJv-YD6tSaP;v z)2%%aLTRM%b4}}!8=4|Yn*;g>nm?@iUdP2ErP?N1P~SluPXLD&V({mepl5aCuF@_p zh+hW1`t`np=E@zWdNT|5*S>=~zmZ0cuF0}|UCn{OwT_i+l)N`xFmGO*>~J1$N-eY1 zS+R{zn}H7KtOQOJ{h`#D^`;s5%8@P+g=ZgbL=r29l+236mnNyucggi;U!1)IBJb(qjdI3&CebC-3n3DR6>Ow_$| zukPx32T^Z>F{QjOiUG{i3Wru5x|vL>uGLcrO6;J2gKBG{&j2L{qi87wmIZRd_ivVf<^t$%zYldyUCP=VX^Wv1{azDqkmtOEh z(PL9=U%Ec@>j~1|r~HZ4-zqBP9jPXwlK52cSWUC}6Z;rDjxAAsnj(x=qK7#9P2paT1_-dSYZ#*PTMz< zYfK(EKBgSifW4?ZLwxz7S+^G-|7Lbk9RuM_V?Jl=)Y z&AiZ~qPwFLHPCuSGgWDdva7V3@fmS-Mlo!_b%0AbAI`e>uMX z$1MZ4yfS`5SHQ(v==n$A!NFs>X5$Snv=fJK*M)#giF4#SXV5@VB- zM}YrmjDudQy}Qz8R(nJpwU^QP{95>1ITq{YM=D;Vfk>V%ao> z@jcKY^3VTa&i^)WCOXR9hxh%C$ZJTX>xJAL95iuyiF@3Zvu{DtpZTZ_5AErxMNRkg zNT*VmIOZ62b;KU0>uPtT^h+ydZ%xp4oFyL@HrOz}mXTp`o=EdYXrR3K`~V-9i3tpc z1Inp})(yjD5Nz7ftMyw$_l>1P*rzQG+dmafL4I5mL*QaP&zVu(AJR>z5gXm|(b2+x z8l`+;3Q*9NSVN5TrIP^txK|bO#+pKVxWVG^xEj z6UC~^*Mv9?rwj<`Jn?d+m8~r~CDcb9&p}iY76y~NKM%?J#Jy>Wj2yb0Z8~D;qG4v* zUM@J@hY5ue?Acd5~OP;Dg!d3a^VkF`u8$5&S#we6_6*bWZ`pt6*)d&JMM@w`4PK?I%5>JM_*E-*F!&OwFHqE!Q z^2U!io3t@F1SeaG^%3!NUxoacn4kZkIs@0MJ1-{tfhS{Ju(7?fb7kK_H~BC3(5&nzyIFScbIhw$m^16?;Q04w>uPQZP(q4d?-?mq9e#8xFU+&QOa*J1?OfUt@W} z#F}D}w3Uo`?>5kl2oQr@$Li;g3YNYr1gDz$38jRRn>T#ox-wa;ngfK?6XvM$Y>1OH zK`ODUx27*BAUZw>Io)uj2t3!9Z{-hVZ9mjW6A{5;iFI8$lAg>=cBJhp!i59Ufh<08 zxh_%fF}X9LsXwR2Xbxt{BmTlLBv!!z+rPQHSEGEHx1tFZC2A>aRIg;a9sd49>_cTo zx7IzI1m;mkl;d)UYXgux z<_u^G=p^(1$MyZ~@VEzERF#cxwa!f*CcM#E#OHFdBm}Hp1f03H0w#$f9(i ztEuB|a(Z{X3du-9UQsb2pk1bqNCbM{%toZ~0cjNt4a$|Jq9VdOYPY2oTwGsYeNfvz zae0B<3G|==6dn44nJ+epl`h}L=^GJ4GkOzk_L?h29WiD%qYY;&e?L)<0u(>=+E>@e zc3~((SZ?CZxrt&3&#ueW61_iGK5$RDsn;Gz#N6xRk=+ec>dqK8YjKwhBrOjvI9(eA z+rebPujr@JSw@6QD$nn&+(e}}a1~k2Kp@jYd|zS6n}yiSNc9bzEN$Q1XRd&XD)yFu z6#eO0;fz_^DVZiSH%u&A1`Y*YnkXn!iHW*mo>O244iZlj9Jsrft6368INqYN%46{& z!kb@=7)vgdxG>{Gwbz0TPPY`%os>xkj+yP4-u5NXMI)b|E#&oeHL_yUOII*O!CX3L z)&^$D$^+=d8bpKP`xhc&JUig7*K#7kYb&1#v-ieP^x9^Gh2qFyw7cFM4RhAa;B@30 z9+2vV!KZ&c{M6G9(N5w!RStg(V$uYEAz)yFk(TtVhKJnI)rR=_yB%wi_eF@y-nA5E z#yt(IT_HL*A}$$SF zDq~Zgo#_3a$n}45BXdQK`*;`}J=T)zHA{v_mvX+HW-~=X7r!TFVJEZn6O~j~X zwH4+g9_0r_Zsf&h&AE{IO%8<|H|IV1*qh2Z>B8xGJzmRcl|EW-ZgSEYo83k-iC}3} zQ#+4(ZJr;wK1(s%|p&x?W&gwrf7M%sq9RCWWS=Dz!T%#Dl3 z5=pxx=&6caLS9K8x-vXp1RW4AdoM3?asJ+aRsbi|%{8jyhNrwbM?ROXQQrLLt3?^ZC zKagbc^$A+DlT*M(fnz5pj*E&~tY<;qY`98S$k1JU`cE7FP8 zO*JTn15G%dE*dg6cv75MpEueM>sWeZ#h6i3vQcOweLHU}g=0-r(URF_pJ#^@8rS?p z)p~Aiy0FgFavv*LyqUa+^T$YmK$Gx)d@l28$avz`?gcf`y^pi_Fjl|y62NDPV`bl{ z);4)oZsz@pedBS|UVyf()r?caRzmxZ6+eyDda6R7M9F&SC_HD`==y zjjrJ?n&Bl8HJ_JmE~S%i#9B>j{MGvdXxQ+al@t6noSw2BrTvRG#5U~UgEo2eULlY* zeu4+qIvuoFbAk&-d zBSFIZJL_xvEef&Jkkr!J9^+7sddu|pC#cncl@8YAoD$J<2EG->+PbDX#}9;aEV+P~ zp_>&9flLb=>%qH+Um@&)MEh&hkWFx0h;+pjfBVR>L$;#D3f z=@!i`uIDbvf4}FY2VU@XXjmOnfcb>x;b;f1ko+6{Wk6iZEmKi-y|;Z!`Ao+p1u5^k zqY%f@&BML|(9GDsU6_BY(4FDo0JATUQ<-ur+%+r+fS7(&pQ~ZdSM5!P4mE`pTGWyp zX^|$1!mzdVP}HX6dnF`UO|1upjdqqJvb-GBGIe%SJ2Fzfg7!uJQQBu1{;-?Zw3jsD zjaYAGX&X-d4hmlfEY^mvhu!T-yg~9oCl*yuj1^d~1^CTbhI$QH9rot#Gx*^jSJw6v zblB2*gf_xzD^^|&f>a~^U2R>{eug&o^rmbb1sJ08a_`~FoLEAD}2b<^A#@U$}>+l^((X~W+lf^ zdTDOt(5o^(92|(oP|O>n>p(N`Sjp|{3Csw^{PLXVzNyU2)zQ(1#z14HAOJ6g#~&t- zZqG1V;@zsgy`)mNV@(A!;nW_hGtZcqf9R|KxR})^RhMRI3C7o1lNndcdTJW(4fC=u z%t!1Y-h>z-rB;xaspZkI)*n4hA^l?kEBU%w(cPOOw06#;^JbRh=#wkuv9nRC%6j~C|Sz4c@bp1IF+c3G%h z;%{QDBPnBw;%YULGBuz;#-Z86X%Y}pjAL0xmP87(2|t_{0o$~#$yo@DvNn|6O=asqN763~ zAEs2iFIHa5>MO&087TW0EGg5f{iWt0nMw}x#j4RHseFZe+13@VuGb(B*T03v$m{a| z7P+Z2>vWy!nHUIw+B}tmY(<)0(r(LHK6vh>uhdZlQ!ZXp?oKpL=X3Cql73@PWE(9S z>TI?f5BA09dqtpY)=3DGTU(k?TM&ph(?wi_M063&n0HXv?L=l%S+tt2OBb=PS-2T3Esf{ZpQbyNnv1x};TIn-7G5vcS0+-5P@(&e zBm3|L5f3bOM}C=0-8LxwJSKjP{kgvR)tz$VYPOg0$8&5^rk^rcy)ET}UN821+i@OC zk}_wV@q%Z(SLLtTCdx+W4A=cGd4h<~Zz;eQk?1^x^c76%Dwt*AhOzAgcCu7GuNI z?(5s*uDfX-cvY3MN?z}GHf%xAMoBr;J6La1xz9b2@K3RgXI{Lf+woj}TQhTi{DDJ> zkiq2;Z5i4glOjBH6Q(j}V9(8=FHpw5j=?g4AYSNsnaw4Dk)Jm_2Nl3F(hzT!d~Gd23JoJz;6kIcB}Pd9qt z)lvg-m^4(HgS@%CJsNurc8C8F+BoO)4iV@KjY3CFewx?Z7md8}Zg>IE#~=$-8-Bu< zuttu21>_qILm(PAUaY^fJ9w?L1X+$HapGVtJ00kEUh^QvrJwEbGjuqR2$*zFd+azB z4ACe;-%KkB9G`VE8_)-wv*&z5K?R(5)_#)^S;=5}il1Oje+?(C!kt!(vTbd)a*?b{ zp<14JCHLo($r&E>d1wBcvBd}(t(dljT?cVlxfsh*rH0I^jQNmaz0x@%)=Wo_~~oxn9TLp=t7qyGX@ye)S># zNGN2u;{7onHou?-o7F!r`FFqr(3x{~=(AbM8?y2!6q4;zhAQg;6js`Ga3&>~+)8C(o`b%pjrp zyn!JY8Y3c)4LDAXCPeE^Y!sdxi{wZ5B1!KQD&AHhxyu(@{p1ylVxL(~iQU<05TyGz zuNzw8hHwz8+@tTHOqZ}|Tm}wW3i7)AZ)=7OXS_z{t_UkI#XPU8k09$&`; z=)xd1Pj*&DO-%JRCh1J`8ckd20DYBWluuP=L>caHeCl5lFUruoaT4< z6Z!DbN}c->P^A*+&3YC%YT`meml!zJBt+~^`10=O8d*PHtggObhADqwCw&Xp>o9Q5 zqjwCq%4E&0avG-6dY~GVx9^XPIU=^F+c_r;V)GOY4Wa5CZUW9_HOkvDuu&~Fuw}x5 zfn4>_zSJC?c+M)dvWLJvzksV$Gg;WJ)V#ni;^}a4zBx?7=hZgZ>ufZ!s%^_uIJ1E+ z<+n~|jtyoqG)t|fi*}CyaXCDUEUgb)Oi3PHA4=z(OO)MVg}|u!f}j(VyFWW;{%;xk zKgNCIaph~ObVfK7luj)27h&3+XAcs4fgX_}KmfU`OE{Q;qDXV;2g;*Kq*y za+2I~Sm{NCQ+MKekGL~VKDkrUSJx@J=<{fc5pUN_DTrtJJ?MneEVMU%npo9xeI%7` z`c7M0bIt5vfTl9G(>zJ5B{!kJDR91xhgD`>w->lPnXLVI?Lk#7EoT9>TXzAO)iO0w zoc5!M%c6hkAceL^BuX)cEQIAbo zq`>T4&M0sZpj{Xd`GJYK&Ija9{Pu6phyOR*$#!po!Fu&WneM}nu#6(fHEd$qjfxG& z#(QJq9-&upryvm6ZP0%mcX#`GqELc8ebSLb=P##LBO*5HX@he10F0)C>|n(S=f^Z0 zATc}muQZW-^gHXaAl-21l$vfs>yIo)uL68 zdw@R5lc0$oku29#I4U*Oz<_x!3BiB81q}3DL;xn9#uLWH?KM|vr@73Wtz!yP!NWDW z+IQEuIv`704RuS*b(o7tWlL;j;&;%M@}|{2pS1m)%+PdmE@{T9X7Ql0H;)%GA0K*zUL#rA!Kf+~@vb;RCs<(lt zq_oL7i2C}+_j3h^W$67+R)gV0PmO}e6HlRNu#QgKT)-Yj!F(vWTY6@)ek8lzbVZzb zF&ZC6p@}%v%t5IWe2Wdgsk78{AIv%VMtd7c@f^FM!TpW-*2X6$EFnfNMVZgb1!4mH zxw)c|n{i%7f9|oux|wCD?0Vp*puaw!nMa*Me#7SUe3x0DMSPiWs^|QD9=Zjz9m)Xd?yLO+P0d88R9Ew2yj+MhqG@~@9Z^t_enl#%v9m}aRaVQC zHgHr6_7*o{QZREUnE?lJbCCQbvaX7_J;|`IeZ5bxlnqU;{m?y=a_V}bYCtO_*EO^K zNGR04;l!JHL5pcFQhiN#@T&j?aIm;JlfOs`B{09l-v|a|GD@BqBCaWoD(Q$9pjQ{< zle>zY38h2;VI-1c0s6)57Q^b>;q{c~3;OoupE^y=jkjX1+vr=&eFwGwC>c#gpb6OD zB2)6EF?#)aR4E_<)QL@s2S9ZqA{>q=5upGr7DFlIZZ$%~$t(j74{S59d)>xiahXLv z=UNl1=C6Ui*jF!R{)Eu@wiFE*6P|m?Z6pu22StM}lyi(Q9|7 zL!I@+y@Y2X8BjpMaz=@<;)ur|zywZcybsEVA|leiI9SOz@BYA6{eGgW_MhwVv%53T zVjm|poE}@E;OABl_kOf&$JB&28b2SYE|@1+L=*tR8M_^=QC|-~+g_oLJhI7k4yZpP zL9WwnCX|G}I<-eJNZ$|iBq)h~(TtYqUEsy%&12xo4^M37{o}AY85z$Ko6Ismbroqf z(3}OD2KIOwGS6xF(wXC)&F*l=cZVm<81by`YTcON(1;x2+xPaYi&0lr9hxQe5R%v& z^aGZAiVy19Wv|J6ef;|U35v?^KYNk?7-QJ)|6s8A3)w;Q4mNkM>IB7I{}G|`<9Oyl zJ&VDdO=!-fXnSe-l^*A?@MF^Tl2iSaqG>DQaAv>Tg@H5&|8mJ-MehC&-thIqtc~<% ziGxRq3izy!Am4WxzU|{YzUdi`3%KpriybYOJR#!BCC~k`xZgNI z=RU4F54!O5w11+%zF${*(sBF))56S1xLNVichFR8$r%+OPIX6aC;`q{d5x()iDYVY z*@-+pxb1k&SPJuC@AitgQ`Zk0|$_p-Z{2n>n{zu+R2y`rsyJMvAPOKu7NmCfBiRB{*OP2COH@u z^C;9vyPFL^a_+WN^i4qnl$}D`dpXLtR^ywsBMWD!zdP# zOtyY&$+4J1Snp@vU)WWaWLeM*WCDTqHX{CdG{YPBcA03jpy>E6|6fs8028B?E`y_^ zb-sh=1(#^$h_ox0VAjKuDfsia)?)Fp2l)u!s{TVWf8PWvepso)fbxrKs)H|y498bT z#BMEQ&@$@hI!Ou|Z6GD;AAkR58+2LrvKdBkD9=aZA61pn+8b^(N&jwSQZ*n)><&@+ z5et<66$|t;bG0ELvK8H|E$)hfLa+isuSYK5LBi{<1<^N3ny9xOwUN=&-2r^5%rB6c zJg#-`jz{x1r^Af*+p1_O{>h+D*qDHZlc;@g|KW85DB_>ir}U>8SILh znA@@U$Q5rSJif+QF~Sj=4NX|UYpHLYtxDXQHnpI=O)Qbwgij$F{VP@F<`8k)*3}ad zQkZ0A&;A*M7KNSc(i0Q%SAaTG@9d?n!uuo6PN_cMK_7_m6f;3L?+L9QD$S4oFE52y za;I;8){5OM2;(90hMdP2+Y|~gO@WVa|>K` z{ww|+{LB5_Of!}KN5ks0>w;%|-mf3qH%j9}NESe7%%47y@svUD%hSJEuQQm4#o2e( z-!LbIixOEpH9j8orxav$1pFG7mtjVc^+u(1`b%YoX`j|lN%7H>LyIhpURwj}CSg+z zW%OHtdQoV64X!PdnO#j4N!%V2$Cp;b=IM3mBBW$`9)K>N{_(L4vh4?QR9m!TIz{_J zzfxPVaVUAw`o?H{ijQtE7JCHesMLKCSGt_xFSyb==TXuPkvrD2SgyB8GUO=CWcd!l z87#a}5p$eEoVx)Et}gqVR{@4?Q#N_6>)thO+9>Orw%_4(V$q}66(m5JTE@R6@5O=P zFb(+4Oegzwq3)<&E6a(&fh!6D9TUt{8ysqv>h}YV*zp$}Q6OsMg@8McY>cu?xXAL# zvP-Fl#|XS*)}$X@k7-EW*I)99#Ib1BV5*5uiNwDE4FQG*CHv>Xt?9lq6>!#3RMz5Z z#M)>tUSWcFW0U!#ApIjD|8dz6@6f39FlBy7`90`>f8lpv(w90=X=x%U08{wJb3dM8 znf)@SZ;lG&E=>g3~2gw>J)I@<&=SopGD7XN~Gs zo`QmoO#XWMi8Q;5&TmqtURKb?b4h2vlx^PgyD*OrI8|3NQ0Sen{Z+!aWOR^;;yLN>5CTCQU~vH3yv+ z^y)F4I}dobPMl<)swwD?eP{ zDBc)0x>rER#4mip-IY4pj`}d+pyi2`om7_r-)c295Eb|_O=u;BgWP75~euskvVuMRWT7D()T*Q%s% z%8aOvX3JIyxfP7+h|n`3##38j;t%XYsAB$^D2fRav~x^ckza=Eu%{IroS0R(8U9n zS5R!|lG7~%i?*Df25|r!YZP94(#kOzj%mr;ht(rr_Z%jt} zPGk8I*{q+~cQ5ll=~7+ujOrdFa(ip_5i*4`Gpft?R;US6^`_G)(ewLq=2U42OD_eN zW}8;DzqyARN&zX!UH>uvom(*y4U>Uus{BoGT5d58c|OCOACVX9rk+OLvf9N8`){}@ zmF_r?D#%mc$c>m#s7bp@F&RvcA`vyQaD!-k0iX|D0m_nfZd=t4C6B(nI)y;kSD4Rh zFXcvdw69oXp?gp2HgnNhAjUWyg5QK#X_xAzXL|Q?0k+0=k=iTW4Yk-m1TS|F@3Tiv z%Q?+j5-YmB;A%RVk7EMf&Uelbkh&=#RjzOU#sm5JLj3MiXF58pA~*1qxM!e;U6 zLr=3=<7y^DBOt4t9WoVRHno$Xq+&tuR_iWy6$<-olZ12~(r77Mh)w$J1iL1!?Bij^ zQ{BSuuSw8vG3&I@r`pg6QwHrcg3?4(({n_cqGD~d1posq9~c-=;YVLjAqIY_14^8L z8>?PDQRG&M^y%>O+zFfzX_y+^^R7y*j8^XNR$Z_#)K-2SetqmlyaGoH7>p443S@W^ z#Z@7ztDVe+^dyx$=VX>X9Z}DIklM#MEJ6I7^I~27C1iR zQ}FU&%_n)O!*RY`RfWOpUGam~?O8c?FzQwee6n3t+>if&E!)cy9N8T|XxL{VY@c0{ zkH)5D$DmE@Y!u?9j37>Nej*~i=(tQyRoEmcon>+lXeNRuEa0eC0+&1c7QchM`!GiV z(9tukd=sLKT}Kj*qqMcd38mJ$jPy$1^jrrmW#?U=5ainZ$Sw1=?IF~ncx8t+3Xey| zHC@n0sH`JjYN*$=+t%9X7OTWJ-w}85HmAg?UqunE&hN%C$pZlR2sBV?v{+4T7loR9 zlC7@=_tcFZrtGfCGQH7itqlDAgyrMES-cbM_AOT3K3Xb1QdjY(aqK3T%Wh$988S4i zV1^MSEXr9cWk&e18!>+2p-BPZOKoqo(LHow(%dLALT>bRu<*ga z+FHz5SubtKc%(IKtMJa#EjRg)%~yEE!A;k+#Fa0E1mlLoWT7)bX#du3aj}&${Nswq z$Y^&(fd{tYS3ze%sMw?=X=N5tc|(^tjIcfUZRNwf&VBn#E>pi(KG(km z+_cC*u5U$6Y8+afr!Q&@+Nebgp!m&z#3z=|H+E^qLg;*1qXfmbyuVkv(r54P5ep>4 z4g?y`{~PoD*YMY}%=1m3cba8+KfcjcQO3OG8NYgm&r6%LfwjE^=&QoY%4+CnjIxvX zwPU5qe29-~F2Y52K(;KlGj9Ng{T4Loun^DIw&{L}=dH~TjKFu$9d0{TBi~1nONTl@ z9-EI2f!-va9%XDUzO}r8k%7KDvaQ;DOwYL5$(j?!AolQ_ zlDm9`6T{=HE@FPoV68Jw^Vh04o1+`95hJITJDZ$l8$TO=driA84>HA`K|7 zG|WerD)x*3;+sMl$y`Oi*d!(hS;L>1nfQPQZ!EA*}+|2CvKpf&oDcE%aQ z1EGZQ&!qGwB-im(<88wnx?v%;LQ~~t-*iO^c9n0P=&gHyX#|BzYaiCvGPtpMujaP= zXF$$K}mPdEu%bqk$!N2@RES?!a{M@$xI?5#IF&ic!AET!pKFkU}kX_y( zM#qqt6uHP}0Y+x+(WNPDB>{1N&|Flo>Wi>lejzTPRqO%SY+eBHfTI_)!8URpvV7IV8iVgbr6F1!W@KOOyk?s}` zjE23nnoi?~MOBeWt@N#uz((JpuDdk%(wS?dU>?^ApD$lj`exjMDyMf~M-m~uA+5;? z`;t~E;EQ#Z@n*UwB`JMEXQ&EnQT%(g9qYSyQ8i1>#Xhy(NfW2={aUQz0@6%z>YQFq zMgSxOU7}OMT$z-V77hTSMf@gl&my@DH3yuo59l)${G;HKb+efs=X9$(XueJdf%X8-z%hX!sHaY9e{w$eK~i=d(q; z-u9e`z-~LM{1RO-B69XCKJ)9D&k{S=e9c9iopVG0Bs?3IFQo%?Vzuq>?EGWg8~&hg z$VeArZomprUiI>57G>&+L#K&aM13$cdXB~X*`@b!;ewt<%Y*#tqqo7D7tCJUK3keC zD5b~aTu zgTJa@cpur^4UdA z%Mzv~=c1Bso1U(T@9_v{M+rQ-qOmU!*VZBx4fo6-0EseykUgrdZthtWJ_a!S@c6tX zu3L@GfwKX`h(Un*F5&b0>Y8@)*CsUmr4(#ho0H69mNQd@#i=8*`}U9-%-MBd&zeI| zp4x}TJRT#S_#aS{DNcv&PcvV|PH)DH?$>g&vUHpo-&%}As%+C)U2Ye>DX*4y!d;VGw`^)Fh-%fp zRy%Z`I*OY6vji8!dPTwXh8wWq0ga)3r!HIehn%vvUIh4TlRY_e;d*Y)nI}C$q(dZj z{f#19{q<*iMZSXu#wyHO-p%6yu-=#?qZ1EL${-Qc<}ShTF~zhexG~I1FRC%0XIx;T zL^mLm{Yq=>n{kQ3A#?5Ws(eShLjLUsDQOPEpfgb*g{BLntL10;g5vKL43+^)10eSz z`|hQv3%OPa^A~?CSmsb&`D5toh98p=ow>91)m^V-;&qpms}-BRD8WE~AaB}k1cCS5 z|5|$KG@(U~8ySNhgU*_zRxHuhfeI8W@~^-1a$*FDR5_5AIjEm1X_@iIVcQrWec@?_kFx{&H2tq1B@4 z9;M$;)Cc^%Hloioo#nFU~5WVUQW!~5SV8Rkxna+ggFKPIY@l<70vwG(Gs z>$2)5Wxp_5${0`yX+c77eV*)tPVZ-f1cSndH)c}dhSOr&ECVJsY`Yfb0)cUUD>ba%BFUt; zMM;NB27-y;QE~+yBh?u7!D`A^Jpcix5d3eAbCz3kip%mgRqhoO2(wqS7~<%7fT5k} zhbQ6*%?A0y&Q-%MTRQ}O7MV9*Wx4l1FdG)x8f7zGIfxD0zca@@!$Uf-((F+!Rx4V| z>P)X%uQ%{l@O|%GAKO=vRg75Th;0+Jjwfp%Y;hJlEnLhNB4j<0C`LvNw2yIsvG&uNsF*`N@sjqmNC058dAoIlG< z-PSMc=5mf{}p@TtG{RK zku%EO^G&x*w-HM}dsieI|7xdEAc5T0`+=g~E(KRx;hli&rNs;#<_f-T`jCR+5`Ksy zNqhG@cED8Bc;M^FZ5d3eH`KqV&dnZk%OiOqVWH+0-xeBg$5xk>=RAY{4jNPW*+ym> zd@@Vq?oKyO6u0AEPDPK1MwySwHMF;7#qtm+eQ9`{&I+U~{L;tkSC0%|Nr^KQItdS1 zF$&mh-D?F(%239+AM8C@3u{wc;&mtRDzX_lGmDy}4uI*TA2sC{8!0t{n{3Y)G3O&@ z*OZet%KOjYC5BSdiX4Jf%7!ad_xelF8@P5+Wt-HxF&p8^XsVBaYx_5xX0Z>0P?vJ` z$6<%i_@+on%mb_%@5Lic1V8 z*t+QT!ycz#o`5bR{&=(>m~4_RElL0UWK8heJ4I~vL9PsCWsE#Vi&O-P_1`?Igz2hI zR#%4~y^6~TYa>;i;~=m~vmFbSOqa=*e2gIKPCdQ-9dyyIk~iwIH698T-09al`q5Ey z=0?nqfZ(doNe$>3-Z`~IV-s;^YwJYg{_buA0Eu9qPpPBN19x^`B*W~Tme8y z676;XU!r5dPCqP6N?&F%;wi{a<^9i=6!gorUQWgS@tY;?RTV{H)&bZMCAR1ILl=)A zs$jy$7J1YK#KVG$_L^b1f{s5MT>v^4gaJ4wg?Sq`y_mc>B~e)a!hXNzlU|(+D2awWz8kbLU_5#m_sN zVV!Ewb(R}~gpF%SH-|6ig$w4GwB(pYj%zI56>HDn*yC6=b$@2I#8E~8x3_u+7OEm& z?p4)xyetZKYpc6WNbGUDR+ea-YH(m{d^jIGEHSn?*`Klbl%f0|dHiDLJ=WA=q*5~8k&IMv%)^-x%WTDz31Hf;y=dY8(EoU&H0=CGrx1L z;+o-9*d%=TF+1w`paZ28(^+F$9y0!0huA1_N_1muGu|Hs=;9zVKRPZ4d~#=g9+2R( zrRAD1EcfD6jnfMTovPg)U@>nUjIUkU`D)6c)w>ZyxwQ_QGzj6dNa&a!%P(RD;t~Zm z6q!#p6c73(oL|lC0g}~gtPXqqlB%R5KGe+GVU^2hvg7yWXS#~QYUgjeQh953aNCK> zl*diyzaD2TX|D!c)qTi(OPatotvq(|Kkp(!C;pov_+N0VPHi9a)5_;6y=5?m0R`j&YLHN20jZs@?6VYu z1o6It`-K|z!ed|jcYh~0oArq5e79x|Gn4ealqW-Cs|BJ7tL(N;$HKW`9NmKZLEY!} z#}@0QoZslRMk6!=Udz85zc?Y;T(3~ zg_#jwN;p4hULg^TW&2q35u=b4@>Z|m^Yz!wuuEz~5J3n(+Be$0ggS~*?7CLRqArhy z@qwXto6sqpdb?0{q6~>C(6fYeA1hQ=PFF-{1TD<((j1I0jRH2)4GyXjeYN}^SY#r+ zbPmI7iD8amhJzUM3hMSEe_()%)KtMD>S=EREBcvgaZ4 zQTVB^nxBM4=A1rtcC~CWUY*E3+8Zd5+#<%)5HiXjaA69i>l$a2E0?>)(!bGpYbA2c z4ae4hIZezGe!BB?Jz8JJI(fM-+C8P;^RT{G{yl`NOx5RWFgD{Q;u&2OojFLtUnyoge+()U~tHYTG`Z`&cgYQ?K+iNiI-=z!+SXw027N=TRFtu`f* zew`yh$#Ix1|8l<;m^vhhgWnnk-Bt8Wpz)7m0xdZc!19Aay`-0#A_J#_FQ{nRA^ z5=;cF8Z>)ZR&pW3YONZ__We~eED4nQ>2m%kL=3DNJkyf0%8pp{(k}C}u!ueQq$D~8 zEfF{4kHcbysmo^^+kV*neVyGGDG#p-40GHAtA@^iQ+|Q8cl#V` z?0N_T*(3yYjvbJb51%dgtwy?l^gdAH7YH0`ruH~{j5EneI~|$paIsV*vLwFw-@L)+RsAMWb&B1{dgqE$(azyylmOSNjaZ0e=`!Osuw zogLuStflv8^}(AkuKa-vg)-G3^4z|-%H{7&(2q0`va^B ze?~{OG6frZX&rR|Wl(&sSxZfA71aOmWqz=YcVp(_$D)PL`l00uX-kQk1DVD*gHywk zhEHYwzH$0vs@q_8eORPJMRNG8?yYM(c3k-{Z(+*ozYF1SMaLTnnt|QYYot_W+t8v~ z8+hO4-nFYOdq;xBcVk73Y>$PpCdd-r5E_*%f?W^lrUkFmm zJz95L_Hat$assyG)@{3U9G3jUm$BzGF8WGvfXyf7d*qunKkzs#q`iItJjE(DYi24r zTztWO#d_i*?t0(nX3bb7hlSL6x-wO8CHQETb?nSIeQat!eVM9oRoO34gvxHbV@!F@ zwpEbEzOeP-gTRl}!K<@KxNP)rvqsl(Rl1dyJdSnMYhNgBCv5rEjOI~PAXuLPP;ZGG z^r;6{m8p!yA@ty(dys1lwHH8FS>?Ai!wc(qPP0Z55@WAX$$;`sgc2F|h7EN3 z{EL5)P~Uawvn;1+v4ZyJG?Z85bbsdA^nTLe+hWBT5W5PP5(!_kqJLAKfoc z#@}l=hj3mU5PWnq?)voHqoy;~+TzL{jTUqWDizE-e*Kehol6l&8CiLNA;+!xdp)kWdND+y^*V}wSCqwYnjP2GfYZ}gp0bQd zVDl_-W{vca1QCZ2RV@6uK272P`xe81hqpzj)b@fNI#hK-oL_@!U0{-n@*MDSVOKjBX zQ?Sae>44@_vi9U&N5*nCa}rkPjh0ibVEO%l#>BjW4+E^&`1b^K=Qt+qQ-?O3tKqZP za)XqSvSnnhf18+5{Va^6r@x*WySMrW=1!3ruU2)pi?G3;1;VAWnEU1;nWZ~@@v5CV ziivW}zI+ByBC~Ih?Hp0!(2%ZG+MaJ&M6x8vD4_B&F?rqcg4_WnI6~D-cLes$9Ggh~ z({=@N=rpI%MC$Xfp z?@j~Bp50%(?Ea2wGwav>!|HWF8MONDKXU!w{`H$PxN?ud#QPWM?sxuk;Bqse{P2n5 zwxOZ#{03qDfXs)x#H(I@7V%qpO+(JN*};3M($}!&gUkk zl4iF*3bqTJ^#TeRkV$q2-=XnbZ1`1YcW3`p%y1#b>fWH-a-1$Yjcohe79N$~otiJ; zJ;3IO^3Kf!aqB$!Z25h#@2`QFzlVOy6e`E5S&~Xh-fVc89k0~ZXl{$YN3aD@_i+1>&99chBo@q(tOn+uhWB2YM&3PI#Pkt-w!f-z zsi;8S@CetAMFaPQ6D0>G;0-M3kqt%j30F5g_rL?`x2ySbO9w%MwML4hA3K2T3bK=Y zAR^YH(N|)iBZ)9_@pE1zaY2+^rlrBF!OroN58<7y8h^`a12#6XVET~Bb!HXVYaJaO zbsa9zTTE>iMIO(`OXr$)yg8^ha7)vXmi( zziGCBOMxTVl3$qFsBP8|JukDbHxIqTer>c}T+#G-rdDY|Vw%G$SG&`lZKryK&s0P} zV5r2>kC8W?uKMG%TTBwAX~aDpnMNZQp)vEVL5+sfY7I8wym?0QBbMrBpP|34TfH&r zYN-7MVhW$j6pZ!=sSz8=ptFP(f7e69iUj?B#;exWSSR}s1EB(gpmvd>Enj1UY#V!y zd0Bldpp{e}Gj)g@yhja7)gwzovQ#T}{aT5X;AE!dEPXX#SK#JbQsteMMSLV!TluF$ zAqQ|Fnj4fy5;czRdAeh$KT7183hTZ^XQU8o~37&m9-^X^b=6>JU=<+>>o zHvvI7p*_?~nn2TqO(8Cwq)@%_8N)2M zvOH^f3Ta%&-LCLQz2%+z$ns8?pJX1@F)4%E%F@0`&u`AMZ>aYC?)5cr3!TvDcGYc- z)t9v|!8-ihON3`@dWFNvAdI)^iHeVHkC(@`=Hl(-Qt`Oix@!r_}#$3fT+I?T#zXS zYzH#gha0q(7L4=)V#XR$Z-2$-0Hp<~xv42vae049Jtd>8l4<+e>P=Hmo7d( z;Fredb93^c#FDwC#^yaR@U5gBy%EqpOJ1H|O>f?ZC5e1HU&89JpO1;|H9ya{s*#aI z(7(DU?V{ja>S8vlYVtOtt-@DOYcRv)Wv6)xJ&=Qn4$>Dl0iy%FHfB}&_~=#23EE%9xWorLRGfr_j~Shm$J6{qgltZeX3>;nja=#83dcT zJy`!SQ39v0XVupG(Bo=yGjb)ltikB(lM20P850{7sz4kdPX41G)Gq40kO}loMbE=3+Qc>cm`*mi&{@Fs9a=8OkIbW=!(A*kWrB!uoswIh*Q3UNqAr>1 zoZYU%YwI!0rn44%sqq<Y z{W0&VkcbstWNTdXEsRm~uYA&LZan(j`{=Lm>%=~%iULe!E^MrxIpJJmc=RxE#lKa> z^CDGyb8AyV`$jnXigYhS+FG!LYP_>Xwp1qcSn$a2(JP=Vvm%+j;P}$-)l4BtFK1k?;$#)Onqk38HhUoM3p1P-aI#{pEqgvnHgoj>FIdrMp6^h{ zZyX9d0Clp8Qr9PkPq)R8Yd-Blg;Px2HdevqU-w<_hP>hjS*<45+u-DU!&wOq=tFvz z?${EGOl&J~Ou}35=#>!2%K2@;Q=FXjpCiZQ{6l&={MrYL%#v1Na;09#D=_FeAxTbg zV^zq*Yu`n`<=I@laFW|bCGs3NrA>3Cr{~n4rD_Y6+vIcSEyZ{~?AWt(6~D2_%>1}| zT=q1uN*44i=CAteI63h!BSM73kx9GP8D3U2|J^J59+Nyp5?{`N8Wn9g8jJt>$Utt> zwn1kt)$un zmrNl6gVhmx?vBknPzAKHAHMwzks~QwJVq=aRLEpTql=l8mkd8!eOQdv}F)yYz=U9Rs z5h^wa&VzrAN-WfL?r<7eqf(IQo8RDgH!J4rr`gQoq>U{yBU^d+&perHyzWwrlVkq# zSOdH%@Z#+4#%nGGI60Qrq0ucS?S8jO>VaP1i@|?E)|nkn|85>7{lp?Ow$1XE&Y>FJ zD8hzJ>6(zE-UGg$H4J_5o2VZLNj%UCa`|Uw?Kn_z06Yv;8x2*{Sv@~->Wo-x&@C|Z zv5C^yP+;5nHW-(SBfKZm{xyZ_RI%eH4NJ)p8YbSGO%hC*tIiv}q>4^>n8s@tl|KaVw@ZlD)FnC&&+^IH9(>W)4O9if#TOC|62 zLUQf`2BWhM6)u+ssDGkgOJZe-QjG}cbhFq;*bOjL0~V@rFm2{(f!^&T3?^1{dzS9B zzXln-UI||F$H|GRENT1#S$J5WOFMz!+u8hMv#W%wpi<|d@1x{EFRSc@rU^hYR?W#; zI9}1Pz0jk?zd_!6+4(})Ye!yM$|5t}KD#tKK(m2SDt)~>9(l;uM zsZ^meF zxlb?yVH9F}Q<>{Ow8v4c&PP})+4*e1VqpuPuNKHocfRDrI_ zfy;3EO$+cQt)ANS^9&knyPeOB$L{NQ7z0&*Qz%5plT=5q(p-cB9%$v1ze}UFwXc5GV zUI^KYA)iFT;w%@P1FYbbXpI8R+%@ht%wkHIqHh>!$ zJ5!jU^Ntq}basHJlO%Hg@P)+XZBdklM~@z?g^-f!#)1@+j$G{vPl7A0Qzl$Bv(=BW zGDOB_Ptcw?+z58xBM@AUG@+XMJnKZ@B-%FOUiO@T63%N68Qr)_a`% z`Dxkl`<{rq%=P2$_d{XZF~2|sClMrxC)JO8Llj|zkzXL=MV++5iFF*1cTpm6B<=6i zl}Q1iUdcAYULg-3_B2WZ0b*pDO=~RIX=Qi6$NMz|RWD&r&bC~q2Tl$^m)u;2_RY(7 z^Jw+Lo^1lvH?f~htzkXX?b%e&s~<<-J2qx-8KapkAlrTn4)I--A*d3MN4+18orj+JKJEuF9lxw+8puPO-ZVK>=h&^@G%5uF^ zavcrCKgb$f=f!e7LCasSnv>*)-)_5-*!9so{Rf*E`Wv|$%QvIf^E!AI-b8Vhlah-`{Bz1nB@VJA;!}nsJeHSV)QxO zGmUa20d z<2~?76k2sK^-^%1mD1CbC?r;51XaJL1vi^Xem?#jl;NwYm+R2e07o+BAgoS&$gjkq zRllS;ZHn>e13t2S)sk|R?tKcz3I-;QfP@mN#R@O@*q0iVr4R%QxCa_OL=B+oq0O-S z_@gjd62^@5)8r+Pw^8I8X!hu3N8Ho5%e@mQcnaxh_UK7Q3wAV_bEUkVPr*Vg3%H4a zd6a=Pl0dVm(BFN=ZWU1+8r#veL;Y$L7`6__IH0Z{@*)X39y)8ZhN1XzM>{E(!$zX1 zd?Mt*E(gYK`e?1o2tnOYJgHV|_WF}8hwXm>-<Ab2TYY^!53GvILv(Nm^;WV_m| z5xspp5oEuTiiVom1nvv1CLMawN(|dv=;cEW*8nFrRE;FKPCl)sbZ4f)6K4%pX>DC` zq9O0j;9I%-oBVxwO10dR4Il7>Npi}Y{KGzfH}>^aj4Dcw@9pYBlScM5fntq_F!LJnE4+*67;p@{j5I5EVMHn%x)ABe}|${zG>`>>nqmL`ihMT;w32R z?KkhHRBZOhW#7Jnr#@@QKT!)ESMf&`w0bv5YcP+4mK_eG zGehFz3PT<&J*-&`DhVrHUFaB^J{c&tK8%qdC1GHMfF#=TxJPct^%-jT)rJZd3sj`LVAG)l;1F{g}5zxu3bow<-G3Dk-rPd4Zm{$-YRHf^>bKe(&V3 zif6r+_vDyg0vEhzGBH#cl5Iu$T_4>cR@6T=$}dTX@F~D#GNbb@J`xb#7}2V%Fq-ye z9E>l@k5@&5tW=z<#Kko$(bxy>g?^~ZxG&kf7GyweNb>6 zRH=z(njqeN*B>N7ls0u%HSjx$t@{_K1K&e-M_#A}IwruKFW@O^SkL}UaGgPOou8Ul z6r{MU7rXCK88}DFoDD)?uz?Ue;*Mna1v=Cv@#6J2${8JH2;r>5C-L7(ilmj?k&H^~C!zT>XMi#4RTZ}kV)+Tri8Caf6M}peFCmZ-G5H5A9#JXao_03Hb;D|0-<4nRh zR$kejFUmno7$BZi6V3_`GO%_J$%^vxHDZj7xDphLe(+CP^2yb(hJyVH=sEaXp0MP}=Vfr0L2ZW7DW5D?08QAP(e*%Y z`4XiKhKNFuM3M_(&@spI_>p36^r*-QM-i1!d?y_3tB#ek$Q&%t*$JIrVRR(&jZOx7 zTiH-&50R6E-|O5N8ym`DMg&bB0J(^Ub4@-cnC?5wAG|1YB;Fh)273D`0}3znWS=9E z8&G(8N9hqFN?ZH{$*r>5fgbI7!PUAUNzpSs+&I~%JuSzlSV^bppasJn&I6fIz&lQ) zVb_3oBvO>_P8_d631Q!!ZqFP7O>*)(jns(H$js+v7(ixzQ;^Srag?cgKU&m8PWGu2 z8G+TQL{>Jr$}Dt4I|f-tH#tn-wo1l6+J!P8+5B;`ml?}aM(9bW*`Ni`PUivC)ojuH zne0)Z7#J#6w(Yf93C?9ZXFu25r>qVlM;#FxsfwT4y&6T3XtDBEAO%-{fu8*aDE}Zl zWvafgW0)_zP%eME@djAccRV!AWJUeC7g`vJ7A>#bci9H~&ef|Yi)~aA&I3~{?Ojmx zpgZa>WG+M$Abd5K>~nsZT1)FxNKCSy{jn^?wgd#64x*T<$2g2zeeuIS2~ZTnJ|eJA9~z1O5^`yEPG zPqU@i^_(3w781cekJ1&~Xeq|}e&>O;Bi65*FpxE>Lur}t(yqiBTg2|Q@`wg$h55OX zh?Bz)$=&-N0F06q>*bII(9^z4v)P@8D=)t5xwxhva~1Ex30_v5NiL#D)?7soOM*|r zs)8*k!H!5F?TO;9zS~iwBO&Z+D5OI%1prVz3!v0&5CHL;v0&f#5c^wWOLlb2{Y{sb zQbPxJ#Rx%?v{%5X&(oC*Jemwx1GG^$JoPNfr4k+%5{-Ln*ErULs(Ged!N{U{K1C)FV0`&VLUylA#{5+Oqm%Kc7M(o&3 zTWyumvF2Q_^FTGDS#VuWlv4G5GC;%tIAz96HRaX$8P5O!u^0e|ffs5zviDD|3JhjQ zm#Ka+aiz|kX!7!QJ>lNf=V0I@mM?*W?dI`*rWTnIpQib1BIrg(Y+qBlVsCDr3yZTW z4P7hrZk}Ot4;XYTN{_knNcX|vIX-maZ-T0FOgjY5=(zm#YJ<=yOn#G06qj@yi4rI= zFE)aYz8&KDyPZWBOnShgT+6WM4$|0AsPU%<@vG6eRWPzHKt^cbL7A7ZjaQD4FvN|A zcS*Ryt~+M%jj_=}92~_=Wr}xE0S&PM4MsscX zDP2uqs$RVkfc&hq-?F0l?vCJ@kH4@b+V3hu>ie3`HfyQVY?Up?zOf|t4VXr;@D$(m z9ewpT$J@GfXwNe0ZqrWbS_AM2@$i{_R94z899w(X2tLwL;W=KSg&&zKQ~nfKer#uz zCyYD~NkpRg)|B|rJAj>ZY+h6F3_N(zKM)RQW7CL9&I1|7;)u-^OF*VE* zTnCTy8H_5~*i!HuGI#}@5?QfNLA+q7x~XEa!Rmvz%(D01O!hg5Sby3jdgPhwUr6+=b%a*Y4w_|@!G?~4*L25QnykJ^VV0__50nsO03UtV0koXy za&|bjm~htPJ@lc?A2^-$1SFc@6&Msc>XonnlUubWQt(dTM2bcBc$m0=ooxf4C}g+f zAG?h8*6Jj5!ezG@%MvN{V>f+Q0@wU-a$t3;c`0|(98QNT-Uuyl=jWE^;YVgGyKAQ` zVm%{9@ZJ&YoJrg>2Fo2O!2P#P&kvQkanQ-Q5wyVbtw{jm(XIHbIpO4_c<`YOAq(e8 z;vE+(VxQYs9=3w3y|nCKjpVYBka%;}u^R>}UTbzZIq7VH8x81RAV*oSUWB#OGM=m> zaI@iPfdQ1-cmY!Xc{iDA*uERD9_`V(Z3Qvi7v?+Y-oeBfZPvtqaQ0(bq~LiXN{eKC+b zVH^JCk0Z)dOQ++}YiR~KCOs05(<)h9+hnS+s(<8o0Cp#*DTVDjT?jB3{WIbV@hbs8?| zUjh96ktQ|o@avh5?y;H{xPe^Zio2A7xEAa*EpQXLa(V=qZ%Xd^Ko@7@0aE!ipJplUSJN~%lvY<3K*VN^nbft0aMC8s9!1beUL;?Vx zgq2QfIKN(fC+WkqfS{!zT`9m3J#5C{atY}GM@;wyvVm}#D5Lru?B;`0^AsKfQg*cp zeDa-%#bFNsM8a0otTTZ14y)`|ahn`+Aet{(b-2|=XdIuC4KBEj(meB4t6UA~=l9%i zio->f(8WK=ne6z(e$y*sBB*2?GTz|W_UP`NDV9;5GjqapT$Dq#MVvJzeMw|j1eV9J z?S-DHe@qUI%8w};!Ky4T>%c0eU$(G1#QtzkVpZ9*G6-=rXq)4u*fO!HokP9pf>- z0ybDTh6GjuF76mw$!whtgTxg{00^~u$2wI4AgKL-qw_D&4hT3TaKE*Pxo&I~_{GVx zQZB+=uWpM)=@aga-0It_<-+4U3T%XVMT;s?H6 z4!GABQClq6)g*$~f#AVk_Dy4s3TRa#Z8%WSyB2Euv%CgT!`WZ84nZ|+agaYa0UP=! zS$kD|0S@t7yi9Pn0)CRqas3_DH~C|aT+`7qPOFmvx$E2jk-R=nu2O9ok9UM=puKBT zB=%i&!MiiG_dAY5fj8uf?R%^VAJr}9)?9%@f~>NU7ykelD9u2bs0%N2+X$~PYMSHtm{$Dn+P!mU|s)Ju53LJ)i*6;3s6w^rju0sf4Hbz zjqBT~C3kirbtYQJ^duY8*q9(xBZigm@{Yo@MG6)u1z&~WI_`vZTDuFtxi$et>ZM`J zgHD;Fdf3Ez`{{iTh2NR4opZai=hTCD8JP2%o*+oLiKp5grK{? z9>f(kLI^83Ic1_Yq2vx2VWb9(Jo6;5V&hKjfsbpRt)&=U?ZG=*k5kv8e_mdiP~J#* zd0X%B=7tQB4jNZ+cW&Rq;0nTqmc>1ul|KblM^ep$>!g#2m%S7VOnqD(|3r~nuTFiS z*?B_;phIy*cb%K+G_r>hyqXJM`namUG$OoyuCw+4sN{;|NnOe1G4Io0Btr*)PQAqn zDt%mqk*nl3t$+AfoYehuc}zwONr=!JO7Jc%81r#uNGYYx?f^$wW(;_|Hwvge_8Z2H z1S@zU_m{vAcLuWRjhkV&qK;nBs@oV?KTckv@y-arK252d8@LDuKafdM-W0_kfF6iW zcQ=E02O2wt9|>?xR(uzvyOJWP>TE-3!XA|U?OsF_gU0sZRj6Nv1$WPkb?UdvOYrcG z5Y)}GM`;xyq|{fNIhSWauc>bA{uG z78}tb7y{>M}I)xgHZ*7*Y(g@2gnmfk<^fXXAmjJy~%Ix zg>X}-@zoqei+E{IX^iz-oZU%}Yb&cV9gi{z^5O2)Emr)TI}A1FDPlRy3{cR+?n4gP z-am1dJ;ZRihG%I#dPNN-T&)prJ6k@P&E5||R)-k|a7QOtT!>Q+MRn&#yk93^o}%Pb zl8P4UhtRtV=#^GftQvbwW_=-Pd|aZLuS${D@ve_!v`}(VZ#5Sh`e@)&;i)nOFM@_A ze!qusQ}Lt~O7qTRJv47+$&}_$R#OnLPDn!EsQeU+90{DEnWX`&?<(&XL@=OQ(dn#5 z03g&>-p`wmN42`8v;KmXZ3<4;hC(U>PcD2erum4Vfl%v@Zd5D(BM(}|n$!cBK16gT zB7g=%gNl70C82G#*qgOr(Cm|bDr7|dz2jh|-4#m#a6S-4Bfb7jc|YY=03PZ`{oNN% zCSWe0Al%Pu1H?;MOSspLo=5^9^y8+0%=?{pwA$^5YZ*jajRSMs-j?A6_@!pOhSB`L zK`3pIP}~>~K>JpR;(}8bU#(w;;~F^t5UP3tLQi^`kFMQQtItPi@H0ZzymoxjCh@LLP9eQ{3Vznd^B|0{md zg(LP@b6fN1#gcn5lDA=&~AU8(vs?g91_`p7smG_XbgU{~|~Au-!8Z`xpa{ z-YU-+Z%LiLnLzaTm0bRGBPWVw@ui=<%jtV{0x{^b4Cxng`ysMG5xPrfSU@eyX5^f@w*-M=@JorxH=za_6Y-C~N z){>o%v?)Q?hA!GSnN&9|c1_0&!nZH?gX9j(T4xczKu#y&-`HT_#%Clm$Zb5wLw@S_ z6d=VcX+UhrJ1=PA@zTnIzJG4<1N(EESO`DcY1A+$FlY7{2WI+p9TJSrpRb)$?2K7Y zb<18DKg1R9aRcwgf?07Eyw7uOv%o5=!l3xC;u%+0E-8`Yf; zezHcn-|jB3H+4oO8e2Ju19#`kF&*FvGMS;mZBO-AUuzx*n-0Fp3V@bgL%`|fYaPu# z0!a$(Eu4H92c-Dxku?BL<>Al{Q5ra{6sGl&f78<@<7qLTR6lJ$lb_C|g6=7wWNDQM zpr_gMmKDsvdDP?gf0I+4&=Yb>8xiy{zLiP{)+s%Lb>X3)aAbQ$`;+uzLKdS3VzhqYSE8FPPG1vhuO|W04~fJbD!9%{Y?<15TgI3F=n? zYt)|Tp=P)dEw;po@SXTdG3Hrz8LDSB)Yia z^cpMQnmTs;5MO$*#^CF5ylp4eAPMPXq6e`lUmoA_WaK48Xz4Ez1Y-Ormf`o{T z7QfT@m$icWme#-tP{V+5%AR$iuQC=`JuXJ{Ai<4c)}PDGso2g8CfR?aO`X;FJ-|6-IU9>Cyc_3CycrA~3DFaN$QrD6sBh z8*x3LbEgqQ$W4IznI4Svez&QCV1&((w#tw);1~@VR&}qH&N*YKzbz6dHH7(2C)nPJ`O>!YQXdUWUAot z3yBO{=&evsi$cL3XD)+8h?K+(aE}FRm~Jn3Wy5@2XIZcpk$^ zr(Mt9&Tw2Sz_G2q4mHg?h{>|{nC4;{}Hw0chx`VYK0Qm67BXXG&=iq;kx@XMS zZ!U~8*tReCXR<9lKCVi14XLDV+Yg`Lcl#dlOmil3&>4js$yNNOL9CGiUgGXAlQh8tKL0+kTB?= z^~xgl+ee0l&(**ifMMVben# za*p-Pd981F+vVP$S6Wu-1dHVad>6*H?S?N}@*g0FPo)LO*v!R1O`A@L!3fC>6I zKUlG>Cx!ZOeW5)>xkwv*2~Ahv&1m(R*E;<$t9B=4Mn#C+mcL zKf4>O{xG6w9;@GwzG*RBB6YTqxz>qaZMQMjoU?I4Qe{Mc#``1HEbo)wd3V|H=p&0m zTVYITwYIb4D%m)_v>=LOESI~XzOhNt%kks>7JG{6M9b&5Z-1y>G!PlaQcY^2cOE`57Pd4NgJ zNUj&SOR%0r_v)>gr}vqO)?HfakvUaXX5gsub}r>8PPkBt%6+Dl2EP2q6J=Jxu4__3(@rc|GU)w8{hx`eSw|! z;%CP4;XCJm?X$6;rPZSaPAQ~ec&gwy(=@_~i2jk*xOCjT(a}(d7l@0pkWjPMK@tm*^Mj@BU4`{x{BdMGA6o zy6UkhTgli=){*P^4S`0mrEnG8gT{>7JN06VCO+m12)B&F!mKwbYGT*DJttD_T3CsE z6?whFNT#BZq#_k7buMnI;16CQUbXy|xX(!s{#^oqlT&VDJq;QiGtuWAU=E2gR;=ng zW^F>iaxXUs*RDK8lyz$9OulZeR$kh7LD|>v#;!?SsG9UOVO;EjoR5n44@ZK#2UMXi zn<@QDQJTim+ul;WU9?>niRpVEaMvu$mw%Un6L5X(d(*|&kjmf-6+NMPC>?e96QY=@5W^(T@H$W?%SGNms9#>#YjFeSgRD4 zF2i9(A;-$ zar4Ums+FGszHs1Z_n0ycsh4s4OjcHBg^~^Y9dPuHTO-Ae51&@a8+QEF67YQFt@5Nf z+-JV*6;%FDr-RCGm2>IM33R5EQvW|<7!1@nzG|v4&j(8ubwgemDiVFQx!Rh^n`w8V zY}G0hmr_(J^rx2I8M8b~+{V_&FYikP^PAr6pjGs zTd$38bM~LDk~i@(1bs{^6}`{<2MH8`crx@all7S@B2G{u~lVFS8Nr%6ozalet3o_ z@-}cu$i2pptxbq$m0Qj+o&RPq>geK^w=1uO+2W;~(YaN%m4dInZ(RcVTBdMUIUHDfRm{~_nOoVsO{o2*|$ zuwH!mhA_r;3M*SA;xP2`I)_m1o#_TlX0by?*=Ei+a|5X-y)XWy5iat{2)2EDj*+p_ zSl!{5C>?UOUhDIMR#GF2ovT%TvSa+FS=G2MPIOeP8!RRcYVs#AkBR6t%xZJ2h&jY? zzA4)F5hdzUiiN4XxKysN-{of>_Wuqf^gpDWClK zspG)m3l_q}X`C$2<+3BvWzs#+Ir(}|WX#};Z!3UO!UNE1kh9FdP|MjG>e#!(a~hxy zR^iIt$zk*7uc>2qjsaZ-S{OBHi@jzknw7oA_V^65*@x~t3PD7m873+-DqE^U7TPBJ zF~x{~_+ZrArA_ za2zQD1`H&G7LX1Jp@d$2Mn{AM!q7WNCkcd_0D-_Ly(%Syt^%P12!a$5an8nh-uL|4 zQ_kl-=X3arUBX^_?|a|utn2!&RbKoO$Eq6sT&sM{!8q}%JZJT$kJ-NG<=pajjr@tm zBS{T^SsOC`IDXPLsvFQfv(L1$*RPY*<$qo<+FmF*ZolId&&XK*o;Hp#c0CjOwZj7I zS(%@?19r+!B+kH|ucY>zFu`zo9(3RWB!jqi^yYGef?~u2gC-7V#`Imb_I(EUNjgp1 zf#PYZzFaLNq4$$bVtl=7!{btuZ=K6rFinvj+X#*cSPNmUHv*K_ZBqSS3z1C?12_~Q z5&u5)I@A}D6&Prj{aarO;0`N`fQTLwb(tu1<2{0AV z2KuuVj^ZRn;61PsM zGzqL#(KWb#(=j@g&F>_fl2$6>lh&gf^XIV)m18$x-L8}D$DWaN4H@r!dC+V_ z)r&J9=%y9%@KW)z<|X^pL7CBAz)^*GE6gx%ndnS}Rb^ zE<5A-0)09O$lma&e`mu4e5^!(mjO(gi+P7d@8~9oSU@IE0+eU_=F|t@nfrLPXP*Yd<2^$!EH%ptS^F$OpH&Tpqe?DJ179Ct^q@sdW2?82~_Gsv~Q;aIg2NL zeUqdC*Q@xjUCBCo_E^Xe3hf?avRH)IuU3J97Yn>9JFz+IaB*?_v6S1IN;E5j?JiZ@ zDG_8}_yNlbPG|&39+%raKqv~$0N7Jo-Mj7L@(Tds9FaHNwiYMZC{KU-RVNET?`~rX z!3m|+bK5Qy2$EKau~Sa&vh^XeXJU1<_8^?SBa0qm~x z%|z*R-9?P!c_pUB7%)#;t~sw&zs6zEKS!@+n>xnKp_~z{FEO{+8J*)UJJUtH3qys@) z$2Wb?JJkON_~yCE67S-@zu+6yEs$2WM@Ge#qsxxVH?oIgBX_%7es@%-7CNK=NjpiJr*RUr%jgJ z!~fEs9RP`0Y8rhV$f^Po^EcPH(-c>!Z{3l&J9WKGIG!XDBxrI(&y??cJNd4iMy)u) zk*M7HIlmte7vhLOb{9~Xzn$BoL6douET9wv8TwJ7S42RNUILQ6fWmy_bzT(q2ZZD! z%BT44!$t8(U?Kcy0f@^y992CNc=i>4HvI9_g*)tuz|5<}RjIkwo`)+APP}&Q@tZrk z(4k=Y=3wDZPEIzv5^WaQhE7vzcL)`G$SX1gk)(^@vxQNXle-`%h8nNHf}VF+VYBtQ zHbN8Rk@2Amj(hUMVW*(~mN~*JGa%=3bce-&>fQ+_I2L$22bvK4F!39!!Sq@A2!gx~ zw_cIk<`63Lb&ZgX7OJGh7;e}lwI;Y4_5<|$T0h~g)6?tKxd5anmhyP#yz`a)BelDa z)!N&604yR*#395yY(-% z``dML$Oewkm1QsYOXcpaROKSAEzde4yzV_{Y&iT@B6vq>-abNhR5BX6Ugaml_P@yM95%LLo26Qv8&H5 z?s5IM&l^p`fHl>neU34Y>xD)Fvj8CIf&JF|arj?Y0Z6zEAeN?h!y8V`ra!Z4s_mm#ME&U~SI~+NAvq~mcrq@Szw%&!_p=va* zHv@!^^O4y77pUbug;8sq!UIrI=nc;4dVnYL9zGJHzrl6aeR7(CQ}CK?vE{nEYtRt* zmg|2D)!*ihhTONnA1`(NCRXQj6d2!|#MR2mu>RP-_HBark6JZ9@!I_1LqJ0Qc($qU zsfRY?D7tAJkuOKk`n_6+PlWViN9`V3K4FOBbv`KVw0Y_7(SvjyLp~C#jgQ3Y8>VXp zjX{9^r<(Hzj`eEuFW{yz4GPm#P3hYU@fp#+zo*KMmDC@a2;7ht(*4^0jg9bQ2%5y@ z*G$aX-YMM`o!%qf&bfM+D#NPQxO3#$FFUx){#{Z(%*AovGZ7$a_yL;Z>P#|cYl5|N z@+brkZ8PWP!SKSM)Dg|ckF-m6jLZwwwnAoYT#Oz+IvR+(`3xD8SY}Vk))YJG;JbBm zqHWIAyhJ=8RsS{FQ1Aq-zpIWxQ=cJ%{R3r?P~h+M1s9Z>**bdU#*X+Kp#AEr0orey z??J;Z{}CR;IYM^GIxmjSV9ovr+37h#c39I94_D6vGW5aD-wB?hM@1VAa5;Y-3s>TO zyF4A)J$(f2`~~n708avb5BT^_$e9gw0NT+!f_6AU&w~1V{~7{xU}wN!wtr@0n|#MJ zOcMA@UpWghts@PehmRhkTJ3Mjb?%XDp5eRGHo+m#9&-Q&=r6aBr)Vci*fsGb65oX_fiu*mi4}ZS?JbL zkhBZX5KYVlS^k~~%wtdOq0qvZk=j}7rk=;pzaD2!0^_PlPL2|5_JMB9Vb$IP0Q52$ z$Ozw%5O*Vg8w6zmx+A5o4}e05rq{{W*g25PD-(Vv01M|Yc~jqR(wJs`&qxhW$v24) z7@Tc0-oV(^l5pS;QH)S}?0GZ}_Ur*8hDmpW)$9WoLx7;U4!x=ws10;Z=}h)GBpeO+ znLOgD94!Gr2##AeKQOn=3YZUH=xkh3$zVRs`mK`hz(r15J5lDT%#D(`=3s+x>& z%Ti-+Su;PyZeiBYO0{P^i3@G4rx!_`DQx>RHgdtnY})=(4;M^ltMR8C!jwDSFQw9( zZ$s;8g8$FM5Zbj8xvf8sg-qzY=G`)M#!mTH=GW`!!C=Lxq3&qXa9r2|GWe(!#hKD4 zpA$6b@MtI8Ex)s8Y&;XXv+Kq(q@~#|jtZCK67>YFiP>t|9D!9D{nVh+#xaNR@|S$! z^q0xPZm!iM;&QS^>q{O)Qtncu@-)jYo4%(3Z#kv^Prm{FKi&BMWzVo<$F9hqZA7p? z@?RUWSVUwV>KTCOb%6r+9nr8~g}*0FnJp6OeacON8{49A6CobWTS8p-tW478=KaUzAzRkAz9VShS zh^(stEs~X`B>^>83XLCdS$Nr$EHHvfaIjf;;0z7*Ub*nQUV$^c0=6(_hUwj3g>`OL zW+a$F+msOVFxT~-FPRdniz7G$DajXPchl{Ue-)zRmW8eMaQ+J~<$9$U&%u=O2q!m0 zi;0ac$pF>bQxKTxQPO%{|Dj`z*{Hmmp4IxLlsDoDPP@Ie27QWOTIkNPBaeejUwNaN zh%3V`y2M2&%`K-S{*Jf6x>>bsZ?5R|q#b zfIsoSD#yYn4j}~P5~giGdsru9Gz2D7EGplnAYO9M43gSnVi$IV!KbV(rDQPd`0oaL zU0Ao)#Wn}H=)HUL^Y#Lw{D`0i$&;9ZO}*p)LwnEv`E(Rxf%2Fobcb~J>Kt01u-;26 zh#^c+SbQK0+x(jmiy=(Lk%Ip`)`;=r?bxR9@=q&>sb5O{(v6y4ktxYk)f~>keF_As z8TOLe^p{&ZeZ~3-!WrZr@S%NQ!58BNEBw{2tRex%4Y8W?+2_}~CDi|-yu9_DhX{5a!weQZiEL2 zwd<2<8$KU0xHBnzuUL6}weL~yI-5T-UcdT`Sl9CZ+wrqM{j>Q0zU>^(Nn5X-kmvF4 zq+0ob#|4FDFVMW$#4B0mj|_e$?m{()WK1t-rs?oUTS!3BSv*jhMzXZYG}>KCMp%U&l`vFgjtVm z6l`efd^E>y$VWkq0)8pRhdYkk-ukR9OED?`8XvUrZ>3p}f7cU+0GFPzxC>A5SO4Bn zf%jt=zagC0*wx?x4JK2li`3K|nxad!&FQ|5?sMy1lk)w80<+ZOpX)dLxt@fxhsU^t zu_rW57E&ch63s9uTORdlB6Pf?~Rya1|^gt0MPp;eosY+SQNZGNiVF80Z?cc!s=D8wg81^;YK9z5+* z;p#7`qADF@jYLdr)19rDxJ}tN$MpRFX$;@}Z5$n-=q4fEWSHWw+U-VtsCP}y#nv=; zjX5x9+>KodM#NYnufsZzRhh?Q)-u)tKY6|(4P!*d^zn97|eb|%1SJMcYTGK_6 zk_^JFmx0`J(vGTh|4BXbsLhj~cYfX{hG_OpO|$D8B|Xim;OhIA5 zy|zK?Cf@TfM`FKe1bqU1YjP>VCVv-Iv{P`#o0s}G348-&i_vCQ@O zTZfz{sWlm?2QKtDBa*U(usyF?VG8Uu%%DDm+n?E77Jc=_|50H7`NKbU-6(!FV&nVt zLva_sg~56!JB1X(yDAnC*3WV(nbjRm;Wq*Eyjq7NfH1eHO&6I{8}aSIA1}-iL|Vt% zz@Usc)J?+Vf<9z`wiGF#Ga+1g?Ix}RWcx3r%X3n%tH~Hu5UKS*J{=AFNiV26$D64= zo9WTF;j_YdFxsWLxWRco7C9+r*BN%9_uwp0bc@x9)?7jaHOgt3#HqC?i;BaQat4(? z=FQw0@cSJ0;uyE>e?Gl`v=s8`*=T>2?OQ8x8>uM+rCv6egD9Uyu;PR8Uo$x?fZC}j z6curTfPWY3~~-dW>QE6m6zXPgEO4q!Q?;qH2c2F*E!;T8!g-4;EST%T!q2>6UC6E zAehQB0t8?h$8Y|laR2N2TjiJoL0^-zF2glI(-?EI*$z&wms6i;Vi;gl!2=%9)Kvds zok74mT4yz@t!Z$zUbe1C{>ZpLNz|lLTpJXx5)Dofv3L`C1UK9?hTqD(!sJj$MySbS z{QyFB`gl+ZU3m1D*7IMF{68)K*rm4cs=Px3Ij!g0G0HG)A27C&MQ)d7mL~iqh&}}e zFiq|>&Wg>S?b;cSO5A^1P~+5p=lKfT`!sKW_&}ULGdM_y1U7D7fTlfZqA>iu=s%V< zzWARG_K(&bUjWqWx-nY*N2*w9f^&dQGf^!dz`~;|%p^{IHGd}$)H9+q1N|IY=27ga zV7Zt9!b^IQ@fc(dQGs{<&6A6DpA)-kC}U|ZJ8@&uSsi-c4;PH|1;MPl)L`@SW!aCD zj&66#HHkC1?_tl-Df~8vEqidWA6LBiwslJh2zb3Ko9I!JBXq%Yz?wCW!E;Rx-YL=2 zpnu$d-SYEy&wl?$f&Yi~C!A6-4sMH)?&68_xY9=I`=8S+y?Vb^Ju#uKU;0%jI=aJ~ zf0;DpF*^fX$(OM4DAJXA>oDr=wmq7F^<<#Udg?Anx_r%&;tw;z!{Bt-wV4II5xcDd ziGNvz@hFN@ycw^nDd`A>fS}L*fno(l_Kv*Wm1XPoS0Oaqr<3#at*ZpQlV%oOttzs8 z4hKt1Z8q0~FxQbgYcg~?n2(tEEHa0j9V{QE54_*x#JU7ivT1kHTKo>?bUqx@^Z5^F z`VW4+m0eKTo+c|UZX(sC9>!-8CTiI^Eqi~on9&y}bJ&yR z9-eHmC?RJ!k9o^|W#grnh__k-Cjf>B_7_pJ`thG0^l0M`o1y$st^B{8^HY$nBO5?(?3oNPYsgXJS&na zc2d3sWk%!ZGvPLqL9taS_SP_Y9_4`AOv(o*yAbx*GHlZjPyPL4BGi8w53oaLtu%S_ z?%%w3sOL=G+tRMMi${PaH=4%$%|v`s(VQRK0e#x^`|WEbLWxvcZB!}?Q`Ep{!Tw-s zbwBeiM5J1+C=P_U!eW>MdGp)1C!UirOzxNKrxmG(Ct}t^Ts$LteEvMf)3N~dY7yoQ z_5u5A$I2X+s-ov+Y6)1`@SfBXL>q`E##~Y@y+I0=U-BdRtpEJKszUxd@&Es{kFT50 zTM;3=EJtwR-oG=~{99oj|Lt|6x^p;0wh{%iZij+dBTtacJm%@g%`BUcU(3i04P5vi zS$7^8lh5S0?IcdEE?2BQs~H9h?%DSC#r*<`P2uIQi*tHkiChQW%I<8Rfe9zByzjF5 zHBQld4Nr)xtSD<3nO){)6N)ee<=Hq}8b~c6nn(i$sA+S7w3W1_-r>a(Rz>#&;$}m) z8~s;c8-z>f=fY8l6hDuK#G6G053c)T#GQNb*>+_SWumpof-XT-IEn*P{BwPrCSubjX zpt_j;iM)&}<~My#?kR23F~e534n>LVBBZx=cc!S5W2Evd3nh>PRF`Q%nU}>GVs?$y zP?=2Xua9clSx^LXfNoi#YxfN5wU-ofTOxu{&~M#z4e}_wuCUA>+yN(Wc<(bkdhhB9 z`a3ntv80`XQdK^1QyL-a&-n^19-pgC(!ToQOdOedIEA`JR+Y=nr#T#e1d8JFt9y8r z-Cw|_WM1OD28i?e77dvw;) zBCzpw3_F@sprgSnK+G(Vs**41gxV-IIcEz(P6~N8I)386Wb3A1py>uBZv%ai;!5vZ z$81XPjV7z+^%}bdJ4=B2!k&rw8Dr`O55lr%SWzvi<;laPk1cw~{H2kZrN0n1V4ph& z-}dX}=y*xWSx4+=7|%`EyMIxjNIaaX)jB@{c+|Stg7oTPZ`zZ_Xhx#kI!_1@j~ZX+ zvCsy}uae9f(a-A!QELSUhg0%_Na~QqJZ>$JZEN?rgkj*5QwJ1H5tqFmZ>WbPdXzhBi@#vGu6Md&l z&>kRIKn)5fmv)*niY{%mWCg}KW6Mz?_X8{%rRMQ)k*`X0%wGKW}yST<^)E^ zV0o-SgI_m{CQw?)csS|0nbEK~Rn0NeL}BmQoAhn_N7Sxz;=@8Gf29Q(3T87k)W7mt zX7hZN1l(#1@^~bW~<$C)2+iBI!OD=kHgi7Z%5$Q}}{R zgo|?&5upX5Q1l0VQ0a^B28;f!8SWqKv|MRDnqOw)^eDhl_iMc&!wi(9H)B9Vmd*Gx zO*94KXfA2cRrCW?2#yaS^MUIL(*|@RnZfHfDZAOC#-ab-!M9DxltC1c4S9++bio&= zy5(jn%>xEKN+jHJL(Q8j@wom4y4+s-hkGa;#0vV;QMcS$b@D8ZN5#lph7DiIM+&y4ZVB+l&Q5=9Fm|A+s?ynQX+P4;cLa=)-edj2p8Jd$d#P{K( z_&uK*^+!RQre@DN$5HajN`1~>>Z*o@saH{+&^_Xya4ivKoucHe5CL(S`IHbH^YUU` z9K^S=V=g_0Oc=^jxvS|WQSlLeQ}r!77(ThlYEnkIwS9zA`D|tPq}XzO3dWB}#TjL@ z6Wo)c>5F7sA!T{eq%#a`LnZcDpZmke(%rkxPjljNeheIQW(-6m$MM2K)F=aC0ZcH< zi&z0uiYTd>oyp3&Gr!i_Fk+yDkcA=8Eu&C8Syi@f%Xg#3Rexg}>>Y5qx@bEiC4C~0 z{alvcSQx~rmL^Akw%QlRNQS_qhxpqH!%tMm#Qw4btMC=l)R@oZGRsyabYwZPzMd^^ z3j;apS}Hbl@gY29N~5bIpZ((ZR@%JRT_4qiCdvhB;QPh`eF*`su7TbEffqfL~u^w+$0)ZDM%kfJo*A2&bQF^QaImpnZkMvCoqT1cL5nIm=c`G<#K{E5 zmXwX8O?PMsVRINXG=h01Mo_$uQ3e&Fj62c@bE4Ze5|79)qjn+Ne}gkdaIv} zQea|#`a=9U2SFHmET2fW4lKXCWvGYz6%Mw}s_@VBotgEk^RIw?Y$MlAKA5tJFp5+j zIM@GC@@oN|{V}w4@e312L5Jf^T|-++f_m4NbgFG>jd1K9vju&VVF2O(8al9XAeZ!2 zvkkeZ7{TBBb))x80MLlL`@c>~XWmk08RL1*p2Cm1EXpfz{FCIg({hyI7B(AHkm2<9 z>63dBTiREZkWDlhf$X3LT`kd_haQ2cgVwhTT3tM^7}*r_J{bE#kLEk$q2yW zP?lLD~pZRL|;Sf<~}NY^HSn#;}>$8?&~1_kd>FpxbEd z6$eMfgla;e^|uzKL)>TUADG~ZlOf=2u;HaLHz_vec7?Nhlnl z#(hR+tp$EW6s(Y-KqGCP=jUvw{r&6*qIxIAzqggj6Y~)f)m-29(Ij-oydh~7!#**> zqh>>M0>k3s9j5`TM1K)1PAjP{p;Z@LoyPI4D&7=lf!TtQtG}|;2nq!v{V;`2^WuLb34)=}mJFDp@vTv^Enb>m= zFIhc2=Cev|i8@idU`}P+fIfT8@rP?6g7fR;qLgYzlCxx8*0FDY?nO2gXXYOGV?b)G z^76Ra`;|~mO4)8FZeNk2d2t74bgQWX)S(DseEH;Q*7yLvq?AXocs(pSpS_;p;U^wQ zn^bf4eAH1hcQ83(!?qAiy+Q}eCMR;53`N2($yfCdrM(pec8UJm1sgaq<*;*0oiK;# z@mJD|Q=2D6OuMzaSEO9^EWpPZ>fQ#TK>O%tGYoZUfogWYi%ad#n^&VsCO|sN`7oPCoGO?I^W+~MzG>JZ~vn58J1QKvG|2R%RNO} zaYo#h-Z;G!Juxv$PJVkcwlr_+3)4w=;SbF+8*B94)QKz!69*iw%Hk3!{|W8Ms$0Su znby8A3`PcP3ik-?%81ScMq`&WDs^x2uKtKV(T7|#5qY)$+fKj3?hb*M}gql0|`p%1YUXdRPr8&en=e~v^jC%6!iAB#Wbv5H?q=pV=a|N;l z8(nhO-ayYczpQ?G#eq;ri1{#jPnmnOM=$|00CX;9LP--1Gz}-cX^d!+E~YRk z^jw&jlXKjYijimX=z%R_HI_a|g%k(hc8=z*KtvZz|+d5t3 z*!X+f36sad>Wah#JReA1EduBe=d=0B3xa~@Q9jpwaVCbO9w*dhSj9b_GMBI5Uwa%Q z4+UN8+p41kSuJA0Q(&j8<}MA0KSrd4@Dg%))++y63IF;+pZ&oS(4u9h>^$)o&o8C7$(oHW5Cbp2IA1&3T&fVWt=T=zyq z24(@iLiV$7YMy0c8>#NsQb8RlzP6nqe)mUDUNE=u7J5r1-x@eKSM;I@Mv=f{|2!7G zie#s==3+$JdqiV+qN15VPMrt*Bhab>{R8E>`Mmag-%ejP+R!DM# zm;&gV9+9tHy`vb4O(Q9*Ni+N+sLOkyhXKI@8gh;9_hL0`~5D(^DQ1A5P3;3V7bg&_Uayq9nTQt--_XBYKU;F?rTvk^-DvLzKMX)CMkq zH$)c72{^@Y za7lvgfEIh9C$Y|j_bAF~IZ66#v1^&$P z@IZ6FDwQpctx263;9{}Yadlq7j??wM;cJ~zKJ~^v4O<|~SJYHKvkvHZia>Kg>B*Gn zINfFDAKt%@w3@N0_~%}>9hp?JK=4>w7*fZIJEpQGIU8iR&x(RAu2ocsh`5S?4i{D< z!n-ufW;H6W|9MPNMrWux?)R!wC>Q+C@23TG()PX8U*V0IOhz9jk4XCT3F93 z@^TF30rR}b5Lj&F9)Loj3|_6}$3|&cJH?CmlfK-X*o^4zW0y1j=XvCqVtHSC`qLj= zIHDcta4rdvCaa1R-tE-f21`EL{q)NF*4wCh+jSKaMleyb(^UkS{lfVL;~BrjV)f4N zO7CmSxy@)6MO%6?(|a}A<{{RMVqHuDszADg^!A=RwJ+r)d&)4F!Z0w`L!1au8PTUv zEptcxgmCYmQ2XTS;KnJ0(#Pu5$c>@s^t4g^EMUfM@3W2X__QZoH2|1;FIiS>R21iz z!?(Phc=_O*T7&!L@ewNmGO($pvNGZ`y-6n`{ro*QJJDX_QxETAZ?s|Vfwg<~Sj7gT zni4wtVjjo0r~MdMB4>sC&KjLkTYC|GHIZ6A*&ci{9b7*_)EsOiJgTzW%veuK5 zfBlTa=E#M?gm4|amk;^govZCzBi3l0cWL3Ob7(>>2Habz7_E3#nbJq3PZ3Btvy1=) zH%~q{S73nW@`s|}AQ{dj$gA{JWM7#N&f%^j*9+vo0FD8?Vh@rLQ31IAIZ~aznZs!~&(IM<3aS1Z`8H7K4 zF_Iyu3B1@jz0d85>2>_uV&HHXcpZknl(`zSDLzMB)vTF`@-)^ot1UKDmlA=^LcQoU zg}G%pwaFjE$|ucT9~c`=#%%7|%&LWi1}|EZ{7PJ#VFK%8y&ZOEGG*Xcg}=2%=!KK& z`i$d07PMeB$QMWNK1bJTl#xqam*mW8bXMe{Ch8r~1K3!YVbDtobX-e`t|WO!p;}I- zo@KSTNyNv*h&mB;gG|_e?DN{ZA$A50@v5fG@dc`-)AYDs4hb@qhO!pf{^(MBit6cx z_vMjw@18TvFx`{()dNt6 zhYb5QPY%30_q_jLcB`t>gFBi#0a*{%Pn*LdGyD{8Rm_bK@Ljk@zc&snbC(syt?tF1@XdlH6#zD`UDLKMEwOhs4?W3kv#zp!4$TqMqi zBh>auzsDe|sv3T~~-TgLIP8dhbgV=<0Sa&lx(N**<*xW?pV=I*3Q zK^fVJK=!}CzEDJt3383&Z-Yn``JD+jQT3qb@-LEzLIeEw`~;YZ_)Vmsfdd%^qtrbaS!_a)&vwfOAz z?SiJUR6l}N`h-(z<7*swqBz#)t57||;aN#(S@W2l>E$Fj+p`VK`(@bmQOt7A0&Mx7 z?xXf_ z-AFHVIak~2Xw!inTe5O?V#~<5`H%E3BrM~@W{FGk(J@4F^XWh4g?!uF@e-g|?-M9< zUDMweFw~R}tC#) zM8QL%-m|vxu3Pc;tpZ z20s$@?pLq%u&i>^@6$7KLlzyKRO6Mi+z=G%Y3$n!)#>5##P*a5N5rk2+58W8wI~)! zS%ZP?Xs2FVX_i_j5`r2@#&s9pJF_8LQi|W*69UmK>Fg z>v-Rj_pVK9;U&@9s$1@Of0b&|^xHF$yo5^q3h0JZb$#7@+SPhW^m}s+H%j!7hFr_2 z&0UAX3?#gwUia0j_E35vaJx8>tEU4|{|)Q0ey>oLyTJ(6qGEP^++ zs1W)+mTxiSj9(-cP+LN^v~OdhIn?6fXTr^klmSK%%->>z4l}pPB01rasr9loV`t(f zT|4ZL@{5(hnax)!0L@o$eker=Dwd_!1V;xjBut_`C=OF2I(tFLmdD z8&=hK@*dx|tQjKQaA-|KCpn`F*9Fa-i%H5i362Ggg>Sv-Z}blriYj9SdqK^x zAR(rbKB^0&4|sb;Ib~klf24nunEGuqVB;cWn&i}=b>3`ha>;BAAzF}n-^wDoOHu;w zC@o(BwbNY2LT3vCRS5AHT>}w)X5`Yc!WZXLhrKT{f6G-M-ipI)qD5@*Y?0YfY~ zv)bGUpt+WJ{VCb{Fm#6%({;CVU0TrCr#jLQ zN?WABym~2h`sPr#JEv~MyPm)EO2g)<{KT*Ljfd9d7DhqPF_=-a!05X;q$Iy~Z`l|H z1lNFY^TIBUwz#Y_DY+B-_%EdsCXCRwKx7W*mt3Z(L!t1P*EF8j(ZAiok< zc+Ks@h}GE*wQ9;uT%K`ha*0$ew4Nw&dFAaC+>SVO=|{xuuzHbew!eYNA&14Qdb}pG zUtPhaxxD_}6xT_y`pIaKw2QM>ufO*KWg=N{1#}MxHV~J?<;_XyZLBHieeVFK7vGj< zGkA!i9%PKc!SOX_&XmUcY#2C4jyP}#{(!b&oO+ipoM!Q^y- zEUIHNANe;>>KMg_shYByOgVP^za>on)BCUV*tC|5V_dw)EeabaCDM`Vc~4wVmO^fp zyKW8BkMk4pGrJ0U>j*T3Fa1>i;a%wXIMdtKYN9g(BzIFvwNu;7TAQS-Q!lG<6?LAw z0!_AwJJH`P=Ln-oR*OB?ivpqQfgT3A=N{{4qfLBV!6eC=T3*+y}yUL=a@9gRsDQZE^OBtE*01W5{!=M@i~@G{=9e z*Wc@AD2Hanoz?gC^veo{E$K}(mh_SK_-MR_pJ+h%QYu6D^=VCRSd~0ceMCr73xeBD1GUBv0CX&lBXdP^Ooo# zLwtl3@y3t|7#Z^?sAlr=oZ*zx`s?g{ZtOCFGv30A@zHi(i`skCG^#_qDutNrt}4$O ze74Mh>A6M|qwxlk#~%{}xw8`$n=-vPD{ZEyo-fI`hu*$(kD`Bv`tGcYP$10~WpC8i z_~{en$y8iKFVob<(7;&9_?%B~dzjj_=;#HDM&U|M!{$vUwBEblG)c{3LC0|B>OHJ@ zu?zU~_5iaFjkQ=6zI~Hc=o-d*trE(J^-~LT^H!Q)8#w8r^ExApx1+kI`qs{+(XLC< z2Iu+&WD`1ZT}e(U18zoM6q>*x|Xg+&Pd?BccWvfSf>?*23um#L6#oQ^db;6O4 zf>Q!{Ny z1esbzbweD8I?x!8P$y~mBsA^c=8<4_T0w})2H&fdRE?0Z&fWf==66kcfl@Uinu#-k zWyQ`ZDhV1>z2mb4QZT6wI+ry#WF8VQV#RcOZb!ly1zWjse-s;6nH%wX7 zKpU!EBJ;6O2Zdn|VBiktnsbfOvJmYM&8#Qxlf>te_fjhLVn`j_)x?r44l}Qf;}=1F z=ck`xf9YH@%W(IbYswte01==6||K@`^{LZHZV=xcy;~S$!U~ z1Qm^sZh<<1uJ47cPF-&w8k$*W;-;0VDZCHh1`_in>kBN=a8z?<$?w}abW`+iHG8rj zW^h`{yNOe(YRyFfyMlVd7GiSy*3#-npEU;oA>@biC~^N$w3BTjEt1w2sAd;I{GV&PKpGTrz*yvJBrj|)0R zQmO0fylQVY<5KQ7@9$-y79l|TDwho=d_OSxu>+Y|ke;#lIwK}_(t3bg%9)r_cM!yT zIZTfkH}ggF)vQVgwZQM%o1W#i-LLbrtaRcA!B8pP*+Kq#(E6MQ;9B3vA&aw%Hj5QO zHR|2($&IHRN$S8tA8HAu_2o zjn16VS#`S=(5HF`*l35}=WvkZF60(7hdPX>zW-s!WZO=NqUWMqfZVq+Rr>Q-0Xls9 zEhjK#O4rTA%H)Ad@-mvF=({V_JAFE`-xgs}Hx{mS7xb!nIkVA95Ef*a7rQ4PhYI6h zB*RCruJV(@W^3cL@tT8+u<=_R-){}Rh+@g{mWsbv=`Xh1r>-^1lOwjB5bu5{R zqDft!<&kVpkP&Acj@wP^&AuMLX)%~_;jU-1?IstOu-+D4b(*7Q?eWtz+7nt$@ejw4 zM2GcTP0SIDp+TbzG}{-wnnPuDT2*F!n34xounO|qEu(6P1R{wjI>qCRzq~wDfgy#e z*_1@})fCuXm3MG`;!qC3dId??5hg;5nlx4o??SpIR&NgVBgK#%dI;WWi26!XdBMY` zx2v?Fm$fCzQ>m%0%I=(=oGiN?E#=<4ldfJOG(?50rDR1d!`9yZt{;^&J!>7eMXuI> zRO-{qx?T5GWOd6tWIR!eC*5A>Up`Q5pGr{#Zot+`nu-RH@mJ#;`7&xU4! zWrG)qDODpHlhuT?h$aD%NNIm=Aa^=QRKugXfG#XXuj|m;?X})Yo*{QqgR_)31&8E5 zA*Vp$v9m+2eu9&_4ExToJZ`^m|^6K#8@23@lTcER~wcSjk zGo%z_#z%{R%W_UjVQJV#4zdvzOl$-j?{sTEyB9s|cxEKb=8zZ_nD1J_ZpHnhWgie!@Oby=!X|jXU`fBM0yP>C%TEhISCmL z^I{8EEp}KCn=f4BX?jl`fhwic>ognDJYefq0wf?S8t(+@0lr1Wx?K}1rRcojo5@fz z+sO*p{jF)hJ25vCJ4w0yWDE+Hv5YlTLo^k_HefS$4E#ISCQ1cgi(}bm8|^jM)PV;( z;N6DFq~nW>K*Mp4*}HJrx;GY6tDZG2no}LOff^=P*vUg{x(PM<)m=>;cmtUsh+&xP zAkj{4QbF_9EW|o6tTcZY=~e;r^A%h)l6If>PwcN)h3XAeAh>Na8?9#`u(NH^HC+md zfs)npx6Pl*@uOz1vMgRBtc-eG3ar$EW&|4f1H$x)3Pv7nU}(L|gZI=;wM^w9lKw|q z_s9T+hC6rG$95NWBwkHCHU5RUK|Qp;XWgAJ2nCxJuaCfBy38;v!I=s)LS0NXS>($4 zVKGX%aqf0AjiH)Yqm{i10aZ9dQAmeOJvb#6Q_!N#Le@t>nkJ>11b0qmt~fW?`0~nu zz(iuIB`TkQ)V%tWA50826f6TH(pG2hC=S0d2x+gRI#_EIy98ifqD$?Rw69C7J(wS6 zF$gTRG~OaL#g&eWg&j{F@_}6k9Y%LG0yqFhwfK-JvAOsYoB%${z&(cRqXoA#GTm%RtAwfzgfxuFFmy(1Q5Tu4CU5c)g z_v~}#o!Rf+GiT4)Gdq9XlYj1+%za@LQ;Ra%b~)MUT>`;$p47(zBY5k=E*3Vo*+jmr{Hb?4j9v^=+D4x;KTrjLZivuDIt{P zJw+31wEwixT0 za`$}iW~ITLD{m^#Pv6_+>c_GldnH9UIucAMtg?ZO1azmYp0IFFvgOCQ#>@Zs2+I41 zK!O(d9;IGKxFD$@og+0?@NI0d)ly3iu6GveF^|^2Lnjb!Pd2K09U3sa4L|IgonKzp zLRPK##K;>Z-vP`$KTb5-ugZ$4vMvkVjp)Ni}>qN%J56orr4o%p1*3NiEI&}gYN|FJ-fg?Ot{DU_E)<*7YV0erm# zH^%j5@heOil9Zy6;HC8~$ZK4%VZUhmsPCxF$k;+bR=Sa+RfE(tLm;l2&v#k=N(t!) zdS1lRo7NLDV3~`0+nrHfs8j>~wcL zsbT!4z1wwgj--v-24>c?rd4k%o9x$ye56c#I|&R(JJ--vk<;C?<>_f+FmqL8>=yj^ zp5(u_f3&BDJ|NfVIy|qSH!-sw&3jRR2#`3yqp{kY&h$n6wO{cwK+R8Laz zv1h`vbWZXVGcjlqqa%ta&wc)|yHH6u7%u#AI-+AaH*XqS9XCEWE;ae2*UGZ`UzZJ* z|7&fRaa73_9+}N;`gSi3Px&r=X_N86{y?k1z9tDFX12J66Fn|luu{gCmR)LFkb7Ly zaEpCwGJFpm=f{z6c#68H6nLqG2_LmrUqk3w_mvV~OC9RMbrxjU)5{CerRR_JYJ(f zf?806jb#qmDG-jjP>muP)|DxyMOHh{la0YvJ9QIz68HugPOiz=KB_x{A zI-5DYw6V7y8P}968Xh8%6qz!TJnub{{2KoMZTc#*Ctx~3j6uDLRmr7~l-1$L@j}SP zJ8NAz$^3bNp~bMr?|j4fgtPXu8%V!Z&~%PW^PmeC+Etdj8#d*aP_U`HS@vh%Mwe6Ph7=MUk3$*j@VW9-d>Ni8 z(&=%xb%IqdcmAnm;>I1W$ZVdAT~O(}D{P2b-7@tHHC3TBavMl1D#gJm-4V#(iuG}3 zS@W;f+7j@4?{xe(h*20~6m!p1e4e$Urro$;3@trUY^#cibcMcrmMi0YVi@n;3x_4w z+Y;g*Ef2fPT_e2E78a&|n+QxNu{lR0D{E9Y}?q&9n*4Zq#&%bi{h%KbC5~!=l%#stYR? z*}#U%e@?;P_-{?RwTmX#D+wVK$UNILbf`y~D)1yghaa?Fnzw(#PjU77Qv+$vWYV!Pa+YC~#V#)~3MuWU!w+4jTZH?dEcsBLev;J8R1x~}S z2$`cT-pc|S_}>GuK;aO^NC*TnWNmr>dHEYJO*XWw&!MR}GTT2^80Iujb%B?!>OX1# zS+RCai#_dSw>Zza%?_1K@E27K(w2p*g~d{)omGccFErqvr{6vL?+e`7Ta!@AY5e|! zK2@u$Z{`1NL*()*RhPX7nwc5$sTBc=v3@EuML83Ieclyd#L;!J*2$13>#-mJ1O7Sm zYyON-Euk=-*047RA2F-IcCl^0z@{Q3k}btgT<&bCTlP$=MG9>D6zl~t#I*6CSS(#zTzlxxNoXIf?6=UXR?l;SL(lm<*Tm{#-GbHwAV!5hC0 z9tW`+QsUp&J{|tVI9_i-e&STg3q&w5azr3o@ZL|)QC{G;#B3K9HQM&?y5oIaiR%%q zcPZnmR24h58gs>s<07Q&Mui6(vSN7$Ln&xKdf6XX<)B`V&lCXC;O1(;PooU!OK6mfzbI2+`7gK%wNDQ8R1bvYk+V*Z6Fwj8T7eIGI@We$>aRd6*@=fM|b7!m-%k2)R9REm1C z92S^p^i|IKx4O`}>JMwn)ztzMi2anwFU1DQ`ox^d)cS$(r+s?3O(poO2MSWeiKV41s-9YuPWAw*!J+Y#8Q=vQm$!b20!D_nSwoRSW1?o-b)fui$f#x%Jc)mFG zPVeiA&BR%Pdk*z~wGT#87jFz&l#@wq*_qwRUtdF7e^@%9E$w`wjN>aXsza0?QlWr% zMG_8`y*+9XD1uJC#*mDLz(-*M4L3ss&A+MCwI6_5&Rgn0Ml7vq5N?o8{QfuMM@Hj~ zMf@E94ps%T=09lOBYR89A=$^CB`^S5Rqlqu!Sfqq43T~@P_VVIo>8R^ITm`$C-Ou4 zwI3<&d8=(fwlUzQ%Wjg59K9RxvqshptCn}ElV;pXIxm9ln1a=Xn~*j}QU)FWs->(B zj5WYbycvnSEmc{rq7*HQyX49+&vqwO!c-6UiGfCdJkt?KR$DXxLlq(L;-fS zT%o8SufMOZYBKprYe3sA-%{19lr7QkFw?1TtY8RHhPhln^|am2MpuE zgOj;2B;X&o75^oW@7{>ivqON&`)1kVvL<^{yy&(Tp@d$L-xnNDDUxc(u8a_KzYg5p z=vISNA+-AKG!;n4e+X6wRr0B6z%@#mZRVYo5M)EnutDVp*aWyrBziEt)z@8wc7hS0 zu(stN!9AKKCi(<$q?_CCeYxI)cKvaxnn3A&rPim72)!Ff6KfHxx2Xj9Iw@)0B~=h~ zKXgo{FnDy%DSdKEXXQW7lXI29f0FpA?u(y76Xb875gkLG9p?*=)=63#)lLRM zF2%Dhv4Om)K?FS|1_(0&cBRt!_2Zw^cokCiWV%Xxf#+ePZFWD&vxD#BMSXk6u|@mq z0OrFBDq}>S-YjJpNypEnR*DV=qSo92Nm#uJxztrs5-uZ9&B^AAS6)y)L)SC4f3l`7 z_d9{NRzlp-Qc{OM>a5axmfuY}Nwkwguz~_ooth{#cCe6N1(AW`dxrpG?wguiTq;1) zlafI|hoxI>ad=WT^DXC4Q)ax*)5MvWmdSqT%;Yc)c#W(h6jmC_uz><-x542lcMzDt`YufmgNg7=Qk_cpI1u+L40-@(7l$K+2%%3PgDaD+BaK*~)n zXAdY|s>;}(@X^u+-?GaMO>m>W7Ffq!jvWw+=yK!*3}u-nV$&{%vi2-B-ssk+RBn3H zeS#MtJVg4@;QOCp7d;5#E{W6qA>#mz^DD$Z+v=DN02HfT7&D9eQtG||hWi-LVG3)e zbV1s0wKWrUJ)L4#-|t$ZzQ@$*K;Lt zf1z|rAUe3t{lcnY=3Q^`shnFwqI~PRB>~s(s}I<(s`KNei-u+3!1%5*+O)BWsyGD3 z^Y`(t(Aa9v)xIqz-DhFYb9_DCE0Ak%lp!qd3GEn{;1UD%geL$Y86uob#KfMfy;@mo zV|f&>iboB3Yq^ZcP{|=449V=y{=h_@9Ur52`n5JHxmwcKI;%=ijt{A{q%1*a(>-q+}K>_*s2cMOE-L($-i(H5?xVNU&L)# znCf_x3Lqu$8oKGpSODPKq6=)uS%w<;VoD&)%hFue!FQ+X%A~5_g)Psct?e6A6%#&K zTaL@r){exCjgPnp=Ue9um~c451vXyh44DsyOP68pdz=Hmk6%aIMLFX^WoeA^!iYMX zTAnr|m@li>j}!MhGDyZ6Cg_^pcY*{Jl9(v$9HqGY_1lrbtN#I-B$bR-Bp+C;we9QJ9PyN&En&#b4dn3{O;xq(C-OOAvdlxcUy%F=`?1;ozix zRegh{t|~@TnV=S9WJxruaqGY#xUg`LF;PCGmL?`fA2$T%BrHFp6vkde4qjC-TE~uG z%{SYp>>5-To3S?mN{{c?HO`G%|0R&S$m$sVed?|?0ao`ciWy*<^ELO*5)W+$K3dgz$%lZEl=5RZ95e(P6aCN8^s zKfz7iP!3v}fe}t9RTW(Vxm{GSL5D4mIBw0x^E?vT^Fe;;Y~dCgx^$ky8ZnGqT20Wa zrfTdSFQIHvo_oeS;5(X(k#h^@Zq?5wHrEa+DBR6t3esz*1&kcVmA-b9;>TYauK;v| ztR3+i_;KG}8qqgd=9R8SsP1jGeQa^kma~e->hG_Y1*CZ9to2nB0Exd!Ty2E{$8=S_ z>^?AJPJQ_H@^waL45Bx%BF4zXL>~60x$xSq<4Q`Tr*mo4jn9Vv42``!uIYHA{+R>B z^JVi$P)QoTD$Q+G>eC}OZjAgHK`E?knqGTPCVd=8+{OIxvX7g^V57<7?BDtTo~_mM z-r>%aa)?VCwD#p-Sc63s;t9ea5U-*b;-zK-HdZ{M5|(r!JoZ)Ww~3ak6JLY2mtK~S z9^k$!G!r9S&l>fLz~Poj2<5z8fg4;;82Ig&r?l96W0sl;b0f)p*g}}~oZN_})>ai# zi-zs(V~x{fOQUV~*uM@d+Bu4u7+ zKO$|W+bze#1h`)?F@ni+g?h5))S%W+mYASfPXkdSkZGjiaYfbI-ZGL5cr`0KO?TBTrhOSgI{kXi}MQGMxTtk!>nxd z9J>(+;_e3X+B{od)SkU!G~7QaN*w0oUQpX61!`&zd}HQF`Z(todTflF=OWM4yQmqO zuO*2Nrai~`))nPQ4#Ti=VYbuz*mTzIVU~ zvh%S{)n0Gz=P#oAfZb&#u03e1nQiA3TOIA*7xZ#VR7AT9r4ENnr2$1T)SL0c_qE{> z8Mui&sHL?-{)Lj`NaKY3CNze4M>8`zLiqX$T!z#<6Pjy4zdD~BzrhhyYzGuX zFgmmopy3T60;E)&&L^-h%>GA;mr|&d9Pg|q_#%-kZ6jt8hf&TsO!7D5#+=O_CR+49k>5!TQ z@%t;FVgpJ&<@o`iNjtJUhLQv{S|~|cZjba>ABAIC)^{4pM&XuY!UZECR1KN&L2dfC z`0}V`DTN@;Fe9bV6%8DSqK4iO!O<2DOt9mH-}H zOZh66@LfPs{KPliw~p!Z8#EbkS@rzlxn4fDz*JNH2zxk|&|zCPYs7P!+GHDVs@kgy z{IYR}cpam@7k1rOi-5-TKGu8C7uH-;JGngr6#4VNT~;TPz*y|fD%9`jkeiR5n%pC~ zdN;x8{#!^@Nzyxn`#fj@d}W+w$Nl$?S+l1mVp-9=;6^>%UxW%uj?YLBV3Z~LQ)K1F z_I*_C*QLr5qCtv(iF;P_qsK@ebQ=|=+UoH$_vE7H_@iczO3U8bF625&fb!p0!`WaX zwCEkNhf+@gk?ii(W`{4=F{*E`j6JVI44#huX~i`*$StMR$b^0@UZR8DEnLCGLz3n^ zS4elKJbE=ev<8G_K7wsK88J`v|2`E;A`#oi!h$+j6c+(GAsJCr16huc z$6}KpPU1dIITMfdZchvUIo>J`AH&fYY;E+7$I+Rbs-aKZPpZCoVxWvpT0b?EM`Q!I-qx*!4_3Z=m?klV!8TL1^>3k}}(|Bs&?_0oW2A z2_Q8wOTeLDJnP!F)|TFIRXi%?-?tsFPbZZfQQR%!-VcpnC{^y7{SgK6P4V&`?Ir+< zXXvnZN6njc1-5)ypXzp1bDCuP%r$S8pe>Nh=R`E0Nj6nsw}^PeGzwJ_DbzYf;#}OI z#Ov6r>>yGX_TwQ67rPTuL<&RfR}EB$ED zlS!9*wQhsT+ov(TtU2aibz*jO;TbFx_J}W67EWQlt97RM=;aZLzI^9=5qh+T z)mogv^j%{010)cg)^RjOCgGq`SeN(c+sxJcS^wISe(ncJXw&Q7lAUyQ#m!KX7WHlo zR#9t2sP3oR*%6W-PyMwXst06BK6D?rINk!-I4nsjdi+( zsOgAel>-C^Bb``9$+r#zp)^vk2aLe?vVWiY7&F%I6y)`u0n0ogcf4;~C@m$d;>up+ zNgPT(mN#91;eF;5Vo{d0H^nkm^8_XVC7Y8qPETlUKu`UOWaDXHc#@ozlqBc&%Fxyo zeImev{MXCXWDCHzPZA z?NHL9_(`ZgIU>u*^GVx^6s6giOs^$5Pf)^k-t{YED#-VLu9U8}odSpk7Bh$6#)Ux=%p%Hk<9 zMZq%kW-k?dWyS-8uM@tshpt&x(tc3*xw%^z0FnsFiD`EZDqMP)3pHexm6swhMd${6}AC(f* z7dmBmmT|S{+O>+bnmabcI|}W{*IvC>IL3|L3NE?C2c02v@vNeVp2p1~QNCG^-n~^2 zBPx8?6c4q7-kFP9p)62RsGNIyPK zC)&I9OvK@qgalRvXzwTCMpr_Ng;<#a6d ztW-+n3G0F5b7JX&(Tsm}-dw&m*nQz-G!ZjADzG~aN6=hH;7GsQ3lHjIg~Att{yx<; zanI89()j&9N=ir4UP#vJ8;HYr_O`nt^S~i?%?GxX8)EU22*0Kel|i65?l^83+e&U1 zVa2~+S@pc1;-M`mi0Nv1G73W4%<@qN$kz-V3o}f}+a}5~eA+~|^y~v<+3d4@povbO zFbxE66}40w-TC_zK2ulo?^E*>kCrY>MA=joiH%H80>eMRm;XMs9lnw9_bCIRx}{7# zVy^|EYCJjzcy6`qvg4fUGat(yt%0i-R{XItE zXbv!mYh1XpRO>LU9ips>up9I9taq-y@(Wl;3^MG;r4GcEQuG3EDJEG; zj2e|1{M)?Zqw(7zlc=??TZ7h=rI+ume(!iZaV4{|RuYcx$BbOkOVGN1v3P2FwS>nF zu?$25m!a+$_yC8XR>tTdgw<=4f_sH?H~0YFIw*I*i^f?oHBK8I4-q2V6bfO$)(=cq$ zsiW)9x)~W6Wg76NO}=m=ScUbp6p&|@tHnEu@^{y?ue6Mt<)(3}{=i)QTGlo-&oSBc z4&3zP{`s}Tb4_sO&9#&i8KZN}0<2D*e)Qi{NPp6vfGW}s1<~?jjR4g!#omZIma<|h z&@6nJElV>(loxL*@v}UJbiM$ zk?!*LFG}o6!GcFC%^u3Z0_Z95(}wFHUb5GxSyh5r4nsi%cBNxo>e#uGVbk@l0a2`3(XMC3 zOtTYfNUafQIf9E8)EWZJG7^!Bw5XoIz`*|HFU(N_I*2VT_2NpkTTHN%_AQO=##3m3 zQsz4iPe$-qKH%Unq1H|qwFNp;l4RH)X;0@f^A1Hf#H)Tt71s}Ki?7)hjB6bC53Q#a z(&n9Ej>_eKR02`cFaAFD`f)^fnAR7N^&TZBWr=rKdBY45m=K&j*rZ+UW;LVzSeU7I z10sIYlNhiY6csUKb6#?0j!ew}X971)Y#y}CtYsrQo#Oozh6$5c#)v5rWe1ft5xuL1 zZP<*+dMPUlpb(@cskq*0&LO4i_NJrBOEnwjTcODi(Hk~P03h36^G#@v&CY`&#R+=8*lm$eT~rP-B9YU{9q50^U8(Au7EgqpgIJ-c?&U zm?!%6pO(zF{djH0u~U)G7&@>XlKtVxyobJ{T8C#M(bQaCk@LGCucv>E=>jPEKlH)*!=UK2GIP<_~75CzPr`!=Sl)@ z!0IskyRW*!r&L@k5H4y_XE?bovMTYoo>@yehw7Np?J?Oq` z`=oaDg#}J+qeE1==a3sUKWKhs7EAGYv}Y--e-%#=;9GQV=GgvyO1E})LOM&nw%4~U zlv0_ws!q)3FPC9b;VysRnQ|^klqJD*@7)*qU;^3vLPOZ`V=!h<)|!R797r>)K%IFj#}d;`se=i_`cBgN%}8lM=QKb=ihKg24(fuaTx+`Jkb{o zw+0`*X`UvxI2P&kByJx!EMzAZl7!yZ=CnmTTZ*n4-PTID{G_M0N&P+wF0BLG-3XWM z*GX%r?3AY@MJ5NN(u{EM2~82EZFqkbX<+i)qOsHL)P8T|{p`?+i|pndV2iNzpn(^z z(BH)TwEg!36PayBTs$?y;k&S7*&CB*Gq@YW4be;Zl*a7o=X>h489jZcqx&Mw{Xg7d zJZp^P0y>6yijln{UP!PX^(WazqtEyX+0_H z8&zV?-1TMe!?g;BDGj(Mi4^;Si|Fv_mMuax9Wcn0Eu?H9nHBkSZVr-Q?vR7Yx#liP zt4>>;dFK5du~(fX+Ko8Q2y{|+2Mb1|Pvm(1n;L&V%S+{XoiD03hDLDXsiBPenJ ze`a1~KL26DTI}fV&GzZP&}U#+n_g3L!5$}{kK*t`di-;@ zsx8B32^cyPTol8oY*f82NY8^iS;=Z8F{AhURo|b|OaJSC(kjc`(`+A$I5lft3u@0& zrtRaTr38O+v~HcB6+9rfULytYiaQjFtRK`$67+0!dL|-rsyajz<@Q3nW(q2dglLE4 zoRzweSofqMlmYMQO6@;!>(u&YdX-|wfN$Q_hpMf z0T5d8@D<)mmx~W%2v{05ZfZlYXeEv zq7$;Lj>Q2z{dG`A^b}nyxoh%d&BUSfl^M(Q5L%GmN$1*?yhjg-PKifn#v@~8^yL~C z`AKq~ji}3m`OvIc+>dopxk~ubB}#WIgKSq+4Ey#@j=all+PUU4{JxF|>^IDOz8b^V z6k+(z9_Mk6GZdOB`g-|iUF~sa?+WrsyJfNYMM#LF$_Ek75LccG=a&6SX~?;21-h|Z#6q8h2z!k_3q4glW|^;BWx%3Z1YR> z8+a7?{0`~|-FgCvPjfl%A#g!emH2vreyvDOChehOK9@bGF@V>)o+U|5UxxUP%7PCr z&Wu*Ph5{Xzdk+f<42^ft`y*gyscQRw4^1WYUp+}@!Z-dtHT$W$SiLe>i2N5yWg%FC zRvKhr5$aE%hZYd@^|01h8Mf7SQ3(w8wV+@`(&(wc$3k4n31uS8)hz8JEE)2~z5aCn zTS}+FN4`kC35`{WB@d=Yv)C4hOCZJ#xRHCqB+^%@|ES4Vl=utuJ?}QJ6E&b5iB#P- z+T0Qwn_-Dq!5lAVx-lkR7-_I|!g1iBJNsc-?%#9QHD|mAO4_fnx}%$_jJJ@@z3h&Z|FuwHi%= z17SmzCX=!)mLIb!*wCO#(t^=S67aG2;F61Q=_72l$lf)-lB2&*MYN18F*0=>RQZ6< zulG#@jl1RY;+Eu_#35gZDvaCKjZW(Hx7x0HZUVu8sLK>> z=vxbCk_H{gllleWVZs9W@)j>bIHDw}hlW&~sdX4^v>MJ)imi5>H0K0~Zs`{+851Zr zT%*S74z^>akKzup#CCC&$dCUm2qxCsN4*}Q-oU+x!t8@1EW?*73b`SU0)};OU zdACoUoOm6-nVQ+pX&VdYnRGon-ueFCc8E5VR6-8O7y@2>DeqrgNetYmq_7nG^xx&0 z+iOT(GR14UV)Y#g3(M;qMj}kq73A+SK>X-&&Yh8u%e>NmZ8Pb57dKMgj5bub6)oJd z3wpx1N|mG*GX`j`4?Ob0DUY7BBQk59E)a@(%U7G9UZV7!& zEN4hS8Z^tvG+lym(Hyzr)M$UUp>e(81-siCSF4|v>pn`a%@sN$HlYmN`aMR+YmREE1aF8JnCwv$ks634-V0G=f$1u)`ugTV(A7j%em~e@6Su25`BFg9~(^n zRgv>Hi7rH}nmy9xz|C93tnUC5A9qAd(Ogh70fhXWouQ;kv8U?-0(jI$GEc!xp-*+y zxsZsqt7qawsYb>(nmrWM|;?m#Y5*8>GO@_su{s*sXd9eGVXW@d-(F0`uC7Q5{xSc zP^)>X^D7Dg^G-?pr;VPjVz&pQvbRX^r^+kxEsn#}HA&QWsqs^zBu5MFOB>#K<>#6fV#9$x>NMI7Ku>;vo*pr&gUxj^pf5E9ISofJ zogg;0@#!&%8|3-1YQz-&@adn$&H6&(f1mOIy24EWfepV0fsrN95Xkb7z6JP7P4k3h z5<^onYez>>%WKjt@hd~X!3%W(t*4V89k*-MGE>DJ8MOFbsV&(GQS2kGw*ZJmMH+D* zJXX=Q5le2)eU9k2O`gYY8T4Q+p+@tm?<)hpmMVAOLz`Cxa2xeKy;h0&)>`S7||{)|<(vQlzqeNqakb@vu5L~c6DlXg(Q_c?*r62y}1nK73Htgj~M z%UKZ8ODU`ZMoxQfsJm-<%>sR(b+2#rDBN+9zL_CmA_R`;Sg%+D6jQ7(LnuP-rIFpvRguH&@*pBWK0FK_KrSD%{)`@ zl{7g2G5n#E8v(ZLGMAdx!QL(&rbMTa{t7nf9KD`feb4^O1&O!?`$RnxOPg{>A!=#T z?`1ySYBow;R)@QEkf?FlfMISN=eW9qcrtO(;B1A|tN^bQ$%Y-6nG=C-jZk$p!pJbc ztf}IQ?-wHO6Fz}jK-?i&7FPz?zx%`CSDOkaUeI^3&281BSL?m_qQC4+?tydFlq2Hg*8aY?+-DXvg zpY(+Hf;85j3B-;Cd$<<@H`Yr)&Qw+V8G&fUP9SS?JYaPt;jDrGp=&bInXCnceL=VE z$5eSPydkf}TxB>&3!N$VFBWB6LOc&t90)6quj&pZ5b2A@Z{evD8Q!{%K+J9pRKhLd zdQSJs-fgWSVXw0_wF(n&HJzip?%gOanB{6|3NRPz_6=Q0+?T}`5i`VF9@L-Pyw9g- z{Ve~LG-&tuSx??g33YYiuV3+{KuHBJXd{Lq|9xbd!o*FGR-vz+yyxzym2%KsnDKj#?!qm^cA*(4~c#;m3Sm_Lso*w00uW$2Vqt%@U2C|2QNiGI5=iA&y z#d;(|*Z+}vebVv`7>@SN*pK%%#a870#u{;0V_fk_?d4vetUN{P;nx?!z4c@|JqTbQ zQl@?-j8g`pSND40L7dUg{9kaH@Ee64UO~4U!kMZxY_#{oEgIPmWbe9rtR` z0j13wB*CbgZ{4;`q^MPhbU+<2DZv&UonxnfD*xlM@ZY{YBUkGUF{v>gsISⓈTl#46jWO^$_9*_TYM#{_JXsq zWsZ^nhVaZ5Yz1D`646i1h(p+fA>wC!70=vzvrToC4lWsov3{=4lanUSV0$V8Pjs3x<)tb)I1)B z_2wg|=4%&tLUY*I#?!MBo*Esj$^MX=cYC;XAL;R*h!s}lBgt{4E+7#nFEt++KV{xK zt02t7;a(955`pW-ZG<~|)X}~Ha=iBI44S0<$<9Sn?5~~YjsVezt>R7IzrCzg?CMxM zs1CmJS5P2Xh#wy9x=A3)WzO2f9bQ}4N9atw7XNVNO2N}FCvq9t8k^bIHg<$4?axU; za90@h1ILGufkq9oy<@PNFyI7(T7?dzuLO>Lc(B-E&NuTvwUgHU}8)Fne zt)g<1mbs$@=`%elV2o)&JBfpSP2SW<@-C}*Xd!uH9yo)!yI=b(hb@gMT(}jAZ>~T- z6qPqTSAx!=jXxY@4BP)Q}9mD1phe}AZQxbcc+gG8@$?HNSp z=BlYAGdo`6hatI8?^{ATv-5`9^^T8n;@7pKFI_sm%3p)IDS;^E2nj(`ak6P=kEy$hZQ}os&$!Xmu1M zD0d1h&FKCn-|j*C`;=<=EcZ~?GEO9x{PRn`??Crvo2YL?^Q5MF)WFYr;4(Q+7`e2) z#q!oxrZ|RG^wqfUI?5@#{-ay}y@baej4C5fE`W`t-gN(?Nw?s;sKh9Ijw$=iiJXgD z4;&)7`MUuDf1iTqV)$zHJ<+}nx`IHpgCdy+3BHfs6_u?m|KOoN+fA|KuQs>k78!BM z_vAq#xtal#BK=#OCBt7Aj)6s~YbR0%VW?tD%TRDy5*o15PPauizxHEH1{8Uti987d zt|uyynu(2{N;bnqX$P`bN4iH^C1hp&&=MTdPKI#E_?sM+f7eFzP{m-M#~4L5_lx&5 zoIz$2rG5mWrQ!7rcHjwYi2R|AS1v?J|Q5`dEimmKazWHaAt3h~MJR8ybRDoqS2xCrs3R>gNE+v9c}oi>qkZ zsI9Ye�-Rpjp6|?frd9e&DPoB%kJYeIR9&oW|RKJgF)?h2k|fMMkV7ZXkLZUEKzHLx*EfQAZ2tS3IPoPpEg8-Xpg^q>B?S z$}k^l>7u!HA#j}aMBN`pzpWVFMFk#1mx2h6!%XhjpnEZw77})kIpvPVG`2d{FEGCC zsX6#Gl>lughOR%ia4k8y*cuu$l<h2y3X4dM$1 zvf^V*Kv%Fuk1-OsB0DRI%Vmvp3%29YigR_3;|Q1SIoZSpl3vN}Q~$M5l(Q_{**vp0 znUUr2sbf#2Yp58Q+5sn(&qL86t2D3~J%71-Jp{V)X9{ zXQWRWKAX(Uj+NMe@laPAu{aAKu89Ye*sm%~o_+35+$B}{KySF`_-nfZRM|f!_zu=7 zj*|=BRn@_^7&g=9pX=75y3X)adotDOZv3>0RfnBIa`4v)tF0PN=sz>E5hDR!uBhkE zB?dt*!cU!5UBgasbgY9&k)lTsgwUjfj?O3@0)`}n7En3~p@q=FGdd#0z|cErXd#srAPIp{ zdY2Lcgd)93uZrc(d7f{rGw<`BZ>{%_Z>=x?C0WUxJJ)?**Z%Em|MnhZT4P?;AOV|7 zn+!xtY~wQxzBf%R!g}>)mYXjrSj?|9$APIbe`~k6IpgXx-D*2s;>Q|~7ea%>G4D6ZAp-9A~ke5%-@)akOO+O+5*)a}a zsLkBu6a9}M&>wk_aMV202qHmkRWeP{UESc*rC=}wJALC)87rbZ($Q&8LGZV#X_Fq{ z;1IXPB5vllV-qfSH!j7|ZJ23n#;o@FcFGRtb+H3K#F#>|C)xx^g&_~rb)+ndYo{Xc z1`ov=!=vj)%$|9phPLc4eBk_PzbYhdX1YH&5=n(%lZNoHrU8>}Cb)yQAmNjqXrT^7-PGiJC*}Sk9j%0~6oI0d-Zn>Z*)jE-ADcc5$KIj5O{8ocg?%Y( z!q=OWdRRDYf@UPZC18~fF!~RMYKY(?P`g@$?JQZJfjv4L)ci`>ZE2)eC&LAw<>ORF`Y;ti6SW|a~ zcr034xi-ACtbq7uwc68Cp-MF;YYa}rd5Sl(Uua}#UJBjTAuX2ZIV|9u`}t~x#`@=J zM*hX*b>1x^iL|j7bEN>>)7CvolU` zp5_Iz7f@v;EcO(Uh$M!nhvKJqjCO$@-%io`L-qH%)qDjBeJRfEvyHG?rL{z}tt*kv z)jAt<=~X&3VoKB1s0u;gmf~frk2TWgx_oIh?o`OE6RC2Ozt8G;6Tb*%H8v7*d(`kT z8mS7?&Eg}+>U#zOvi&(;!M&fKAi4%0)~A(~;viWxBA=xOorjlhLS5o1COQ*9Vnz2f z1=%$1Neo`rFA(fc28Q*0SVqyzDVPaCTb7GH3V z8o>ZAjJ%q%Ko>0cgI=$y_AO1U1~ef^$_Hu&xgAO^F5BAJ?czbt;Ww8Or*2-FYc$Je z1))W_=#uDRA-8j*L%bEYpab@4b*wGlPirT@uy0wX=Y1sqA0lp9cx)8jY3jAV=hJgR zyJ`e_Kan4&SQ44kz-0?&6m$*6Ptb8juqijuTxu?LZo=m+wb1qUDu?!Q8@KYsr;kU+ zl=$^9{#xOh$o|m0^X(LCiTm-Qps(w(Jw3@rH-zrc&@>j$9&D_ki|?)xVxD4D&ecnL zv;*E;GK98jny=g7sc{whmlKl*?rDAWNdQ!nG`FehAB(FXz#Czr}2gCp){mZs_? zB+iTijUI@q4D-_zaWSeg4l~7{-C$v56)hXJbCE``YY?+Z6&WjeoOb}dh{B8Tnj z^6Tf{4+eK}Fi%D6nuw{&YrZ<@sG>z5=_iw;dHlq4jj`XeHFrGTjD*$2;+H{=7lWXx z*M2*nP4x&yGPhQej0~*`qGEBMitXe5dJ8H8H~RbFlAxwx1B0ZWMVa*e(%(}+_WcKHYGlXQ$%F{{WgbKp~YkJ<;9=R<}YHj7x(Z>PG} zyYB6c)VBq%g+F5E|6J8%KY@B2j1{UI_rGi+n?NBGGRuJ9PI)O@V%HxwxA5dV(lbVO zA*1t=AA){+q2!OirU;tAET_|B4Z!f-0%q$l4CC!M2wOTrXa?r@K|WHA%${3 zRoh%Wm6(YkxciBdw6t{A{GSWQ+op19BG8KOD^h{Q%1i1LZ4 zEaJ@=9~dfl(m&HBI;_KP`D6G2=t73jm1;RWlD!p~A~uRg5{c}yaTov`I)B%otUB*m#>X7J{;XT`hK?6QQn-K0o!-&L+!{t8kHrN|GUSFcTy z?GSDsur~{6(B!elM>fky>{uk- z#IooR`yjk*S&Uwmbb53E#@C$DUM%7Ce*NzC|6#E4uSptsjpIDv&^y=Hs9rtl5XAL* z{AmgM#Xtqk4eiEB#}=>`gDoTK=c2ZdJIE|Ye}hV;NWda$v=3|zNe&dh0eZ3GOxQGO z{50;k6}bLJgcY+Mp_M^@QUR+*&o!;yXC*-?2Fp zB;t6{D97FKeR3(m9!z?VP!NK&;EylN3a7!2o;$7Pe>SIUa{QvMIIfnIA|3}T20vLK zL97>4$&*jT$b|NE&b_&^7Ov<5pVjawG5Y$Tb-ek;JI|#1k1j;|<)o@@yjUs83&fhP ziC<9*JJ_zaHElbdC{L`D)hX#I$Wp&|l><{N=xu@3LI;9YzY0ObhW{!OBUjh_PQmvR z>Jslp?H-qKZ-c?Zk=35(9g3bhsb66{!E!C9z8VGA<)o{p+9Z7EBi`1W5%LLY%)CHcG;}Ju@F!TP+PMpzDzKkpoX=OLLlR%N=Q- zJU)$Y?)+YqmJTP&;;@7MvJ+C5ex7Z&zJH&e@Cd7XVJW2602u(PFMBwvAJ=pKC)j&tG~aePFdBT2SxOCURX>m)IDH|8}f)d!pwXZ2U$;>^GUj96S$_zkl5jpXiuAa^|kI9{- z1WNB>S!xs@GfS18?#(Rw!k4$oNEhZR2nh|?veE_}mg^tIW>nk0@t@!$)+j~FpDxrQgG zTz#edO6jxf<3Z)ZeogcgkhC1pE?2>WP>!lE#!XQ_RI8FB{O~%H7oTFKF)m(4Z#dzw z=VXm2$-my}s#2@f|14D#Ne!{jpeMFlm*4D?I(rNwce?T~)GsNeAPJdvjJ5^mI zCTFx>i#T#U2Si~bR~@Dlq`2iqiQBoig@P|UfJgt|fHFQ6NR)q1D$h(M3WI*^4GuCs zEY3Y7dh@;e&m|<5y;!zJIi--sd%T_CncLOglznVLqoaYCbxQU z9VX8v+Ss^I^RHXY4np2TtSN`6$wgG9u<=7EzV0WB_{~84I*%1mnAS;%hY}0V0HYXZ zzWM_AvB#z2j1>P7S zzMT@1DeSW_Uq(@EAisecrgwqE(o@r$92gLG?^hkAj6>gy?kN6_ktEmVG09!SiKrEt zl_6;F3AJudHHzfUMbhtvCzunCR(Raf(5#Gj z8YnEsw9ku2+76het3=u`%kV$Dc_^MxLMofXLsNpSekQ&?&)LH{&kfxrBah@=B}AE= zx7l%nv}c(OtA_2z-sNs0Z~MqWDZ_Lkr|qy6w250RAk1XJ9_%~Bc*(k(JL(%(+qrt$gl0f?O>nA}?L zX*H&Oxa>(vDx2{sEbRF4CBk9Z=C97O!3ZIp;5;L%!`Mk?p`CL1_rCs_A-Q7+Nh5Tf zW6NL{o`eF(RN$VBcfSowe%C@KkerjdO-HLd$)74Ct-;U^|M4ehCw0so=ZZH0qO9My z8E@GPvfi?*troU?EhXZdeDc~SSUM_!>~p`6lwG`8^UlEXA}T}n2In8TL85P_#H z>S5!{h)b&jUWzYzDfF7D!<`K$vWCj}TU$(y zRjSOVvz!6nUjXlp#2);b% zv^1hl=bP(?8W)^PAT(b6a!0JuZ%f#A&`0nfr!4r?59WW9Vt@C?vazt{YF zg3SbZTj5BoqI;ybQTnMYv1~t?Kixz{5b;t(&srgt2YBIp?-RZkXurn-<+r;(C-R~+hH zVLojjfoGc0K|tRWR9oq9^~}!Ou>=v%g!z4oIgudU>oGupwOD@w^?5_ zkX?KO8Qh3YpBro|2uK0JV8MnD%p(;o8G9U)qU#fU47hQ3e5)blw(HtUJg(-ThQ3v{ zSCRKM<)y;PFxqJ?!M&m`|Az0=B5ll13zG!LTN!~4;IRs1?zdCEdX+j_HX8FcZoa*1 zz&*Wnv(QQTs%GxFywZNEn7OXD3mB|FU~F>L63H0gXBq(c!7%XGza(ud#r#6(&*v*D z=06x=n}+K8vl4|+3l8Ts57aX+)uOUr`YZOi$j%p#QhD;=y!gO8)o+pH;n^Q^x8l8tgf!C&Xtt>{^y$?_~sYwBPhF8 zkN_e6jevm0J5qr)E>(IwR4&yCWF}JIYu`0GQ(|PIqyQF4!K2cimUu710mww@89WJG zTCV7-m4HSi>Zw#1$L&aowXE^|+LNn{wU!l9G6Cy!tf4CFiX&x>1eX~3fN~|5yDIN- z197Ol>r^8*r#M!>ZHM*`B$0w_u{XlPe3cj7HL;Bm|HI}Lm>Ievg>PbEEoOX3`V1Ix zRry`-7a6diei+=@L zeNa7Z85Y3f;uT`s*881w` z*v*sN_~0+}x?rt#S0_rKe_6f9rttf7YX)AoYkNPk77f~IK{Lq|Vr?&`A@ZhiQl^1k z7yCRB90ho3{awA{U=L5&cX3p@#|d=(p#F-ZSG^S>j*7d5EOz&6e%axDNDJ>Xx~Es? z6X@B?yFUmDO>l7BbehW^t>C)>ovZ=`qs6Ity^#)tf@R>>)4Ga`4-H*_1sVoB+Bi(jf0kU$YzCEw1p5uLjRH!h%d-j;q?gDp6C-0i!X-M?&{ z;-Y@tb4C`ESIoN~N5Olt56Q^Yw6E{VDt7BnPapm@(VyC<<)m}GCpdyou3qQ8G5+WR zhJJxORd6*aj^yzwW*+S8_|*?Op!Y{f9*V&u!4Ino3q^UwQaGG3ono~sB_$Pp)-|JT zV#6!A+!OP8BhzPCr|Fr!0eqvJK=^RDk$tCN`19R5WMrLO>h10F-xHfbmK*o34NT=g zp5jfe?3iS7eK#lpbzL7H1HYE;A2if$cga^yz3%5A0Rn>dC58x_vq!l!XR)1<_Ay8;6*xkMOEsmxAH4{)Xd6+F|2%Bf}Q!e2O{KWgYLT%8H`h3WQ zd^x;%@ne>;&GyFS9OrMi|?ey(NmcYlX3sQlo}s@*d2=cj9dOC9zF9>vdx1}u;sQ*qPl=JNBzn4*>YTk{Hm zId#ooA6r6pGE)X}DIqK)>x^Q9##)aOnDk7*%7rH&E-hQBn`#};ddy2TL^4Lt=bF&M zc{t}AQu2+Ez15LVy$*_16MM>AT=VSruc)-tKAVq10u=L37ppeDM#bzFuDj{S`MTkv3tHy(iiWNz3W8PJ_oPC5C@u&A(Y#PQZGqG$vsnu_% zeyzeqpJ!(X(%#-oz*eW36~I8{guP0Qe}zq#~aR=zq^$**hkMcirz9r(+=x~g|<4SN`bQD`_T7EBj%pDorR zm_WF0317!!vtB(&)v77eO%FWGO;AuST>|LQh!$kJQz1vKCM zBn1>2@$ZaSpME@Z_>?th+T$!%8eKRjJznfZD`<|z@a2RrE+d-{|JVkIV}ZwuwGPfw zaVM%fo&~?28vc*^Yq580Z#Qn5{T937sP;JGAayY`Q@lyq*McTv-ZouU9#Zu3qkxR< zKHf-d-{5=>-Fc|N!lSXYVd?tKU>N*1erRmNLUw%<*j-TKGh?j9jBFMnumOB`PZ!95 z*Go6LX1LQ~^MI^bK(GK>46u z-r6v!4qTAfGxBA86I4*=UuEa7aUK-EbE$rP&w1)rQkiFc(3vp4QdpY<9FC?zHxqv6 zuW1u+NjSAvQ*RC;qlg=OR`{hWp6rXXD-`C+t;5sE1qS9`efR28R62Y1}R6 z+0Ya|<2=M7jo;lCkUL-o6o?CTK*`U_nEsX9Q1-dycV2Xn;z2|IrY~8*}=jz)(dSmYeOH!cL zSbJ2B%>-xGRjhYgfG$YjI}d`Sw)mFCM7%QT9k>y!!Q+_R#eA$0%Z*tJd7EAUc35+` zHCm_>DDmWTty%C_s1Gv@WMFzhFSuRYW-h9Q8b4&>-NL~P=-&R3L?Xmf{6ATm^KB3f zC#x#k%fFUMyFa+PhP|9 z;)~Ou999XiheN8LE%&(Yf9*1GMf& zTB@voUxg5#*=rHUaTftY6E~VnXWa^+n(6)-#r47#O zH;p(B<3(2=>Ok0ErCwG1F${E(>#5((M2;|{t;;PpaB5XvAjuDUgZH}3<3pdM-ER@F z?atOEo$}>o+8NJUttfckVY2~qp_bUo&#TQjy9S%qe`c6xCE!VX-ZQ+Y7x(L_9ryo) z>;8X#?YsZBL(#5j@K3q)>;G3j=dz&qyuMCW*!{hv9qb!E{1ub;6XJ*`J-K}W&CkuG z7{QhK6^9VNLNlnDZL%Y0=MKVO?8p?xZlGxK?_lq^km`ttIBsdG@xCpaG-G7+Kw~jK zfPV2uv_E~3hw|l>vFDz+Z)pECsQbpdW?12dfdPP_W0s$=;6`*eG=g!lY!VnIPNMkP zV(rzeWdlyLc7Y$CVPpLkRgNaWyaKz4s=Wf2+C@@IPSQD zWsM{u^Hie5tLxvbhgN8XWIyj8?au>{m!F9hYXqfBS6f5fE~5D|zHlG!p7Vv*3sVOS zrjToXs{I|BI*)Po%uyiL*w0>p0Vk&_pG!5TOB(sF$T$hwsRGPdR;Rj9g1?7vanrr&zhc*ZWYGC_BHzA{|R7wBN zU8^g4SfTC>7_&aK4yGBJ<7luD69|&D_405QZ^eSOf^?Y^Kk1g@KBwmh+%o>`IB`A3 z=>wyt-DWZ;vZt}&?V)47PYHJCA^iYc9(_$CZ@`cJMF_Z+_jB_Upmtu!e&F&sjb z_s?>Og$Jp<|C$m6+kSXZ+^)UkP1OQ;$)@s~nK|Z2ujA_@sc?o~e})6Q>-H+hDBP(w+gY}?y_pQ|vr?XhCWk_ibSKh8)s1Q!k&-UO@3N1F zMP_PVoLO|fM@U+jaD=8kX6iC|9)fO0XeG;P)qXgh;S@)DBT2izlJ4C&j94C+mcAR+ ztis5z^|%Q1^{Nw|#kg2nX5-l4r3r$KjyJGU!_?&NC+rNCuwQ9MBD+Y_cCN{LQVeWo$hx?gpgWk2XCosu`7F0!oxSw5A~@$IsW-8f!S%3A?)$=}JjMM<|hu)hjNc1Yh=d;Iat}$X{$RrDOVT$_HqVw+K^Q2@Gp6vmKvi-_Kz7e6EpwP*x09; zVn}3&rrhJ_aqY(KWpSf)?SHXX_m8euvIbRy@vdIR7}}p0}ne&oVd?%fOL)_TfL+|ViM zdpVBB4rOJc9#ys29{;24wOfY0nfRbkuh;eQ&bVcT!VPc_F$VXhs=s=V@oG^>BoGa)K~34|m}hFGp|{o}rD>2Vk7m2GslDL~a=8q0DO z%ZA%3K_*5^6hos^R4J}1_lX9b@y)Nb$10nyz1`N$x-iT0z>BQ1B`@9z-azOAjiqj` zCiWdF`Odv(9ZG|s%7qVtW`Z1F~CN)3J^9rs)vDs;t zdDMfeJ1E8l`qjbiC9TM$I2sfbwyjnPYvhgb42?31&TRE%$6pXPXnuU52I3KwLobw^NOoxK_?q)P+!`b3SdnZC$AG(R2ze{6anI3qh{VyhrRp zH|@>voE?c4V9y*98!5#Io8Hb!pSCp+v3dZ~uv+IQv(#=x)Ey(h;E-@8K;_%1*1#{5 zV@{j({6y8rbC~Xs7D3etBfiwXZ9>pTLgt_A@;Z@Xw?U{SbP5tkh>OdWx_$p9X-%1Y=)!Zir|?uqY&w@VNwZDAwn0~ip=B%YUyP5}x7;|B zS6=e3qqz!;@D2judEL@^+OBG`I-HCF#lPz3CUt5KsPAj-teV<>l4_`ybolh?1q^D~ zxfmLw{b`D39IQ}4T%&mAzJJp&aAoo9&9b(z`->m2)A6toIxbe{R{4|g9nu6V*=mnh zoYqJ{pRe(cy?a^9+I0S;;RA0r`B~rakoMP2CuZN;hMTZz=z#waPSFa|kB>SIVIJR~ zx7Kdp@m)pK_s(e6`BB@hWh7GVk~Xf(Q%cYtQ9ZXR&Oa){*b|RZoEL}ZZO;Df8}&4g z-QMp7?F1o&M@e~=$ZyUJlBcu{zmW%yx&SDLJ#{?l@-6gkJ1Iiqw-y){kB zkHiqmo*r8m6d*1j^^Ea=?fWM+B>hfms>@Q>`5H2$HT@kpQd-=hJC;gKqlPO_!9N!^C!EtcNKq>5f1j6;m&0|T)Hw=0*YqfgK zC~C%>>dW}D_bKwVY4w(Z`j)Q~r=U*Pkt*LRl3S9y6-mKNomSJ~M>FSeG;lb-T&;5B zVml5(%zwb^b9M{w?&444-A)=`9SYkl7zQ>qSPs@27PZF!BD5AT`SHX}d@(rKQ0{a& z>E1sTH7x7w>f8zS;0|JSVd}>Vs`btVViWF$cl-OAM342S45X7cmvLXazeLC36^}JK zGy_=I?pGaHV><3&#C`N1WWm=H+G4k5Td( zw1-jMeL4>d>(Ph9Uibl1Ze1B21mY?d2C=r9d>>aFY&cwukTl3#$NN-o{`oqG9F_{&pXPptn2TEUm6eJPDPb@jJ@nsDgwgBv@_>#^C<(s`Kd56NtM1 zu}t9C=WS~L`D#n|-R@Z|2z1Hg=()8i&f4f^D@NAM_k;q8gw{qq%a zT~;0W@2fOZ!41?%iF`CCVfMIgvD8-dkYRM%aj|e^g6fzaK^McB=9J|TnQKiCX0BE@ z@;L2EipQz~nGJADG-Wm4vXrj0&l^F(>Xl>SuRNhb(?inj9zoR(**rWBh zbf>8>bvCRb!~VDP!zR0`CS|Gj5_I``d(IR;d*Ng>s|HqZS1tg4f^4=!e->A8vfA>8 zUmEJr`MSDoBL9a+jWH6j*DO^TgL0uj>n1*%-KS%0hDZ##tc*yocq4H`1F0gkl`c-q zs!Gyky2+vq(lT{>(iUU+X~B9Zi8W^UD??w{4!xizuVEB;Qb7{dY)(+fU>TnlXK#|| z&4o2MaXn3S)qLQ0&vh$vUiMaJsi-c&>ki_}U#E^tn)o*>Q9UBZs_H^bI!$po%q@l7 zB|HOYT>C~7Jx)-k?nL)JeH$TiV3Ni8^QG7)P2eqrdS$O4Az!Dp)(nVmtS3+Lkxd! z$CqwL(5IE}c0dmLqA79Rx)oZ2_BV~UO}V8SgBmM_D@s<Qn7A%QSZ4`iG6Y&9CH;ULKO>&zfY>DY+i8yU^ zSG?Y|(w=;0#IICRcvm6iIt9A8U}zMTN9w?8Orac#UcV1_QmJ(!<}M{&J=yJ}y1dg#1@hiL*9;u%Me|`!i)nCnH*wh@jL{Es29&0cbr2yr zksvP$3lJ!am?eQudtCHz%79)b1e5Jt;Xu7mQZQ^#JGTUs^A7vks`Ky2Z=^_ZC-8uVtCZu$lk4;Iud%N_ay0Nx`(Yq?0&^bCj9 z(BbDB3d&n8ry1jQ9inVkUSk^NI&2L3tP{hd%0`%$4mE(?rdcSR^U?n~5$UvXkc%?V zo2G7WDF8>dS&oPgtJ!rmvsRN!Klhb2VzR}Zur{jnpCnpD<6KGxp-5;mwYJp~U6JnZNC>)mtD6d9kFSG)%LBV%{S{*|*c(RwE%!#b$RXR0k2 z&hCf$F@YM$07LZ&fS3YWF<5g=Ti)k2Xl$16w;)>hBmW(}E@xV!Yj!oh@S;H9+`k}( z;{Svg{}1B09wN;;`R)ZZYqNgw3l3jMOP!fo)X`L^53NN2he5$EH?v!D91Lktb zDYtr4e?;v&f08cvj6~q-)gD|#i#$a$ECO0#nT-#E&BwP#|5U8?qsGdzCBYNaIccz6 zvXP0jM;ZtV1^j&k7Km#DYRtN%4P@sD-GDklb1cx}7x5YLQqrzQMX6Q~uoJ`(>I_2g z#S^$cmObIv#xBS@qdW#{>NwXf?J`uHcdy@TZ?@QGQ_jPWclcd?M{)uA z)dSB%Ov`J`G#iUIjsOm!_h6jRjPwfHb$w92qq7%ajrB!)x&PiFJsoY007<^|*VB5` zlXU4!UgXU@XSNYqDxQJjtwJ{@UFl@(Y&N815Ppy8gl~p&~ zmU#m{|92?;x5H>+dCq7JZpgq4G)y`j?HO&RxZd}2v1-Y~*k}Hv|8^<|j`R?u0?z~f z8oy>kGhQF0&SQ6PE?^ORGwRh77npCyQPHj0fddr;Hos*RV{M-I!OFbwk^|5%gf+|< zBpziG3(maw8-7_Mt#RJ>Jl9Cao@jBQ!`*q+M!>JPt5)CJQtl?8@ay4;T+ux-O)qh^ zuih5gJ&GfR^YznX^%l@fB>77#t~?Wn>wlK=6wLvNm=(LZ8_f?Tap(1MMRoB0FBLmc z!3|oMxjnzZpj4(S^3Xu80vl3ocB}u}scW}|oIyld&=C`+tiUAZ88p2H%v1q!!}RWj z46oPl;zr$rGUm4RoLZ-Dov3l9Fl5+wIWR$P0_X1AstTkSt{57Y5B@R+qO2u&Dk^`z zRyg)Wpj&6L(lV?2B`}3yAG=%hGqA_EB^^}iPBSzaF(uM6L-7G7UD8F;wX-Cy)lW#& z0Dwu$j?}>D{p>-}G@3;3&XJ~sax(mztBr>#h945sZA;Elr)Iby2ttFS3yPI!TiQZD zhJQZp_A(Dt?fnn+-hWTV(rEl%U0)3qGXbXbEZVgRHLS%pdNR6{OE};)0aq)cu4vIed?(~w)%eYpU?}}g7dp7#UQ%J2gJSSaKGdPZ z^U873=m?erSYy!bO#x&1(>3#-c_y9{(S%*VdRFc38&FJXN|wcGXxD_1%M~3lE+Ej@ zwBs&6L`UFcLV4{b@k_yBF!>7czh-nI2t;_Eb}$M=8Qlf&=s701yUdx*}jiN z6+3rq7Ux#*o!?)E*Y^Tnr~>tTRAq0}O}+ACRl#jc^aPy?1Xc+D&5NA>7cZhoj!z27 zIQ)ZmPcP(CgTrp3N;Ri0(P^(vn+)ZOz(6k0BcOEf5JL(F&Lb}2tN1B+i$N<1c}8O` zo=i|?wdQzM^}uPwCn9`G<={{JCI}$~lo$o<*c!K2Ytk-)^CqMi4|{2&=g9J*Z?9g% z1ijV1&jpSw-Wkh&}r?}KUFn;)jr1ldx$RoA7N`)?z*}(7`+sq}E z2Up>h(|46=(?N<6UDA?xzhbtYi*3vG;aTH%Q`Kr+_Hn%L)yL(w)LKkeLxb&wvr;j& z+@v+j0$pV6#LFP3x}J)4L}1aW*)G8Je#&qY=lf3DJWnBmx!xA`8R<~|OLc8cSz=$& zIUkPBLc60_0^drpah2!hEf?=N zzG-+~_Pw|fq_jg^9AB#!n!IZJF_L%$wQL8ANolGJ{CNtX_CLs(|NSXkvL>YC)!3(= zSQYq%AHWIHtr;*4LZ_cnY4D}^mm!UAF}up2jx~mxX_qY&02`!4J?(z?M{MYaSj*{g zYK_PQ;iKbMr_S{aT{@G!uSb{|JJ`}n<8RRll^X(!N0vLALk$Q4i%RXuS(UTE!>*8N zKQcysa@tsCOZoF=ybx)qj~~31`PGV2b~Pg@0Z~A;b{lk9VhI=%2yD5E(d8Z^&a1y{ zJ9G}Ga)>?>`-VYpqGEwTQ4x?p-Scdb6ZSOeYz>!)!CiZ;W4Sc(a~YM?6t;BnNMAAq z<0PDQ_A${x_n7dSQ(+I&kUJ>!@3AfBytIlf+udiFJ^6Qa{CAcG&T!g-Te#?HI;k{i z?bWDX8NGX|_a!=`ex&W%lbFn&Fn7NMz^AZzhd77L_0*I;xG^zbs22(|f^v{z$#2 zeMG&~l3gw~Z;-Ry#us=ft5906j3VBXGY&50S(z`x1VxjBhzts!-RHocJuGEIH{z;r z-%bfz)MkQbyAxZnwSyfAlv-7VHK|ltziN6)`8ClhIxa;lmu{B~gL4zxnjY8QL|Kdt|=AvXEds1JTY46nhJO>Li9pr7nwq&Um zX(4O1d=GoZk=|zeC@;gEL|Ox^%PnQ}5S59`HUQdHqt&gOTko*QJ0N0`LUfI1cek#c zIP2;!F0Yd`Z~sm~>q_1JbDV>Uh|8(2?5^M=uhfHX%{pL~_L)nIoZjnVLhBtXD%cI4CTq`K~0j>6eD#eq|M}e-BFF-wree zL-{)`!$xJJciy+-DDfVpSP!o99ZLVa&8GxnkIaR=KB=|UTTvG<`J@?sg#fW|jQSvx zq$YBGy5`LHvrJZ@17gjC_OvYFbV?oKNTCSyaP;>3c~@fbEoY7+GlA7fu)q6nDr)v$ z)Gfqld})Qy{Oyzgzj$)Qux2(x(h$NCx1GGMEB4#qM-dFo>XtD92Fk1d*gdj!AE}bp zub%2UcuV=cOyH|I+ktwWI77qT8(_yeRi4^2Up-F%lehb|_rq z(kSh@rj=%Wi8ZyMJua9|uco#$@Iz|ZR;RvO`rl{hQ>XMl{}%bWMN>RenyIracE5XJI+W?uTdT9{mV+%`^1JCyM$w z8C`4J()QBWt*VQ69x3|Q(ros0Hb;BD{^CF~>g%$$H-j|su)Aj`H_h?6 zuL%S$ULk{oCxuROYY<>9LR6L>hu zZshPjyRTgGRYZ9Xi~iGYE|3tnA9-XO`>3`CS47O1@}%-OI?k z!*2PFT_50yo7!AaXW~sNg~ji_Yq3lcNqhfp51{qdBLBIQv2KsAz_z)FSm94db=*IU-H;|aMuVnI z3uO{fzTV^L^vOIpWeq0sl1Xh0TVd`4q&#nzas{ecWBfhK!3JqVsnCe@cpT&Nq`Q)vAa~ydjlN5V1iLz&7qcAG^5x{uuxA}=wYum~Vbk2~e zgf~trD)}V%k{i_P^~d8f)YeE|#nnZg#QbZ>3cD@)WOZ_&A5HjSF_@ElJZMLG&gYeq zX<@s%sW}%ny=wNyi^A{=wD9DI6Qc^e;`zD$*^%R=hXR{Y~4tf;Vs_xZ^T_f3Rh!_v;>gUI`A?dC$ z%(X;n^UZZPHv~JzuU|dQMqsUDLCw{Y)xz)d@+h9BzJ$@7=?+vi)D|y>~#<*|sl^<5)&TMFgbjNRy68Z#qho z5)ep%KtSmvgdVzmKnMbYfDqacAR!3}QbGwuk=~_*-h1y=6n~j>?is!B%$b?<-nqYX z?|Z{PfxW+Euf4x}@AX-qz4ltkZLaYBpcz&#BycQGv;E z5c_epo)Jq|`db6U%Lz?6XS)rn7qEt2(5DSPyqx1Sq6}9Ib2bW(>&Eh|xg+$4&Y^^95)?wu0DaZcu z0lASJMZAOa>*`+ggxb3W@5*ie{`nF{AO($eqv|~Y|DC}ZQDROI0JNoBc&RqQFTtm5 zz3I7}iPzg+jL#rNMEyklf*hj9tOTq8x^3%E)2a`p(LHi~ysRtie_aI30D1T`lUHFP zRD9D=-hI5eSvP8mLgzMtUhAHCrKl}Kd0quRX`5elnB>QaTw{c<`?dw#)Spi0zPO%C zn-AA~zg>8>H}z^^dY$(|(ESwJ(5n~}0J9aCqHs+)1TzWgG*R-J5_-r!KV+=tle|kt zJulrdVuZ@Ga9WXXiITWe5u7IGVthRXou?ab0tC}Qcz9LK!Y(80DI^`efKjLCy#uaY zJ1&nZuH!*!L=7)CuZ0wH)zbn-nG=aqDjy7-1Tx#yh7HJ&rc5wFe)^Ddr7E?AMUtr4kB@i5!r02PwLmP0^aR)`Jg=!R~IBRz%pK{qz5zeEAaNU zlZf4YD4x%^5Hu?o>wr;#<|R8sJ>-H=v*tjoPsHeq3x`-Yfuynl6Zn40jVk&6kDqE~ zI_Sf~Kc!q5R(?naeO3GE)y#oI$hL^> zvTD^veK5E?fq>2xh0uX zDbDPkk!!v@A=dJpIh+@~H?0A5rpM~`_V&i3rvMCI8w6^c(jxf)?!W7GIR8VxGvFE0 z$JdOqi0X3hl9QWjzleTj_v(!4)gjULdjq@`Jq9FVm8O0@XU;QJNQkqNLEW<%Y_00_ z;HE>7)J%EA3E@6g2R)ajK3@AKF8>hta>&e}E2>=qMfLg4Yl>Ng^lQ#eb) ziq7R!YX{sI7^O}Du)(RKym5;WPzJL09y0C^$^a3fK!aEx^Uq8ZtZyS3UioO_*X1?I zZ&IoFAmyzoJVJ)+nv;|rtZ+eIw_uR}ZJ&DZ@~eTybQguvOpWENXrU6YqRr0?jO-{e zlvpwdf@q~XP+GuVyJ?kHOTg|ggob%8#_2O`+(P?EKZB=Lu>+|O&tr6P z3Ssv=Dzws*Lh7_dWdi)p52k$tY68yVy~^oc6nIGM6^%L@8BXerK59)xH+$^0Z`zlh zMGfh$IAktdhxn8(xM)B035b}Hpd=}j&OFTxZsnYy+IM&bSU8Z6+!uTjH^a^!LBmPj zl%%>Th3Om-cUhwK%h}#9M7Puzu`p~L`G$+fDvd14T1QKibN5cgzm!}(c-ZH-LwX(4;8>;< zKE8lbXOJB`Qcsk6P^_PsS}n@Qod?8R11#%yQ%{eT#+lKrA3C2u*K^HLlAJl|BQOXi zfv+qK!%%xC=Ke8c0Fd7;1>{o_YhpR;DrD&UA=w9c3f&$Om@5oFF5S$n-CJ zUWxT5uZj_5;AGzvPkWLy>si9kKLI_CHaSl=52g}H#dZ-=q$(7(`8GZ~4Z&$V+m0I4 zDe~#Bfw4i+A&lh^#_(UDd@&lo)&+Ta1!aAGny)z8FVTO-5nuVf47CERolzm)z6}<- z#kl?=y`jW2UBmM$QXWl~4OzW=9dZWqY0EGZ%M`({-4Wa$g7(F7Y1G~H?`=c7k8Hz- zdVGU8{PQlYAtSw0OP5{&mXC-{1&wd$Ys&NR6zUs3A#XGCUK2w5NNTz5p~>y5>i3Pw z&(?63_OKPzya{ID&{cV%ev1;vr2Kkj!Ic7JfA2xzo+VAi(-+h&%xn5<{I@6Bn@cDO_eLT6CqHr3&c87J0kiJ4Dh=}Cvz81= z79~QeF%ZKpEx-kh0=vxT{pf18)Rp^X5WWUot2=x$SaMX_$0{*=&4S%afB zU-^bae3>}YO>LIG(%S6pJcGik+QR)fKfgj8eMj|SFp|2r|J)&yRAzKj)v#E}T)-tc zWSZ#9#&&1q;*CnMMg7~}r&77x0;rsG=AuYYD0h+Ni#G0b4{AWGh6ho~&**%Q_OFAa z9xKTnQVWpoVDq-gwyr@qKIm*ew>{5npV*}e9(CuE&iBR^3X2zrp*ayLIqn1Ro6a{| zRqBUydDK$0b4@BjBCPT`kR#Lzl}gX4ZQ<5|8c+n~2t$)9`@{W+mx1lg(OBU`*>Ded zgtnSb6o{8XgndXMd!NaEyh#sGvbYkg(Z1FY!sls`a)e<>==%@Q8E2w$H9KKib?l7& zmcwrgNH1{LpIRji=tfvg$e-^YCgD`KhDC`=8VwC0#tvrrfZwOlsc|z~v zb2Cdx{;r1K6+Q&AoLO1rpeWEJQ7xH3H+-UjS)gF(^M1XCVWOl^z5XGWCe_^fB<`EG zh3QGdmP8^H9cn?VaGKOsh>2?Ip#6N`9bv>3$7*j$jDXLi1dM*fmD|O!{ghUX%E6`J zqIF|2LWNh}_+`xyA6&VwEGK{W48nY?zgsA@=xckIqi?2`MQ~8;S}tLVe(GmY z;~Y-sPsmEF$E?)Su<7wr+ADYV7M3~$|EKqfM@iKmAHq{!gwa)a+rIoCV0hh#*tJ? zqbW(8F*#|&b2ESX0?j_f5&EHyYrN6hxY9M2#hz*&RlgOXX%H&tFTLV0o?(QYU7FNO zw0T>6<&?pEw%pTf?}Sv!W{mvqT~F#9-LwnTwR1)fvBhd9&*85q+gh&FoZ#6Qx-?bz zz-F=XC|^|^qL7zyG&+e+Jf6u7qMJStp6jJj*;>3AcEg57!BRUki#X%vGC_5E!AL{2 z%$pF=vJm`j(L|u(DGK4ItO|Pb>>M$LVkTh(`9R9xV7u(Q^U0lO^J%>;F~9H|_Fc#9Ny>qD zMsv354_^0r*ZS>;c)zL-vv(d3U_OGSRTSnWIAwtrPRMhDLM9=^9A3q>xhrRVEv4Am z3*7!nZG2|ZvKHh-3MQZFTM%+T?TTX|RA*N$K3+GUn>RkDmZx7|6g%JJLM8DjHPL8% zqH}M%w(XZB3L!vnNeMDe=|0Tmone+1(A+tcuT#la?0!_vg9SG7oK}ud&1h+aha8|| z5LviTeyY2PdPEM%s|R{%(xuVI7gcdgu0D&fCd$L`3t!r7Z+~yB4lq3DQg>cD{X+FB zzsZx6naiyUJW>j*R!pc3JoRpgLvzRXa@OQ=vqrhp0#PMR7E_16URURra z;4Sl5qR1h)oFoZc)Ch02I`x9zhyi5TR5JOE4&q6iS5EMD zJ-3+s@*mY~6*;W(8{Vkvd|qC70TnBF)?Jnpzeck<~J#2t9%g>Sfyg4(I6iX+Vh6c^c615u7J5JP|hUgj!q45 zp#oAkxNt7rp1>K^3q2`q^C8J=tc85Q8Rt)7o`>z4@4FK-@_HasTS$}X+>y)SZD`@7 zB{RUC$)1-9nC1B;CBV@1CQ;#h4L2OA7k+KbBawARZoc%?^<)uyT)<^#`dO?~LyK{@ zz&ay!NBX3PlA>gm<=lrtMJ*ghCvb7jJx&Cg9q3vutwe#Z0)f!`Y^R_viA67DInI~e zS%f&?aV#x+LC55}(W6cZZwyz-FSH9Png_hw@0fk}adTJ~!N$}xj zeRc3|4%@h@XQ-s<8xBjjOHX3C`uqX{ZdESOQG$YqerEbhU>1g1t|6c=NDXc;K6b`v zOqDsYXz_-9QT|JOTH)etly#yDIrb%qH8y$#a$Ya*rIjC;8s?7bPkZ!lN4R(w(1I-yB_hI`#cTjgE?EKX5IXq7Eh!sDQ00EMnQb{TL&lCg+Msr*B`f4L>t z)G;HPVDz70&rZF5Zqc+0H{2SzgiY~<>IM2|IdR@VKW?VGzNzdIU1T$W?Z`9cC z+3Y}8b2RAd%S2MFq6;+}`J(bZ#QAMgwg~)f?-jnQygw&9u;XRsxkg{EVfB{-y@V+F z5`Ug&j5$Ljl)P|3)QC$6hbd=!X=RNCMvXQx0zGVL%kabX7k92!_uYRcabCocSfY#@ z-Ww8C77S-m@ey?_Jveg+=^fQ@QnKAlD%2x-OU0=?0jHUs4R)2_wRO??K2f6`#LaJB z7D6badj?F#Go#4mG6?oK+0|=HZF)*b$7d4xPvH^x(~8vz?(S6vSi1#k9D3~bJX&YU z;V8sNjg1`T!=RywWDm)OPCxQci}$1X;F-9-3m%D=J?g~p`I`4l(@Kn?I7U!z6eFDa zOHF6z$utO`7$$^-;0mf?c8_2e)-Yda)H)5YZ8Pfqq-KeQ9(vl$Vc)BfJsEh!$z8 zZ14BK3?5 z+B~^55!0UBS+b`E28-Rqrl~)7Tl% zzv~5{PJHlZrbhKb=aW<`5QoB2{K$m?A?jVUh;dYp@K2@^aYRWIf77{hnxL%YfO+(c zSdjufTWfh)dJh!4-W|X%WIpCVU&xVMP*ZNm*)zu^sJhpkLNZ*{YNc7o2onwXm0Ns1 zVYwlurVa`SNoI3<&xYsu-D|J4n5+7Ho-P)%e%FplPCWCz$|a3~cC&+p__@$i<5TU5 z#5E8dlF@w$_?gMZ`JrZf6ZN`Y-!fY}Xq|Orl$zU0D(Ze4?u=@uCg8B3+xB8rS!r4RLZRXX z4Ttw#_M;*Zj0jO$LLv9|6(&!kwtnzN1Ag*s>{GdFB4$l4rW+dM8iQ+26h#-d*DlWs zYG{?101*oGRx_T&fd|=5&&!Gj!7FZWeZ7h078EFf>~r#&c;$C94d)^8*QGP$cIKOtQr88GqXoCzyG^U;J-(~F?Jv3^~?3+ ztz#7$O8;_^_?sz3HQFJ$i;Io6mCJ-T<;yv`!8%J%3p5voxG?!JkOIU?l7_u)3wsIC z7j&;qh`q>F+l%>Rq=UvinKSf_S`O|5M&ZGwn42>_3w47y!U4=Ez8#`}^v>Cpl)JXVPWnudmAd)8$Xw#};nT)M}dI z&bw(Z+Nu;S@q@dFLsYHy|VR^cPt# zzBPSw>-~MsRHL0IN{t(%+uziDV1GK>{NdSacB%ITm$V$Z?vFa~|L>Pa^dn$}XwA5Y zA;4j}0;v5~Hxd67Xb^Gy{tph{GhO{h!~b)+sw(OPa5PEXVDVafxF8jj>)ga|wix%i zM0vn(kh{@`E9cwc@xTNd-9~X*6)<_{!%+{$>0JOfxpGG zAxWgGzfvR??)w$@OB8JD&LJe(d&J5cP^#b9=lU^0jW%!o5S)tL!ARq$K#|6DgA;NHZIjSUaD$cS&- zKvd$$WK)^-U<&+Y-0%D{;*n*Xt=g4~N5VEGjn><3opi*W;o|Uh2ytHl_(4Z1|_`DqPdwYF}?lm*AVG>ZG_EU z>@BNK%v=~4vpG{ZO+6LazcU)^zk(XHB4QOZI;$u&zIqK<;wyc@o8ftli7YnGhPLGF z>N62^ZKtRu9L=!4)D*!&2AURF1_8%OYee1ef4kMc)t*Tqj@*Qm_7niOxG~G?xzv5y z<{Z&&R(z3@!|J)t}+!Y*Pn3 zU7;$dgxekA0r%s(K<&g#O;sJ%*ba>>bk;VGIK<+M8dV!tJp@_^(li)i1t>h+Xy*|5W#f8obyX}| zw)okRD&OiNlAWgJgh%knfWcmp-DJ-yh>LIG(#4?8&rGr{4f?Hj(!DYEYe*L96!-je zuJz~poih1ahX3XI2#1M?M$4fi;x1eum61b3xJqVE}^#lAqUz|7PZqBNL;ij)#i^Mf+mx=@yy?G z?$6hGz(bZeP#`(L1DUgpTuBhfD{pj?>w_vtV&}lMuAX~TP!V9)VcA2p45HCff zu=L*x@t2ZA>s|dz)I0%d+`Q9pC@mt6y~IeBi|FNULi$CKUte`lx^(OprTt}nt{na& z<@ZX$kd?A1Q=?Y_8Qls%>l3B~PIUu}#TB6UlK4QjRppHc+H4YQ==br{l8oT1Y=Fn& zKIVel0;L-L-GkKOlvLC}dnY3hpGEl!-yVl-^EBaMXySJvi%T;R{SVbXq~L!|vZFGw zMgRK>?~7XbV+!&TK#o`NJc5l^{Hip>&zzMdi!|1*^6~8QVI`(RkN$4x4{=Q`buxpe zTOIB|J=qya$4lO~A&{*N7C8$l+{yY=;RTpn?hG=0WyrJC9!HbXkGU6r3(oxCaxKzJnd12 zciVU9&pYu&0K=QOrv6vZke{Ixv7t-z+1U`CK&Z>D@uAL3GoV@6ODbL*5rn8}^Q z}|)e{X1}j`;ppCD>pCYHWN4qs>1#wf;r<{$QzrM@;pJ35{glQuwCwxV$ozK75J_YDO zMNt`^`KZy*wd6;?g;4ny4@&OsYu&Ndix8>vDdU6(ACJTB*+DXqT;k0drm^9kQ5I8L zk|AY0<-8(^{X?wen22DCZdUhk#wEm|#-XnE<#J#9(P9W5pXbz@w(Eh@$;foN7OMHDvQTY(}5ymO!%Hb%J2n@wm+mG2fxbs!6 z@y*ziuK)`lddT7M#5-hA@@J;t5!W;CeEfZ=?Q$BL0zdqoVAB1f&ovf3Ju~QB$QSC*HxTFDf#FBYRC46~%8^0mx zWRupkD5K4O-a@io;(SzQl${Q^FGIqhaKzxu7nqn1^Okj4E3Q4b zh%bUIc5M?9!9^!@ll|8-&AB`fhQmMvBX-DpbP6k+gqU=) zJYVJeu_WzaWC5Fkwze;xMvBJKQlmXGfc|b~C;*6~46_rfAXreX7y^$D+cwExNp`LoBrIQ#$rxn9hyAZY3RmXjl*PR&QNEa~EEWX!6Z#?`W~e zF4nXpH36%NNhOSkml#}yMo&3*Qj7ojY&x-8(Eu{4SwU8-X+!!*KHnDfllypme#d{) zX?=6nt{M*%HPvsSW*hVlw1=BjYkS+v&$TlBk=b<&qz9dMg6^_=lX$|;@xeDcOD3@H zv*WlUFW49CNW$6Ywvq<7Vdu@tbT3mC_h2^<24_@uQYq?fl=!iF!>dEj2cRLyJDcO!7 zVErX*p+p~XgOu3sF8ucUs#^QR%M5$KhO$4JRV^93bLvIQ$sObFO-&&2;dwfF)hm$3 zH+_^dUalLXhdYa&c`g~JBPtc8t;c*$#d|_>p#YzVBJIkpEMOm&3mQ;)w4c_@1jU)v zR-CqiDnoBzWG9>7ehYc@n?kTuzy^?B2?+^u1!f?#;CbSLu=4!AY-0Pkp!3O60VLhW zSOOG=6(X*j&WgUtIhEOY24ZjTU<~!Vxc`uXExwaC=0MTTln7riB-vyR!xg+W=&eH_ zfJx*#A}os!?q$YbWc>Xk|D#k`$B7~AB_vA~4N@H^=p@Zc^ydr!ibM@M#Vwr&I_T@RB z)3LiZRs;4vFisDH*ErV_k&cJg6xg1Wcu6$zE|&#o`wt{)BGY&`>1 z`j5vHTb>yxyj%Y!d}F!aX4G*+e{@Sd)w}c3VXY4i$A~;R&-VRQx^|Q7tMJ@oeusX& z&C`&oPvyMxfd(@7I>T4X9;FBF7sl^$DRe5T-TA6c;qXgzx23q_hAv^#z1JTv$A^y$BXl> zUkUxC^{K!c1MS23>Ir#X#gUWsCltO6)afs+dsJLnnq4s&|8vCD?)*7o|A%u-i&Mlb zNKDc%Y{}+o?rGs@9vgG!R`z}ka zuF~sj@+HK5k#0d}%2h^~Yg7vIZT#{^;P(3Apv;TRqE0Hez@HcF^Sm-`dbHz^l_F7Vm;25RhJ8MSvGh^9%Rz5z3elcZ;*yvRPf) z<+U0-oRr<5EcXgJMd2cLmm;SQZZTkLOJ|X5}xYX{zgK8_yv|6Im+nd?==) zyKFAehBZwiG{MS5as^yMD@? z);>~(ut21P{j<7-mYamu`Bq9~J?2Ab#FTbTVfnd!^a(Csu|l?>|L5a9``Y2!Fl8sqgod`NZ`;iEz27}h;+RsOSwyX+7F($!462iB4on#I-8mrh^H37+EZ>kyNW3)k|9ksVlcd7)k9 z;{#qBCF)Eat{QMbeszjwA((~L4b(m&+G(Ql*Hg5dpHI8jh_(LNfa)5XaC0DkUK_G@kw`msjK?VaK3k z|Isnx=*&64+{f9G z9*?o2+l4&`ECXTRGz>VElu+J;m*bhwJeaQ4L6Rb%3SjB?wt7yL0c4KKN~6eJ^12 z^&1z?nTm?LchW|?iUn&dqpzo;P`b!ro}8zaTzn~e&unO1Cz`s?MdyDDvPw1daehHp z=c5)DrE`3|%t$iPVi3*&-1B1iwCOFj$jitsg_koTAl^9hz$i2R(Q)#l-xNTahhJXt zCENJ4HN06u0;^nqu7Q`(L3TFs&}kI({>%iA7F{O!JY)+Dw$SQxfET=<_*hT=sj>f~ zjEOl4cONv2wF~rp-0+Q)DgYuXolS=_5<3!UInES~=pTNwVMZk{+cF8ste(aD4M@Py z6nx)L;HBo!NN2<{4T0x9y)jmy%~NRpqlx*575AJSV(tP>IgKqW+o`=~=#ub{5?4fp zY;30ANtHJQliR9aLUASH%nP9sx>FgRrA_QRyhE~cYM$Ip7${Vn*)B7!igm1)KLdV^ zu8Q6hVO{5$0)ec;eb>fqgW)|=Vj0ati_@r88<*DJ&=D3DYolM*Yz%7*8A1 ztGpc+Wu$kTy^jfJpn9RneCFoa+1l$(ms|&3)4e|4AM%CU>5mM$ij=;=y1M*)pDtoM zxDdL+NS0V+nfI>rYSuK=(&Y5})>((_4xFGSqCabL5U9hUIctsA$_S~}urcB+4hc>7 zb=xgIRR0IW`u9Ha&s$j%=y&e0r_1_wSv%@`~nW!UddyY49esB&u^6>q@nH4*!O@Le}^)u6w zPt619nT7YTnNdY@Pg$$rNU%&m6X_MI46n?8l^9K6_mbj*3+w_5pY-F20+ z7wS%A434_#mY1TfV_ehzp2|flSCl$$pmy^8y@Zn>dvc?=0_fSs>A47Ghe>_G?vt4} zJ)o8;s{x&gkR>QBzYySM4Y%JpP18M*lDqJrWYVgBtF|oeV19XJuFi*%!7c(5zYS?X zXTD`Ob1z-pSc$|BXL~d5aFke3VC+YHc!!3D9;kVZ9yR`LdG8f36X{2Gj%&Kr(zivX zOZlCgoQjGhBL`tlQ|)XDvJ*8%a-DC|5-w~DJ>W+UoGGkd;4-F_7>~X>;v@cgnGtR1 zsZ&)i2Hz4}ZzJwll+Z1^L&j(}zw5lEM*1h_XRY>;bIh&*7epgB4=91h(uLAKf zVE+RhBEh`8QjqTJG;DP=`0j7F$*A3x>M*IYE^dOj#XUJ{tUm`IU!LoI4zqPVGTt?w z#PQR9Tl73N6p?N2(J2TuX{bkamqm)uO3QFbK60Hf#W_NJcTi3jY3N3)L-;G1J8h4% zUz)qiSzgY(&(AKFX}Kc-9^M!!3t0*z4Jp*sKqGY)gv z!YoxP4)?Gj{9ycI)yzbGf|HdtgvGQ0Q`^vCZw*Y?XU~AH|ziMD$}8 zLSyG#+8wNK#11Y|2Zx6`*LL*Z{_Y6=+aEYBzRW$T9#xZE6&T|2JJP@hY$AKDZ;beV zW|{+JUVe=YP-V`+xoS|CWD$tMCt$0KjGG;XZ85 zD(>lr&7<|NA)lCEA8Z?cX42?fu)O)1DX!hfMBg$M#3fSOFqU!HQhp+?miw#0n=BaV%Qh#jmI$D23Fmp{!_IW; z&N&oe%bSXKNa}c5S=rqOGisXc+x6+`2`gl4K3YOn4Jeky$d{_( z5;QCQ`~~Hw61(f16zar$Gg43PoU-^$Ggd5SG_h${JGVXpejphE2(VP95Rbb3w&eGU zha;Yl&W-MguByS-O(mtGPt4ka^SYJ+51IM+uu2^1nqwn#8a>ypE+Wj;0imn+)xZkG zJUt_~*w=T|xk_F^1Q6L$Fb)(e9@H*3)`^S8L*p)2Zd}q6&&OLG%jA`~xEy$p)6u{% z3@DF&Qx<*;ViDAFE!YM$ke4?RY#4D zZPhE&c?sjean$+Q55kNTTTd_pun-BqMNg2fvSdqAd01r zYH@k$G00JQ=YwSK0_XQkr^J7^PmFHy!?4Ki#6pk-a;J<`JS`|dmA$=xqynNTcPmpL z9;q$Y0@M=a?}=dKU9_ZwbcDkTe=O-IbK01h`L(D7Tbc;kv9j;0pJ{~ z`ER3Xjv-T^QMAtYj0XOj|F}E2jqveA{6(d__-$Dag9msXRIwcFGa#idQh;7qcj|&~-}7A>a=ml!L}e9KxTO-f1i`zCL!W3aEK&W@=cmU|Q=W z)y7nqymBi9whn^|SjV|AelIP5oE+B-58ICgcBV0&R$Hzxq&xZGHvFl$ModM{ zNsH~Ne5#mA3|#{X1)Z;+Z%g(*lQL$dhxmz5(xV$?Vti|F+J95-IU~IFI-iK~HEzen z>Rfv<4^LGXUssc|Q6&i6orlF_nt-+W6W?jw0BV(@=cg$|`dA{;A$TKi%euIG^dm&w zrP7OC$D!2NgM!8pTBdl#P|k3QbzN~{>1-G&%0!**u6!KFyyPqN98R>+I{V;x_2N=; zDlXauWrSo0HES5&kljxZYEc@x-@2goVJU!m=T2r}dBNslrZz5DDY4;A*$jMg6&Je3 zDncnwzAAs;x=C&vFYI2;&ZQ`tZfEP!t#d|9G#?1ms$KFjU?e!0v^8LBNxE{kxWj&0 zEO_4ylOK~AC;F^8s;ana2;|9)cV=uEnK{C%iPXk5Cs0tPG>ddBOX>+(?SrjysUC!i z=sZR=(nneUh-C|*u&jpjrN=wY`&|96m&AJK5#cJFfb+RZj1bIie5Ao?A_>I5g73V{jAa-X~uPA8Gg?K}dh* zpN}Js3-PPY7-Vnjp0~heJzo+DO|cvPmNPHKf5`LYDGSFnb!+pj;M)mCsz&LYCZ|G{ z4FFxEk@QGyKE5m80y|;nJY{s0h)bwSN1{jpMW}<2 zoX^FtZ6A=9Ppnc=QOPg>8Fr+$!z;t5Dx`7EJjbkSy-KqN$mc!lyD0=7niKzxc7LTe zm&X`M5iJTD6Awh5xEPegd_w+EeozwY!w)n#m@j>3co;a5MT7QRS}(9{PE$_9N+#(w zu_jK_dm9aL<7U#|nm(A2JRcl^XcEalokF1rCug)M6P9EkjLpj+Mx;QAyWrp<5a8E5 z2#~z=Q&eNOQFlqRhK40~Ow?>Q*4HZim4@X&#!GMMvT1{BRYheE5o>mh3p#S@!pL^e z4IsQWv72irK|(|)Q68bd_XH{sm?yB@rhS6il?>} zNzoN^&bWns-8nBE+s8cJ*Oe57HZU{NMomPb5^9!i&(qpkb|}_cH!=BOUq{e}-;+Ro z-P!}}Dp%&}79xgHLMXs?xpA;W&}#CBrO2GUM04HTfkbTye!C%XA(W75Gx&T(R4&__ z=H)6oSTnyCc6TQ%&^SKjw8aS=-xal}7_Gp89rKOYVHawTZ#Wb$UO;)zG}`|^UlaZR zjn(7k2c9mWo);9x(p&LSBGF`?*W#t5l17)c!Qr2Y0LrtlS7)s;&L?f3a#dNQcN^se z5#j((N0!e_AHVfEZ;uJ2%~h$d)VLeB1?8NDK;e=x9p>|#a?IDu$R_Lx{Au>+u(C-y zp+=GDu70sWS4^%{^lHt;ihf zr+f%c^3u9qov?ezk9a6pt5akVnjXbMC_`gD`XfY9L@RsiCdC0m)w=%hs2g#~CemCs zGQUgjSYO~u<*D+k$*FmNFJv~el(g97;2f$lrzG!4O&nx*y}~TJ;%GPN6ayYqQV+>L z7jV&Rc$KUP7L3#VP>Qb49iACrZZxC8#7l2Ff3Si_X6gR>2X=wu68vAQGzDOS%QAF3vOK_tj^Oi zGGyz_$!~6|>pfZY+8$s7#YL+Ge#cBBz?zI@++{=e8!5xCx8`Z{Nrqkq1up&0jyu{@ z11vX=@BF}Yb>}x<=YLdMa}o?A;I9K;PYqtMMl{lmNt_`A{8@3b31LF(GKC{UJw7{7 zPCqW>No3V4=i=xvHoN4Ni+8S1+@j?7b!%inGM0uCS6yw2Y+x6cl^v6O;RL})f284m z>ofmMz#itWX!?SeUn6z*3JZqCuDw$?C1ELbaA_ryuK4K8i<1BT-T%F@Kf*cinQ8ln zDyy>AgXF2MDsQO1!ZUKbf3Q%Up>uk0v=CL1-^N<*#-MRIBMq4CDY^aTmAPT_#k|_? zvZ}Xn&Sr38gnf61)*PmXFI#3AFT!0g>j@)@KAc4Dwy?i^VgZjN@rZxgoBd?2(q(u) zHw7tfOGqIwvwhCaw5Es%XLp-_WDwoUEp7b^Cz9No<+G zk|xZEATADIeT%6jtrL=#JR^|t>OxZNbMyQQA8%C`wpUh!?5v1-P&)Cb>|wgU92n1h zr)K+H6)G+XpTme1rYulClo6NE^qI-*TW4Fx$=#w3;NJ0GjrK`;c0Zihp?Lih=M+s> zCM?K8(!W3qEYJ+)7V0WWs;usQX6Zy$M3c>RBeh6-M*@NK=t&@;#@1l=qp|zqld%={ zSCU)iKznK)x`2~sGYgRtAqv18ELk11e9_7%3AS!>Q#C~F45~%M?^}MTPB+J z}m&0*VRFXa{x#6VW*I5})afDaP0uJ?aw;E8%6%WQV9Twy6~i+-YHOPw1CpjL=>=i!Q|jr_nVIv6{@HW5By7S! zN;PZOr_W4j#W_2zmuACEffe|n`(m$`B?|>w7UCD2@TOZ6#j}H5FjX$9&ct;oh`!p( z_=*+#z})UiL;_#*6)~%GB?@3IqPr$s$pW47&2=MFkZVN0X>BNxXcMT;F)vg)1zd{% zbOC3LM853vbBk+{Ys}km$49jr8af5#Wk_iPfq{{pW<*g@QT|vX|2yFb?~N*-<3thR zYwy;~PWDdUct8#Z!Liu+a74jaPGIdeca#2iXs4Cl(sSm*%RPE1Ah4@z%h@>_XI=C# zc5)D%*y_RfDn%DbjJt%Eo%Q}j=+vi)bAy7x(I-UB&K;FwQPPPeM%8xj&|BMO_aIM1 zT(*4Ptu~FE#l0h$-)2NXBH)#hs2bXcj*hVM;hyFiR^a~n$JiT$-5s1{O>X)t_wHF9 z!Z1h&qIm#1xYj=NK+Od@Aysnls zmcyl6QY!%8ZgGLLs*|vW``TXExnt&7Z6Gvm*JO<@es0e*z9Q}}Iud!h7OD?9^-Hz( zyWQ$g-)SljU!z|ZDs{jrv@QEO;@Zo^gA7e^MnNF$W}b}OV(*h6&_|4N-zl=ktn!Fm zK|zR4qCm5OA3o7U1xOhhHDyFuZ#XuPwcn0WsFy48LFNUz$RtvZem_^NN@#1|u%i`c z`4w=TS&g-|18|`$WZl57MQK&dEV4p>lV0%7x!q3kbzUU%T=+|JDT{jK33sDPdtS-R zd~4HLyPI#(HUir^j49swz+@Q|JNDWGe^TvEafG2!Vw!P5hkyoo5m!TfZ-RF2TiZ|$ zE+4v%ObRQ1tEaA{dVr@ve32;C6+q%6I41A|?Y1t_}`NsRxwZm1E zPv0?piVon_<6E+$Lg-|_iW7X+S@|{)K9U%JPB8b2yuR^-(1`846qP&uImp~=<18$U zf^Z?|LyTG?02XKvHa$HxF*Sma>o(}aCK#s58=7IF0n!F$?UIMAUtc7Wxb733a)gf> zXOdLQTq@6*z|-<4xcqW~BF6^ckT{w8M|v(5y6Z}grBFY4^_Uc7N@*_H)v`6UCNGbO z+cMMFtMxkG!e4Oz+TK0wpHoYJ|Nb*&Ss$2C#8<@Wtyc9(hl!n2TR&o3OXrWS!eOGsASaoA~+3x=Rrg z;+`JpN8;u#=?wY~Xq=5a-dnmMan=?dot`k60qJH{7$3hZh{=3WY-WC(Kr{&`HB$wV z_!aKq{Y@}~w5zpc!SYUUuft#{<+Z<1vK`gG1s|AsBQ1@4eM-6+JqVnGnznD(1u5 zYIX{c#`qS!6WXn++_e!i_m73kP(*S-I%X$dr$A9u_8{`rj<=nlheaWfPa54l0o~xA1CO`EKWt zyPusGBe|7b{Hh)}UZjoi4g+7m4=GgH*S4UrgK=5Ag?5^zh?{Nb!%Zac;IfbbKRhwk ziEXms;|MC+L-i%FgR+wPAAKv(78y#{D6!n$7o_b(pu_3Fz@7tS($bcG~U>VO?5UUE={|ue7c=lE;5Qqn8fSlacWYl)decxeqzUxjOY0VWtnPuX=EJ=&jPOT?6-Lg)?Sq(;u zv;@v&9nwj&-wF%O&u1Gy0R}U>z)Y>><-ytk^N{f2GNAX%On(#h4Cn)JY26;I2Fo+0 zzK3O#Z41w|angyJg0I2x*+g{jX_fT>o3h&l%?ZWw&C4cmmph~8>E+FC6F8tSE&ziQ zLKjX~7AWpj(w&ExDjg~Y^u?UdayhoJfPlN7L-Ham} z24Ykw)9j?st1yoPT_-?tYPPNMOVd*JZ#%n?=sW+pfIFyr2$U*EgJ zQf;>=%sTOcOQT8C@JlH|!g^TO*gh-MersXfh6~7O&dB%BC1lPFgbUsW2hncWHf}C`Ns0P04E*(+Vk?Zu`i(6)FT74(5+^Xk? zEZaE@h=sj+NH-9Dt`V{j3A1BToa6&2M@2n6)9mW;paE38?qooh)*O zBFVY=^5xtidy|J{($zL&(s{iR;rF|HEvyy7)_RZi3lP}SXV?`5*~TYQ!rxsw8?E1> zajG^!c+8I^-RC98AFh(4aQ|6n}3aDAm&(D9Sw%(c}=^Bco$_FW!Pusc% z8wep}Tm;jA5IHYg4CO;!{me@bVmmPjzFO`ZLYznk<&?lv@nCnnQM! z-gOs-JXg)%&#q4t)-Z;7>IatK>>QBxlmm(Cxp8f4EOW_?eQo{`D`kdU&V@*f+_J&u zi*_f&rDvpqk$2iEGK9PKPU9P z9%v*5ha(~J30CKQ(0%td@8t|Ht3j0%qx}3=^HAOe#MJL)cug&t_JrU5gn0Si(e=%t z-@ERiS7NwL_0pz4-!A(mR}k=l>8AD7vS$^o;v3W__vwt=BVHevh>@xf?svuCpEzR4 z z5`Y&1vojBc?AMZSN)^>G&7slUBz{CJ6(OZG6@v$OCGf*iChxoZSkFysq2< z0tmeUG?FK?ES)(Vslo1(VZ{g(CAb%Z<>VkbL(vnW`CYG02tARJU239v*Oa6u%|f1O zJL5#SkDR>LcOT!Q5V z9BXni9=dXU>syA&PcJgD7<>{DCPjBKR8{9xoKd53W8exPERVfY9RX@J$S8#g=#(MU zOW)qx{eda4B+*S|*RVeyOD&{R15P#R&ub2NjLaVH8Bg}T)9P;=%7W?D8?rVy^^oGZ zF~$4cr-3rAf#{)-$aYiqzHJmCC9Q zrky+3Jn&#atse86*Wp=0D%JjJT}c!;8iN73z!4hiri=E0-F(OLlmQFWh${n-vA#Hr z5K_>l%>}aZfyretE*oo2OW>*X3kuD%Fc0dHVERJi&>|m@cLXsH65``)44jonTCwe0 zB6df}$4MV`#UoD^jb-t3th9`zU}gA^J>55O1$Evs+k02|dY(pPhWG6EL8R*(a_wbi zL#hd@N#pQwc?GI((v#1T^RMs!Y90RdYw#Cf@IQGm{Bo&gV{DZ9+{v(DAHwkD0pB)g zA81M^1bOQf?9BdhejS(_G#d#f+4nr)Z z6}7aayf^d+w#2F~qu(T*C=}wUi#w<2=tPL*p9Z%r>f1HfAnqx0vrKQJ{Uhu$g4j9fiX%0Aq&d}Qybn|5iHXtHNP1Zhq|XxDVw z^A{+r2Am^D!z73!4M&IUX9Tm&L8T&M;SZgT9y0l`IE;7@LrEyWVV+P$ z0uGN80mx~{v}H41KB$wfViFfa?3peue{NwaeEzx89B{OQSn;uFF3vG^zbr@j0!p4Cds0gB> z`Ez!qAM}Dx;?ffqAREfpz6AVVJLZpE1q6G_+3b#7H;GhxwT3NxMzDEBc+sG46Q;#$ z$b%cO|<~2Ki1wV^>!u4Mo zH?2;;E!$HiK`p<0te9u6w_=o1cv(O0eXPQm|K493hmyV@mpDNzTNrdy7%05ofVXvv zmRpw!Y(5(7R{T?gQ+ekbYcU(ok(Z-^6}BIko@(_iIC?HRuw%}0{nC&K+xxuByl1uU z`v&%Vv=2;tnZ?7StE0mr;dJ-fMJE@Wqz@K(t-SkI}ZVXmRt!19Sx z^-qmwJ-1FhFp5D9oZ5R9v59_dk~&?@`=ARQW%AuIS=+4tj$aRLKwB52%~iQ z=LYycBh00L5a!&M5$0zK{YQie{E0B9-~QY<^Y4WDl_7qn(0`vWKeJBEZ*a_)5awq_ zk^Y5sK0%mYSm)n4=2yb}%sRipF~1V#=LTb^{NEfS{1eAKi2J$W+jeV?M<6ru;1MB( zR1h+6&u$WxKX>_%yeFbjR@a+_^#^aV8&m-PYW&l-{J(+y$?W+htMK!3 z{MNqxbrpVh-~O^)|F`YiuY~y>N&l5FUkOwAi{|?x75Jxf%sU6c?8-;Nc^&;Ht$bxJ z44m_H?hH-mz%^m!DgM04Lr;!Tc8HQ*2} zY!H(*q>nvc#yCniEJH{!|5pM1SJ)4KI`RH*!|JPm{?YXO4U6-?L>Lpd8z})^@W8~B zIdWV!8(BYS5rXo+opRuox&10CQmxb3{disO8EC?q0kn||( zi8_f)2b^=kZ?aZ#fnSW~|I!rx-30n-mHg;V{XLB4|E1+-!Wo1r`Wn&dg>m;d6@I+D^}dAaJK5A^8bd-_Tc9&bL8G%7a;k%A--;i z|8PV6d#v%-$k8uKkU1*6lWhH}5r^!f;Hp3X_5;-^x$+%a#(-N=RXjNRTgyuPwIpXe z{OtALjctDA(61c&-{a8Vh=%{IqiSl};=l_R>`(T1Oq)p@`#vM+q}xM~w{R|qMMHLz zoHlU8=4F#Rv#%N*>p4<6;#Ot5>d7%@g(&x!{B)pDIdxp2-$YKf=TmY16CY0<{!J46Z=>`7r&EWoBI|D> zvbuzCQuTzTSSS*)6kOAJwh8^XCK!lid{(EYGJ(fFq*(m`5755#sQkaWFP~!bzwkKg zD`Wj_80+7Uv;KqwP^(5uaH8Wo(OloH2lh>p4Z_-o3r6)oxwpDXv1*#K+9FEGI!>p5 zN?9np0F`fQsOrcyi5|xpDrt>R3(1ep?oUARMwVu@Gt#h*BOFJbznYIZ$Wd!8yiON; z)m|uX9Tb8JVsq6%VB>JeMtya0b%{)m)C+GZ7nu%)&42bNe&@@&Wx>RkZeav9NRdsp zuE1HB2_9v+$BM6(r!s2>XVt-5>^`&O&h%tel;hk%N*+5wz`7Hod~_{4N!78FFH3)x z-=TtLyIRnyUUFQ)E$x+d(Z%KRUPG5KnkJb;FQUv!?ndosu=LVMgLDsX{(CqyYnOuO zgFScdR!87%a%TX<=*iQ^70gqYb!55iT*()7A+;VyG9(K zI#p}$n<$E)|4zeclEhgAdPAoHeV<#&U9G6j?xL}@sPD-*nt2|q$5!z&QfBc=#_2j@_ev#_2{)70(U=&#J)Mc+1q`I zwU9?3Dp&Fq;i7hYM0mF6!OXr7Ox@V5wH76VxrM@pZ>uh~Jw4H;)%Rh>98ME0(6( zwlw(DL}kx)`_iq~Tq$C<+vKEYx1|MEHOgEAIYfjK?7`bp^7C<_3p#qbji8;vu>1~6 zP_jSpbjk-N)?+dLrM36y>@aozZ#U(qAa&a`>FJ;f0(RrtH;Wl5<7Y4hPR_BEdpV&{;r?vF__$j2V+p6{RT0zq!ST#y<)>eE z2smbW=!#^912L;GIRr3?;8bW(mghE+Fh5jtL;cUg^9tvP?UCHR6ILlnX#^L+bnqdA z(jUTRg-1-=gNIAx5wbn;4kIQK8VwKTa{2_9(MauHWQ^Qy9%&1Fkg@BMXd;~5djhY= zxPO(N@cp7$l_;0n(b_%)DpxN{&Vr+}t=nblcv5@dU25>#2LbEaNeu`2&rS#(I{|)Z zIelDa>Y>nlud$6>#AJvHnQdYlXrKY_ttTxlEINNCF$aSJ$5*&QSR~f{;@yZk>1kLv zcg{NvRO4%IzL-XhtdWGQL$U+4#rq%L)z!N!h35dg*-T;t7d&usmFTWIrAIF{AbJ=WL?VPycpEZ+Is6r5)p4KheTdI zSOadZQF0};HYO~Al%dNn7%!~Fz-^r-iP{$8@2cUVw0P%9vjyHZiL-tk_a^OlJy<+9 zyp+U#kWFW1$#7zI5l4|U#K)o0fV2*#ou|J5?}M^Ho>~nfw!%|)<|!#t)B=z8A-ZGh zqJCbnq-!6VLK3KO$x^yue%2^2{4iIc+2dntdO{0(_B_`Ma%y|+ZJn-FM|v?i0YB%2 zB`wdy)PVuwLp7$KH%S<%iBA3C=HJ!xW<%8sqbh5Kl$piZcx+sdMN~g3D!NDDdMlGjN9hnpT&H2Jc2oP+-cECQx|xT|NQ?_Tpwksu0X%Gn%NVt%0@n z?i2S!?u#?+(*FGXkGELVp<;w`V3H+5Z40(xjk-N0E}2{f;ZHJ-C{^tMX*BZo{v?2^ z&7QI0^b23*ugD6uytWN)lY2^xkW}kGh&)3-zAEqVAc;O94hq|S2HQ|cJFTG>c zQVlG_<#K}cI@cS{me)?OR=m;(q~T>V`?oRZmcH_IGxHr)E)K)-*3Fn!B_4xf@sMuu zJGx~qMX{V@vkR;gxsd59L~$I7g6V-(mq#4&R?{Q3Bd3pXZP3XTnt{+n%Ldh>p%7Yv{g7Finpt zt|}icP8QTCD8ZE>Z=MZF zdf1>x3Yx;+iGSEC#kcB`;HF*#Da;Huu#F`uy;BT&$yD`eGX6BzZ%$Y=pJL0*HS)_b zKTy3Ev1ho%WWp$$s1O#Gergtiy9b_u`G6<}c$|aX;h?i^vMu-wHoPsn*LuzjGeHzg z!iJwjc5gj%EN+~34W4y3Rhap}1UQZ(rKH{Z?sMe)>-+z}?cP6*><-y_)o0q)#i^MO zB-llxHhMZ#C)`53uDXC(G>*z&Y)VL}=_opd;c{TyT}S1@C>i-t zb_O{pEi|5s<~AoylHO()hM1ZHK^C%@cIuQS zJhwt{o?_}ocZe}3zFMjv?RsddTln6w7F%0>_}SbfDcT{JJ}OD}Vm5lfsyp4;ix-+F z5`vooo?TQe!sPBU@M|xPbwg8=>c9Ive1G}8+8$x*a_13Sb(3o$-DkK{=HXqGoWBA1 zDpN3I&H#H4f`vPdoUHnGV7O$Mzh6j8SH()8)za)aH6ktWshu4(Ys3#D zIuzrFsiXnw)3w6oxfAa%8yhE;W+AZ^hkGBXALhEp`)%`vwT^aVq^|XmyH%3-j=&wz z+r#qkLY3GOz?FKz z@t*Mx`qESjG?kHlwq#*y@Y2Z1V20o&9n34InyE_W95NAr8k%Y)M!-iS%j#z*E9m#n zroV-i$v1V=+k(nU_^wFTcA0+GYyF79zPXFDw_C@A^;;Wan0*mC2;I)Eu<%?yUfKf# zWrI?a(E_DOtZa|-Ebf-?iN{ts&PCMSVB>6~fL<8L1%<{JPf_#L?f`gQ*kUF7W^}ji zvp@2Ni(UK(;PWj;p_A~?H+N;Ru&5#X2Riksc^7u5<@YpI&$6d_B3>^Q%$+a_9@`~3 z`S={-@QH$MTS<0DTtk(%joJVS+sMdsk zx2T}c)dicG)ir*bD&pE2SI96b_0-c11?$h_#TfC;Nz;>LPNJSB^?D3*)U>ym@wqK4 zJ$3TL?WNH|&PwSkBL>^E=?TCyJW=Mi+l?pHn3WGpWg7(w(SX1RC}UQAE__>OqHdxy1nvgRkEx&i1lXMA17lVe%7A9H~P@zZT%v3Yf;HY@jLQ|XQHM5h^Z!di| z>)($Uy4_h6C|v_??cvVu%|c%gq8v;j_Jtpf$b|=KWH)CWsuMwy=3BK9GLUI*KyCbf zoztZ{<2Im$-t=g=-E){OQaOw-ap<823!8+jR-uo*{N=|qpH^si6cO`*$)u#;Cbt{c zt!W+6!nVDijpDS0-UR*wNlLt@Iw4VFt-A(Jj24_1S4KW^!E1vdtJnQoGzIz@X!~u*)|Ugsjn#1(`3B z6wnv652sZ;3h^C_^)!P~!R#Pj!R3T1Kt~bZW%UOOkkh7aZB!vv>w})yn_86n{MzuM zu?bb~lgkJV$(X7{WpT#u|IPpYNWF|dJ{5&c3BCECtn)L^qBwUL>vLPGV5kaK)f)BW zas7fzcEvNE{i8~<+L9qRUYutcyRM&5LN~(=?Li5f`irKI@i zwp_CZfa%H0KaR)meB;Q@i)V-(gO`=n-Seolv~&4dmvBD)6c@O@0CVg7s~{LWbcT{C z4@1x)=RMy(3dSWSR37&wTC2{u%6P){38jvf45<^EU96Sr;wJmF{l3Cr$#ZudSyhu4 zl2}q4Pd1>MD^GhF}KU6T%VHLIDJ^W$gEch5Tbs zdpM!j!pY)vr=+Az{10r79IiR7IbaBV~ z(|J$Zl9x@|^#zi(o#`lIcVBlsD5$w5b!c~NT(}6Ht8en&w>k|Inj1M21V9^} zTq({Q>gwOvc&L&V9>{rTrC1|Nv8+eLk#e>(fmeeCz{2_hZ1V2cy;Jv&q%tovWGk}jQuScD0WKE zNMi*@1Fo!YW|p?bZt3{9Lp<_ma-`nh6RkhVdKZ(gO5>|m{Z+UBzoS(}Am)16K?YWI z7sTccW4-3i2+|-iFqtTs33xFDiA|gWWXUU*r3INU%EFbL(e#~Pjf03 z=II}?-!Ep2BxO_0=;TONqrloTg>p;pGt1x9$>8Ahu1qaneF}nVNgsI=fSUWrULXAq zbCX7EApaGBUb4aReNw-*Ku+{Vt7uB>h?-dnzx-yZp2a>!zDDf6`{3VpC4Ta4ChNZX z0Dm_h;Hww;88^F3PlBPR@aJvB-560GHEs**<-kLUETYp{4;!I;n@OntRUYZy7Q0jQ zdgZaNPV!GNm9Ku`Pl2MpvtM`@4V2ya&bC?a3VUfYI=JVj96a5U1 zfND*(E}GXShz$tl?9ryf=eW9@MkIg&Gi5dnN;>}i;|MaWhP5y>2o+i2fwN4nQ$G`9 zotd`<@uE}eIE<~=ni~;dxouK6Kq!$_P`t_aocS;)Bxn-b8Osi45to-NvK2trOq=)2 zh*kPGLV{%Ymp$~&TZ#y6uiYPbM zfILnEkCiyxLJA3> z0Pd^}QdFwan!?A%^oSg6CjjQ$7d#<{%MVVzmecR!!Z99Lv~?jeXT!P`SE`7 zd)LOa*9o# z;+eFlWsUAQ9#&?bTF`XpQ4SC~j06VEnFG?NZ3NJ(Q&xqc_h0c+Bmq(@jW1$;AL8Go z=a1Aa{Np&^XGgHRuxLZ};a~WhsofzS+-v)Y%SexnvoxnYX{DDdX30KPaM^;7#P8fp z6`74KzbSanuMU_P=`(MqUawdp*=iKysy4Kt#{Gln7502lWM>@3|ISLE)iN&Jket{@ z2fr1F>z8Z9?27v1$o<|o-0x%-Dh+v73A&O5!W%jO`;`>*XL^v)>ynNRDkS01;vP_A z!aQ6K%Gs1=Q*gp5Abn0EFu8L;D55yrnJwS3lkzHCj{D#~ih_;-O}81q?hXz3X8CT4 z!N@DNI}7I$Xh>47&z{cPz1T8U@Fh`})*B>#OUhvU(K9p039$B_^hHKN zpK(7G{<_k_4@?sAGs$%ZZy)NbTZEY2yT&vMxb_RM|KI)pmz>-xScqL0-`x9)Bu4E@ z1<#LV7=SL)6?bDQ=3h;1g)V2E{=n3T+Ft*_WFs88=L1vDl@Cm9Y|p-^4#WQlePN}Q zzKt4%51vn8|j1FX0L^?REG$wA1Jgx-np+s11b z^F!&(ltT9x))`5LrlVlGNs(~b>kWgWuq{hi1zl3l;Ftv$2hkdv$5L)A(R5?6M`xES zNdl@QcE;wi6{k7%843-RcP&NdPf&wXJDqPA8!ABF!inixe883td1W_#TZYJIPkr>m z98aENz+I+Y-+ci!Sc1{5cPA&ZcZ#}l)ks?03=+!gp&17#B?Fw$>%f4rI=&e(Pg4&< z8YXoIMOsp|N~w?t?&pHNe)$E! z|KcJ4)mL{?YGb+VWs6B*6dXR8o(P4+U6%4P-yaGR&|#Dck2KG4f08v7|AEOp@%tyq zjxN<0z7asPLXfz>+rk}2L3n4iMZ`AveGJE{En!NZ#FO>CwnFO_g^SbJ=hYHTg?YD! zGg$AwlDrjj38s@FTV|x3@mecMFD+;Wlj$+B)`C{Qb>hzx_1_Gd?`lqY85Mvwt{rj? zrfAKX_tlmOVdUrLlTjtwj^6!&m1t+VcU5&4^(V6t+Yyb%g$A>%dceeFVjuiy7!mGY z-^E9L#J3DX6$~X1o;%Z!mYC9Q^kKUt z)2Ke5rd3?>v@vxH#i)rDvg@qVNWb0(rWo~=wvjCN8i%-+0V-sk$??GR&*AXj>A(C~ zBhbF{Kz@UF4Vt8i*rl4#4CMgJM+uZ=5@Te{wFFtT^lZeQ6(`!;VCp<0 z0^ah)h6BjrK01*vYbd(QTV!eN;Wy#x%*~zsZw+HgHN+{oCTE2Nr*h*CIXwHW+KCgC zEez|4cB!S-kH^U1tp-tA%98+b3Zohr0h5A%gGs?*o;2xs&<}=N9gMmUs5yX>jBpW> zNpP6ZN+OfoL56+>F0VwWJ(p+t$;eb&-79u_vY7=L_Gu~RY`2eZ@2e|P70qxM7UcBs zq02A#IYr~H@UM2Q2nU-KrS6s=Oe;GO;0X`Ucb!zm&jRe*+Mzk77^@^jB~BKQwsd19 z%Vpqg0=YzHtfeRlCvGP5ZuPQxbc&l82jb=T4hB8N{JwbZn+kB3igHN-#JSvX{88Y& zS?wIIcutp_g?ndW!lH7^Ic*fYYb(X4NOiR5ruK7gY>IL-NH1HM`kA~~X4b%~vJwEZ z*)34n8n$BZ!ZSxOrL<>P#pvvY7D#Rv%Mn6}^2NaXZ~>=fn_*wWIv zpY@8ZOgTC17Me}zFP1MY)q=q@9X)|t(sBT)sg$xAn#-U{eCC13b@Bx2YWt55IGfZI zCsrZJD@n>nBaUI%Zu0Zd*1AXqfvIc>Ypl;1#oogtT3>dB$s5aeAXNz)eEumbr7rVR z)w4W#>Xh%8j(*9s?sms0`A<$|BZvCFxm(?O-EShLsL{oVWd#FM;$^sJ6;s_=sFGd> z7$h9la;r{y_*HJdBVAOegdMKdhftX^$vD3pz>#mVYN$s_!&>_jR!HmO{bvWi1omG$ zMk=q!F7&Vx8~V`Vna?~K_~VEk4xkuozyxzt1&;F1T@pg~VT99YQj=vfvZJ1P&yMTH zoXc*$!u%>K@Q_ZTuWP&R0<%Hy!>eoZG4FA5Ee742Ef5*oVv;3>=N5c!bR5Y|wMnM= zPc;^^XbLm;;zSOyriL8e!x;uz*1nvPt=&0>5Wf3bTob==PDs#sL3{he1Wt(?N$Y@s zo#%4kZn*Dbzx(5J_?>SYkF!y-j1zrQwP(t`&lTGbJb|Q^oBJbRccwC?q zDWxTQD1nY7N;KSf24g?#2yeSyFZT48x3VR0IHR--tl`L!o$5kb2db9EhAkbqa(gCD zZ8nKYoS%i<(Z$0$#R^cS1~iWTeZj3#rv`s#2ETsH(N?RLFNQl3=u&JNsm&Iug z1}mhctz0j8r+~{E)F;_mC0NF??1w#en1N9cx2@IkO!kTH<$qx6pB2ES)G4I0GI49B zf1-6sATnU8`e{gryTi84)n3)drDm)UJ=v?uQMA(x&+p~0F#o3-+~<0x>~eG`=d?Xi zpts*#+rUJ}6Q&(R0WFRb{qhRXs!I3h@7}Q!wvvWDWGn92x{$9CI)%1oXc`(aXvBLJ zQ&7HhA&2zLayAj^k%m3kS`1RksZaYyCCi5_^}3i?zn*{!VcVz0`Pv8kt#K3V;3bcw zXJHdV=)u;jE$Jmy7aIi?XWVdnUNf=w3DPOjo6h&L3(+O*b{6{8TR;=3E$uhe4iVP$ zT7%B(wzY1=016b&E_4hkP>4N+i|OGJIivv{g$kb+qQ#D^kfsjFjMXXVb zRcxI&72G}&y=T9#&M>Hl!Q)nWc_~PoiJ_@g?*_YSnZ!F7RT`>hAs`UPDW~JKn0mP1 zteO%rb{iSy2&Qw&32fRNrwTuQiV(jSSm~CSkL1sLwOO|U`yg4CUH;ga6%2C{y zr=+wrrIb~3Sa0Ur!Gnc9b#~D$AxCsH<1WC(wH+^71{(&UUDhFioG~idcr13(i5UA9 z@?+32-eQqG%LzuyNYCHsL0=Gu0ra$NuIec{5+ZxHj^&9A#%~LELuP6dFEjJT(zHu+ zi`^z(*aBCa8xE9kW^d-U)g5Ez=6kB3)(Ir0}@TO0KWA<(6 z4a(eXxe}0(Kh;LKH3TR^q{`AI1qz(NY_N6~7BLRT*K%Cb#%u-Mx;5dk^kdcMeW4xt zD|S7;UIl4IszMPn@RK=HJmXK5F7c-G!62ODZwqi`GZU=eTffT!raOgvL%G`%n6WZ( zQUGX$bOThjZ?0m<}LE^u;WN0=O7bIPN8Dr z)BEmR{#mGmDV&uRIj@k5Y<>s(MsENu^m$~bQpcN^5WmD2-qjb&7m)t)vO z6{(^gE;<-oJO&GP05vrYY;!@u=~Tqs|oyNgal@l|Ug;;yr#Kx_!9Q+~A7I1Gja z1z_p7x;cO%Hxgbf%^blV(-HmNtoYShQh6UbJ@Z)0NSSb~nIpQZ8U~-o6_iRATrg%6 z^&4J^&_4hAp*}r=(7lR^cOv)4Uvj3`fhx<|w&Lp|fXf27}@f;_d3qlWOyeRLto-v;9bu zpoKOZ?Gy%Y3PaAJ_v4m|#YbMC0+Js;FNQHv3aIZ++^4sopqCptuNCuP#70gfnKD_@ z$RpqhqfBIZr?;we~t!DT1=dlC10mxxvd^#HAX6m#Y9JD7SuzmOrC z{ZL)fw3Gr)zS`Nch6dIR#7Pd{jD8sPrFl$PFHPdpXV>^-1gV9CW6geNOgqAF-{j3| zot4$y7oo&cFgKVshMeVMecsZXz3D22mw`b}`@F-ILpesONf(QOf}L{xIY|Z@_6bRVDOZ;bn!~Hwo4<> zkX=ueED>X%(@aBX#4y61mFR`UeV7G;QdP zQv{L&j7Dqs{qEN3FC@z6hwYJzf>Du8%=eRWjCv8%@15O&=eV|)Vh~PQ2VP8 z;D^>7tEvizaJd5BvcU7_;cS>NSWw!yaVv|ogm9+au0cPKx`*F&+lA~L>eM}5eEmi* zm`Ah5v44uFP+#bfHwP>UR~!#!)R8UdSiSbSX>_g_LunT_o_7Uy>tD6bC+QzuKW%du z1AA34QLMoiznldTrUoa4DI6~rq&+!!o2V;Gk=5Q0DcJ9@Z82*Q?iu12 z{`#Y>3vp7be&_jt>DK$_Ok6%ipF`r$@7LTS&6|Nkjt-Uf))nc3`?ZyL-<_t(0` zy{%brD(==3(ysgQQs0P)0PWTcj=QT+p_%Z#hvl5u?Kt=!xI-Q8@uwHR6nT&J)9HmT zn>*rZGW@O;#Yno%m{2;-1sU(0Q)+?D&))%=)oK<5ZVQtPD+Qoc4fO>0 zTB7E~E?$uha*bCLu1h>(gh%hZ{^&@(V%mg$;GokgwDD-Tx5F53^$7=)2FxAPIH2cf zLH@MD2rnI_a}2ERKO60p`(CjzcVLgE+3c>IL9!gh1{d_CYzBN(*|}5c15?tnQ#mxT zR=8vR>LXpm`HfD>Ye%eM%DO?BP7V2$bt1xP-d6?gol1F-;Bv=4%jExZ`wyZ;UI@n$;r%;C{BM8B&)>*;*RA(ZnofxX&Y4P4Oa|lN&XZC>` zp&x55m`Pv{@QAgzQgY*84_zc7_yVMAoSXG{?W|Y$)0Qh3~H|MRJuHcwL&SR043F(39#@C6NWP#Z>jhOkoeIN@$;WT?tE(03 zAL`Xe2H;{)Nb@Un$mD%$o%&-@mk2m5E`hfDhNzqDtz@l|N7cE7YmG&>OO1P5$T6x{ zPt@2%c*(lQc|^sW@_X6_AvH5=C*I@70eP~9Yw?ve0r+0#GgcX@9)WDC8p6ZH&sg3x zg$v)q)&?U%>}9xO&V`ux^Yfdv=R6WVFgYcl5;`#!@)pnN5zvTCea4z*8fKsh^8-=m zTY!EYStX`cey#ykL=H2h`iM<$=9sK4)9_2htZPYDo(H%?BVw=T3%63F3)~Acv`P>r zwoqWoJ6tt{kF;bz$@0}d|h#cyN1$`A_rG;iDF z46tchs2ec_X5hG5|~P&U&_ znH_QCHG!PWI;NPw)6?Q1y)X9Y2PTJirUM$T@9fJ4SFMVMIvMGdG?r#~qG#K?d*6rX zsdB1jo-%(G9gTG{oBv_xa#O0W@+j3&0#8eY_+ios%;nZYUbL3A1)?ojZx0~BHJ>pRCeV%}a*OSfQ&ZM%G9yrJIUz|AS-zyOv!mhl{gM2q zfU!pcF|*g#h>X)+V$2NY@u^jl?|O9G@8=POfPQ{t9=@p9chm@|%%yNtW+uA~E)Z!B zjM^OWJZj$S&dSPp3~CTn%LB@^DU_Fo{2<>i06Eg4cG8^TM@!%%iirm>J?nSIDl>Y+ zs#kL0m{kh2VnCQ1)c0V)#*T3cD%lGR-q+~G;?%Q9kEE>K+n>DzC_Fy$T)V;{Gnl>D zA1A!JTizgUp`FNvjqtA7|1U8vc=^^N*C#bA!bcg zG9z5-!CqC^hOSC-VkF`2XlxiS$M$~QBu1`Ot-3B-i>b03ZG&m`nZDhVHp#CWZS3FT zD5HSVB~ZxtH=U{Vru@4-V)hepwymN{5+2*{F(}9`$`w0pOQy@8&BOKQYk`};bCwL4 zxxa~6FpPMxv9v3_V{FTZQ98AXIcr6!v-H6SCZVj&w_6NN$hlp;$xvasx4-F?c=_ie z_aFS?H@Dy2>;m;)pHMtb%3&Ll<=-t5J z1|E-JOul&uD=EC(s&w{P56vL3v>U)tQje>qmXFSbrB2<5<7JVQy%QIt$B%JsQe5}z zy;!zjyQoG}vLa#Zrpi*VTW(Wy>G;|y5~i4oVMRe0iE(T}OiW)ABHbapTd+)tS^<&Q5?~M1m&s^u;XU>`L+{=G2?47;WUhiJ(x7Ob4T`Lo#tjg3k zY$Cr|2GWb%aCVtPJ1`-G@MXS^Ws1}n;#|*XUuXMxTQ^^Z?3aoyTXPoOow*sIyWo|8 zZT~UHf%it0r{+=aw+X$8{|4v&$v^qWTGSJz_3!&E&6I-p=NjEvyKRx;1-l^MvzbdY zA+uyRJ0YuhJf_6d|2jUaS;xv%q!T+m21J@c>+BHQT)T3u6rw9{hBq#URrx4k<9W+0 zMa8Q)^Lcl12@AatljT7KyTcKfiMs)3%C6MqVNtWTP5qpJ`BQzjot-r1B6}7uhIBfq z3_C2z=AwncOU2wuu^I1Z-~V|WuE|%)v-Hs$ljyUuR(&z)KPcSmlld%C-o|BaRygjE zQa_Y@rBT^Y=w~AAvC<-c>^WU~uv6!qyz`)j1#5oCXpxCDIJ(H*b2mNc)0zI4W)Z10 z+DOi7Is*g#^7tiU4YRSSN0v1#(^9vOz_CQ8f6iWfJ$K45&OD>aCBXv+;zzq>J~oNj zl?Q!ND`7|S3E|Y}v}zXB)Q%$f$=`2$_|{6h%J1S5^06lZ-iY4GsP>Gzqt(lIJ5MAP zsRvaA4=%;X_&KbqKVsMW@O=D?2KB*044_EsUF4~9IeFPFae`3xM=_*+w(LH8M-X8= zM}hOk^|kT+KHtJvX7^UEq|HgD^|n=S{*j|Ys#B2p3T+$-5^u6aC}ngvP!AqqD)!y z9(hZmo-eH#*JmVU`SKvVxRAPoW6&3RX`~OE4e6P%^w2AF>JAKD|EagXW_q3Ais!nm zm0x4KB?3-PCfUk~;yx3WVQ{AR89)4XYFQ@;egd(W~O ztbR^Oqd0)OFSn3{6S{CkX^zPQxtMgK-JM7Ghv~}opRBuV5nw6}STix@Tm&imot-7t zOwvqWl=owg0ZSjp`>}ae&aUTRc|H(rw{yd%sT?IlM-4Wp8g(r<=Epo7p7DHFNy2=+ z#I#z;e(2Dly4}g;fT5+R7Di7UOyE>t+^r%)UT`MXc-h^}mez3L<`e%azlF}2CNHKX zXop;|5pV-L+m0KCjgi*tnpv_wxM#>K{1nC~)9~>DZ+eC;0&;PjA_D8;Cct04g7TdS zVGOdARFwuh0u}?4w&&$|u?fZY5-wk@zbfHk>yY5RWE{y}==n6?7{aLhKwnTFWZRLv z_R--B6~~VBA9YiV0Ao(QyWy^zOy^^jPNU}+Pqc%F~5|)(eo_ zORFLWyCGh@pG&KM{++r0Kl=BXUvH0pjUfB8={hlOBvZIWa+=3j{l+Wql`J>)AUbuO%g;y_)NEj-Aod}BdNg)xQ2Km&f<@H> z{_0B!ycZgEJj)m`+VaBj29i26vn;^~E)PjLoE9k$y+Xd5a#3B?02b5ZgPsn{%q2l* z`tpouZjFaBKcB1cvowYo*^%!GDhhhh{)wkMmBNHVZc{Ek8?Mv}icU=T9az<4ux`*; z2kOTFO#f#PLP`oG?0C5ah3Zo-t_CqIc!Hl}wPiQMzSpc{9xW2QR9TV-6!Kz$r#-r) zdnPX=PO-kp3AU;(I;i~mPK75v@dn3WXQF4=t-nP^bVIwP7Vhp$RCSdAb8aK1oUfec ztfVI7c1hZU;sb^#Oq+}0^!`B~Hh%opo9uGowvI3L9OKMW9~uelk$G#TlqVVGG}Pd- z6m}E_4BWoKScl;Y_W`Bkd6x^?X4gi!MK?T~umtj?8Z)a@7pF%x6=P8|d(p7*QO;B2 zLwdf6u!Hwwi(_oJ0)oqftq!=1o$9H?&piDWA^&6B|K|k?y$PA;o$>ft1SVQ$YEwz! zZ%k(wh+fTIxgX@>0TjPpO3DM~f|g4p_mv*QXe}UcIOV&aGteJ4+=y^fT^K*e5qt&8 zhS0}OI%Q@-sv#Q`37rIcPL*O zKi)-8Ocm}FBhiF#Qj_squ%N+0J8%@1ZqQM_@*~a7ntWAMDz!vooc0pvx<W5}8`O{Dq49h5u8t4}TiRkMi_xxJvr#8PPDyoGBb< z>YYic=Y#XGhbEAkGDhAxC8N20Lj$qgS7w#pe-x&~nJJ@d=*GDW-k5sR6y_Fkcy!|c zEs&dX_CwvOK@jKB%xk9pJchabZ&SKetzsk|>g)oY!KnE9>Mkx`H98&2B2@OsC);Zi zyO73Y*sr5YoX=KAU3`EqD)CW`gbYDF3x_)(&f|Du%Ij~f@rr?P;g5ZnSf-up#MipU zpXKc;WOC#=Co8e46NEUG(sZI9j%%{Nqo9ae1B?jJrycQk)(zuz0#e%mf{>RR9xgC3aVG82TzBXCI;|=ra%T2?bEi~{ffl1GTL?urk5@%Jdysy(A?H58A zLSfUn1!X8EV1o;I`Tn25Op9nxfhF^LO@;e4k&vbZ~ay zce|arX_%}Zy1=5c{3)dIS_`|4>UDAZsS@vpQ{hG2VJyY#dgbrRA3HEyqs%OQJRa(p zSAXqhXz?<-5G%Sz_(_5DjqvRYv+G@8RS`S2cf6|SW93^XV?MHii6`-d~6|QS5Y#;d~Q0-nGx@tIyizdmqB`tJK&_R@@i6 zWiAp@BIPz&moT}>o**}nBIPjN;;OW9G+TwhQ4%z-NE1SVSi*@sGd9CK>aHL z7mPa|>X=vmrtSaLHUoE+QXYQD5yAT;qb0aJBQ5=57fszG-gpf>L@&hB7+&P;Ca}gu zThsd(QR{DbDgT=^ za;~3x{k}Cv-sK{<>x|qa?N^53SIB2@`*^6y&0}8u%?$cqyctye=Z}!nN$A6#kCo|W zO?#*Om0;8}W35z&t#)j=2v}|d%Z1lp<9SbizJ+15`%w>bK(D8hPaBzEF!$l6hX%UD zSljj9oSVQ_nS|u-wTzQhTn=ML$f>hqXlQH*vsaeWpZVOZIthICd%jxTuO1!W>ahuX zY@`2+IU(E-vxa_WXuGPksN*C>gIqgZcgi{s)LufbVZ@7;1;a+MSnlhbJ5pXIg&UQO zHKl3DPici2_=s1Ycy|GX{{5I~>qeXT($YGF$k^9_q^8Tz*zcjYun~J6Z#j98l85Fh zN1mHu(B?@Z@i~r#G&^MY;Wbu(Z+yQ3zVe1AD+}Ukenyqbq`cN96CTM?YCV}*CnYvr#3G{0}c$`^v%{!^r)}~Mc-e&J~r+*sb$}dcCST1LU zKL_1q-8@ToSeM0u#;GN2m8IkARJM2Jp6I_X>CwZi zyLzz2C5y|NW*`{_E>UM@@S!mw*Bn*!$jk+kg&N}n##qkrbw029FI4K%wGwFkdw1%Z z!!|kV&Jf3vJcFHO%Y013;&05!7uRVh)lF&bgde^u9-*;c5~5sQ-HDMg@x@#pXH^rt z5pO&tzZ)_Bl&9{io?i{16iSuxRnPFR1`xP=@_4F$90R%IKI_^h<$QGIa}5w~I-$|O zXmPm(P;o&??a`9Drd(q9JBiXl58!8d*zz^zJC<0sEzn|HbH1ztTY4c6osWjr(N~t{ zAjn}Pe-7ZP!R>|5OjFe_URMl`2W~_m^J{||IY=2csN8fC%?26ZBrIxcBj(-WSO9?? z)z$l~cJ~Wa8IAK-Z~LoFaJ*f9lcK*)2vh;Z^jN9|lZA`%^Ra_I{YV4@tSVx&f+KIu zvn+!>{cxLg_{@!SZpx;Sh*+Uv)y2xbc_Z!c!w;#~x~&sqI`Bn=;Ry;cUuD`LxLFR_ z9i+JMndPDfnp-oc+;}u;OEKpwHSq8CNM+-(;Q!+U{|_qZvHgU(fZR~e{B=GG6AG6W z3N{G8d_kjx`&_g-H_pTg8G^VzL1C^+^ZDUcp`M|2x#NS={q{rG+xSjHY>6B=S~x9; zU;2T&xB=60?fbc*UKC~&3|@{G{0a#2v_WdVxF$+E~wsorGs9U*Qn@*Z8Doclz%3)ww{o{iYjt?sbOQhi1lxHRrCgA1K&= zxbpi@Mg{$<>%*@`h-Eo(JlR*g`E%IFCH){@)7dbqLvN?=p2#i1D=S*#Rn~gU5RkMZ z(_F0*!@N2NvM3799-HAja2L(^bFJe=%Yv(B3VdN4Dgd#SIHB`zuqi{lOroV8{E)z=4LQv&*q82vvLU z_WYjAthtT1DH`dBjhsO+IE1-|I9sQ`waR@}MhsJZd)(^6=~SVGLK^XTWW=a>Hi}!r z!1$rFl}6*{kh~m;xMbgfT7fX${nq96U*CQzNYa1j`-xv`Z$JIB=~)+&?dTZA5y1R& z32h=8pi80S>Rm)8F%BDz1X+hvSeAaT8jM~Rp~}k#TmtR5zrxw{G!6&xau-$aEW3Q} zX|#MnDKiVnT2#ZW+I^1vc~eLk2Doape3~^PVO=T;K#LmGm?~uI&a#nx4tC&G3qvqr zGcjm8>gz(&^o476sUdaMMv&!yGuYoLWx)bL?;QFc8aS&Mw?$mUDeLNTpn7RgZ0Y{ zZ(Z!{l0yU0pr#rT*hof~SB!ss6NH|t2y7c(u$qct)6j(C=Pa3FWdP<+33emikH57{ zqaAO!U3Nj2l0&V_0)*WLrfdqMwKBdLawGMzgAfd`phAPItIAQFq!x^gDq@n9Hi1h4 zY^yF4CpEU(KQ%CqC!-E@A7NXW+f;x-b+1?@=x=dq5|l!{bV3>2C)+C9mPft$cYizq z_+wujP@hW_W3DNWrR7f)=IasKyqoYm#a+Ozh7EDkq10!X<{{=?`^uo^)*yB^L($yq zOrjHG!mb`)j8$&_I2=0W>9r}Om+mh@_>tmrP#v!(90$5R;SeBAadZyLNXR8LB#CuiE2*7|ch_ zJyVf+*@A92j*yPQfrY^T1wBhWida10>r_3+%a{-e=#YM*(f^ zgi}w}ioh}J@>E@qCau%=eo`y~WmiWFSN3H|lTNaWQ&+5nPIj-@OzhHONFUmM{QKJf zz{AyYDO|DoPo}yq!bOI45RWtzysNe@%?XJgdKc#HroinEEnI}Fo{PF#DE+P&R%NW@ zLQ^ybMr|wbHD^VLa?(D;4`qetb znjiiEDW{rhgjH4j1vak~5iLc?k2GW?qoF!8Pm;n*)ZOVCLo|gvO~D!vI%nwzjWw@3 zI}I&cq*+5_Hr4pc--hcVle(&OHbd%rIN)rAtD9sj7L_3Ge5$31snpL$e{`@L^_`5mj8UI{Lyc$f z)yekaub{N#3#R7(NX1t8ZCXC8H~Qy|$1r+G(Bj@UyARD-H-mJcSHAC>Rb#>u71Xo_ ztGi?=ce9=Z)+o;ggdjmoA+it=m6x9b>MW31H{~N;F}aj}K)+Q3|7BIE-@w#B9Lbqs znj;&m0d|>_eC2@e2z{B7d@jA>){Rg9DLJPAsF=6H5*{@lqOzV@Wrql{L2mG~msoqW zXr~{}aoduP5)h`G0^UYhEL?0=Y;>DnZgRJ|9%7)pE!oqVG5J{PS_Qc=pO98h|L}&2nI4GvmXV#s5z;eXG5=og(F0JTfO+95j{p;0LSX?^So~pvw`-!(cL_B+~KTEK(xKQ zExVfqF{H!)WyF6*>)+aH9JyjVn(w@aK33Gz+r(xV7$eO>xquFVS&8jz=~*iM6L(V2 zw(P9zUj>I&6T15pLB;B93Z{+`sZo=<#mQK~C%8c`1d9`=e3u`eqETYnJBqkGwTn-# zP&t?6wPGsN%r{B+rNgNcbxr_h?H5mhhK(p%r3)a0Wk!Xn+Ih~ZfcIPrxk58|k48*! zDJsDxoir}Pw$O;HygfAq>o5@L$xB$3Mv$#GwlbvoHw6?mCe=xF06-=M90pVAg_Ft@ zfA~Wb{H2|KHLF7TmY63Vd^3{qze?$K1}Se++zmRJMgB%0Lm##)T?ttN>}6zI+E}C77!vmN_MBGSRe(hvbU z5=CuzmJjxQKhgv>tJy`QIrC0Mv-4r71~NA&bpVx_0CJX5F2?5IKiqZ6n+>{U4>s9q zbmt~Ls;z|%T+c;kt^T4E=WE2=>_-AWQOo^TSM>Y+<$DiAnKBv{AfmUi)lpq$?YYRw zs!&fGesf@pIKY0i0}4)_uMeP!H%f2*1Bh4+RUtZ2JcVJclY`HFIE_~zIrG; z&n2h~l?Cx!QaS<Gi~~W%B)~HjEb!gpq45c}ZKBn83STyll~t!|L3*cM)|)x>IB+ z1}hPpr3_bPV!Hz)gFMv$PT*M;-geigzfbSqT2A;)O2zQl4MJBoA-hOZq9*&GJ3MO^ z_%L(BX8XFT{`7oj3$1}5a0yU&&8);&(uF&k7pv9Rceba#uR2`qJyr-N7MBF@@RHcT zKT^!e2D&+!I_Ec;ScNqrLpo$usK9pLpy1c$6W7dxi`8$f2-_oU_|p}Hl5=CeP+7Ky z<2aFPNs+*92@81WuHdtG36D!K4yFBrFPWb-mx^A}$x?f8T2b#UO4aNK#KE4E6gqvO zeI^k*)GG#mAn}K0{-u+ln~DaoY`Oor8 z+*kDbpC$iM3jWsbc3E>o6|-HX0n+wU>MAR}g>;}}hfhY~fYn~b=J`5LgMb!VV-`(4 z9@bawFRtmn|3W3`nT|5a3JKe~&p9-d8s_fy@Q{hu)290w&>1tvWV31Bo98}m)p6sh z$;e6Gr+l({iz>{LzT+9Z)GxDWa(h|Q4?7vQb9#s7l!(y<>pH=SQka4$Lnfg z0Fk)+J1}qn4_-w-T{6d7O&6UUto%$IB8M5-6xS)zd zHxUp5z)6&b@uVMBqvt*)C^SIC;k?lC{H1*>YbB#xi*gUXdjm-u0%VsLp<<{35`a+djq@tWf1^!PzqLkp()Ff+2oEv+t5jfXi3el>2 zLKJVnA_L0cDAwr~N8>lvIO8YUI{4?ZismK1)HU&?#+K2slCdje)Iw3t#m~oMMHLsI z!C6}PSrI{J@KjxC7s#?v(wS_7pF@i|V=?X7FtP;ghe`*{=jiU}9-rqq{IhnnWGLyz zD;}h_8sKDBD55hwAjD;>bUwp-{^(=*o^SAt>O_d~F0O?WC2pmaLN>(c^ttfE$aIE| z46^ca30SVZ$QPb-IJ5;G6A_ngqSk_V{QT@~ei=RoJs!OR;m$h@wVmOhME6-VPQqz< z2Xyo)k4A-ZO<(y%_eqIj?Slc9xxs6B@BgshOCQX;$}jVH1j#EWQB@dZtw)%3EP$tK z7Or%C2x5M+sev$Z$?#EB_BJ(ZI_6_%kIIw9sKtmH2s;O=ZwUg*u#5}nW@jW& z=)s>3ryeYZPY&^T&!Oi}lL~bvaWS3P=-jIMd)}RU#2mg5iZG&maZ z%RU*BcLsQ7ce-8>1N5zQo;&$0Dfxnk<-dYr6vW;^R zOJbU%IM-4ZaT)t0f%hmG!Yh4=WGB0FH{Py#TOR(WN3x@KXA`&hp!#Bod*QGwFI0(O7(@_TnaT;_*^GO)l z#5mHwA&0zqCu}p(N(n$mM^kXn&p2Q~S!$9;>5jY5@GOVBSUBcIM zeDk@+evlumQSA8oLsW4z8>vHqJtN`nL9mgnrB2HRVp@L4(hXlmn^~F9xg`oSyh4Hv zk2vN6fNE(NL@B3S*r2saK*dvi$-aHWq5?Eq>HD}Kl6I?3p>;^E(2Cj5CwYJVCIwVf zCq~EP%rZY}Jx_T<`yh}rrdzXC+dMqH&cUH_LJ>}y$v(mxG{=a(R=Nkhh87YxeqkYJv8xTJ(RIhR`pGJG$ z!)*LShmH#=AjCn)6QL%8pbf6c!&nP6@o~*xfQ+I03Kcn16V|YVwFmY2_7opaG z93AIcY4#PYKdNhtDm%Vp2n^5e^g0FpQEWHj_ zp}dXXs*bVjd=DoapMNj3EHPX}g$eoQ@;uPJbJ;#w(_rvM)K=a6(sc0aZ}?_1%;U4; zc>^3c3?}1QR31?QLzql85^{DF0V5_F75SMo(uz@hFPT4CH=}FFovRef7^}DE?A1!R@8FGhR~qD8I+-{`gSCA9m;H zVx+SxUr&o_JsMo~;VaU|YOWL}!iey~UZ=ryWJ`C89513FUtS)Um>TWjaZaSt9^%9C z;?8^U>3o*ac~dN=h_gi7QjO&6I^c)9+>Rt3o@=V$3jByoh=2brKK%9VEZPHN^{?1} zy~g{q$vG1e!dxTM4??CvMD|z}U?6tp4KS(odjc~(Q#i+y5ZM70|CJet)S27gT8&WI z37AV(Rd&iI%KGl}G$gkQsSt!YN#M|sxv>~m(<7_iF`9gK$uIjAsfcS#doAK#$2ZDP6+3BC|>;3)bRVlR%hcb3= z+P_d0pDXx2Ryrhd-)r<<+7~Lj>D)Zuuq5t{ilvjkH`vp}pUye<^xms$rQbE!zUax! z{duR-SLtws>v)d;m+}7;UbPBeFa4g}HF|a7?)Ih8LX9yRH%lX8F5bHgLi`^p5qJaWPm~wkRqbV-B?K_#o%a8R;`jiz^)%YQhpA|*u?pIeH$QM@?zH1_}UnRPw9= zpCrRM%KV#JxQeIm=QTxnK~Qrhb;Wm@8&SpjO;KW8_47D&X>o0)uKDY8TcjeDZ9lih zqx<%i5z8JmV(MxQF$NJ}gpRR7Tmv*`N;?8Zvg;LhhJp>+8 z1Sr;;ze>p|J4)~qVgb_&-KUTB-peFmS3l?9#~Ll>ifUt9yiPd;U4Cpiam9+r(Sz14 zQ)_wU`ZE&59@sJ*8;dYTv`*5)M$8BP4vZflKff&bJ8HiA3K!|0+!Xjb(v5xvvfuTc zRr(4}f0KX{qR%h?ra4)T=kOi)pTjF-xAOEwRoG+eoGX1+iwW~roQ1kU*tyS6h&eZB zjeYh4iU`HcUCr3$?|Wt(P`hVpm935NM_hdTI7>EaJ0Q)gL$CL8UthrTN?~ebk)to? z-BnH%g3>~>mg*U)4dkdfUP8QWT_w2dSQq}y?ERlNzW@hunsEq>62{5@Pj%|i2 z)|MvvaGs>?^!dx+ML^R>F~Uj5kHUJ`qmr)ZRqvvq`Lx0g1*l^YfmunHt(M}nf(B-A zZBkmuPGsnVK3@FEqj4ozF1&g&)k4ecZ}Oa?z`XEYPnXZ7jspTtv+POCu{!eU5U_c7OAM{)Lg@G6auZ!(gX0)s&8#^rfabxIBz$hkTpdiTH^)aV@5)obwI0Ms5x z!0Jtzp^k3bkc1T?w7nyyxjfVWE~oH&{^zls_pjoU-x*jfO6xdL9@wjT-H5Q+iJIq# z7WxqtC=4?nj(jz;N0NX;?jo@dPwTd_;$4)g4}GM(qAhk@~8ijyC#(&4&>Awo3DHO>as*bW^1 zQMvi^*p2-F`Le%TwY8w13K<$!$M>>_q~HFWy#DE@%k46l|_I^3n`{x@tpKU{i^YpGQsOxQGOjUAWNKW{Z ziszI8de4&aqmOoe_|4*w;T`IeY~Xj3!?J3>8f`R|AoPp0_SBfBe=)U-+bhMiZXZ^Z~bZ32X@#!eNeF0^%w6cq`4oPa0d^i$dO;PWm^u zr1C7CQ;_S~ou=z5u~E0z2hn7MhnJn4*qk=vze12>MeuJ2v;S;G@VhRt1rrCGP z(B+gFud2yxQUN|b+?mK;F)2~;e937h3678eu@C*`0x{Jk8ZIQd7U_=oke!?q0If0J zd;FG1=iH@;UJ>NsXj3sobRSasIx-|@V`*2f<9FX!(6!Zzpc zVmq~N(BdpC@hUZ;7s9&9!|bS0!waQneHHzQ?MZlPQDp2FD#pHT2_$j*-O21R>m#co zr-g;l+oe4MO6w>oh zjAWj{|9P)Lu2in+#b`s*-s<8uy>^yPdm7Az#VMrtLAJ7PQbcXHILK!n(U*gqzO3eF z&gsKmXi8}^} z-ILv+8SI}EW)gDfcfUnBb(&*&$Fo&x%Il6#X)ZtH@5w6|`LMl;c@woIr{REA?9`{h z%i$B2_A|BzmIc31so8BO{;fJ%Ho{3s01<||+6g)P(78s?kH$6ADm$pw&^3c*mia__Y|QtR3m zs!hgA?s=E;q`!JL`CH4;0(-*2vJ?W`>nfkAu8(u%F#t*e7 zf3ojyE5Lc>E<2W09Du8atX?dH{q`7tmPK)KVRrD$@nA>%JLcK(*7!<YL%Yy8V8 z#|8t@xLmCTG2~S%7bLTjL;v;Zyolu2M@22!Auy&uY|QIyNzE@*Z7#z@8DFThf+wX2 zrCQn}UD0Z?vePP=p-~cTY__6X#VyI8ZsBV%ym>0`TkA%?%!on7?a5Gj$K>+>m{ma| zwiHuWEEDEHo3@I0>D2()qK!BzCnc)x8y9wXMJ9Cx0WYni@tuN|BbxiVQ%a0vCax)s zm7d*+NL;w|)sKql#$&@QG$x*>cXGTB zR<0_k-}}46ToiZPinfhx?Jm>`E1_2ZjIWe2N#8p)@Pfw+Zg}Gk)cb|NsZf3CG~J1H z!eR{j(oa$4yzj%}dCEU*|Ilav=#g)Z8h+gL^q81q&K&QV;$vz0J#}@=nPbizW79EE z9-9!y#?=<>F;E^Gf zx46q*#FQ|Loz3x6@`5Foe4(1qdaxhVwkaZUiE~-BD~=Qbf(tXbPp9%0JEu9ir*pX+ zsuydY50B?|t#2k02OT`W)9mURl>~z!5V`B`BD5#HSyViSw&k$X;*D4=4vWQNk{!M3 zRWDyXMaBwh+VysCl~0DPh&CN4UcN8$X)f-JSo6!(n@^>g(3{4IQ}^9of4Cl^=8=Do z>M_gk9r|j2stsfiCDbFT~N?-heemKix_jKMkG5hmQ#x&G1%rxow^Is4^hoIS-I;){|YlvB{W)B zgM4S4MXvA8>%*K^v(TB^!av-5sWDPoc8T{c)@s8Y76i<_u(fJh2!4X~M%1=Wb2{@W zFfA*bBmmTAlAzCKN3PxC{7~$m3u_;DKzpZ$bW(~q9VngE?~5F?DfOtl5)sE=q7x8m zRNGJgH2$C6mYKoYh$Ea+-!*#ZHAJtq&-%|Hjh{;tCnN^X9QC$+U%mPrBAK+u3>^dpXyZ&7$@Y(r4B zo*L^IlYoR|&yHk%cs(*pPX*F!qiv2Z*c~uIs5Q%ihn5cc7cZ5q3G1Mn-~ENlg199MdN77t_Q;A~eFq}>B3>)FDEB}LTnehq19o1c|*O|tKz;f*t;UssWsMTQ{ z$}^WP?+(=&lc{gf^-Gn>4t$|nUk7ZP8}#kP-22ckxOq$A?4D=#KaUfzLk#1hX1ULfZbgH4s#?_%riz*|GvHm;x=VK%9@ATPL7X=Z97Ph#AHv-R~tK&FWl+F@Z|V4VzI@g7P( z7`)4ceRlKdf0*ar|KmnYH+WD3yo~f!xxseeXXf%mi%$CiF-Isw3w%oO|2{8z{vLM4Um1fG&73H+>;jojg#FJ_7LX)U|Vb?g@ zw!%l((u$1&nenCT_kE-4wlzL;N3RR}pv?^uQ}x~FrblIALjlRTaa59GKq_PR7r{r# zgHXY$oLI}3A~_*>b@XIxS4sWgBD@TR**A|Sk&^owahBSR3C7~d;Y>q?3=FY}I#yPx z64)fPX!BfG!-+uCbfbPp;Y;OvHfa&jhMCSH?;lP$#!bj-AfRagmY{u~Q~c~MW!m}+ zn4;XIS*&oN*}4mXs6#QdRe?dpmA`|>?|h;1U)#!4V&!CswXA-U^p4h*`-%h_$Ucl- zC965f8iYKWDp|HnyyM-z)w8x`kEz+HUUk>(DVumqRrbk5GQ?tQxE#dkkcF~-}K(-LZ&i$5I7SxmzD z_+k;_qJ$t4d$^n66|$TCvcl)x{e7Y5Ij%Esg(sP55u9JB#%yNV_7z_;=A~RtE7lmy zZE57l%uJ8w;W6O0$_j^iz*qOJS*p7;z^*U*jEm+6;iW9VQTWMH;t2 z)HnolTb&Eda`$^2`i06UydO0g`ox6H@mzM+I9w_-leD2Bt=p2&AHWaO)Ftr(Z_Tr7 zrG+%K2aT)%ozNR-G>?v`S2pgWd#T$80DTErgCERBaAQx;aE#9B*!OQ(M-}u9uP`5k z_)Ya$TUlqkNUAo6==B-vsje4NG~u+Kmx_u?wZPGYV7t6@b0B7#ERlXMIWpA5tngYB z@NQZeUw)ScIvd1t4mTk?f`{o}Kni;M$f`5jkV^;wCQdyM1aHPfGd{l)iq3AxP{}bO z+*^4oHI{YBFBf-fym~7Dm-s+T@T4?M#MPS-4AChAAy*Le8Y7+>8yg$1?7lBV;C@4M?K95WRP)MzAQMnDGtB^qT3Fy7uIf=KVVZT?6(kz)6>kS1#*?9Vw0) z2UmNe18klq=C<6OOIY@?*UYrO$s<&Z>8f>&lHAX3atqnye=XJRl-NA-4e1bG&m zlp&srNE?C=@+S1Vas$3xW-H*1#q?b|08~?31sW6BG*lEau%ub+?9cC*zwRZTfXt8@ zzuTs4zI5m~BA)xkb>KvB?0FqN5m<|&+q~GLO`fd_@N)D+{H^IUKBYod1a5M)KQ) zTOeGVx`jc?mP4-`BE@sf9vcN(#U}AyC{K})?{sK3$tvf?hI|W6UmYX%rAC%ecK7$Be)lFqlr}V$5*WX?{(3D}j)O4De8G&ZtfiryESKZz z*Yv4Nta2KN=B~}aYA)jJVGxLSD%GcDaS_Ei|Dx3i2OOJiLu$9`px6gkU9QZ-Vz@^L zNDgIe)f%w6eZT9JU#pNWdR~Gj8Klx^to+$?^36o6g;Cb0m{EkmtIQdG5#JXkWYUu7 z6bw87aT5p`!&Rk~)1Pd~f}{9*mre5fb2-~%o@-mr>}v6Hgfgb4k^6E1bj~X0vG!a8 z<&}0LNvxJt_Mp;@_uK+ghf=MJ?_3)v5iUcge0Xkuz3VP=P-j<9@)ZzImRqD`MmVJ#ABv(0tr~0S8!qSjUYs+Me5qNwnP+(= zzvLQATRhhbcMrNYGIr1lI4A}5-wFfTc`TOIh^|&r+G0HgF4ervY0xtYx-JBJx#GNT zKG^2B0-+F~#WkW(`)EY5E5YX~=2w`f^wPZ!=K<_%s zigBTNJcc-s!`RBw1Fam9r}1PH|3bA9{_La?Yc`(-XboyOAgJb)5dtGQf>d==HNE z4sqGZe0^=zL0;E|OW#*nSrn0aS1fR{=0Yih+S50@qZ9~Q3@gsrK&Vys==#SlDb+r-fPr1D+!`AESW)40G>x7pDCr;2&sgeYK?+5 z+?l+>bwGdJc}+|ci7vLrrmaEQsH?7xY$(O*F)p*v>iga9rIca2x22ChIu=sop-NCD zCEDClO%m=?W;$_ECvasH|tOYs8Ri@U2W?7A}$ZjV4?t`NOLm7gz=IZj; zL(09V@U=FH_vL0v{HJMQSHx~< z%aLEG*iZBd9zGwe@J>FU1)ry+*-vu%(Fw;U;^ak342ZpC8Hhe_T=4#+g!|@wJ8I^5 z?bKImjlHa<-5zLsT7N;Oz4&DXr={e&x0q4=!vI&)*1MSI^T6Rj|G8|D2uVfL%y1UM zh2;`DIuV;PI?sJC>Rln`tfAs4cyhXSvz%j;OKaxdv{}y+?h7PvcWBGCqZC-mlh@iz zEZ-1C7ot30=D%PX%FnAf3D>n~?*@SN&em39IB0`B9l$PSt_3!vrCyQGQ)9way=@j1 zW~Md{b#xPfW@EF5!4P!c52|^*FL*yL(oHX?y^>Fk8R*kl zirI46*THh}wh3I+aqNxk`0fmhUB~XYK{j43QDEI3mA#=#u=H+m_F~}gQ zMKs8lC$d``5NftQd-NV^K*>pr<09K-Hq$6WSL~8#5>GlRpDZM_Va{*Q%$%5h&Z}}& zH=A)!h8Bhpw+IZ}RZGDn<2|JiOGRY`={aQsbMtcun4~5Wlgx(-SUOiW2_v7oovm$< zd=<)nC(j>6;=-4-K-Ji9%@zzp*Kz@ZMKO?RjU|yOz}*V^LSMZ@#72WKa5ghGN-2k<65Pg zE?zoydfZDoEGxU*urWi4dYha5`e5(Pa5{k2#FU z#~&FHcq==_Ep0n*Yh5}g%Q;{oHD;8|wBGYEQFT;G$>}-SouJWcit#i?!5bqVl;hB# zR#~tO7E=RNrFom4zm{``KnP;89`}=uq$@WT405)ZND($Q6{Ym3QcE6X;8pScuJr`q zV*%F{Grn>|97QCiILq=;cb5{Icpj05E-@R)wT2_We#xgxAdN9vhMfuSzOs^WtIf6| zaT$q^^Pc-cRXNrP(YxB}(2IlL8;Cw(AdraYzln8nu>wG0DnXSxsICvwzUZ!ds^fR| ziG7ST#{EeyJehO+Vm#ds+2iX!Pay!VIvXAGcKS4dITt|s)OpL3a&#VrL8Rz12vl4y zFnBu8jE&pV+-*&lk=WBR)>UZ~7d)-3qSj9*EL3`5gDOC%ygg3!Ji;`$cab30SbsfN zsh-3hn8!9-9Hs$tn6G*c^g>$Meva;-&0jAfj>WwRBeE+Wv{+YNAdR`CAZKMMLjQ-o z_l{~Zd)tMXv5cbVARy95P^2T$`;1bg1cW4n009AM2^~T&GddteU?`yk0wYL55(qVv z(3C2n2_Yc8_g$_41l?NLO<+-feO6E&`t^M(fx#(kLn|u-G4~emI>#tR5 zfJJA_RZ=IlPH?2UJa=^2aGv!O;gMzokAclYnOJV&{#t=N)~sIUjCT#ohEuy(3$*?p&N+kxnR;R49jV=YVqpQyq=Cd zLa=x3x@3&AKEc0z84xMS2JWH4qZa#E8yxT3e#bH2^CjJwe@v(hWZLai)7^9r7o?$# zIg&_}TW@%%HB^rm)qCLCwv0_IjEjRP_rO>SFk-}sr`?@DQf3sa!&a@pMqkeYXE(u( zwg-g@LtWMdX!x)uPVTJd=QpJ~^mJ324K;^5m*1@% zQ41;~S7mWP0Q~jk%S4_hx#39*VRiYcNg0zy#k)!bdAZXLm zv{t2UK)rf^MI>f^{_jxV;_@&*;fOBdM^g) zhC|*l?Ls#EQBehR6GO(|OaDr?^{%QLhPXKx`SxLpEMyPsMaoG18HDscZkqGuU$Sd; zr`O^ND@I9o^)tz^eo?16{DLdurW;7hrz$ZxA0in32UaT00P(HR9JV|SR-0IVh(Y<$ zJw@KlZ!F#lcv+ZQ(F}{8&kmxD&*lD^4_ARlxMy~@>yYsT_`LN6(`E1!rg_eN;ysP}Q7UocV3T-RMCT&M&kuwPHai%+UvRxYJCJQuuQ{$5sN{WTx|A>Mr4 zaGv(AM4vF{9!nsof{b>_k{@KB0dFGNcgoE3;pz;8u-gaB*k2o^fHqN<9-~*Hzsla4 zc?;ATZSglMeN})~-|LCgtszcp`EX(Dc{*|WNgG`#6nU8CjbpXEso56^NjmbB*IPaD zf@un2phO;Ac6&Q)=Wn4l$&AOk^eXkp(zs3_EMMTbX>TlvIMjEDo!Jg6L1wKW+wFu1i~LRih_S?55^@9Lp~{ zANv0BAdDm9!T8eVmT}aUi(B8~##j14)u1FeJ975L@cp2b)(^Sb_FTBR`Zag_1yhTE zNQ0L)FKgL7dsnZv0mQw5KJMsGtgI?ORs~?Ee}zKLN4{zo75TP;|26Xm(4ly2AHwP-zQ&{FQ3D96QzR?SV8(lih-0z96A+)Q&;)&@ z_IuM~m);^|%*3h{Vn($FpblolG%!eqTx29R&%gnUuj~1}AwT=0R&Tg;ffKi?uhRZ3 z(EKG_K5G3y7sv*zOMr_J!neU}Pq!x-E{#w-VySh(45`xUPjjc}Q_BbL#u)`#I%l_{XiZQKNGQ6YyqPm2MIG4eRaiwpsf2 z$KH2J)gmAjNLN$3u~3NkP3FuT^>%HI5orAz5@=w!7{zJ|?Anmj*Ut>uaAE;RKdIrx z6Qt0B(wFJ-1LUvL-`h&mm9@UzLdIv0>hhy2g;$RFj!e~qooZ*j3F)N1${QRPOb@+$ z{YRYV+*nAtl#C6d5wZ02;^=Pc6xf{BVIP?DH6Gr~+9c_=TnqF`P?TlOqN_=&$R0Tz z)QeQrf~}yfX?+;(y|Q;#;!8GO*;+{0Myz1uS$x1I{87V#K~nK?>)Nm(`2aC^13Oq- z`!Vc;4|Xw0$!IjJe8hQ!L;iq0&zxX22bWC>rgu;ZC@X_F>Iaj7lft5~d#!tSn(rN z)ZfZ!;nHvvP2)PxsJpj6+wGF)TI%3XzZN8fUMR~q`CQK&TgE^UpOy@3(mh0VlV$! zBK_Yv_dnN{z{n3gEaIJZ*UZlFS#YVv47qEi7KQ3@LrMgBg@_G+b#cju6l4D@-Oo(k z6oT*8qTJeIEFHv`iQ-nI0(`U`ybKC9;jo_T>j7)QzybGn79JY?l=ty~P$(W!4kh)O zst=$JFhSIe<-=WP{75dM{p{=qqJ3!aTIInw9504|8QdA@ejf9Op45y7MGg!e1Ji+E zYvx}=KmKFGec7f0+0Hz&(+00|c(<)_xAGzNH&XR)z zaxV;SW_Qdh+Bx;kAaV^NUzG0zo9yc}=uk1so1Mas)^j2oxpRHDfA0Fb?%iS&w`3bT zP%hFT5UTRoj1Jm-lnfdY)$M#N&gkP1Y>_rCvhhbdq`V%QZe}r#UuUQTew^?~J(wR= z=00g2Tj{7^2nXglKF5yK@D5Cmk#C!yJMA5e6qPI!WF#kOzBQUs(@?^?#ka!7>E3bk zZ{Q{O73sE^aO3Ku>*v68LeAwKN;b=WkLJ0rk3)C4O4)%YZc^prcf-mrcQ^OphT5-+ zONOc}f+N&Yb^=Uz=>Xs?fKm4O_Rp-O7&lS0*t;2DeGmkUF@dqAw55Z)GdI2ks6LT8 z3ibCFUgrR(~$(Z9otBHbo zxupT~zOYBiBMj=j7c+gBa-{ioQpzlOuTVIEuhfQq*yFPq%K2lnJ@w|(`Oxx&JP+39 zHMB-m(~|_B?qM4iW531;ud~h|$S*~5Pc&mFfvPUBd7Y)4)26O_ekRibF3@n7vQGYa z)7ByRARNDi(eUTSxs|vb`P;#F>2cURtUJkjuO_$~?mtHS#Cj{U;{>Io z!J&PZmNMT&aB^MFIvZ(Nl$mGQFSO?%5%2ZLPSIG)@pQtN(W|ctm{8B zFdPp@3e|S~E6$gkBaU*3!lA6?ZuGmRdK%Hq?>Kd!hOaehAv_A_@fN^M+!kCNzyE1s ztPxd5Ju!SDfJdyY%_098di<_I;f8-(U6$VY+%xH(;8$rOMJ*{_@>UCd zl1~MFiyzD}(8*tZbxlLYgz)*7dqr9e#20V7!b|-fC)bOQ*A~4iYw?P=6 z^QLKi?-W&u#rTf2^iu576JmVDS_L0!&^P9)5kAQZWyqZ&^JGe=iy7MZJ%PGeQVE?y0Bju3z~;p zVb&S_*jpNyA{1C;!YY$`-SR8GXeH82o>BwMb7I=atZavWw3anXxYjt?8-y}H_(s1r zWHzWwQE|crs@()YbdDhTV8br_ueN4Gn#v&!J%0P;7)wEAe1iY386x0Z+&*O2Up2+S z)`1IH>6DE>I6c}i%W^;kwsnnE+pF>Dv6;DG=ZElgqkdi%!l;qP$|*!w5XH zV$_qyX88ixK4j}>=E!;WIiW76KJOzVuWPIJ%k`P%rGT`jCqW2Kn|GDZI%4Nn`iZU7 z1Dji}@Tpd-U2f$5(!sJCu4deIxptD2;wdI`h+|-0s+~|5f*#<_10CckAne{3J6ygUso;k z`!4NN|K(Bjo@H1F-}Nu(`*+-w)9&g_56%(+4b1u@(Ak($JNFp?+Ypk&L`gi6I=~>W zVL?CUd~SB(u68MlU%g3!s}SIfZdr@XWhC@zs1K?hrhK(OxKS)*3H1~d&5cI;!qeZ) z3fFd=KK<6IpirlbCXxh;RA!t+dpAOl*rMUvMoT*0xZ0Ew^x@P!w**VYzC z1fZH_3Q^T*>Ko}nlhTjWsdH4vdSqY00+|D1v?EMlP)_lkDM`Tjw-N_pm4sQf!lAmT zcTTraF}iZj@guFD=d_JqIaq7%JMmUZ0?Z?CNA`K_ua-xTVufYLR!U;<&D-zvYp)%r zSQxtY$tZgmR~t)i`LU37;T2F(F!%VwY-jWl*7~@fiY7JO`h7`DOQ!C$rR-%_3Be6- znhHN?cl*sAFaapmhPW^HjmRu9u2t`qI5||Ve}4V)HW~Z}EDtKTDcC9|Sj@O-qJ#Fn zw6|0HV`k|%F<~K*PLYAR5|xz}nb=#3AUeiNHfu3!^>pG^kCH#rNXd%b=`Y^plub*C z=u2>19G?N3RngRt^bg7=oh0-U9v5y^tFnHCeD_$p=e_&BF3fGOA8gXgXK0|X%NA(Q z;HXVLkB@7}S*JWzp%(u7Y52F-B3_cP<7Ey|PpV4PpT3rf^-0RCN@TFS`^vWUQR=S# zCxJppFXr}FwaBGo(nQB8XPq6JNd;vI zIAJZ_4EKY$k?t$B&r7+En{SZ50OnS}m9(2~lG=CgWM}LTyTACLju5xuu~c(TuoGuY zsr8?uC$zL4h&y%!DBOdtH3-##4Wma3d9x(Ihv*{j+>j41$K;(pooJ0d9*@+U)P07` zwdYgq>zy!bTZ9)xANE*p6Lww?UNE_|x=BNVTyrIzsdgj|lVY8ys7?>pXNb9PsHWaH z=(q=mMb|JS3!ujBWQLKI&F<+yCH823tz`>4=(u1?WS%404etzzN-JijO~W77cJT3u z!}16Z=LDy><(0%S6UNL0!ER{#38$UM#F6HX*n;J&?hB?TYn%q;hD8=Nvu`23UmC&C z6@QC)Cw(DSOG@ShpOWYF=DcM6PBV8IVOp1YsGH6@jP*U6%xvx;-oP|mXP8tqu%uzI zPE}gYCyP_vPllwut|Dh#d;}g(3awk=re$i zwXiO`n~uyo0QX?7b5s;Vya54VWOafaEan|0f~S*|ZTRYGp1$6Kq;In1rCHKO{h8$? z{I1gIk$`qT@oi2?My5XQ{8jJZv`@>v>l%&ZfZJ)S9ap?ylJQ^#U}P?sq=Z(s0>ibLad^PRaRC7fiyL z$6Y#kKU^@~Z_%WTo)xu8pNGF?tPK)Q63se?eO@&@^KA2{-V--V$`=)x$;j+xyz2Q6 z2+~(z{N3_PGY#K2*_2=fS}LOp(_+DDd&x3TN-4H*=zSMV70dv*mQ3Y_9g5tc&kLer zRxWt>``x;#*> zWuC9*iCRVJ$m8=XWqrec#{JO{!SF?T9I6N|9 z5Md>q>hv^|1ZmsfcuomZfSdM zk`%?sUZ5>+f(tdqdq@V-^n@le`hL-u0-W0yM}#*_6rk-RFfwLHdUgRiOg1|zyIb^l zQjW~dPUm3V@$S6AzkhCkDj?*vg)#}~VV}Iq-*w4aRMHAIoIw|Are(Lkpq6$A;q@6v zW$p(Nx-UA=7Xg{^&UWlMg1pRY0#&!|y5b6J#uYzA&`SCLct(oT$=%YG%A{^!IM|v( zEUjqNHRYECEo&o{VSDd`DhxjZH@p!oBusQ!Evsb#7%mW@KYxZ%>Tf$1dIuumSpW=* zvscW`Zky|L`$5Qva1rokn(MT(qn630RiI^Z@ z1%;i78k2dFx30Lr0`dpZSVzJBtXho}q58C)g?8Vn!P(&P2JQ|!!m5R^VfR8SWx!`{ z+?ttCtfdW_rciv78y+^@3%?6>Dz%m@F))^cw-pPIFQI^M(kXr<#)I*gFN1r4N^sEX zgF#;qw@KR)9BSxl*xD9COo$O4MFDl4YD02~fR7^w5RO1A^T zIh6w?XHLCfdix=`%H~<8dOr^A5WcFc1gKUkPJdKNi4lWo!(H>8aO8ZHtg@@&SFpjFTk zN9H`&yT?4>?5j9^A;FX0j$!tKyT--F?d8}AVhsZw% z-^010i;XXD-ruzCM&(uaS1u-a0X`itf6#M`L0Q)Gq~-Go^^LAh!`SAR9~T}|vmT~` zDs2$o6t9a(-OfqT$6M@;*~!MZlPO+-HdJxMS;K7`3`h}EWn<0$ruj&cP%~m@R%s!O7E51C&*=2- z7Ws9$60IH_ z(0#;7W~&(@Tl1Yk8Z4ibt|Kp)G^RIC9!zdm)XbA7s9D?uJXX*d9iXgJB*U%X4BQdi zMp(-Ny|EVg%Q z41ccqjGoq(;iHseFa@_=h-a`9ev1-bdAG<^RH^vEc;21BG{Av>1%jgv zk{38}2mWbq81`DCWY{$=mW{hj$T0){eqKxf8y`Fb149mz-^*!)2>tYaHBbp7_e% zL`}WiL_?N!0rgtbyf{Zipv0is^0w);n))wqMX;&Pl3O2S8eocJ(UUM%Hk&_2rj@jh zrTvKp-C0oRC@>X7&jvfBhI8cvgJbOuxF|5!jlpDui@jMO-3Us{4h#`gr_Pt_$aSu% z@*&GvDXFhFfhLVtLJdr~m#QqHIYsK*;&r9@Sp6vhcf~d%J+TrW;MNkAt68@J3mWE@ zkBmb}%f@1&uV?EqTT)NZh`0ydQ1>TRH3-szIBCjVYa#351ph4V z?7`>bkm@!l&b!!8-4L&NU@)d^!Wk11r23m_)5y_W_n=gD#Dt{O-Wf%1DdPmxyO=jA zZnm$eDY^*^Zr)^b3LvgQvRtB0LUrrY?O7`=JPju7JZdr^8WT1t<+wMkJ&jwKR`f{~lK$|OLT zAlu0Cdpsaw*;m_V5-QwqSu0v|_xzdDJkk%6^JrbtIcqsR*DmxMFs;d=_kjqxHt-iG z2P+2IRDM+!}Qp&yOZ1|I$TJ+=BTggMmi-*cyA6L)4$Q)!dN zC+~*>S>=K+H5%>#RUZs`TY~4~DDVCj3SQw`v4@UWJ3XRy9QrsHT&PSe5cwxG? zzPaDU&u0~&Yg`=ql5n3l^d|4fwCm2*Z)Dy$HMcl3Fh@Vyq;K~f6i@FbYFB+<1a{7; zx1Gx7PPfP763ev3P1b@Tp#M%4Z;7!>ZS{DK!cGKmR$rIIO)-=2dP?%>jLMigx_K3c z3r|6vrw0}+39B;VtD5^gyx1^-XyiI&mh2##r~-LD7uPvG=C$R@ns(-3*Wd_tq6 zluVKG_L>s{`I5A^luz*U(SU3LKjL>K4c6-#^~%GvO^lC#A8@04)80u@Mbgd5D)in# zQIepb^V{o-uT!s!5wP+1Z0$N8Bq?(b%CmvJ30qoPv-q=A^FO0^d&Py~6^IiDHLMI} z5kqm-INDMOr{u23^Sx3ZE8_ONj;b|q}K;5_sR2NsCFTxrz^TeIr? zLYm>0GY$YYBG`NU9u@;ZFx-O6;#j#C?LYRY*#wT1D@z83rx72dsv;(DvJoN4Ai8qU z5H2t(Dr!7{An20Y_;hQ!oJDA}kY%L&1ieg5I*X zUuAQza?3k7tdNV4)S03_2X9{)%zoQAL~C=em}6Qvb-PZ#ZI|6@!wVIc8Z`>qr89WA zg}Ust+90hfZn2F``w^`ivWi>TEkjiFUS4Y1Wt+p4`iFOi>FXbBVK!T> zex)j9mPI7V4W1E$PMPq2R}uU)UG3qrqU2Bq6#Z(oj;0Ac*Mu0 z*m+sl%Aso<87sCI88{8NV6s0rWXxCNMigxHAtkq%@5kx#TV3&=Zt%ZylvDSKfhRg( zu^Ilyp9K032nRqCk#H_Wz^LG}q!t~19|p$Sv0gAO>Z${~Wy^$Y+8q(~C`Gv4uG@L~ z=;+3CRfT!A8tqh2szHjYL2HwCwbcOxHk=(5&0l}kCS=(hSuk&uq&mtYEGr=Yu$iO! zZXZW?YUMzy93PVRiF|({JmFN3Oql$%R9{)oD>noE749mN*&TVGYLYVIB#SdkPaiGw zbur8R=AvDdvj}vWg4G3$C=bU}!Pra+u`vyaF;UT<tl0TIfq{zV+zFs7tbxD`#MC!mx<6p7G^OeBo6hYGA%H%81>`ibU;zOWDs^fq!zk`=)=fuIX)_bxF5twD8|FOEe>O)SqPVXY13<__cz zD;_2%H+K%L0Ph!j?OV$a&o(V4aS1rYlbA|J(%mcai?$Eg~sn=EvBjblKvkv-o)Lz6C&m50MW(&`=bHJ?igZh2gJlg2xJdcSh=RKkBCd+x&TT&dm*yZ*p>I`|mJPJ7FD^9@TA z)m0Uai|ANGR^_Gz%kLkfT{}!`IHsjBw@&bV|+i|nZBV14G{R1k* z`^yqz7O;EzZ8f7*isEbOAEb5lQl{VbcSIIFc`>%)F4yz^H`_uy7)pS4RQW+xqH22p zyp&uiLfwzI4ga}Ijo%#^W*NQIu4{t2k?y*07SZXXkELxatA;lzjyG?G4sM3BY4>q} z60bEo2aSn8`%Uy=8&`Ccr^Ah6zx^k(_P%iiA*)ZkJqc~?(!vLx{w#7o|80`|B?6vx zfF}QPzR%v<+e$Tzua}=U=oW3U*w^(vK7`hAZIq4PUrw=erqpQ2EnlPOX23gDM1|gu zP$v!U-n0@Pbm-DN;d0bVO|v-S1ng~8ktZ&g45Ih5-QBw#3q}aT3IZ)dYR^2vte%!w zk@V;B7?pDX_~di^6oo8r6p2gOOQ=4&@jvPEV{j*o2+bgu^+2-wP-$wjM3evpI52YDg!QhzGDLOOyafIpTu(5+3lJn@|xoL7C`Eh=?7;=inT7K=%G)@k(5 z0(eEU4&|NFeu&^QGD%sivT|Xz&tcg6L~oBbb$ex4x|e}F000B-r3t#fnf6xwi0?u2 z>kxmXyQhDCDw64}fE85kdS(0MshvDB45q7Px4CYqc1<8kcau|1a1yolS|=z2mUXFg z{cdC1lKJ&3@_e$s2-DKzn&1uZjcxBe0)Bb7wk|B+Ehm{KH`z#2nA!~uGo{S7KQTb4fS0H46@lDat2vzuLnuS)Veh@A zltLY%JW{!!0a_qn`F4fgg~*CGclZrP&=pFCb?|(Nx6T$r=MwI=oGTXvgA?G&1hkkK zJSMW8?b9RHva%dixl!mcwmLqfVv*;O)6$S_`j~BHW$8jLkq5wGBHNw)4(IA)WW({Q zWz=NCivz!JC=`+ZzPQM)xpQY#?j2pu8c+oHo4B$WaC6AX5MTW=Gt}&1i!agGx29Au z1~Wdct|CQI{kSM5NbpZA+FXg2296f(B|t@;MW=%)FkS$>m>L!O5Rv_z2Pf6zYg{9S z6qSxuk}(8k*H9U`RGCl8L)zDb7s1UeCA)GE8F^!7IJ%6^)vLIh?Nd|>vL}9fNKN~$ zuXk{NB}Tz)U_&eq2TokqQ4W8oC{Jr3w!gnAB)Ln;lvtOl8hNb!;F~Pz8`za>H1A}+ zJ;j<9eg7A>VAo-mMN1Z?nDi#I=C;-tM@eD!riK* zc;e$^_ZG6**R$}a3rL+-heiK@GyS|{`|}Q|xeW)fW5nySU9d~cZv*65{de);AZ6A# zKMLW|JlB#!Kp0Q-c+pJ%w~*bGYjH`@MMH;w;FJ_( zjeMat3nG{bpsYYx;Mpo8Cz!4UL3l=!6d)k2vtbARc_h`UuuZ9oM^Vm)`}!2ZQU5EK zio2fLXM6`~(Ll&Osvs8UJz#VtiD}gKo_73gdj&Hec>oXtW-Q(U7mv2#ULn?__bOv8 zpU2pxGcvisGQ54KhgVE`SD;(gK9<`kIVl~`x1v^((Y0k;Z~1QH1RWX3Y4JO9i&u7y zkCg4pAzk-4J|wvYUO+Q?;@P*2n3w>_ozW~OM2^63E$oz#Cbkz$-qA732ko6|wU9bg zi|f{!en!;=Q8Lr>qgANn5!E&Lf}&`c7kRs&RZ}k zST!q5Yns@!pO55pP}5+Ml>yCj^?2nHkV}g+oV)2kNu6aNU(85LUlU^|@orIs>Wzle zahW=C8BG;m_hVbrnK9{*$6H9PZxxbrN&W_(sS9K|_gyd{;ett$Gsd|t2*TNF-ps$w z7L-@|weW`VFNS9eAKS%eqdPx2pkV_>*NC{w45dyCv26_0*Ed)yRG1&>hkND_$D2d- zex1$i+%M)V6dnC#P@X$_=f3r52k~sBM=C9Ljc!~1h85J}1F$;3V0zu1kTP_m=)=Uu zfe3cegV`}XV=*SMzOR1%<*DqmH=f;%ESAYzazB26uggIhOYY*fMX_Qk#NvUqpV9OM z)8zGVLUqN<(HSL4&K37PDE%Y0jRKGARGZ0m^Ga(puE8~z5;o)~Bqc?s>2BJfuEkU! zL<8SDo;ShIuh8VHGJt=VFL~^q;lEq?)Uxvj||iJEQSK_$Uz=aBiyc`-mFO<#jWwD>H=7n%W+UTBWz|DuYxK-I{Kpzb z2Hh@4w~WSNLguZGG3Yy)Y#u`0thl}<4vEMB+yQFbE#%GQ;EnnQ_Vy63bqk(k{ceU} z2u{qXGI{5+jxce@6VdQM4#FSZH>rdY;^9U;WqF!jKoPq;HM9RjhxowWYRD7h4Ue&I zoZ_${RVw(n$sin*TLYbx_uF?(BbuqqQi?>x^OEQ?@;gGFTAozLIRX;2P88qxBfs|A z6g0=DVEz8QFtoz^P{h*Q8-8c|;d?S{zbg7w zLoh9C+fo7pSeL2!Vzs@+oTYyAnFhp-isk?T>jGj#c41jxstuvR?LNws8sF6=!(FP@_1{ZA$;f zab1c3uF@m+7DD5Ak&@hyfYH117@Vt-SIQZ!m%Ql~?^X9CGh(4P0?f82-Ybe#U|d`K zB=0DPhZJkz7i*>PgSPeaqwC?$#$UsK3{M7}ISOk3fa(2iChbORdymtiV@E2P&>>rPU4_#|R;|g^PMgx$#tq9ku-mdxVK&R2X9dOrcZNt5mYXy`K;N!FVzb91G zhrS)#N2oWQu<(WSm*vJ|{Igaf?6%!kO~7p0*5Y~oRY=gorh)~z{R21QmiF5or9Tez zE9#*Fg+F!3TNZC9(!t{!QbP@1hjBxFYy9peAjl#S?UO#$s;0KrlR-}%vW=Xm7i_aT zk?ZDnj3SC;v(rCzYB{kMt0$x}ElMG5-^uFPl}=xCH#-J-{~}(rTQee#8u8GX)1Dzt z49z~dwx8Q>hK>{#`Iu7Lvgj}AI?xN+Tq>T>w)vyXw;$Mf+1pe@v8l)i(8nOv>euC_ z-*dTr7h8fV{|+Vru^?E)M)+ExB>4-DOtoi*IqD^K4lFxyPao-L)Y&SY^3N(%*s-xX z8NFM6SD_O{lPv}z>^5VqWMcQAkhd+}`4-*;ADW7j76Vo$ZaAh3aYIY@`QNa9o!HO; zo9XfF={5`c8+tzql{Xd>lMXqEVhCqLk-|2EgP_v2*Ol`RQkLp(AIjZ18L z15;JCmgfTYftBwFg!GK{eEJltl!!O{670vj{eY52gJ>6T6hkc_T zu9t=W;8RrtK1_>+H0Grg9X^whz4Q}-;Ms7$*&{n*M@5HbG#{sUDA>Sd!ofj^Zr1`0 zeWa|q_tY#;;p6P^k;>-vlEEe&r}`$Xo?HzRB8@ONN9ss=X9R1Op=&xOygP_04;#k)vPtP)VxEFB{&lLv9HFe#T_0~=g0xfWb7y+eIeNJrA5 zU=kZOiyyH<>d<)}IkI`&X2Qg}v=whP(r~_5;>1^Mu(G0Z68z>~T;ewP zgV*!9Q#X#7qM=VM3FXQ)32|;k-4amuRURLl0}F>rUPg7h&{#YI62FOPT^$$0W~oRi zmZnbFkm?h#^OQg%z1qokEN%c&A1E8vQYhSX!4!hV$C*gnehePto4@xkbuS=?^~~fqo3OPq&d6 zBh+jis!3GLXXB&kSz#VGZ*$C9t}FKZaN|w(yPY96?wy>DE#w&oi8>lVC5TzTgZw%q z%4)dVAt_VUQ?RLiTm7E*=j5l0d3|72NbX8>u?``&AI;`Y z_puV{B$%1jbmLMN+2B=>{MsaOlQ79S?VUVh52qSW%6w5JujWHVD{@TL-BKV*KMoT3 z$|&b5dW!~7;+>Foa*3V28-T=w!ChUZTW#Quz7B>?tf}MfY1b;sn;r)n>J0Yww34l^ z4GW@YC=hOmm5 zNl%8N%1s{~(+%aHd7zezUL*#8KB&=9e?ql6k& zayDQ5Sg}H)@2-Y>G(kKDCov0_&5jdQbymwQYOeqt#@^BzmcF|*_~;oyaNrYxv?6vc z3kI90p7d-k=>{0P+=TvCkk@>#_eLj7@`mLN0f~4l-kuvRsLo5D0MP&t?X8tM14CcX zmp(IRREno@Z68%9o_5$xKIk~HC{7MS?swCnc6>^D}>w-lQ^ZV`iPUs)X(2Fd52>xbJ#7P z+NI;(6dP*!EFX$amh!}r{eZrdR*amH4;zTyM9*~$tOxARvdK zYp-T3!hZfLhc7vnJ~+!h(pI=iaETsGwPESRqgt*0L3 zN{6!cfQ+MmB%M5i0OHEMC*Q0aL;0S6mRyPhm^?y__ShuywlJKaN~=$}UQ9`d!lH@E z;YAs>H!ZePojmO|z{}P<@cNls!=0C{O8FlYcGu}-E-hm%w7tXQ3xbM8#lq$(HTZ49 zxtUj7GtJvl=fZYRY563H?PXn${g_=2VsEA|g}o zv5sqU+m#}tQwX4z@yxU8OI1-Z_9C7%SM<{wV*fc{?C&Cdw>2p-a4)9Q z<|Tz8G8x0?e<-j!m-CjlVC-yx8&_QjF6jh}XO|H$OI|OGY=2WSuam-!^^^hs&Af3li-O@B69at@(g3f*kBuR!^G|;E zHJ?n8pH=XMcJuPz%An;i7v{>+xk8YniA`D%R?-_{lY%3 zky6!eBL-4U2gJW_rBTI;BAPNIiiRSLYL0!3nf-c9j=EOf=3|a~V(*m_dX*05b3W;- z{#5<8wWzk|_Q~a=a;*Q5Q{3zIz~bgD3z%D>n>dtxRZN{DY8?pzsOY(}OMi{z3nFv#7alu%xfl@ia5w^|Mi zW^t2jF-ZO#-Ruw6)>Q`fd|3Hy=$ZXG^W)DXwy1jvlE*h zVhWWg2Yp+sjCnMGD3)096F>Jur@DG|*5^;eHVFCeHh5^uHldv)lT)jWV&^$b*e&~- zIzfv`X|L`=>`#}wKlDm;zfa|H)zl@5aN%6ZHN@KxRb!%3iZ< zmCfgr1APjPPX(;kTy`TW#A38=>Vl~R=IJJ#ZEAaPVyqfi<4It!WZp%VWf8HKXK`dJ zaRZ6P6Wk}uGEM|fgV*ff)W{f@o?G0257>JfOwkoA_m7MjSRQcuF8io7S@|~>Kryqz z>KklTQ<+8(q*55<(HP3}qGjC*U-N0Sqc7KMpzP7M35Ohr&OWdcN6nnf&RymAkibS0 zoHk?1dLCN#4r>?Rk~ojIC_e+8)xSWyS3oqy99FY;O?R@;r@>?K_&M7AW0#_g@k$-( zKdZ;wZn!kFKk;_UxVK7p8PaR1qbjytvW6K5M9FN2E zvA8jt^7ah~@A~7_LKBy65MAD3BRUuuQdW9wb~g}Q>FBU9U3;a9+4jVptGs1t$qiI$ zLL+w)laxl{0FVaCBaTh{GL!c=usmHJtlUN3m6grH z4?nv5BO_^Y_Y83BZHMu0tU$;GQzfKiavKzS!IV@ef-Co`A-Wp(=*+mrOXQ*Q~dn)r+>N?8P~po7T=oC(41=%u6HwQMR_a8 zRr8>#rgb312>+#9{$KN}(Ty*``&D4d@blH*2X?^{tc5$k+z-adNX4w~fDOV5e%skD zkfy8aNnLxUZIf0$n=XviX}tZ5pw996czv!iSkV{8SFG>8HTyngSSVgx{_=}avvD3# zJA}v(z@_gVT8je56#F#4WzzWPQfDvS?1pFA7`zpI@X7qmP3S5HnfoevhQqotWHQU~M!s?3;4Rn-Qg3N6Q1(C|1Q^G>aZ*+)|3nCu!mZV^r6A#T2b2@$Y)|+96OY)LYSE_S#&1oe3{j1T`ivB@)h6PA;C>8AV~;% zkIEamXQUr0re;Iz%_;zF9x~aVv5!Kuj9dG(wRPP-M82K`aHz|xGK8AZ1%omLXhFe8 zm!H*L%KO(^ZeUT^5#NLS_0nIIN*X-lNkdWVUstOPWT%7j9U%0<#ZZ=Hq5iSIWKqC($049D3M0DV%+_ zlq+$&E}a9^^&>23X~O@_j26QI=q<++&%m+AHx*fmd&UcM#YUC8HZwBb<}e(FIfXdSkuuc`4WDBd>D< zmrdN+m(@Cko3m>90r-5_rqkwhSnu3U^YF!SLh8`J)j~Zwf()hwGjeM0{zv%#zkm8K zBY^))clbZm2!QoGY|J&aFsJ3SPE|z2yrn_^;bSEbwUVQ*OpM`c03A@Go+uur(1Rf4=wIT|Wa!LB; z8OB06YN2BQ9a6E!m6_;PCFx(jVL0l22Elv|4-5NI9qwL3g<>^NSFpnarn%acGbJ1k5A4Oc6ZL+)P4*p!(FC$ zK})BXGkPOZ8}~XFzvd(&?aflG>kck00l7S#(3%u~Cyk>)(x0WUShsY>x|JvJDD2~! zrEBx%;b?E?K1**QI;d*)tjL3CLFt`3qpsZG_*yyqc5=HaCvELkYh@Qhh!|IQ+W0c4 z14j(g90?*53(s$l{l5nM;eW)#{a3jE8oU25{87?nq)ktRXWG*BZ>k1V|MC*8-_i&i z^Vmh6Ju_uD|8MNQcR*9wx;KoYqmH5sB1MWgARt|O6PQto0s)bP&`~-G9YQabp%(=N zBs2|Dl914ADAGGfNkXquL+{-$bI!RsbMMUP{oXm}-t)fvxA$Ia?dP|CYprKJt3J}L zFdPcwi{>O>Nsi)iu_^_d3|g@IHH`Qg=g6A%;Hy{{W%cj`zcWkV`#RWPmAET^(WC7H z+nK5TlLUaQ{_0T=9%E>^;yVTVHso{bJ9GTEW8VHRtRWA6bL_&5<#X3lJ@zOft@1V~ zZ)pf@=z&%!)u5%y-7YR=QV79^M>~ZXaw@Ye+pUa^hV`0O>S=`=K*|)KpSe}Al8={~ zAFH)~>cOIYCP;V0VlWVaVP-BZo$;5CM*Z5VA6YQA>DpbA-gq+l&{eR=>R_A2^T*{J zUyqa>KVXNq>B`ZJa#McKj`zq}*`@lecGl#{?7J*mXH51jo_9JD-(K85Eo%%S$Wtvz z(Run&B~+iO=&S5cT_1wYoveKKtDk#TqO*Kihn)B}j#wq0QhDY2yO&BU`7&_`3VGZ5;iesION<#WlA+md^>Oz#gxqF1Xr_BB-X%f=1^Jr!1l3ce?aXqUH{(o z9ckM$N9=+QL9`NHEnXF$t-9~X_q*W9n|Bt-W10258t=th0(5$t4b834FLAMPJgE7N zia8zw{?84W<;mk{vvm%)7G{D5R}j9Yleenm+bAe0ciPp5d~sv&->7q zTc2kIj)$)QRzuf6n6UX586ST*F%t9Zy+Y@MKhOSDkM)-&B-}C*Bo4}&KNqs%UKCcQ zm9+(}vRp*xd+zi6=W_-=b4*7~G{+(T zR1Ubp!=)4BPx!ASjZ*7nItzTH(6vjAO+Rl)$L=SnvsDOUv$P(Ta(5Ao^rXmroc+oT zS(uMsrWzC!!?byU6n&V*wC)2ZB%FGmdr@};0GQI(X+h{!L~`Kg@_oT|^QWXRpF}^E z$>qDFTgt~F|EoFBprVFJ3!iIs$m`P7cNU*x>CVTXxYFzFhTd4rXY+Dd50MalyKDj` zA|3++J*FBLEA*t&VI2moSI>(4s^Kn}E==x$Sv{4=7ll8XO{_lcDzxQz$oss4-LIeJ zb8YzXIArVpIu7c}-WnI`?e0(69p!YdzO=(3$6shotLefte_p?hYSlE?fBWi5-xI?h zn+N449!Sw9nsrHOa3<1+q<#47c4+*w{&X@_CSdpb4}ae|^Z2ip^3Hi8WZ1FAKv5ai z>RIlidR@rrm1~q@1muv@BvtPN5I77}UYSg#2Y6Bv2ALfOk&gnxt=Y{eq1Hrzi2}r` zgE8Y`MDpqrTPl|v-8|?egIu|XMh=R3H(uXcCYX5=H0^;(ge-#ugGGZWD80h0CwcEp z=PWDJto7)HJM-)=YT7DC^9o&}PAlrXJ?|g8{dF0nZg3y81tmR+h-eOA4Hn_tea4nq@7m%CNl=mZEql}H zlow*yfLjr^!VSz0Gu69{z2W>4N>-Ms$W}{igx(pj&_;J*FUFA0MH`!&(XjOVz%PEez!3bA&{9}P`Mu2U)Jg!AdpNZA`v4}?rg!S+s@ z+`IN83WiJDS8vH2a;otV1(_lYv^$@npE2gO0wH6w!>JaJDIQsURi!$?Y?=VWq9vS0 zin4im1@SJSu6hRdF2nBx79$5DrkJo1Q$0!&KttNHj7!Sww_t9y1*JW)+UN+gkp-e2 zVT5ip5J`P#?yb}#W=6s=Vh+xGx!Uu%wv<8MesLSpCxEqUBM|`+ly?XWS2HNz68DO3<;CJRUP>tSOk_@LSDPy<^}0L|Vo8lP!(%{-z{w2Nf~dQ#bi+C1jlyHR06Vi$ z{y0yx5589ilEg}oa4ix?f5;^JW1fwqZ5weCD4QEqjQ;V@rT;dR!I$&xn-tcud3YF= zrc3g-**b!hzL5hkf9k=x?5iLdAn}b>AkEF2CT&xCIpUN90W9Ymw_9rRSy&Mp;| zF4cq_87lw}7+u>(fRostk%Y7$fRH&eUu7ZVj;yrP-hfDdX9|8#SLDYNv|qJ}`<=*q z09nDP-61O&NShz|kkQ&Jr@tu}u5eApzbTk|l8#-W=@qAam6;TV`RHumb#Z(euOzal zY(k`6l0Q;dC}Yg8ZYlsEjm?D}_zvxcGA^gh*|{G(7grlEd@HK?0K*b}Sh+tH|;jpYIfVrF|WMhNn-ESHD{kKOuoDl&D-%rdT9b^?FbjdCR z@Of3*!-gd(fhN#u8W2E!9sdiB-x^zH)iE^iS_qYnq-WrqV8BAFCG|lr&XgyCK!u?> zBgXWyU9c#JQ6aOmbwas=Q>%2LgVSD5SJ(1Pr%~d&6SQN$58zi{PuV8A$$-knAG4QQ zB>7(OF%m#Lg)`ozQ>awQJmg=q!VgEN@5d1fzL)H%Ea<$seV-7` zDpCmw2qjrFJ=xKtIfW(Ic=}ekn8^3PlJGl^r&*qntRRjN!Wn6ev~I!3d1QiYkq$n0 z0Aw=OL{v~_-%kS)L#%tSrNPf15lj@SCb)(NO;yeS>td(gD8pKE*#JkS#DJqR>kO|C z9E@oXR%yhGbZwI=7>m@Dc3v%Xa)LVU`tJuF;Tp^Et*osp{v|<_dw6(0vX}{b< z{w&K5n-!0P;ZsEHM+&j6E4D7#5pyDLX4#NByh zwqiN-0gwc&QfQCREJ~`l(Jv&=>aAv#_$A&xp*q2&;aun(oR%+O4Q_PWdcF6uI{2H- ztenk}F@>WpT3xA@juvwG*6I%y+XwF)YELIa`gI ze81SCMO^sd=p3dt!8a}yWZBcClTj4!Cnu+YfuHO5r}(Rem|phh#08hcSnfbX1Q~Qmk1}akG1&Kw*P=dIE8x2iQRI3YL4bQ`al5{TIC4&y=?HAdOqQ z8#_cYbFy>7jcyLh3^>g0wEbM0*AfsAFz9Z3`YfvULhQCK-wU8hwq6E0S}%PboobA* zO8PG2BIBj-2S}($gUy7Px%Nm$bND(-eE#<*Xmfrm@ekilGkHfdaaxQAEjm2{*4n+r z>Zd|!k6N;V2y3eMGN7g9$QJ0x&V~q^M7=l;q~!k4D@{q8ILwQ*-4-XCM>EqS_N7SK6_N`wxVdZ#B_%<7NwLe5{r+{y zQguLLUh&Iez~M-^*PgdB`_KGPHdB38&Rz(cNFW66;xOj?pJ4p%>&dG%%XQC7O-@yo zH59a$@Y>GVft`@2C;g^mhNO(S_6vk*F1~XS6^#qi=f8Rul~ajW+2usS6}{}9583ai zQiI&|Di}F~*GTCmDi}!ImH6D?r2OJE856GYr4G@@-|#;CU9rFZc(z9p^U7(`v$b(_ ztz|ouBds3T^B$xht6(1W2IEvzmg=~8K;ud8L0j&Qzy{^%GEGkrdhDvq7wGxAvulL4 zO{^ZJzfJcyv)xiO-FOqDi7sh$Sr!OJvALi@*B}2{(tmwEedTFp*2Yf$6`=l#VN0i$ zrr|j}u@}9|n;Io|sTLh0p%;QN>{TFUM3h-ruskJY@~kS|d>YM!H%d#-4vv1W%2*hi z;bgtTDG*#9+Jl0?SLTSiN=VJ}74O3c56haw%4{W!?%dK`>#Yq7a(w~+8J?4r9S~JT zSI|U=>el&E6OwmPzrLnv5xN^S)-G93HwizSI&2}0O}=Yu6O=;F^2dXNNlUM$vrl)| z+C_GcBH3K>^?OEj8W5!|$)^DBD-&l*pIOf$Z~8~X4qG4#9^A1_k2vq6f@)W0ROq!4 zB;ODI3N8i%8EU#C7p`hwhM!C1x5!K@Z*~vR_mP<_X$p$Sf;8ao#Zc2Idb+k&OKSlC zD}lfLaw5PqgjZIZtGatA$FOBx^VCs*d%Fd9$4nYEmon8wN`1^iql?K zch}NPr*>j|5Jkw!Z>9gi+c%>67EFezQA?%fo?9LzA}`b)WhFPlvW-X!t_cSzf>k?4 zlYVYhZ#W`x0!1+coT@w)F`h#S&${0@SYE5Jd9gX2+_aWJ?v1LR4iml9Wf?F1_y>~y z7k&QwNn!TC&kp_7xK4Q#d`oCHZ-EZCQd<}{Qs__U8R>top9=1M0M)w0CX`9!Sw_8u zrh*kbvu|Ib^qUymQS>{t7^glsIsUG8-D@zgbg^fEwb0m-ws#J&nCjQpF6F+xYuhnc zGBVt=x~*0()+IK#{N(Vj1J0f`i_=*I?#T4Fb(B6V!cUN3Vj{DqU}@6*B`v2>E~~}9 zsV-1UW>7*R==(@D5#hs)Cyz*fw@snXX2))HetURtt4eQ#Z%t%bH=ddWU7*Xbf^j9wcw%~e_Nwh6#v>a$i z#&^siL7C*04#B|S<*Vv6TUrD4=>BX|&yN%sHqvub7|HOkml#Ein0YoK`$+nI*$mxf z%RKRg#rULkk-=*ewL@RU^a5J3YT)RTdLU-hp|(lmRtn5Yk6{+6MVa1dDi0LSCzv*B2nJnH?#>ATB-O} zNeuHQD>=Eack6C{mc(Tx&h-z5_%2iRej4Cp*QjD^n=5HCa1axk6;;2W@dJoh;aox7 zAH)oid?f8i=|>fda%|+WWTirTl9UT_usb~ZDwBz+!q?Jqf@SdpEKk=ddEK#2H_quD z-Oi{=w8?oF$X*BlVyd9TCe%9kAL>BqZP26AipAQYy$`R>4`k#+_FU4px~dlJ63e{~ zurs#Ur7f~GRCfAd$9P5M_Nm1Z$DJMK$6v$B$?xC62rYxLJmyu51mm|E<*l>|w3NfP zMG6oofE5BSB>PMUz$UTjMy4gIgH%Swhe=!KqqZKX=WdC3`C+#8aYX5l6hwEIol15# z4(&qKFf|<|FH5`rK@oYDfyZBC`kwwF0?`mP?0|R#RcFXbwH=SZm91n?y-rh-(Y>+l z?lfD$G$cx_MVWuFOmHoib*z_i zPqyYS)UzT1yCcp|;Igj!J@pxpfkUw=O=e2xlY!cyu@6k(Ok3x0 zWW%PH%4SPdrGkf)fbzY_U$1NrMXVT-mvwIk=$o6nxO$#ldbyFKEe^k)84_)DTS_yy zvTw7?jT)vvtawAdH=8jaHsPWkauyRkh@3z?dC}E@%IgtgSFq6_+ca>vn0xl+Ij!z5 zRvLE(|5xGL<#I)yOne*s$VfY3FmI`Qd$hdF_BN}b5W{{cd2opo5-7iO_O zVLTBe%x6`ad%auFp|MaQhn*d(=$FspUC5ZFTI+@>rZK*_=SOFx@;IcjJI5EF(U_KplqMK(nVLMzIWZor|OpZ@*7_Tj|eZ^Hlkw9JoxHB4ou zJNh>dXSnUfhqPkdy!~vFHjuJUyJy5v87e_|tV!;IlbsYbDK+{T*oZMo*nzyxv{Qb{ zv4Ed|w`fU7gUyJd*VbaVQlYuuQl1y>Z7CE&h+&jU!9Fe~*hK0UboJ$^zYsEYrOUv| zCjO>^dmtZnr+u`Iz4IJK#7#AlE?l6=rv(4j20Gju%g|EkwAVnIF`(4@@ z4;bd#OzqRt&99&5%GZ)&#o0wGVHcdXhsxOO($T2bUo=-wOq&GFP1S;}(EK8X*L)}! zV*^-MW7Kqpvj7uG`O(@LmnSN?(miyrR@N(p(}?s{j&ughCRNlpja$my-td-uF;PQM z@F1I2#c5OhmerTKpycNM{9>g;CS&oFX>SnKt}6PrPf^XPw3PfIgFsaN0|}UD@H`5I zRrkk(yt&HV-5EVSvzSbgZ>!q91N6?avb0$6nq@(9MPu55ii&P3h+o#Rmd+Kn(5sbH zFtg|?W#!@fQ(eR16es*2e^nuzvJb(yduGVw$aWO-VYg)pSuQl+$W^%Lq&dJi+r@gh z>A4cB1zw12cMa`IMUx2%&^0{hWmX>o~VBZ zzY-j1ZVS6mONH;WZ`jmH7cB$jLV4J=rMa$$W}OWQ9>{+~|Hf-bl!H|ph$*>c*Lo|z zC94waXQ}O{I$GV;J#BIA8{XGniRx_UW&N8Uc9)+Dz)DTMN{zTN#hhIxujtfs3v%^> zb}SS;MLdBZrDZX&(M%UEcuyuDuN*hZ=#CRH}xhwljcx6$M5 z*AS$%PgWwEGu+s%Hmz8&_q(D_4j#b60(1gMD@_4H6w=!wPs)5!B0n+No_8tK6V98| z_h{!iC{I&?i(`%gzJ)_zdO=+b;Yy{Ts}%?=oK1@Cq5aAA$6tehqBid+r01S-$W+lo zoc~jm&<|@MRUme_R5cZb3Iz*j_2w*5(Pcb|)q^=W5oKAJDi5W|b2YEOi0AC6DCq_= z*TU!yD1nwi>E1G`&o);n!tR8Le z6|prZZx`IKG^?`@Ug$}Se0&!3_)o;2rb;RVlGRx-4>bRx_xY3DGTwJiN_;3rR3Iw} z8z?NUTykqja@O)RFWkXIC9$Hi`e(jA-$i#Ho-}^iLt5K)91x$6a4B{(VwOZWs=tuU zy0z8(ut+w}yiBau0R`q^<9}esHSX@Ph{G~VCO=u%*9W%3czNGEWsH4S2bYE!-FrR^ zn9etn$t**7>#^Sb6Rdv=I!RT(dAZA!nT4`%O`k8Sw|7muNQkx=b~jpE%B!i}tsFi6 zzKzoD`#XNoG>=O8W6}J8Q_etsA4R(gXSEU40zF&#D`248l3zFn*_zn^XzMDg{C#bS zxu~weQR;h&kiIWr_*?il5~*1T*Z1Iabkp?;n>IDMvVFYK>MBV|&NX8Z2WiIDb3Lii zMohod6IDQHv;-72lk+IxQDIIkvxMa4)}u`WT+E~B3c~ELLGZ5L#(dd-Z)EgU82|D} z|J3Vi80>88pL4z2bTlu#dIeRPwb4qc6MnToz(lRycTXf@YhGY^sX&BHct8LjXs>Gs zwy&46_i5DL<;?_bL3t{8-Z}vrFp(0>M7vxU=aM;uK)D$3zqfnf&-r3-HBo%dky(@6 zePg9vL9I?SyL?~tIat|V!H;JT@XOkAk0Utn-mA!D=YgEX?y0zls;P=?+RA7KP2l@> z8*nP$CO>qW7bU?w`YwO9xX}JGp8n~LdyoHID#e*4|`+cubl~TJt#guO(M@YPqJz4nJtlX(lz^W)x@$!WD~t1W6UM!bob7`PjSd?~$&Gamwc2sM&{lQQbx%q4T4 z%}9M)UBm_nf#6I zA1Q8beIZx>2!2!?$${RT(V4_M6pnK&2RXpzTCU1q|ft@ng zjDf{SB%;ffUQVVbU8Q{qiILGw7PDlDaqiq$Hy4ukZZPP&MRr^iGWK;uP@KF_apyS; zoWTwXx_ZTz*8Bp*kQ1f6f1^2ushLAK1KNyAb=zG2g$kWyJei6t+Fz(xtXWotlnO`F z{FqHTZ^|65Tq_r$wA>VuIjo27`GtzdUn%}?(S%4pyQlRH^l;FM#Sl2VfgCpZ>}9)o z0!uUO85i1JMu@c^glW#>-VboJ>woLABRvCh2pH7v6VybPbw`FED=x!j+&qR{@M0_8 z57N~4MJ{W_sU&+mFJxkKvkIPhMQEou1^ya5Coi;@GM=rBp}yR$p-WQ5m6iU+mU-xIlG{Cx^Vhc5y-!C+Bwks00SVJSx9&pmw|onFz(UpZxKgVr#Miv*HaY#P};#PHM- zU0T3hIt})=#?qcH)3EZl31TV!NxCkXrhJR(X32e^YsM=uuabr^JPXQYKDZkLeDUtj zg)^udb@$ILOE#!lT*T>ez&Ez>Krnk(+!YCGIt0rU@B^^|hwv*EF{OT2mm1U|AVYY|h4ncz;SC$ADEZg`5IWo1XJ?g&s&8~z!D zv-|S13o&F*DzmFsPgR)8*z{)EZ1D=;Ei6Q~Xiz!|S!sL|gN_$}84=C)5wQV~8%(N~lmX)9 zZ~2A*42vMJ2eKLlng|^7CNvhQ+FlRC>JiG$;(5RtwdwP&huGjjmlc3y%9pK@?;0)_ zd8}@oNv=9$h>dvxFqoG~;*rNJLUItYJ!lZq+u&6F^3ZyEjpyP*d;ncahRL%Jnj?~| zVX7oI{_oBk#QEFYE#oDIN(qnx)whzQFJ~xuglP5tNyE#PE+fDI%x=CVoSwu(`yfIL?BtyfR>lTbAOyYA zHP~AXJCfBlD+Z#)Qoy1*zOkU{3Y$9HbA0F{rj~7W@QU5CR~igo_Qk6~KLhw5d-|uE zDbyoAV152w558@iUQ}xnU1e}(dyg2MQmLiIi`mTb>r3?SLQv&mw-s(K5JRs3evWx{ zsWAXcRK$=kq&{88^Wm+Ihs9dNqWf|xOxu^Fp6uWD<6lP<^@uH4pIe~soJ;@&^l+xv z#M5eS?lpwR*lgJMB^6#$Y;V;#SY{r7@B7-^1DzJtrC*_D|lJBlo-KmXK8DyKw~JQ<>COdKWI8i)M0(_m$W-<|ZZkvf5V1GC>7;dtEl$-}>`BB6}p6jB}J2 zq$?*+peh~cU45Kn)2E~jtXl}j$v7vizoNLg`Gs8kBUl;SLNXO;r5v1US3#Yd<15U5 zezp+VG!$Px3`s0=aPj0}gQ8Y@p33N6uElDainXhX7P#IL6S$%Z0vj1{fxUPysPDU7 zq4J6X8Vyb^XPk01`8vVmSanX7sE}+*X$YmW9A7XLrPcpkBz03cf<%96*7CNuA+xCP zB+I+7I<*{jN5#DMpA3m2B-%7EW?M>e$c?oD*k!m%>UtkV-qd1E(~vcjhpFlrjNOUv z7s|L5^tE%e6ci^|On69U9>YK1uxM97o7)uOp1rA2gE)aL5E8mWWez$8AcZ+2X$NH} z+bh@vpV>lZZTDc7JH$qO;9RE}bRIO)qSZdI2FO@;vI8w{?vzQ|f3XVvh9XL(DJ_Me z_WTD`%$=$aNHEp-hYITIxn=43s2yFz+}hmxvZ)4H-K%T{&UR7B{T4nkH!MgYr7+U$ z^ay~^IPw8c|GaT*JPY~DVvp!lcZOYGztCz|5vQo|*KY2KSf4KIw{P9naBWw~s(4~2 z3fO|gXJ#w&Eq1fe(*K;)vO^65Kjq;Ideo1h6G=EHe(O8aS}+t&?1ln@Xoszv*4n37 z23Du2%XRlL(w>*UwAb_>`DchQ?Ck=kv+MCW%W)_f&-b&n1SL1hO2AU>{d2eDQj5st zU!7H_WoZ9ykLTj)`BEN0kRLBR!7!;h`fZ>OKad1*r+?gd0AL`lczi$ z{)XP)d!ZCz>^7BJHKI(pFrFykRHQ|0BejFt>9Mmv=)_#%V9Yq>Sqj1uSHbFgC<`<5 z_yTvm3}L4h==8a|?a(lKp2h*JctcZxE7EhcI4W0f10uAzs9zp2S+Pp`lKm+(#C4ke zY0*(JNemuv#m?#8PaIW-dvF-k%{;|;58tC`9DIurOSZyc8m0j_y2|!|W$k#5s$S{b zZO#fNeYxA|(Hf3dvV(3)^4PGC5!k$^|5? z)Wm3q-6EEa0~5<3!Iy;E-OkvR4oJyp;|#TcC*={Oi2P^Ri4g8x&b6#y82N5cNVw4+ z+XhQxr@f8Z>vXg4TQA%C2Q^I*eZq$U)B`9iaug5T`@J&y%{PX{ElOoh-dg8@1p)+Z zCV<*fL7|OsZxuuD5|X?IJMh^%1#9ut0VW|{*Gog6PG{G~p;~{IYvR996T?byVXO(} zGC)Z&CMQId;VTiC)&9bMc{CVG1|w83+$ zCvy%j!@zU>T)ASvgVf?{{-F8#7*q&4RnrSAEB&Q~!9N1@ul)YcwKXET=oVyLT8p|T z!iuXVLoVa=M~ZM<+{7DO9eA73XU+y$CR-ho>A{VGm!pHWZ(&^sSywbPLGaGjX}QHa zmki_8n+eL&!0rTC6Y_0ROSXp?XdL;&U&s$T^F;BZfrX#qgh!poPJcr<-qzm)+yU84 zNy&)a7HS%3NowR8(|?a^!mRAjsk66rmG;~>;rmuY4k~}PGViDf@!D2|W6NhS;v>aL zkQ1cNDCxuU-01K(cfN%279Z>ahtj#qo*}+Mw-9SvJSBYeUbY~xK3vn}IZV?nF_A`* z2paRs2n~m@zpbH%$2*?u(`C8b0c+1v#xUAtk87g4F>~+RrN_rTTid|NSs4}`!%Q2t z@28$2-ab3qHV!MNlOTE~BT;ejB(>MuLW9@z6>_qCL;C^U+D;i?5gO#UOZT3b10 zIPdsXq`|daBP<(`Jzx5!ePSG1eWg>6w1gZuGF3cm$2%ipp=7Pbz@W>(9Ba}+JUL(Y0N;U!!Yz8TdHDoD?k`F2ND4Q)8JJ1zepLWJKt;k;aH!orX-laaH_`CC29PXLVbvPpb_0k{v=9 zsq7heH*1<_&Q^BO5{sy41{=;DI^=oO2o}heKg=ec=SpPT|IzE=>gTsRpQD^PPVkwR zeo!S8jK_}1*WOqJXRZn%D=0MBg{S>Jt3R$XIc_ZFjMRrbUFuauV}?6@L+*8cxqtuHe6Jz+t{ zxpfDbtE4}gTYt%Lam|a~d`fye+h$R_qdWn=*hDOHV-cO}l1w*Wocz|eMEBM>{lLvz z(~Tw4%v@@@GkDy|QlcK`J_q1BtzfjS)&Z*{$i*h<+|n8ZU3;Iy!9988CYaDD5eLKw#N{!U4BPnl~^t;<45IKQ^|o zV1LYOnuV;JyDGEQ++++f(b+xSxS)rS(34{!%uKm$t{{?AJ~zI`o3286)f}7lAa}X< zQHJxZcjwQ)JXiQ~K71%MLGdF6R1XNd9%O1LVHE5Ucp9@tGeNAay#G7?>FKg zOvQ2c@VVRk3%iGWiq3>E?Zot|A+EN~)*^)_YDb<2X}90=bTVmrh%FW4AIMXUi>XUr z`IU05&G)0f4>re7#GT1MIe{w=55z2Nw}yRp2lTcLd_AEx1Jdi;O{OdPkjwc#+xD-9bjNKw3mQ9i9f z)+S)<-LaVeY0_?aaddx|-+E~vA%Vq@LpC;esrnE?NXrMy9Pq}>IW?m=m%ReYY0K{Z zEN@MA|J+8bB4``tb;s6n6h*!S&kDXoJ7VH#J?>fn7CporhVd>dP*ke3#&H=RH;m(E zeykh+%{9G;IG?`1qlVz3DUF`pAr#lT>2CvLj@`oH219UVOE`e1i}4B4*RGuWalC)- zVX#N>7(gg$1uv>2NHrc>?__u*i9_xOA|~M*wc%Z+j6`IQ1sKcY)|<+s3D5U{POR(!EU33tW(ZAtVuCi2$5^x1jY^Y05!YN%>x59ma>BgH|R+T&)TUMRC=W&v6>j zg+!!K4qPjK54zvo_>+1QHze|b75m+R@CfpNd=z38ipsuh#FfdV=PJK7x2?Pm^wnIV zIDPf?7xMG>U`pYl1bP_>{+RnZH|t*67D)$aIK>&8PoQ-5ahDC3e$q$aw)I@B$OTS6 zWZS2>uRI{&Jf@~9e*O754Q7T2arwSi*3y$jX08Oc zZl(jKGbXdEVyI@jY|=cfk8FxjA%vg6kGHD|Lz3mIRIq&K*rHnG!}2r`NeZ4@>7Xwk zCwYQ3`CRvL1_PORyDod)$POn28G++0@R##mi=6JmiGBcs!vbgXjEXBZi5oyYK=RsC zy}RboXCX5UL@CcBbO_2XQO2X(Yq-5;DKvPZRhL1H)7uO{%lZ)nEJnjNwSYJlZX zM)mGmmh%*iLj(YjUxxt=Fbsl{_)2rt*k7lX9P@=EdCUu(^YzW*8a;K=3|I|EAwL(kL%)}H0k5!a;$XzpH$sK<;_h8*qnzl zQ}aFkyXRV@C0b8ac->!Y%(y)}M@v6-8+vnL{4jJ?V%eo?iF-m)fJw1~fU?_As24N8 zb*=xqA^o@(Q?pLBSFH-)Lw1IYYt0~T#?>Fu=MS6 z;s9)sndKmN6h!0J`y#hhkAp=+QrO9d#(O7&KT`O9q{w|_^}JS2(V5Xg)y3?4lGXx0r@#0qqje2u_$CZZDi4jg7>nmRcJCy9N+0-%v<4`GhSdY=Z^e`p>! zez)+`%PWovQvHTMi%?PC@hG_eNP4f#)7m0dG{VAAm&ve#2|m>oB`b+dR87{tnm)St zqQdVRtnrc5&&%F{l_T~r{nbzvbnCOYa~4i}gZg1?gl+^A&T~6OMRn^F{>Q) z-1_o{Jgpxo*oWPedD9byKLEf${CD5iu1lxT0sAp+)jKNHL68KuR3Amzc|hNzbm(T3 z`;OqaE`nE1PIi(0<{xI|zaOCN5$_xj$}qLa7mqE`+>DE7Xw`dAWNagSyJ`$I^^t-u z7$xIXi}=MS${nhPmpgejsy|<^B?ELVu62mq)@uz*D5RV95L0SZfeYmEpb#4lYK zUxavz((6Hs+7%CEG>rg@jf)e{@Pq4-Ry%%SLkG6ESdLbglhyem=ENCG70n9o8=zCv zx2o?Mm1(t2sZVPRWqY?vkI-kv=U~~*7W?~OF1<>E8}9fjz-w(|iZ#r-HeQtSx@lIx z&@?M$T&G5s3N*gkPT@!LBtTPbVSJbI+^4KXZwlnr9rlhu=>sr|c$$ej^E8+_b3}+w zSMg>~)m@64U*}xl8=0)qn)qG&0xxvdCEWRT`GU$qNZK9GDVqL^`e_m_I@>aPJQ;Ti zBPr!Pz4c1-0idhYwac}(Ih9g^5z!whAi}wpL=1dbzK)mrYPmbEx$%q4eJbMzi^XX6 z?0H`kNM>&L_hR^5M$94He%%BPCT*tRRkTZ z#^%%9{;V*)sma6my3VhpLnUX?6;bXs-A!aKT)uRoP~FoxRvNI}sx zAC#EKmcAx{#9>3=Z>~N5$_#!*GCpD!er<$ueHg1C($P;9-7qczwtoaQ^te`uhy||ssJ?f)#4O7@Du*&nZO#B z&+f`_y4w*^TWn6bYjCMllfF6~*;5+~ht*)V*z5?A(j_AKmUfzzCgQW6;&fW|rp1c) zRJ8ynxqq;^--~$LCBy(12axX~qP%YN!^D*2w(jjy1Q97Rdw{UbM9E>$Pri}e@l_^R!Ln6n|qcwbMj z9zs67;MlYCbLxCcj3cvahf_~=wuR^H;<#N{QJcmY>HVKRQv8tqkwUn0=l&j5@~?V_ zjM=@MgC1kT3yOQ+lYufe>KxU^x%LV41@lC~5x&LH*MTp)_E8@cC*Tf{j}+9C_V$*p z`3d?E1l-i1Bh#}_N6*NXt)(Fzg~U^1b#L5CanRjH2nunE&-4klIU1!#iI-ImP6bT0Tqc5lBFNv0FP%6`7?p(V`~ zAO5SM&4N#sLBo&(1JJEAgVr53wB8K@?+DGj79~Xx-~YT30d7vtPC9mXo?AYWEFXa(Cc%NoqH;6p$*k% z8FNvBDt2>kK$*5H=F{Epb#vC=+OioSp5zt|Qv;Ro&h#~ewIs5>SKnilsVC9Dem;>q-iP~GNhYWCJPhMDZ>LJhS(A%c~e`(jv5qO896(cuxhEOpJ#tiE#Kv4b zpnPtu^(8?SbgH;)&yvr1&FSs^h7BV=T~Sx8`cXJgaU5HQu(*;NJYBu(;aS<;l!XjQ ziOO(tDbi&QgGM)Di64GAjLTcXJ0P+evV{rksI;Dv{$i}lEcA&6qg&VXdw0PAg=Sica zi>|+DsUMrp-j6HKEZ21Ber};;r0ab00$z_~^@h|N+^PsF3EDANSOl^3;IKi+_nCM0 zxh6u=+dbalqhwq;(|m5(5q0p)VKH(7yo__>BSyQEu9Xv#+U%ANb+&ATP@Uup-eiVN z4b+sLAJz`6JJseINOymv2-Izlan)kxk<q4%UYRU<-p$4{2_wrihFh~6uO7@ed`P|7bDiX!Dio7w&msqVsqP{<& zy2*!4j!aC9Y&dKHiOIZ-R_DbvzR`4_Ez3B`Tillw3kMr6bbPJhi7)fA~+$+_hZQJVbWMA5C*T>9!Q)W1u06mAnaFHy5U23jMdX~$(3SMzu zKaNxS7`5__CHFYTy99iPXKs!IxIlXX%ITjXpd-C6&!rR;(H4v?7(*%_WhU6e$C)y` zT@De#RwHngUiB$3aCW)aC`t96B|2){8j&3n(%9RhECR2Xa@GXNzl=B;Y_y13T-iUU z8_-qrxzR(oDu(YH_3c@wrj%~o;R585*Qug z$e(?tk5`Cg+D<(-M9eEvCIj~-%ig~Oq@WS5p_4VJVdB}k#a%E}k?O1Xq^p?^V7wY5 zJR2#|5)K5CcV|CnTvfkYf_G0BL4$;fkod`MfiVU!pK&G*FQtV=_Nzfx_PdX?EdtB@ zIc#eZE`s!t+}CXYa9zEPSVe#VVK#UueW_~d2UfzguVko|#hBId-9a{j;<@h40@;># zL>~L4G{^W8&9>{1BEX*Q&c4K?dRr?bRlZ#&JmI0rAX zWb_&Iosoq;F>$54Wzt=fnPI1uI-0+1`H;apP&~(ut&ZMCLJ=$q($)rW=+Cp?oiJtd z6j~Yq%_;&X|3CKLGpebzT^r?H>Qce75Gexcy8uB#6CofV_%0GG zwa`Lalu#mN86<%Of|LXZ1eIO{448x>z4tC1Pxkknv-dtfzP8u%^1Y6oUzA$3^qeRnrK#Vs0YR3Neigda z&4VJGVD;~_)JP_v@mw44Hzvr@_w+;}DFhcu3C~99R!(gw{|$~taakDf@T1c6G|!f! z5wY#Xk8GSsW?PHDPYN^W{ZFR)_~y zmiLLBIT)$oNJtLgE}YP{X{i@ClkT)?RV(yfuo(md1jXc3%{v6@FQYb0qWbIUKHmz_ ztv-jx5vUbUDBuy-zlCIs4@5Qg_KbR<2)UJ_I;NL3H^58hX1Y6%W5}9p`q@tdGt-08 zi<;)tFa#dI4lFz(O8P=~MP_!uTl}1W5f7|DdEcgSvN`oY!nIjOt7U`j_}sYe{VVbnjwYBCS|MWZd{p7qS2XsE4=eN@G3s*VS^GmT^-8s4 z7h*|Ll74Lpop1x{sJq|~vsK{0IgJ?a$-^MhhPnmi{K!xtx*Z|3L)cNRrj>R zSl}UUPUd2$sy*%tXlHg+#XGDX=Ekp*>zl5t7uqn}FGO!CJ&;$-3@w?pzl-qQMG%&%6jV#Sq=cot4Flsj@X;G zC`+D<;R*VX+`E#3BCl=O!)<>X+`?zr6a=ykx~{(b$f-$aP)YbO{i>?354xgG7g&>! zF~Wwm<4A8csFj4?o^G?xUH7+`8Q*_^Q=HrYA`ascm1pTh)Xw${{d@Exjnw5TGyM+V z0Ix&}Su7Oj?W57LAKSyvQ!jDNTga=$Wg)Hy4>m-DH#5&=XH8vQ^OET(v6YaCXVog6 z`t;dis4cmqE4*nn_gk^bU$$1-ZQfLVL`-K)gXgkm$(oR_yOT!0ro98a>IYjbGt8iZ znm|ev5TNixiqDplc56l11QLlZA@e3)S*S0>=@}_p92`*XCW+)|j`7)vDmCxcmioQ$ z1RgTBexpxpw*-+N<7LeK%SNd7GcmRsqJ;R;9FB6?ZPwZV_FS9meV4d9YUc~kHjxjB{<`7Wz(a)27Obgtg|yMjN?jbpqJcUaXF^kzbB*T#PBd1OT=hzywF z9oCrgYqD$AHqgur>y=e9#homnCwt5(RS?!LAt&^T8u~{9w z)YivXE+D$d-laN4V2Zzfv)!zP*>3C%{~&Z}4)%#=d8;Y_{n$J#Y2^Nc*I}9a=f9U9 zMkTUad$xiJ3ep(=9`u}QYr|Nm@b^={RWq!ukdz&04#M10F9Bc78eBF0`@UzUQNZFW zu|fh(lx`Tk22oYgS6*Oprw&W!)+79JY)P>F=o01cblBIY)b>&HpjCXW86cXws~B4^ z0E`p=P@|!lbIwKMGkGENU0z}0N0wHA+blkN!X?Aft=HMwHum?!=x?r?#L_4Bz|?@# zBwOC2bOA?%|BrQPwsZJz&8t6P-tN!gFwr?#=Gx$H<%bJrFV98W+Kb8+wu+JG7fLTW zkQ_^r)1WsfdaE0N-y#btkbG5fcua8@Rg531A)tEY=j1mN=Fsj>Kh%yYsj`rX0&rMH zh+c?`hTi_S-j^3yozAqc<$Hl` zxBS>9ZHzdu&J-ZZ^4nmAwHL~XNAlGppt)Fv3ScFn(ytg_6rA00Yho`@cI)1#!qE#QX@)DJd8hYSq5J}vVgdFFknxSG_$m*xZz+a2LaQ>V zlugNL_m7Fc?KVtu#5L`e%*%~?ReN%WMup|2k7Jv=*`26ZjrZejO?vk`R^&rLjU)$dD>|PCJo>1#F;k#?XWAl~ zS>j5uAQHn;>`uq^aojdQAf<4@%g%JnNMu#_AC>~3+vIVJY1FokdiCPd57VsHYB~SZ zI-c({LDmT4r7-GvQi^csdGv9gV%&)jF?JG>pmOEI7S<(*dZ1Y_&+67#&Kn&>Hu(%U z$VLyh{uM} zwzH)6iP({I( z#Hve3$Ky^6GXX??N}-=APSUiB0IWr|0>oEk38W<5pFForu4SgyoYlGQA#7}FggjNm z!aivbeC+b#vaWyeG)vHo+ypln6cmO)5!RXRg+c*?Lt~R94^*$QUUrvrc$tybJ#Jt_ z(z5Blhb+Ff!jsLPA61Y^1jvMfQ}>6*#V3y>Qv~K@vu84fYQvH!>lVrvN#qOW0HYk% z5b`wCrG17eQXv7hB9U-%xWsjmfbF$UHR`{9ZS!gza31z}rM4;o>!(uS$Ng2Keq~(D z5zzo#uk#x_KUh?fbqu`$KuOR5rs}+x@+*5z zY|Y@vVkNFJwk%3T<45!S(N7*=>4t1b*_Rf9Yl}HQc_3YqIg`CFE~nDwWtvmFVLl}g zE299ABoWJxMo>txtr919%Wh~&kX*wp`NPVZEj8XK?&^2lg0qV(&^EUiWr zYNmhkbd|^9DmWS@miixMgOQYPEM!DrM55?mW#~J*2{#5-6z1(lvi*22uFP~V5!}x> zDva%vU;3=k>yj}Og>p(Fq*x7g@@5pc5CIMZ4uSh4Ak21Bj_P<(QMS=KK_onRsA+wL z>M5Qt$-a*2ss4VHX9^wBd6<0btXg8J>%9DChhX#+?1E=v55O&Wli{fHp$&Kv6unj^ z#R6<^4U5sPC0Py)+LSnVvSV?@2QWCmPm$4vt&aX6^sI#uNFK%GEdCs~Uhs6YMQYQV zk{#hAqd)>}c)^;X0C~hL^?s=Xwtb_^;(8{6utcGio!6e&YTVBL&7^W7`uh<6=Fh8V7$9_dD) zts}+SDUk-cpd9TcroyjbxEMRE0PitvMPqP#2wi4z+382Hn4t-CAr-e5c(Rf4HZ1?w z9NL%G999Xaj%muvmM$J7{T6s-cLbI5KY9j}X7ti3!#^JG!*00rjJr8_1_vt=-i(rXbBy8g7r4c)#Rd+>IpI zeYByd*Q@!;B?`EFCcg$$?%(e370?Ws+AkX#>TG2<^$xV1mF;w}YB!R9qPtH>DQ^=4 zdc!jHsKqS+5c(S>Zz@K&F_SQL1j^eErng^A2WSgOdrsJvzps$wKP3O+?Mj|7c{OmI zTjSO&cYdWIq%Ju?K`Ab!y@T0CXNZpsj+hSo1~uRKIDEY`j~1)4(qtvU_iew$b` zRQ#T6Kg261m_(qv*1i*VSr#$D55CTh_ldsU%&&gUDj#zFWtsni9DlC`38gO1G7NOB zTci_();SOZ-Ty{B|BFlh7B!`5Y-X0Q4*y{z@T}hYSxIp~-;|I4Q&PWZQ-M?=1cIEa zqXy=#{7aY0ukn?d`RBWFwU)QG&P{SrIMKuS6?Hxb+bT8APK8u*sd+8G=noQ@i~s4P zrRi_*|BD~}*N=m<*m5O%=5rTQJG|==^fQldyR)w31)*}uI}^mreN9u37L})3x`QF% zm}3|Ei0e(m(!3-#h6)4Q0|7S0dMaRI|FJ0ks zAXz*S`=MMaT9AEjgpQ+ryrOh^FZr*%<%M6YZa>X9KM^I1e>|0MYsU5a5Iz2%m>)xC zz}}V}`BeK8&wtUmu{_oz2oRw^c@nzM z)&BV$GURMnh6;YC40@IxKiJ}a9Brl8z$rBgst%n?U)dhv_}gkvn*Hk?`cDo{CA|Iq zc2|_66@Yfn)CJaMP1UwuZ5e$~yY>3F=fgZ?-4pCm80CXDOM-gm~W zPbBkOs$Eik+QnkkZ*SD~Ks5zSH1~Lsv>Y|V2%_hzxRztR388*ihJ?lVhUi*LLJ6_?oiuLp16)p6vBN8A)^+9nf*5HiDk*c`U^sb-T@Ua z68sou4}AJ>4K-cW{!%d>DkGP#lF{%kVUpa}o~FCNGKcg}KKf^k{mz8N^~p8&2U{M} zuE`A%2`3?ekLHDsBoeH}>qg}ZPJl^?+QWhc{h53ZI?c4vE5o`$tJEQ9CA2Ynb&^Cb zmB*fYzLJ3Ztx3BF>5LI*q~Mg#@+DKbt55vFm!ZI??+RX&#kLk^BD zhEST$i*rgwne}X9c-Pn17}!gjqR$`dwB#(iZchLzG;~kIitW7Lz{)|r`_(FHMZ#9z zMP)HbU8gn9TBeC&OU4VqXQXCCZJ%bS^Eyh&Q;t*X0Be}BD-D*wawL|6UbJ=dF84AT zi=p~ji|Q$=4kR1gU9~;4L}Y}*wK9Xvy5Wp|i+=O>v}LeY1g=a7RvwwMrSTxXJ;#GB z-jtCb<3#viu^?uu|G1kC)&#;LsGDki+e#&!xWO#kPA+hNbz*ev`%fNrWT0CO#4>&RDzjGb8yKv* zX8KD>ymWqxMC7$KQ|2Zm*ye|(7IQ+0w;?k%7|upfk%Adw_w1OZS(Z_ke~tu^8H;O26Kxwl)B!7W|Wy)PjK#NV105+nQ{ z(C>EVOIJM~h=P&3o5Q#AjGhL-zx6X=MwSSz-(USIpK2hP!sQKs0f3uSYCu(0zjm0J z$w^?O$)o>La-#|W05Grnu-w_)!T!R0v)N384MZxVC2hTeP->XVnv&#fJoh$q@1rZ? zR^QdO`o_ykbV@r!xtU{R69Y`62al~h#D1l=tPmuE)zAx+VwQ36ax!yz3`F`7)pPIm zif=p33gTfPy;$v+n8Y?fd@2Kw;Hj2a#u-vg&oB~CA_x^&>l^QjjBZMblH!h{RWh!* zICp9BTDzk2Xa)Lgwj3J0X0jP9f}?EB?u<4+!MrvQ2@B21~kiMDveh5X*42TfAeX%U_y5HYJs_u5QAUv1s{GJE&mmGF+hm!s&dMsFt4bgFysJu zg3HAPb6wQYG>WUOFnWS+fZBPhF}?j6tR_-x!(~1Xf0yB-6@ML=4TY`p`~@BMi7=ET zeAaPmX7Fg4_gz%hvP0Dl1h7qV0<%euoMd;CBoDjJR-t-Q$Zdvqm0;ibz4iq!W$xBv z2RPAvO2jJ9DFyL~Hk1rC_l{)P;l@%cXIC>1Q4v*^#`>E$FsQPK-DuwaA~=jp7V)vo-L6>G6sxLzq6TU<6H&tDLUeX_MV+4(k%I@-wq ztoj93vq(4c9$B%Tht^v$DQ`gp?G4pV&!)lOGqNHEuQPn8f}dBMm$BflG&e`vL#m(a z*tVJK@7MqGYaPo3*!6C&MGm;VNQ176drz1?{Wj)Mz`;lq*wBNp^_plS_#-WIBfh(% zsT%x(o5**MPi{Rf1neeRIq%g)Nm>*;p8`8Rt=%bq4P?xvVSDm}Zxki9Jx_jx{FXj9g7x?;3k&vW!cZc^b_ zgU~vluV>nplVZTuC#N;AH(gh>4hwOEtFjZFVy9dHR>zYc_+1?J3Mf+MW_nCTgqlH> z=Rz+E)CNQQBRfrU$SB9cobE4h@tF>&eKnucMHJZ zP0mgGzim zM%VqKo)g_-q>t05-TqOc-M`*&!#fJn(|a*db)Fof7czq{rEf1Sqiq6L95CHK`UP?Y z-H0!3EnNt?xGK~NJ4G$Bg_>2TFh5t*)yc9h3}`SA3_uj{lUnSOeY;s<2kv9q#&+oz zGS}^jm4B6bhr@?H4mq7zDJPjy*Eu~l!tBD67FskBNYnh=er%i459}e3l6*}-w-w7T zG0I*~ddixBnK{Z0_`NR4Wj5Mxa$%ijZQjuD<+YWyH`dOOK;iu=I%6qbq~gyX)8pFS zk6Mk%uiitBu3!eCg{79dX6b;6>XDj@cKynAY){`Y#@72Dw8U}{meU>5t;~;T^D-O! zk^`!Ukw?wn^olrJbyuBg{ZUZG0jr~$Qj`qY+xa`Ux=?V|1>1jCA11f3Q}Qm5j5lbn zwP_=v-3x^0l-_h&R_cLj+`vD1)W|bf7)`H5sy?#wMG^T(?_w&OW~ufvAVaeapuGx< zx@$7cbo%a?I0|QlqB-yTCIzki5?k5i_ZE>~V&f)YD#{uz0#{Eyk^^G;9XdEmAa8$f z?re3ocOywit906ifqZze%Yd*Ub`RnlF1l?qkBrgX`O$NO5o^huGcmUeO&`J)s6 zoSA%PEXH9>rB3yAW{m*93r#ljPWjf@vWgTlg;45oNNzlrw&CD?)o+`$h$CY=GhXH8 z@jjL;ER6cIiSNq2DF-v|BCM*bYw|`{;$p6fPTJLp_7CAfx6br+opMM_)J2&ZkMNi2 znj8j8HbB-WY1fz`a)ETFZ#*l?Msr1#17E_`P6j&NAB)uS^6#wcUaZ?5@mv@;bHQUA z;IMAx>U(pCwG}{V_D83#pFC@xh@B$iT`o^;U@~TR_U63v9fkkZh(^K#ZiZ^By>sHT zuyOgsI%wByU)eLS!uzs4-{oo#yLE*BId%;6 zWyfv?P~q02k6L_x@>Fm)D8J+i3BR%l5slX@Db5q*SJBY(SGo3Ou56^dXEJN%z?ZZl zOC{X{f6;Z((1lp)I+4eyzj`Exk&38x%L2x8kMvaq?4c>sg;K3J<<4SAKHui%6x4N^!=^^sT!DkV{~4*i?V2 zgTrJ=A}N;4XhF{-XJEs>Ro70j5n&C&4)<@9vU^{qn;E1B`HVCF?dq$)-k+DF_T}@b6fD(}>Qp z#T>?$UZ}NMy+eCvUpytKb-krj4-Hx+p~z)7&J!aq3{9jGq(8LNH@)7al>X$Am6|%) zmM=_w>|FT-3MEP$SmfTwPc4By_;XS*(_J3cDaQ(;+n0f_wkT`bt0c_&owx_7*L72b zr&rkVg)q}x9HBT-K*PlB+D{&^a*@UO0prfu{kum>E$_*QhhmNPto&_^KT)GoLM2yBv`nVVe7D4TMQx|s5=eL9 zPUPGYgi8sospi$^m0_W;vT{poO zzhdDPJ?QhEkQ!<^Kkgyd&`K(>No0!06XLlGBtxd~PiBSu`=-)Fx&15+jK!SWGS2&~ z>{RSjl{vosS}P_g&XK@V0b!E^rAtvy&;I+zDbvnty7%XxA&PJQ+t!GY}uy zVWzaQSn8QX0I~qpQ3&LV9iikITMmt#U~d}cRP?wk0Q}d&8ZIV*V{E-6U_+KRI*E~b zC0m`6^ZhFD-j9>Lr5frPLZRk;{o`bt_Beb4<#bW#5o!T!Hz~&spWutIba)Hh;yQG_ z2!JltOeO+i7d9ARbKmiJGQ#A|6!FsetS63&?vsYjtf~8bC50Kt8&wOcRHGa9Xxoue zi0P>S(_d0D&`$IjM$hoWBdGSoPWoE5xofqM_I2Wn7ToqhGwOZ;rLSHk2HNzc-?(4d z9Ie}$m*Cb-bVlK%^L&g7AbNYXjvtlaCe%mTZnT=cVS>Tmj5{ALx(H*kA` z;M*rp$Mt5V@5Nk(cT1r!xGyf5tGlimKu z;R5};I*-S^)$3XqqZ@8uGaxsl`Abi(D0+)fvf5z&e3{bl-E&I^6ot_YeB8pc>}(%k znT2%~WG25!QgiJ3u4ElG*TQi}Dm2nj)t|3?(@jhhZH?ZK0mOzdt<7;xZ(S{Q_|S4x1!Q&`}&`H_l*3& zOTLd|;z`o6v2^aXNg}1Kl$$+`jP8dMqZ~ft9P~mEIXxj^6(P<{jefhE7`z_tiO(PbfmbOBCMe6jc>DQBfuk=At5=lo&F zTEcjz*zwQu9;li4E`#4TuIyJTxh*N4c>eIzbI|>ZQ3`uj(FmjKS5ZkRBX=Lq$>puZ zBQyYkdYnvfo}dHdP^_xiiw%P&pOT-=yUbfM=^vXl*gF}m;E8NIRoPUgRt{8OzK^E} z|C&R%n;kbyR5}yd8{aZ~r_y{Z!@M)f2`u%sUm`-{n_+Ajwmny?)K8{`zM^SBYDvv@ zbD-*b7|VE5%qs(S1V5;`y|+EY_L$tzn~xinbH3BW5=nkQu?X=p^3G^joS!QG4ovU9 zCEt_4Z;a<^Z$6r>j;nVy+IG`+BQz;^tL-k0EXC~~)cBkD1InLcS;i1#&PtDrQ{ac1 z5yi?ETUXa5O7J*hlnSL77v}%9Y0KzxSPU0E{q5NdTD1ai4r`nv6`=iS761ZMZiZf; zU(p&$Q~OF~rB3ezI2ErxMj?$WHAqGEuSdtuh5%Oa8=x#fy^c&wwd7*u#WW28UCY}! zGrH@(f9B0EUrlII9dKR{2fl4E^&y&%d)Us@SQbmT>0M=`PyBX&c-@d?NW7NofpU&9 zOhrH-!)A!)`jtJo$7q$S8I@moaa@>iEIa-MY9=6XZLYU0554eEOJm}DQNx6J8`7Qn z-B-Xd#r=0mTm_?a6xouP41tbxj{wE}6q13kaZ=}SsV?~Gb5TRLzo(R$R6(LB%zzPp zu>zZT;&s?xiRICq8?<*ESU8zcYq0S_ zeV%2@K*2C&?b?}rBVbycH^*L{pbBt#`hyvfISQw}J<4f%ilw2FY3)SG8LIMz)%;Xi zozs2KAgm}Z-;C3LA7t;;28fFi{?2pd+5dN04`(;b1O)~8&4NL)$2?D7XtoS?xl^m^ zj&5|>Syd&jsg%eG3MuNG8!caK5J~@d#$b3%>0ps*|D{vp0pA}ILrXc|rrH_6dM%

S#(=XS*H>=bE zr}1*P6Am9*=9HJ7^|{xNwlOt2+Da#pj($on`xN6h8m;;=u?URxF0`j@(W3uq+sFLI z@LqYnnzxTDhyZ`u9w`<_nvXTRh~H=lWQNqabS~GzDSy$74=kKrL}rWphzgpu4;Hi7 zc<*4*UFo9fyDJ5>n7XO>k2TSTo2)HFXH@_z-JMLbslRT@m-a4KYttQ%2f5QRWJQme z$`~9W42dbV9`SUnzKatKLQi9~`MWkKxU$wl zje%csQyofRHrqgk7TmWW^V5C`V&5Wa3@6>oHxcPC36Q7ZUklz|G&y>ZBa(j}@dJB_ z)+LHxXIp?oFk^~IT#_fAn8A-UuQC5!MT4cR+q2&-R?>|K^Q1q}u(gk0SrfK$4iu&T zW5#jG+1+fu9+p;=(rq^tn)w$#%=7UwG|wW8_et$_InVSeoCK;A7aFH(iYqVcbZGD0 zdQ8U2k{<->37$yER3Hd4n<;mps-q~ay&jj1Qa!5ZHzvR8!;dTAD#i_SGlSRbZvJK^WN$!)cW2PAGZEk(Bar=&+D@`omGbV8BlAwFFT2%ir zznV&9kW7kbY_FWfz!2SsMJn!tSl{vJN4l3LtNUBYx_o45qvl;nEaWY%(Yg^|on66f zAVAl44vC4*G6I?u~$5jN` zcLhT&iWaY~ffQ=I@ZTyRS0ox9TZ#uED84k;(S3U)Lk4n6kbH>sw_)v3 zl}he3K`)@UH}2lXqm&c=b!&evHh0P&Gbtp@m)k2R>M8eD(+@YLX@56i+cTR}j@t5s zBw{na#^qgbXVpSWtPw6kh^ccQXkSGftU}bETD~s4Jr7~L}l#XH!BRkzL37XNecX) z^P#gsFMb?Ip=ji_Ds{F}BVcCn79(XA0U0vS zU4#Ol++{$tl9QvaR_NZX7MO8$^fvLeiiWY?dpwVZbIpH(2>!nw{{Lmb|KTnC-zozZ zx#VqwQusDt=C);(_RCI>Y;}Kw6~==214$WU5A~R#9cKGq4-ZREE;PY(?v(WY)f}+# z{7qBV&CB*Kf5f@ElzPrs#d#N^>e5Szqg*e-bIH{2{mCBm;0xdW!$0-^Xz*|Ubau?sd@VGh&~ClBuRDHK7#Ao@{xY^_|HOd$c_UPgm~+KKjPmt zZtC;Od2Kx$w0vCG{i*nWay%617P@^2@wH#u{YqJ=kdlprgwzNr za6axccwwR`Zu`2bo21*{J-)VGh!Znow$jVvi9*$rCU3M7w7Jq%o?rg)pN0QF#xMLT zhJ83!3N7@vN_{LAm963P$n<*ccS zDWw}TVe2=p`{&R}rIa&(9nN|)?JQ%;T-5@(Vvn)+C&@f0BrDi3iTbaIX%;R0XK0ks z4JR;58LM(F{CddJT(0PgC#_;bMv6XITwc@j&j>>#Jl?ftJtc6=Icgajx+S)Wvy#J~Ulfy+u)Hn*ETY2w|@&pw2YM*b9cF{e&s)8}%c~9s^C{cdWKA^d^_pRL<2Q`G8mUZr8Z_INy z3Ky?%fH$w~|J}H4D3FP6qN*A5KeELJY{*|G6+1XQwwPuP$0h-Y1(M7|Y5GS0quYa( zigN4GH%QIGorwPLN}%p`Ddt$>kHlXQP90Ng(}dQ$XQD53h3xhR1>bSH|0dlyfZ z_EZ6u?f7iCUY^m95jEqP^fG4bWMDZG-Q1#V>;%A;w@LOW z98r_h1rOBU@(KuYvtcsecBswCmq-I|{4~3?JIE70r(C9McZy#;M{5yR7QE0UztH7T zS#j&kN8S-4C6}K?rA()6F|;~{14~Ra)frL$u+LmFhI zB4T54wcP-cpZ|VrO!umLrd`oJ|L!N@X-N0!9}1n|Ni_r}7?uNTB8TT)t@|?N>zpfm#>*QEGt7X z3fpP0NALyFfm!${w2h2F-U~{)F+GO5*^@HpT;SBe^eTK;m7y*8$!ma-SjCE@5$JbWS7$Wl`}2OpU#XuEVk<)%8%c7#Hmn>cqMkK2 zNYu(#@sHWCa_Xx%=L$~euCgjTj@eG{Fy1klFbl3e$|$=oc;N(E!WCzRPHHL4ut+^u zyTn~bjx_}jk9!!$;JvzLCSYKMG&wLFawYv8t8RC-M8CXa9B#{N-;ti}n6}eaWvzBX zUtpJx>@#{dMQc8l%WL-ar+O|BdTM)L!(BdeTiL814I8xieAnyg#g>3beX(6p#xsqv ztj3Lh3<6Hg8lQ2!U+Px0CjNR?>}h)-vH9YCs2>*&AqMG@j-XTcT0WBi7z}3isnbd` zcsyEa#L>50ludlee^25%VeCw!C`!DqMYPaGn$iF`ptN*bHUrw=!8-tIq1PT$lx&V^zV(PWmmvla>_CeLE zwH&MsY*^ ziT<$4sxh~A7sHh7iW;SR_Bj^DRp{=@OfOFRxsSsqn569#+Jjck$X~wUm6s;mjk%~< zZHMXA+%ZqWQNJsRjhB##(dA%B^Okk3Hse~yMr3ahJr3|>hqa}dU9_vzIz9POcHZ(% z&yA)h^!&?%w>_DRfKb>!26j1(GrCioSfzVHO0i5~qn+98aweCZO(IEptA>vW*3q?&)!7G3kY;wz`fcCFp{fN_A-eW zsN3B?%-<$iJ?biGtg#>QOWp8p%Ai~AW4V-lRo@C1awY=A5C{pdm1~QuZuSXb42`%~ zWD(wqR(4g~Ws2bvv_#?yv5WB*I1-I0f9RsE!dT>A4VwABANTsEzNcPk&npvp0R*m_ z(vC?=2FBmE*MlcW>b9rfT+IEk;1pTM38W<~knZNsxu_ug7(?HcuG)IIfQoab_A5eI zFggFpI(fI7uY9RVG%J)aqufhEjlkUnKQ#I-CFUS09FlX7sxHg4FLpLDEz`ZYx@BE#=ly7zx)r_; z{RM_#W)IU;mVG{n;Emfq!S`NKqHded4#l#C9#g)f9&?#wu3Xv@=N)fXMlh{FVq>TC zHFuwHt^+P0Jx&qQ18E3Ws37^fkva-yX0QTCO}D$nHwV!~ckUd8^8dD3R%66BiMF>F zf8bqH;#w?5avR!J7A_Q>fx@O0CWEif?n6gMJBQ`MZc>%;C6f~Vv8+6sVP`Gi&KJKG zf6~TtcZb}l>cO~v6PU_1v9_PLnPf9gIhxxulYYqsjIcYZW-NzBi0(uJ^Q#vWP9xv0p0ydq}*>0){S6qsH+Tv|gkOrYFnFllyR#$VlJ>z;WY9+pDQA;<50ww`2nvxY{ozdO<7ym%?r5A)iztXfDq`bh1pMzI{S)+VH6~qtJMPq*&v$>w zwZ%2zhELCh_4>KXIvzC|jwKo$|6I*BNN`gTJ1to}FI_ZaU6Wg?@NkJCN@Os=OifjU z`YX56mt8qw?q6(_O(UyG`k<3bl>9KnA9rOuSbKHzjBWVljpN1e&%Z~9jlyRQpx za7GuJsy!5*D^42iCVU)Y9M-`adW5yUPE*m&Xvw^rk<7#cMMx!5beK!n~JjIGqFhCWgpEa?E?R#QVORr1$l*Hl|7&UPe90j)rF9{Syaofk- zoia-Lo(8$-WaHEKWkuu!(mC+1zach`64zHmUn1o|59VwIUJZ=Zn=z+@^`+@e8?mKV1!BCPRYRhIZ{>P7otKozwx4SDJkbJ;?6%0u;s z)(bPLs@~n~L|xN3{&OyFUAAYc#|Pe92Q=XJ!H+aMp2wABe}NoH*A-z(bh+-97XilB z=@s-%b>vN2i3zFTmfOargS6F;r<3OqQ7O_{l#4Pv%q7GrdiAdqRc3kkhT2Xt;d zG}JuO*-{@a#LgCVx)Wp+vRl2heyf9Y?z#sO{4t=cUN2ax?2wqkQu(aVD_X}d-RMf~ z%@)3}V!WTs?beees(V@!y(kBsSW)IWa3?%T{8nNqP(d5s;|;|GQXL)m0d*+{7Nhqe zNa>-38wo{wvF;sw`OKuo!Qx?5DYkN3zONtbXeY-__7a$rBG+fVzZXUiwdB5U1$0}{ zEb+k~izA}7yETDYf$_=GlYuZd7lB+A0W7>%2Z`J5X>c9NbX!&qZdNOK@T_T9HrJ2x zDzP8X_>-oZs#hJtPudB@E#c=Q)yj^OZbwEuKZ&+CsC*_a5aVJ z#{LL+pZaRyk*OsVg?<$xmu6$ypz>&eYHJ&I11slMztdL<5FTIqJbH2ESe5hfD0lMLZn;(Y zHsGuC#m)X(f;0xwz!OC&@$lv5VI;g<4FeGd6$FORt{H4`V%KBP6_Wf#X9NDAG%Gzh zvj}OD+fht4x+yDk*HrNOVvASVtK0w#h-7Zq&Vg#d{XjC8#4n3K>R7hER@a?)uwi1x zl~mu(9!BVtZ0qafxzKLTT;hLiD={<`NY>zhft+R!;#*rQ7ZWRuksrPLw6vq<$n|%Y zfn4enA+vXMZNBG~oU2Bn z0q#2*<*l>_4XRsV??BD?9U6Po=J-X`Rf8^A#TRz&1dy_`X&ArUY~!BXH8?q>`_Nwg z!CYy6ztEqXOFlG_S{sLY8=n~psX-9c27txAv)_`*=upC@Yds7y?sC16+_Jhoz=Xq; z0kGS$!{1t58f=5&!) z5N$OHkiE2Ugefn6H|~+*9i8))&&8|;72pE2P>aF>w+*3dE!#ZM$5 zbJtprx;sCDfgzo$Ha;D3J(7zaB{J==CUV`g0hzo8=A3JNFDq_*=2JEY?#Aiff_z;G z^G3&FMTFj^?0)ZhZBx7{?{>0j+4a4<=^EBMqvEq_2`<|Tt6E7FlQ(4W7Ga8t=!%$l z;^jZLy#vKXXr0;RXK+lmvff{fTLQ`N z21bF=^Yk%qr$T|0hZ>R>qtr*iXRM7k_QJKsECOZLmz7)!M2yhk+MsO zL@l+JHm0a&vALOXh}w&)`oU6xaVGYo{V%BAyAnNO-B2rGGa|ur7XoI5?Di4e9$6tO zI<#h3T`&1}$r>0sYQG&AJfL*qtm7?;jFpwM#cgHx$d{;pj=h(#VZf`C$^r2ZV{0+S0c}FxkwEcARmPAp zH7I-d!!5D2D`%{$*x(mA%I~#fayl+ZUlz)~@MUuxL~+3QkO1cECSw@{+o3pk((3}U z;69!Lh-Nf%laI*I%$@5r-~>=vs3Iazww%)eHbUk6xN9{?tfYWAyUyA)z3;CZCbxnT~T32M+GXpABZcl(--&l@KJ9ANPnZ{^Ln}9f0VPf|$~S3ORPsB`7_tS$Z};uvBs_l=oP@oWYY@(8~yBv;ZURLit2Y|x(}u}RVH)K_(!EKediIA{So|2O|#ba1?nnCeNjKf&F>Wf zi~dB9mSS6WGd73iljhRXm;Lv|Gy5%;8mX00ZO-_LW{_E#UL3}R;FS>b07Jr}oHq4- z#qI4s`G~mX7{fXJ%N&nv&V&gu-c!~{NRJO__!AKAndqhn4)Gy*IC~XxSTRi~nO=1- z=P5VEpweQIN{9Qn2!RxMg?F}-;=9K*lNgscuEPU3B_`9iR^h2&Z6g)q z_J}K!`9^443xZvgQS({{XMXjab{N*HUD)C_E!JcZYzUoCOYh0-mbVcY3RghvDW~>~ zyxJ1If~+>&3Kd&-D$Ik}W|piJAq!&PM>j%1P_T@dRpMZ3YMLaQ;nYD#v89K~PO9lV zdw{$KH5#f{>osm3~f^602J{J_c&4VAWR1{xYsbn9S4k8#grvJ%{SujM94=L5V4 z%>L!ncjL-$!+y?MVYFq!6T1kvH>6tiW7FFm6mwPlrG3Z)1A{tQhHt$HHuoHF9vu4= zAE6p_#i_f*%K1Pt%P$AVXzD)QKdvHvV&!5YrUwUzO_UQg@NOq90wv$%!&jt|#(>v+ z(=ZR}=LfExKG~4$R@5*6Y;?q?$cAnVFTbL^nWKUs*cn-XISx#p=&Y{|$(FBROR)S^ zYl!TIHZ@aYWWB76)FpihETy^?Jgh9ZnwF0mM=4xS@n1<%s5(F3oZ#{7tx z(t{Zl=9WV)ZIrAc4kXe%&s(&YjB@(r$8rkl)Uw?L=%X(j(p0dmlEDh}DUErT@}^<6 zO8n_SO4W|?40Hg7o%Y#GB1Og~YWP{qS5hi85hlq`X*ySou#UhSVGExI zBi{_A!pZiJx*lBlvX~UtnewYc9h`&iY*rHsq(JD6_T3-T!InGK>ZJT!U!#_OS%?B~ zE@}lxP}Ayod=1ZgrhzT!$Dc&=9`|Sf`0WDtlyq8hM5(MVAl_C_XTx40SnA6Nxeb1> zLB}ui&<@z=QS4^ZsR%?a?GH zUvnLuVu5YB^ih{F<02~kNy&^;!YbeP@aQ>=5XWihDu{tYww3urmzn5ESvYd~RcBf8 zT{-?yG{{YuKlOpcPa$WkBdXt!u5x}Y;l{B@hq_lCsTD;oGRCNCU%t1MVQ=HiS}UHq zo!x=3Ly@$2b<)~(3TG#_s=!^PAN!2+r%-`7ImDQ7Xh})3k$OIs9s;oJ8$_6BO1^0Z zklgdoviKzHGN?>H&^NiJg_Cb3l!v9iDmQ9Lkm5>Qtc}cZCKvGpDShnwbP)?N)^C_D zxJ$K#t>e|ylERS@nF^a(FO8hP-LHSPJu(gK6I)p;Y9xjbK(K@g;**|kGxxy_tBXsG z5#H@8vX(UHDAIB+N&9%zwBf-5Ysj^~$&2Cew(xC(GsZrI4#5TfQWBrJY|tK1b` z5lXr~ETyPMgZ<{x58Ax4&gHftMrTj^?)l+O4Qlud>Zt7D@jDOy`!}NhQrlfIjzhy!EY5ao@f`noLo(+0r|o z6(}U^qU{{Ibd!Z_?KAdZ-s&{o+{V_fX)f7UJ8wu;;nQ2Op6~>>(^Uwf()`#|+iHl& zrb#)pppYcDnl{h?$L%Ea-e$}uq)sBcq02WSqTd^eG01H035KoZ;7qWUvGhw-scN~& zB2fu+j-v%dTWz&t9of^=39We}=>=nw;E}=gn)SezrDPR0< z{qcUdN!Qq08{CZzI-~NE!BO(Huuu&Mq_d#p?FX6;@_nq1u{!!BHGs~YC3aeZS8wFnqNS9*b{AR`gF;W? zRvbPvOkbc=zn4sI6V*&Nog?y9xsKKt5JO)^^-R6*E0f}rV(25PJAUgVuwM`|Oi$WAh;+4njPcH;W$#9j>GvHgoG8T&UQF>}hVZA1Sr& z&mT-246q+PoD3PSTQV`@BP=ogj_~bZcm3JH*!cLT+sg{!yQtU4Ug&@6`~PpB^NoGO zhb8Pq?;-TC<<@H{euXMJb;Caf9G$YLJMcQUX|)@?waU8?vhL;%^*$WOIov-n@A@b3 z`TPlbJbvQ8S`+_oC5$@Fo-QMg-CN5LSM;}O2G>W-14XZRC(7Y-PV* z#N0Bp-XJR9NnMe~#+EXX>Kut5AYs*~fb8bb`x>|(3)R~yKaEm#L=57NNIR9zHFsbC z399{%E|?@Qy|cuYUO5HnwVw|Ah{)XrZTT*=@oNrW&SErsON65ckaUR2VY4n(VU1$( zE~dEC&vb7zMVDk=jI789`I|#QiM6uhu$G#800Gn~Y$T|aTLYkSZtRX$~s%Y0ggY|1VP zNC3bsGD~GXY#Of4;aYV@m;G4Ki$CWb`N?aU9-*og(JtCe|BH=;ldzw-qzF&HlP@;F0` zQtyN4#&0ukj#MYdghG4+CU^)t7iXagt1Rx{B%R*qib@EuOjhKSnD_N{y^+Tn{N|!% zP%bQKE~*BATur{>)(#s|dF;U>+j?Pm2_P1X5iB33;`Fpv?VdyXMZuTRA&-&R&CQhF zjW_$>L1|(IK`O42SBHZAA&7;A7)soB7MBO@XZF^rAH#h@2cyJZ=2nlpZ{@6>5=bz# z5ZQz6nqIgqq?QopDYRY~fSk`+n|L8vf~ND$_ZwWH7DDiIQ{~ZO;H|wyd{m%e%LRZ?Qx;;#I5k4nS3E_A{_uzgkn{1I60T+1Y~K zUB2(NMq>hJ8!9;ctFp^{q*kAuAF-dA381JJ6D(Wm!lQW!lC?we@sEEzNgime4HET8 z%}8I=_^o5!zqgBAnA~6fgZ_Hx6xmDgUBB$Vy8BCa|1V4wM?m%Q{&zDx6%tp>ET`d46K$3y`%xnC78%9yLAyp%lJe61@g_7$TdT&VEsx;s zzMvrHvw|xvDjO5#F*PIIX388p-Jyu<8(u0-Td|(ovIjTxjM>LsHCpSxe{8vAJFW_- z?C9#;%KfXmzjXK4MEUkraqjmnBHR6ctTN|#y}rqmy$FP2pjBDiecgWZL4zBmgZyS9 zxe4uKI=rP$vujiXz0}9^mOImjZ#R6)iu2nG7xHa0vab(qR_~qhud;N(yNVa|7`jrP z&ZZEWe*7=#5@SO@rONIKCBnG*iEQF!27Ou`9Xx_13PU?{ku@Z(W~AEfp(P*Nx-g*| zpIB9#_cGYml{O;AT_p|8444fUGPgBs=j1abddK>4cd#;b50AE$rN$dsd4tcgX>W{mb*nImT8esu*z=+xRrO+R%aAJdpD70*Zau1)ue_;G-;YbPIlaKxVe6)N0Po{Rj-)Htkb>jT(-S1XyOL-2Yq-NiJF)@EDK9}!?>$SfA z0JnU4^PjDezdHI$M+ZTF_B^_L#zj2FBmWAz$uQ7l#``4XVnU>zM_Ku~;mRE;Nau8_ z8U%r9ePQq>5E|F%yVlhD>}N;3wCXJ@ezhUW$2I>!Ylu0REycTuB9*C|rGIo{e_*LK zgh|_fQz)S4w<3l2;kXL^=9M#OezVON2WNJQ2jh-7(l+L_>9*i+#dnuyiRh{Kp0Y)n zS6+t%@}#X!M8>N=q1%$|L{qZRKqSSyMo3$C2(s0;FT38Pcq#--96l!e;elrgxCA8F#;G%T^(nrHR@Z5!s zFF)CeT(rFJkiYNauOrrf9$=mRIz9dyPT2pm4>9C7i|^&_ux)tva*|v`L5AQpZ(dll z`IB+&I0AWinH8&JHkg<6Yta5ef2|B+U6!l*Q0YbAp7e*U@^g^FAu7PVg!)V_FnDq2 z^2-q~dOWl4z1my&qdD@u?;gdXDbc=o-rtp#%De22nIHB9Jil_{vL2dk)lB7g@Qb_-B9%8os@CRO&y1F@C+yYh2W2BXgmNXvpVuUjbd&DH(! zzbilbOWywj`h;{i_$*fiRE>(22PdsjT^rg2+($6Z8>a^a%G?5d(+16wV9j2BITEOk zDmVWc-M_7zzgEj%yTM<(-EY4nf31iA^?C@%_^;u;Mg#HUrO(bx-WX{~??}Zr0Mcgm zw2*l@_PwYo62IUy^OX~$Ieb;hc=q@p;t$^%&+yON{hRr{oFOCg1QWrOk^b`geHknU z8ekn$rt3z>WD&+|HsD;_M}yJ(tY&MdT&=We_qo)J!1oRl#puM zd8tpdTk#-c&1OS2_3aTqKLh1|{(b)Cn)?b^!Yr@reVC>NwcONcCTxaiV&-J+O@AeM z$H1dUv7=q~2df5U4|)*(+FW-GE2}wTi?ir4L1xg=q57V_!AK&GrB8>&$dr2*6=TQb z=~g8KHCb++(^W!Vb-e!-IHx7kllm$5GoJPzxN1CsaU~!u;ry{54IThcs{&DUqD>W7#FQ4izW)GXAS_trT$B*=7=70SS5vecXb1{`kHdW147OhAe`d%W zb@fx6t;ZQNsudb6s{={~vn(&+tH zfc|Iou}5YLEAekLM!C~*@WSVDZQ9%SXKtT|yt`8(L5vTO1QrIsMgcOD&)BNw9}nSa zej9Q7$PBTiGM_=0zJ#Bmrcwk6gaqDcZ?PD)=`Y!1qHt(+)TX@Be+u~8zb8IaE2*2| ztN;zbGv(PJSBrwEcJEQBfT!}~+yG-s?(ZazX+cykmUWm%VTuJ-(4gR<^cWX!ICgtk z-3RlYPL`}yDws$$d2^MIkkGfzFXCXRuDeX_l?N_F#LYnsbS`bU%gRD|zc1^hO^|Nf z1oMbq7B7iiM#>OYi=)PP@WS@$&yKDR5^?Y5Cpv4^#fpWKs*WRs1_$)T1ci59a zDL!V^E^?X$dCi_WEXH8X5?S**EkMuc%RPYh0usDP<96xuZTqF>@E*>v8i;N|AZ)Zl=;(agm80f}Fw8z+l#nCe=lZ@Ja5%1gdG=CnayeMEp zg{W{>zf&p5nCo9Nq=jqf1sHB%ElVd%r=RuDOt@qP@w%;iy7@pmlL7QiTy595dvGKJ z=(XG8RXCS=d559<7%eyT5mAIhXD;Ob#ACb=RdsOHMQ@ z_50f@P)LJQ+P=V@)tZvvM+q>#p;}EX7DC4QM5BZA4Q)AHHLQO6<*Eq6Pi{06W>zY? zEVsw8E3%cm5Jk1&H}(hcl6*(V8^VId{mEKSw4pAQrnB|2L1J58YqcpMqiDph-=djg zkDvub`i`KmT5f!q(a=OGL_%QLxZthsNw5D{EgS?hiUsCc1IWAn5{Lc^ z7?!(yL4-f(4mANH(634}76z;?kXL>IUMqa=9lHw@o*3#l)M24godrKy5X}!tD-wJY z*u8lOtId>FeejmOX1{HmX-kL$Im3CTLxsXzF05`^zz{X}M=0(qw%raWDmKk2o_0m^ zw09gbm4YqMVOQr~z^PVd&8d&u*tNjQh~cmru-BwiH*Lbm{B|l2Ab8V(+`RufKwkNnSqpl}_r; z)#4kzRpQ;=N}9vcmPA-hwY)ELW*~m_fw=aY<_#cW;`T2%7~b#gXeiKR7o2MT#3kr^ zxF{I>W=nnh4YrR~`$15nKlFw=AHt_tD$^Y{c!Sa<&0K3E*LmG%o`izuXB|D8zKPyw z54l753Z#Ej^J|?{xIMZLFa+O@GGN|6^Ais;`9kVI=r8^qT(@vTo;AjSdhxo-O)2-w z&0{Am-Z!NTZd~uOa(zq#32>Nk*k~@g#2LF8YHnJBO@$(J6lLZpx~Y!0{?Y$e3jVvH z&Mfs_W=B@o?Nh8qZt}*2ycz&ig<#uOB+VZ{k=G;a?7K3iCmz;HnQHsC> zl>0Pz#JBDs>CwWtK+0wD1`~;U!!PZ{2=;b!(LBlt(J$jb@9}P$i;ZfkVgRr)A1p3_NSVIVQqENY^hk&pqcT5`;MIL>Wv^?a@IlwiPa3U0Fx!1I3|iCe!T|c# zu;yc&mYlyBJ6Wg*8v4EPkaiz6ceY}*-~Lg=$Z-5_va+tZzcMs%2)_FgbwBlT>_mE( zBe6N%2WIY4u9TkF;CY*cW~7-&ylm2nU5~uXYJ}xOED}hY75|zwZkG}_Rf|n6`ygS%QfqGmufMgu%D`;#mC^iL^;wF%bpz|9b`?T6 z{8BAG4W;nmsp{kA{qwS|=hsHc9FAF~IAuB0c?` zJEln_Qx2sR)LKFr%(5#;%sty^z}A}&%}CUU~M!}rfhb-kBWhwQ8YgK3ou_lEOK-9;U5cUa+H{+(bMgJ$#Pwf~0shcDtlzLfe@`)6 zf`@JJcKm`)`u<+)jUAJmK+*TcghQsFoE(7?^l4lm;(TO2iLL)7$Q zJu$7H#9kToH8Q$--2O7hzyF`#OX#Evz|M(BF4Qf2{F!X)T!qav-ji zjJv#u66&^f6o^^~2(`f_uRt{NKQr*Kzb=T(NaM8}#$u!#l(3j~+yj6sWJvxt5{(Hn zl{ @R{L!a-o_R001e7hgd#~w^;i&4F4xvT@+in{NZ*&b5>(egy)|P~-i zgD4@?rNUBj7vck0YW#_peUI6+V@D2h_KAIDUPI(FKZ)}TBW4|+h7fwsA1Cw*zF5nV z6*POP+heC=;AQzqI0X6ir%TPH5-C&Wzu-icO@QOkK#N^SIcksJPC7@E3V|dMsRdCV zXtjOUlNh^p26A5~!y|!i@9v3hb_FgW0%1KJ((=BLOyn5FD%$es3FgzgyogQ^J<*P5 z9Me*qYbopHNm~~!83tzPx2oyBk0xWMX>%k(mebm?V%U+`bDcg|GNR^QfsoaAD=t`g~ldpEKc^Qx&5ytfgX^Bmt?RM!eC#|HrrNdsYO1uJ)*!GXF4k5}i%A*-t_ zPTwm3%7tykyb=pObop(MU*_X~jYuaa}Jt1tEr z0Qq0WmJEwnwu0__(3L7S9l{DXzg}&Ycw3||HrnkqH~Nk|60%X8)K00P0q(YugXI;lNoh<>nC znr*W6c>tINSjXi|MQ219GePhwVi!YR#ph2C*X|{-`VyFj`29AWi+CDzzft_(o7wcY zn@3BZ-!hgsU(pNh0BH}n6}NHq8CA)Sg{h+v5nX=p#>2L!Y0yM1)>18&RxN`E^i(i1 zP+y*(>jt)43aX=zOTx(%GCIU6CRr&@b4Lm=FnbeTnrk$Wd9;MC5S#S+)+65Q4c^Ba zrV;KpwrgIMP8Nu`Ig8tSBj1&nb6aF25#HZrHC6$DWgJ~U`ciK2iw&fnm*$)(7pJPncukd}`NQ$lx5*-^muJbM0P|zZ`-Sm+OSRuqhdbn#(DP}=5 zoAT1_Oqns4D^gT^dt?rv3XAXGNhzgmo9okh?&Dm=DQE6kn-%mLCieWiJAO)j!YY5E zb%?O;v_+|%rp4uJ+i>357fAPYc)(pi)M+5y*I9z0t!P8tZ8{gL%=L9h zu(M&~dPZJ~L8iO&;EkRVK6y3uH?g-EqTYWM`EiL#i1kHJACw|tptv$)C}#aOh&5|T z6vKvLwo8zq5acOp(7>lUA(x(N3+2?YgL`C1ixlo?-bCUu1K#%>##JuOhvZ236$ zff*ZP$>rt;G0-0PW4XtkeCXRgA49I_3KLx=rp#*T7k34ErQnTIA8dcBVtuSkr_ojZ zl#X3QpWyBw;kq1{b1-!_aNQs9f%)T=W(h1PySo;#>Q2}!ET1fLl^FCgccDG&Wk|ni z_a?1tSVPtSKv<BQH_+h6>ar%|GysZ3@ou7-$BJ#Q>pr3nn4)?15|(P`2Z zC6Szazn+4EZUl&Bzpm;QR5Bh9Mrq5%nb~`hV;2!sD?Kul)UgQyxx3w=MV1FL?ZpNY zwh6qAzw77{Tbd(mCFh-?TWP7Zt~qMnlfRP`gPAp`Re#{NpPQjVF0RufnO^;tasM(v z$0gd83V$?+-B7GVEJgztbDEg!heSKF%gVOSF@i7u92F6HF|rjMzv6pWt-<}&1Hr;3 zgYf@+UF9wW#{l!jaw7TJ*K z_z8icnTxBlp{}NoK5XNBfqVf)S7YKKR4x>9u}I4+_c-~Ukyhq_=lf3d^Gbu;&V}%g zzbw3P1r;w~@j?cdWgYKXKq@L#%l?9b@4!uKxn)B$-8ZiVIw-WJzTw!<=aY?diFZak^kq8<|hk+s0@7 zN8p1ppw-4?`QK8o5ZD5$DsO64qiul<%;sN#@sH~Jl>t+}&*VP3mginyqA7ceUm*AG z+MKn~9KJn56P-?BM>f*$H`Gsr&581L9oSmQ8QwD!naQmv=QichmMkD+ zrF?S|<9PzQUXqtw9M z?p2?T1Z$9#c(4Tq$Pee(vIO(PV9jbequ%oe7IUu=mjLl^7j>Ge^nQY9cAWfJ%}L6? zgvkvNZ3z9x5f?dGdy1y|4+-B=uw_GaJgMA1)R2&_FzWqD=gzA^8~T06ty#X+yZi~h z$pZ5_fumP=b#2OFW?>Ge`LIdH_1}R6RroX>*!7UivtywqGkk8c{3{0jemjxs7{i*` z#*&Vk_(LccaXMFW<&)y{cBNRsxA+_AaIaa^SB_o%Xn8und;6reT{s)eGpfKet>zpFHjpMZXb23B^K{ zmo4Ld;g_nZLT4wPGMis;cU8TVTwEQ{ttToFmjGFTGIy%M7U@(0`>C~dVK5qyCbmm_ z#%Og~b~c;vfW3FsdH5v*$2T0CHMZF37yd-?;gS3(GY4zm`eiCCXL>TAZ*j@VANV8O-nN^GRto-W324VO+ zdM>m-{G9nX%GhYh!^_InabB_D8mKk}eZt`V9#^SoVc$lHg8^KW3gCT9^-a=Pn;WCl z*s}ly5XPbj%s6ZX^nnhOw9vEgmmSe+Y5H3M)n=m|g@Dv>QS65U<(&$u*;u$6pSv!V zwOv!S5M!q8F|5$7cbc5On42NNHXkv}dV{<4-dEfjucdv4A)biuT;&XVrk@6G%s=*+R&calnz6GqC(j&1W~ zQr6gx#!0lvQ%YX9 z5$aIf2bbC{NAB7y3uZh#OL+KI5MLTxV=680dpCK*7Yt68@dFWksVTr+;AA>&+tXFI zCeS3J7)!vAR#a3DAztg^ZJ1YfmCvppVr^o;J~)S~$*B=;5&`wMO%f_hoOaUs?trUF ze4^DO$ahb_P5d`u{C72)d^=IArpRqNBL61*hd)~gKQ|?nQU2QX7Uiv0b^}`N26)NP z$UXqvechnipEz7lP>fj2Cwb65`bH|$7mw-+hI77m603@~ZQL}V^$E66q1?I!wd%hv z3^*ru)Wq2=Y>iCiqt-y6x3~U0sLZk3+Tw3n89@+_=FYl(t0Hef+3R%!j+FJ7aqpk` z5bJM9h>vp=OXZiD_i0L*chZ~fU*>n33yLT7!_tB7H3>}>=LZw!VzII9H96{CU>q8b z{YZt#Fn#zM#)eYwZMpkf+l{6n`7g~D)TYIvK48YDGb*#Nz!l&;`6JTfU6;1)wV9gw zaMV7VWVtmd4~KTM9N}nH!<#a*iC<~-KWz8ivgGzl%w7CBo1b%3oL}rHW+~e>Nv5?$ zWr^(}4O z`NQIkAiD*j3C1acKCSsq%20CFCf8O6|A(xaSM#k;)o8xDN8y&I%udxC0f=4hs94vs z4n4tUW5Tm5LZj4Ft5!pbRlLD`(`sS-g;Bc-=sX^xos;#B)|VqDQ=~4jRHWfP3ft}| zy1*LIu!>K*VD_>KI!_?#<~*Vp_YzsS&^T68lh_H;^m39emn7YG(UbhtxxTNG;WPVe zqN5^xp1z^{A^hJ}@?XwOGtY!3imWJ9RfZ1{4W8$PS}pNo0w$`vlbPk|#5Xy@yt6uf zD~TSV{l+$IGs~pWi#HnA2CZyS&h8^Iu#pAfyI>Z4G@1N{2;d;e>lnuabfj zrvc&5Y<(OjXL_jP<6f>Rbwxj7jlG|^ei&`T%U_UBmK~p>tfymQOdV?KxNYvhii1l? za`ex5D^EA!0Dl$cC9HBtUe!ovPE(V)Y=Rr3xy477pqaaZ1#|NO=dWcu;iw_;SL&>FPI#28b;G zgw~$V;QDzhpt0y`>?qXt?}UWt-k_~TQ70Jmls0nxrKFJ#AMDL2iKN)}9yD3|(^=Y< zeeAU65Kn4~h6$`lmTe0Sd2HT*?N_X(=OMd{73T4#km-Dd*Bf8I)*lsWV5@RdK!tzb zU&~`px<`zCjPXs?DCQiRr(6AD1?XDMB0O-1qkYky(|*%=iJn79isU%{#p(0>t2#V= zX<_N^O6RbRZOo07D{!rQm2T?$KqAz;nnqS0b*tJ{jg>!Ajp=)x7;dp?9yP6Iajk+c zZJfY2{+WSJjOZwc7C|5S995H-m1hF}SlStOY%Vw6%Z$!-|AFrIGPu$)gd-y^RzR#g z1hJnPp!{~G2syG+e@KHe$YJ&3g&umU2W%kaW0=|pe@kk}nZ}BVp4RXyF|F78Gw|0y zCC`SmuEkB+eP$TwOis*`oUkOhNipNdqn{bjt&x%?7>jPM9K}jm*Dq-p#}yYlG#JIc z7Mpafu)U}WDLo-HvE&i{Y6|8d$PHMk&h;fAvGLPaF%`)-8?NLa=39x7RiFgyz9LSI zNK6w6Zkueu=ta)Wn7%BClDv=92w4`;$iekXwjrWOYfvyl_rpKd484{Kk&Rtjs>kIf zv6=~#U#D@$lu5A`*`(VUnvS+w>VV}9!cgeuRskt9O;>4PZPC!>AI69vE*n)y)Ixj% zyuUhfm`|QW^^4L)z_($O?LpzyJY!$1+Jr4+mad1;=hjK3(RYU)kRIo6&5xf z+X{^XkI%!GUJcJL-x<@V>c-gQi5o@Lh3R-h{pLPchN@}zz4ojP$4d;1LE8OZ+4N0{ zOfTjef`H=`@4Ee;z>zq>XNJUO<1j1Yh8|IUy5XG1-GERAglI}(_> zb#GdSO(-g^7Qa3=gNqWmwjjnO&{IsmHF!hD<_5^qIZ+)y*rvzVx1|qS(-rvrB#N<` z09Yy2AL>`j!6%5&^WF}P_KQLys3638MN|=we5AskhxXV*i)Es|qj$k??PC< zV2cDUQuswcI|?iZ(Akll$5kXCb&RKIH~BB));yO1HgUP%Po@P`cs$SLCh39#y1(mw(|Ww_%uQu4`2m;PQLv)UxX$6OT5@k7C+O(n^dqO9PW2oz zsxX7#>you1kom0`&Ll-!C+0F*icA)31O`22C6*5gz&XuuT=VCvM!4cvye-dR4jX>0 z&0sPU`B21V5|;f`7H)@6Lr69;v5V5}u=7(=ygr7Xl%Wrqh6 zY@(B(vmjDb^&AT8ZYg|&v!9o;^q|?uh}si)S*M>07~1MA_S6{-BIQVY%8yzGD`3}t zwzAh!n5uF_|1y|OPIs?W^l{8v`sM=>eQPWRw+ck07a>c=)6UI4}uLus`p#r#@bY?uE4Q|Ly z^a;^xh1ZsDEVZ>{w?d1OM!AMPEu4YLhxR(V?4DY>QGII0^3j`+srQqbvYN>Ywr~ID z6?$PgkiIglQsu~s`bM>!J{FHBLel7|78WMjQDQm(9&g*}S{>s{`qq6WGIwollL9~q zfgtrwL{5<(eVSb#|ApLFQY(7&W3voYZWb0HH=pY-C^7aU9%pP7n%yfx%( zWcmZ`sja**#39o+L6)Mc6!9}MdqJHzuJFQV%<+p5uztrfnBeH$tZl~LV~N@|tfv}sk!gQQ3_bpp5U8`QN}}$~f;5TTCX?1n z19=54mpsgKOB9#wTX3ErS8>Zl2wVD_=$hyp_jwBBu0lg8OOXAAjcl9KAsJQ=1=`eOdRDTLq1UD*K z>#xUg-o@rDaxLtvEDp`#>H+LB{3HG#1B3J`UjsG+{mDBRtb{}=vzEc-D`8uY3gT_K zGkQHch9nm9Gf=zd&i;8yI~Gc%O$keYnIjvbHuCHw!YNNSfJ`Pxbe*oJ5L<{ z`D+NJI(;ENFUu%*9h$Z?nBG5;`i9W`#@grQi8?Na3mhjm|(*Ij3KPJ#{VQB{$q zas~$0b66|*hhiCTsaowjv1m^qIaX(G@6-X88*m|xDl>WK*4NbVpY{GG1lW*^w0A-I zXaU~agYHj)X>Smi=VY)UI4v3yF$y&zaX0!2tK__a^PB%@b7 z0vkb-z-AghMzc<}6yH_-zNY>ncihq5)qJ?C=be7JVhCxT2=m zx0i#<#k|6Eid7qBdM5^%YuokiCGiQGE3A56fUQVgkWa0}q8yq6p&kx)=_XI zpR|a%N(H7yrV&dbx)=4da*b-rd`n{1_boW=zwxEhvCzp+OSkpn-9bD>^vR_{BEUXW z4#81Wd=3BoemQ+u0jXu#@^CZ|3h)z(Mlr7_=U_0M2PAB?2*!h3hGLN=!Jm>ZcQ=E2h%C6?~*cbWfukI9gUx#z+jzW1?;;8IV2X}&n zn*-p_9E#wsv6a}~_DJ}(ft-pfHqJRC3eX7KWzx?khy zM$h8M^kXPuNBg|Ae1MSmG}lJA@s{)Wmq$R>_y2Px{L_Dr@led(BSMTUgWL8vvqEjr z+siZ^OH;CUQSnH;rgM%~-FOdkz~#aSP#?RtpipnBmYTva>)lBHhVOOct^~zz^8rCv zL(P17Uta>CJr*)X^EM9GP5g@Yga^>2(PJppNA`@1oO`tp*}i5;i@&JC9VDcZVwmvm zy%tE!MA1Fhl(lYKsWTBTROE^CrI2XQ<$yrM4ZVO_0V#9XbV0TWpB;b?(l+~AX(2RjCN-s!=lLZ9i;_ZU806^iii4rT-`&`Z5#Qve9__w?ciX} z=^mVshf+v|$a06A3j<%xSCRa!LEL)S;3*Q0yH>2gf@Pu59I8BRmfy9sfR+Bt;OxG_ zVyTj|=|tYrSL0iXCRr=zZk%$@munh`#upRYvnNxlcsDDIi2T!6=Y3HbWj$*nFjyq^ z<2R_`+tB?RTPc)Qx+PrHVDr7O{^OfJTh7^5DN*+(#rotj-yqv4*Hl``@V_Af^u|mwXZ2Su?HrXIxwkQVt9}2) z!iV-xM8%AE0pY4r&GO24neCKOabIDwYk!5fXo|oK4OwOu^@VwPh_|PFZdi%OllKb; zcMal;n+1otCl<*ii2-cGt}1Uk=?J6JTifT>4*EpYI+ab)tnHdA5n z-h6Whp4T!A;;D7iGe$r()94#ft)LoYOn2wRO2gZ{2b^W9VdaF9^u9}r7j$f}-O`G3 zE4B0&X5)rEP%Pg9)_dyQ;=DVtKZoZ3ybRKMm;VK!h=QNbj%>IqJ3-14E&5JmYtYI- zFgr|hXegjP+(50QkCLCDy#;eqc~%9X8cZ4rZW~VCToek)zo|Ie{h8rPUHbOF;&0;m zG;%FNV+g-K#cja*gAYpqN|ebhB(9ZLLy4#+<%o{G{sA2HKLg~R3nrPmor&6Tz9f??~ZnN&i1PHTl%+rr+K|AL& z#bE{2mQE5|iTW+`xB{8QfK;GIqKX2dNE7J3&ifi?QL~beJoffx{!PiCBd^tOvvk6G zjcnx|x`I#c#xu2r4%&s8h=XzD)Tm+yLu9WI$@6@lQO?dt)-t=ro4DovH>S_nqf6|6 z?rlF%)cdYNl?2PP@%$g`y?0z&NtQoKx3dj)0~Q(64H%3_CJ0P!w+SXU7D6O}4JL_X za)x#wNEm2xh9(LGl1vae*hE_*SO}4G&LU^<)9mc@^zNJ8o|)Z!`+L7n|8=iab*oOD zTXpU^bxwT`q0#!2XW>S~*~WQ9 zmz0I6o-sUm_`{^!8shCXO~e_!|4(SXz|fhP(vx)XhPP!XhJN(kiug6|i5qpbg4lw& zu@Z(mnNskyrN+5G`J|p}_~kf-HQ$~;?VJB$hLYd3jj1UBTkSU$GdH&aO3tOWeFEjh zwLrJ|e}_plaxQTHQq-p3abOBBX-_kg_Dt9)$PIKwy71Vv{oYa~tHH8A}J&0-xhTy{ivFZx*{cHz7WN^x`G> z8q%sBIlpGxHhEIRigk1D$mudI>|JZAHTgnUd15gwK(0B3^ER=eB*ro`w0D7DQ=Xr zVnYEvuW)DKnOdksU4Lf@2o2c>@ot<-Qdd#j3UhDNZ`Mp(xUb>Gq}rAdtQSkyTSuw; z?ESF72z+{deWOQnzCYEmw)K1d-*Y}*VCsU)K+V<-RKBVP@VVZ`t@`K;^~I}MZem~` z{FM9^j*oOITRfg%J2hO&;5PE5+HDSQsYKWQ8C2C)~Za_V$V=*!jJ?tT!zr}mRyI~3ijnG^{%~MyBo7f zAA4nU{}CoSif+~`J0E}uo>}VCsa86UgY*O0r+nwGb0-B8l;;zJdh+%So^$ zlz7X2gr?u9*Mgw-f6{LT4A6!+u#TCr>MlwYb{%iWe&C*g?=fjxcu&@)UiuJIQ6UF+ zHI8Rgtz-`kEO?oaEXQkYtyK%)tZ#qdQ>k#)djDY6NPLHQo>yGs$BD3#^%pl%yu)B> zEk{0*X8l4ZvNFy875onrIKou6n|(!|l7clTpfH%>=mE@vqH zN=D8Gdw8>HSxA=U-mO137-P()v3C&c-1%DX&U8w^UJ2_FZ2|pwK;JrvF>dY^KMwze zt$Ej{Nu!jW@A#zoKc?`}XL`$Hg-O1F%Zz71lj&|#Uk5jyJpj&^|!?ThJ@VwB*7X0dxNE zTU2oMJ1&YGFMdP)Z)l)v|3a77xcvtQ|K;`nf676=F>B{&oJ{$7?UCN-HmPc9uKfm> zll3O``+gFi#fYBespU;t6x|lc=CALVr}ssJJQ`VpVufekSRZBtEY;Hj?vbGS8i8RlX$kp3KOc zq3WR?9qg1>R{Je{GIjsSxfkMe=i7y#gyu}E5XFyf78%n4!sB;@193j#T)R$$ zLgd@d{eJdPCRp~AsboFB^XDpp!s91CGCwnz?fj*HtG7IPr&ND2^$O~N1>rygK{yB= z@6Nwqboy(7)LOymD)Z68!{r{<@NS8%4d4%V)2eBc zF>Q75L3%IKO}k<3qXEI4uGi!Yahrg=w)uc&mxaEsN`ika_;m{JF5VcnSlW`appMp7 z{`9xzwvt@SKD16z4_d#!;ruPfpZfXpq?gOK5nnXU?v=cy_o6XzBZfI~ zUkd&p6WS!PU`810Hkd9G zc&&{xrI@S5oKyEZivPAel=xR!cJRmS{B>FWU%XzUJdBpZirkXSpG-<|e4z^$7Iwu& zk3V#V=Ch{8-G!jgD6Dqu@?E!gYNJtlC(ds41dhcV?ZdnWr6#{dJ+zzMsJ! zG!^i>lmA3yy-E98+<7y#C-RD{M`#n~ZTY;X3EsOflyVDlfDhkMi@Z*Q3j`OcY!5+G1 zqu9s^&3iNhWGr6~nW4LgxbmyO{=-K3S99(Uj{F~H$HuR{P9Qzxk1B2(DMQW;Yzg{Z z4S&{<+`{?2RU|(A{)($4cy!GP8`|%~{%y!Tyt{fGS}a-(j?!`*DMY%w$Z%hcdU044 zq9L;L7QZ;Ez=9pDR~QI(O|ARcV4~BaSNY^^AnjO2zXErF;>m`@&S|qjjj6@A|3TT0 ztP!_;$_6WXn`U`bhTIN`B4T?GCFAYT0_ZGcNv!Da^#%UN z_5Np%OY%gNNCcWhzOi3_kjy|DLi6Fw@Kt#3wJ7&0{yC#~HL|*rSG?f{bXHgDYlZfK z8lXo!-B@OYF!K1P|9Ck6XbHU%a4V#a zT*S&W-QIdFJkIsmuBA;}HCEPt7Nu7;w(do)pR&E^2dLs7`8uGvR;ygCMfYC!ZEcQQj(ea=M{Io^c*Uf0%#9eLk?KRB8z`BjYO$1Uq~Yh&%}E5K;%seyg*A@s%g zQDEWsR&r5l057G`xG8<-Yk=cu!XxM8I-zyo{~CF zU-Nf@1kp(RDtzj=!O|eo?G5XxcG!kYoj<|b^xk^WM*S~QR+P0;3Pg4c9qp3#0`jM$ z!SAED7ls+`D0XRm+|GGXzbfY06EqJ`7q1fiR##A6knI3uv^+_H7MLS=e{cAIDgSDA z<_Oz=XgjZjTy&|1mS2&-ULSLs#u{vxU8^TJ>Ffo@^kcDU*U(0nMf$!+#wwi@H!L`I zdO;!j5nCQisd!)B9i7vAHL2xbIhMY-d~ImE0xj)J`{pXSHJo{{qGQNe+CXx0K-5Os zSqo<1cTpWRwWoKZp49qYdkwAH%Yl}wk*F5+82)g$SS3kRdG`B`d2>cl za!h3PV!XD4fBmq}K>iX!ff*)0&Q?UR*hy|iJESs>L&{kf*BQp$b8Hh+OpU=Ddt`%e z^=j4j6=IhmFeBLcJ{r-t{&z(1{Dp6{>t&U2w8X{gwMT$~9lMg;uv~%9U{db(ZmAJ` zp&#DZhec*H9Z7$r*SJE`&__ymJ-W|3%xz$HBhzi3bWU7mJsj`fko6iT&kmxV(D0Q- z7ihqmd`|02Jq@|mjS`&F^UNjbJZqg7FvtFUSr1+3@pA+PCKlbeB zEx}Eb?7@j3!E+vXLrC5iI)RgmCm}v7!#~m;EBp@F!`~j)Py64VrFo~EbAZ3lwaU2? zUY1>1BUg5A_GO>56NCTuGyllH|Fc0;Y}VIHMY{HhBMMwJV&|0C^x&bpc{sDoCJbz?08A>K%haAQ z0*#2I?ee1ZiVJQ3kx~9m-M2#U&5HdvOkT`=H~JK$A~)w;%Z5o1GCCH1Xq4;XPD2de z3>w&9!7<45?=Yay?W^hd1b55L)^`MB-Z%v_z(ki!MY6j)RWG{Q2;Of=9L!UL(En~& zeM^OM0Kdfao5mSpBjRqGr$L`+ttH0!2kOQXVjbm_c^9_ssYd~UK@wv&pmUyQN~UMUpR&6Q(7X~7Sr!{URY;1XuJ*p*rkJka!02j|O`vcSW1_Rfg1 z%WO4f({<{jx=IDGLBki@q66~d{&yiHuzowqAHXQ}?QgsJ&+a9hNLgfBUX5B@4RYG* z7iY=s15W>1pwMVThDjZ=4tH@X^E#^DZZ3)R!#hYfgw;%~R`GZ{uG&jF0Iv$0*Aqqy z0u)bOK@0SP9_hEnFovv`-(#<{WNExM-K&_&9H6p zPA%V!xgpUPz1p7MA#*7Z-LbbfgjZ#Xm8a~=MedI-Bum|o_O8#<%f z!b}FQA`}9~oon-;2f^H6ovz<@@O$@Pg+4V|^RUXWA2kxKA4gl)bP!hL+e7$VlH+yx zUi%fLqtk#J=v_f#TFM4{_BYyoZ94ViPI%9<0emInkB&re=cmHb;=%I@7(iK6nO{@A z7~G)lJs>rzvYs_W^s-nQ(Jm;nm~$0^=ux6TRCLE8P_U!Op=3M!dM>$(;)@EU#`JmI^)7k)M1|7)l9X!wNGNn76cz*!k0gz_|jfMjq9EE{=udcF{Yl}pymqn@4 zkkWm5d40N@uS-tb<)Ef|0=X*dAKseq&Lalcm@VI%t{Wpo=635|cyf1Jc#L8>L!OmX zyq1}A>pt+wxC16FsqrJ4pf$knuEdP;GJs$=mm;wlo*<(K`|Q3|Gy6un-DXmQ8w=UB zRaNgL6dGgL@bAzVg zA))Cp-DmAp1F+5YzUwPcZ2FcsOTDg-Ib~+hP49X{fmxFHi#B+gOI0OBqMI4zjW5}_ z71COaq#8lM%)JtM!Kfm74W5N)R-((h{f{e^`x=RJeph{H8s7%hv0Zv&#ENUly?J|M zQuPbnUc`i3gZ#3ijLd#N+0YS@Derl%345obeq_TkzygBktfWM7NC!K3GP25Z;ZEzT zNh)X7_ul)}zVYCwDtvuY)QYIdq$?B*Q}m9XmAc8qcwn3*T%`XOb({l z$k5|Xrh2mfyJI}OSG}0HYx{-Ht*X@(1am&e%WsphQfJ?P<)-uN>J6(1kt>t2oDI-p zuP|Hp07Jo#6mjTi4JE*i5;DrDu?Ud|E?`9_NN}mQ-gr05ipaX@#=)l~*%JZb+ zTHp4fJe4eG|As&(Ui4E(#SLyVcPfK6Ld=tFC=n;gHXW|J*f@R-y{S5dF4^+w@x8)n z=5d9dJmYB2{E(|B&@~JuI~xF1QzO4RNMwCqO!^F&tqzuIJ9Jx=oVMvrDjleanvHbp zxp>rYD7RyW6HuiS1^)Ca`E+3tVV+ijDj7y=jk(n$lP)DCIjA@j>sUM0)NTzRP>BPX zKBfRU(#**5Xmb*$j0_KTE!sgZW4Klix@0D%?Q9&J850W>fu1{bUmyRb-9Pv6)oV+s z_{+~4OuIM(gPggYVxllfkELH49J|zq&=QJ~pg90mi%?+;S8rB%tNL~~9i91%C9)!s z)v=&)yEvDsN|9in=kU}}kfURPkeWy;@AkgX5jD@?ylO)S`%?8G*RU$oXWY)rC$}t5 zE3*f3`C&03)(X{|X|w11JZT}bG=MJ4ebV{Lq~W&4DYE$s9W4glS*VLH*vk3;MeJXh z^51!_<6q%>D145w{-!uJy<;}75|^&j8pC`* zKU>mJySt#Mfg0x!V%kDWL*X#3SqNYLeoHt&MZwP6ki2nPRZ8}(#%2Me^|V=T$=w={#Tul9<$ zdgBpwW@P=F_8IYPm#?K9O(yvn_Q$Zz*gq`|FxdLs5((0d^=FNDLHEO0H562*`+j`) z4&N}y;w{|`(U(?t-^@i~1YhgeiL3#tL>spKwXkaYBGB7fb?!a+C`0`y0|5wmZg55* zu(6wqAyAiPCKSf>czjeg$CHMZ$g1{ae)Vdzx&2OZB(NCeVk+C{ zEH*G8(Sl8luzA|Dqb>6;Nq@N5wdMl_p>1NA5W82ZSW>HIo!Ji3Wmd;ANiMd=o*xD8 z_y<+61`3=7RP0o-Kp=WUuOjjI(icUAwk#I`C)qbOPUcU#m-oAHqB2QDox!%q&==_& zk>&~1;xBa9^5=$Y+EpzSh@DlB`UWqxIo(Uw*5=4fAxlXVr(u(JHLjxtz7wWnF#WqV zm4AA&UMR$!Yswx~hty!XwW!0lm_jb4o(0Xv{B65vH~TOMy>%XQn!d)oel}TR^ZkXT z^`(EJ^RF)qz20{iu|9Or|3XJU-weFm##5n3=4sUmIkXc!{3lxccaQv!?#NwqLo7W_ zS9nK*t4-4`P1rw)G>MGM;TRR$Vcrzx(LQ=ksXM42Sy|_Imux#wRJs}Tv;=1H+!Ax( z9|<97nM>)#1@L%86^$RENa*gv!xEp2$SG=G{^x%;hX2CPi*An|>7{>fzM(wV2ku%E zr&k^~$^qa-SEGVr=8g@_T68zg)5ITn#eVD=^=R#LX7sCUO*t5e>@v2X;bWGN&O6B8 zs{+?U!(BTEfly3*I~{~k%LJ1l9yD` zR6bEx$)9a6v!(*7(lj^IT~a!hpLwbC=7*(L-dh)A1}bj#7tHX*k#D?_z}zGs5{6GI2%JU_+>eAmaX zSFesbtke^#-&*a%s>Xio6~g-ZH?!KR%9wv_nt>yA9(^4AJoZF2j41iTG`tbI+9y$CbH_vy`wisAdxVS6C=dFQTYo%Mugwe9AhF80!@JK}IxSBT_ z9Yr&o8o32DT|HfXDfEQgDza*6ck1(bBCujVKa~MR{gOOvQ0Op=Unajt}1Q<|67 z$mvUTj26F3_rF%qNMt$jpc&6gwGabQ#}_42It~QcIHYpj;L!TG*92q$<~bEjl85Do zse7^ND5h)lnPjFM3|I_a(fn~tpg(?SSg3Bt2S@Sok@NH}J1`q9{*1tuKmB{V|5LpS zw?5o1dl(_%S^D1foxEeb`O2VHjCQp>f|wgD9wdF_57BwwvI%f5q+w>hwXT}wELboN zs1}518%NKrm%BS0UiC>s)J{&L9Zwx;fF810x7f;hJQtPjyj|(l_t6_?$A?&-rR)&D z(Dgxfj{C!mt-Mu+V-%au?pmr~9@~UZp2pL5dg@P_O#+1plRG7yO)B@Sz5JqH-E;f; znQ51XHp8$@^u>bUZG{AX-m*pxczriHCh*gB65fa{Z8)G}cGY`VFI!79-;QB8Z#~z$ z3E;9Fvi&*ho$}pqwr8A1cSFt2xpjv5)punKr}=_4^5W+N!>tCY->PqgPY6YzdxcOU zyJW@lLsE7ly~efj`su;IAE<`iGO6t*^SMO}2YMNez3Nn-sv&3cI291vM2G9uHi_&^-*4(@P}rM{Nz}XO4+c z6GloH5;|Ia8C_V6r9r>u3XgE|kfud$L7pRx&ZIA>7_286IJF*F5oE)pP5yv=X*K-dsL^kSfJ zjYE7}PIq7SrFrRQfVP7014Kn3ywFN|QO7RJe&;uRqu#l@obswow5XOKdlnXIYQa|YiGi|R23vTO00NAJpwVJ-Q?)9)T zV${e%P_8gq2tls0k|Lo!QWl>yTev;|9PfG7LZ!hV9s6NsIfp@Z)t&q4RXR3_6T^4Q z4&_I+qFq*P^IyK}YNyKG>8C)HmB6jVmz}=QL0^0rZg+nlX}s)E5Cpr8Q6`RX3`+b95d5wJW|BDgZDnFF^aQ1bcBl?pNLS}S^MpRV+D z0AG}i^&Lds^Ws#WY*gC-diC6t!`zDcOdaH2Q4793($+=!@U|&j+0U5?Eq)G1T=W*j_TiM2{^bjvi_Cy`NMamU7q?Zko$(*bevuxU_< zEmWgE2cF6(KyueO{W z-oO}R=bN9Z zA}y$F!Ix}2t1HnZW+5me4=D+a;VAhElEU;p*YjAK_40Aokqx;h2US(oO9aP;Edu8E zxyst0Y#Epk6ZuT6+RUI4f7w?9Y zl^yM5xkI6NvWWxNa;>amU4olfY=z$bNg}%Vq?+ZC1S4m1N-9QGRT~876%5$C#VZ=S z)`e^jZUaVOi%X&rB~y=wo0>Zbs4b=qtMksG?1QxG<0~04@yY&qSMW_E%av8r6hmr6 zjE`c#cu0Z|(vH2n*2KP|YznO7lA0YNee!c5k=4v5hG8bMU}johO%tFdb4vdB*2)`4 z#U;d%RklOn@)U^#v*V4`fr<^sbEAcg>^pS;ltB3mN($#bjK)H455Q>#P?N6Lg!?|m z(ZH84QMTSjjl>uj`Vu#sE(~<07UWkC81xH6*bNCZNE;tN2o^$vTX|$MH@?bQ*|N6W zx>hu0kYQ)ue&UhQS>Ps-6 zEFzZRAI;@qi&q8lAaxNe>1ig0>dK2(jG4toXpd@~w?RX8Dx1mgmRy>Cg!s3tQ!{Qd zU=knzup$M_zL6cD(deh7J9ztD?dGA8QH2iK(1UC^-=ugqrJm~<+vb{YmH9&r?p&Ck ze08%|j3Gpq69<5q7Uv2y+~T=u$6`J++T|N^YeuXNn|i0LeIUM!D+*paUXc-@F1U7TyEKdo7PhiEaC0(Algy9qEOT`@w)#N`SohUjm%_|TZ(7)eetM@g!@2hg zS&;a1+hOc>zuZ#M90_9J>xg>&LlYo!=CI9VLd2=4u)}>?*JKk_Al;@H(fi=-fSWnr zl@AL8RA)z+5h?q!5b-rP8`@U7$3$nYdj(!xR6JKwS`>ZtJ9v}kbAQlVxF?#n-*X?> za88g1CKe>KsUF}xp^vl`OOLv(@WE-wG{0j?hU;avkl>23NthN@9o8@9~rkn^b>C>lQL^f0*h_# zUY5w$wDF$hRN#LNp$e3Pirdc!-*=*HoQ-WNV(TGtEml511g- zj|~m0-CmT^zg}E&Z?I4~8h0k+V-_Bt9BC?+FlyTErK1Y@P$<;nWuIMu`$FgV4HB7_ zyMlzQ7pmBlDx6GepV>aqAFgIJvZ614CBHl_orF#mUH7Q-lfh%H0{uZth%H{mFfvd1 z0QVWS;JiWzObD2N5cZXwf375Q0YS9Qv~(YgXO(}q7TmXLz9_BcmNm|CzLzTzuweI; zOV-^h>i~Ig+0i%(`u#jqu5Q<{E;1MGMn)lhb@UZH(vrp2SM4e^xei}pm8@N_$RyIv z?HccHo@)o33AdsEAIFl>t4X%%PdoV!fXRE^+#q#q09Of4T&z*tA}M#*lZLwOeb5CT zso#6x&8Y)1cfi^yGcb-One^I*h^qBoD$AWU;zK~B4dm}d5JS!P?XnC;lY5N1?!8lU zVa`$v;@2rBEFDbpWpxj(jsS%Np2I>K)`?5^on>z4g?}Y4XkvqU<9Pc=PedI^{6=hg#=LN*&qq@Vk}Tie3$g!cRSK8phr! z%N1Bbar?$~+!_wQFuMLDRx~UC-=UtjXi*brAVJ75?YGKB3x-0xmZv{Eij<9+(tPsO zwPQ|2Jw3(IG*QP@L6C|dOUdbBxT6ZNm)=YtXy2GW9%#TgAg0KSExjU(LYa(=88qv$ zceBIpsfe}wlV@GJ+K?YH6OUQ_g&+#Y5=+QtUiODiD#$>4$*L*};$09#R|%xLGSIOM z=qb!hlS6lUF4Y0IAcls^vn}0EBgblzuME5HaW>$C=%u>r(qt1nm_zg<1Hd+~tqw{k z3j@<3xkC5~LU42-J7V$e?%HJ6!0ZF1fmQGFHZefAkx^=AA2F1fi<}fyUpuySN4%9y zJvGrd=|I~xT8%{0W9)DnrWvs9?~vrha|1)dlF3^ucy;q#ku~@cpiA}Jw*Y(Fz{N|1 zdS*!X-6jETqcZ#``W{WSKt zN>y*r4*=mx+g9R;WVA2V&aW6scdyy^<7{_`P_^hk`!}G?*>tzo?tGy{CeWB zfQI*&x2kJmQ^;%mI(ahd8OaQ$=3Ee0Hw$GDl@^_dbI4bhKukl$FDej~TPQ9wjW9#uV>ex)6ai>JYhm9?V+ncLst2CPb==4mEvMF-M zExm2H+x)r^0!{NGg{W9OCqc50)HHvr?6ba_F$V)!6=bOgE|eJrt4TUZMZbuabc$}3 zJ=WSo$mU1OI`A>Kl)|_WTT2=PK`D|0VH1Rae8?aW)20dJ{&5NK6J$C7K%SQSX4qIcwjip)Uvl28t5 z#|)HS)D77ak+0LQ{|ocgvA4k=GUdJ0-SYGjzDv!n@+Y3m+tW~lB|Y0rJ|qnpVRl(d zO|-dn;Fv%O&`xdSl)L(%3$CpW&}?sKR3Wz*gx{{h@a4_101W*#YsSYZdh)AFp0^&%#Z}Qi}q%=mlSi zLMy&|WGQ(c`9P!fupS<_>NX58V#ke9myt_|#4MGu6cNSQcbUDb>&ja@Eps_UF>nP? zzkC@R4beN!yAv@_{`h=et5*@7Lm;dg34WlZCfcPiFAa_J*7lPtG(g51nXGCSKr}K_ z(buGuIUt#7>O}NBsK>M^jD3Dgmm^Lt0;hUdjhA=gWNnzh$yDDsW7NfDfp_hey7U$8 zP`2lG5^tvt%rGOwZ)%_*6H_}LE#(9q4?R)dkrHxr zuK~8rmR!GY;6-?H;uaYM)!o2ndn~%Re4!KCnjH&ktqqOLX{Y&DY!o>4J_;0~)N{Kq z5Yp%>HiK17Rd3tvQDL)f2D-RfQ&ZCcomb=mVK*XtGT*OnsK>gO1*YAgRH;BPZl2{8 zNIvLwTic>FqH56ExJY1jApy}iGNS8&d(FtGv%i?pOFL)+4S?;3DP*Qi>ziqcyGb+g zjWpe+&@vb>k|HETBd?F1CAP`lD{_$S6Eo8FoPc@iUE2~euX4cEPB(mPoYF#PE^%|M z#YqqPV84y!Y)ISnu3z5T9L%|P1+G8zK_&2)FLWNg!nf`@HcVBeBp5Kl7>zu8umF|3 zfvvecRwsBb1G+X%IL#dm+Jqn4_G0B;zFL4-i~Vut`28=-|3huvb*yGg=YAysh)$rQ;hpGv?CTiDjdn$NfP^xZKLy>r>va)W3EO6@fLn|I^Yke=X(BjVuA5G zQjfqlfI{=n%O3Z8-09>?qa_|u)4LwNotu08F%KA`_@b2=(i^A2XF7n=LgOy}aA8=A z8ERxoH8w>D9g0$sg|Q`lZLt<{AZ1Zg3b|!|Gb?z2Eq4lE709Tmkb3dm-kz#6j0q}C ziOt2m1jNAPL53FFtmy4DLI#UO@a5);?2+ErNdZ!eM5tt_vW_Vws)wD;_UX(y)6MU)_C3Ctp1VA|?-z`T{$h2aqTt$!R zh{(Io=4%Gyz$0lbWbs_^&Lj!|=gp-hPgI?yjbZCs#ZT`a_=r{5PTCrCL#;}^luXIm zd?d3Ab4E((>xMp;tSez&OM@2jt8OBeJT0X{4HoyxrzjE}4@}5eS3$+X)v?AuN)+)n?pg$%v=un;#@2zh{!Ph9gc=j_p(n78?mbjalNf4FITdi-KB=y zTwu!6TGR9^sBW1zwCXwotYj`!7ZA62g?3C!jlp8~_pD4Xq)|*|cU+x!S&xr<+k|^b zA_VG%n4|)duNaG+s4Z}}>>-2;UyZ6G_%Tr=ID~yRsLRQTkb;cM!7>HKNsa zn2g+{;-O6i0bJHhwU$oU6#Q))#|$upeLm|Gf_%D2PK*rXVQ3n|xTffOE!redbp7m- zhEhnU3#3d$EljiuE+@tcKlYb5j)!(DMs&y$O5T4c9JzAuY5LE>_oHB>5+UH7e%dNy zD^lgu9RqH#N7=N>${+NZjOt%ZpNyDzq9LQ1sIU@|7LwZpxO<%;Q_^o>$sozW(O@et z-KhFnVjnN+ig&cSSTmEoRfFa2W=m&mjSY(%3z$*L0c0mNe0wKgIPYr92CFdVfFLZt zyHuymq+L$cyW9MH!695?fuX$-%hi?u>f?o%X#n|)vH(^~bNW9=%cQ?2SVvc zm!zhiBkvXo1%)0?7{oxQ?d%>Q1TF1tuc4r5ohlLiH8QCw$EIf3Ji()uSdx7wt!;0+ z8c*?uAoG8LWG0oMosM4mw}LnX%?+9pR4uqlnRo@amF5c-8{(UxAuXk=_~ZUX9a?TE zjrpV?oU5>yw7GFn*sWQ$|W$xxu|xe_gKgyvS~*}x3>@tvz#exajj=T!*{bSe@u z@Bfiq|9`43y)5(MO_QnmF<;l)v)4JD2}Y9Y) z0yYK@ORI*1-eNt#G2ii)x6ZW~ z=%VU)8uQ4F*Eh$5xVX=fAa9#sGabekA3_9oS4$4t_U5w_${QUVVFanS;m?d2%SkB)qOJe zr{ra&gMO1t4t+&dz0B=yH^!N1Tkj51>^5@hOQfXnJNq=LEsC)QqTXQ4u2==&>p5n0 z>WYi}Nt)^>uO4A{_==FmGam6D8U_nXCdXV~UK4hqZ!2x_bJci*@e;nI2h7~;SwQC{ zMf0mA78R2k7CR`Lc=OC1#vwtmRfngI3sEhso!p+m?Piou=b(t)z+V09uH`bhho-w! zwn@XwWz>!uqY3Q#cX*sM{!k5Q?$r;?H5+ z_>Ep;F#WXcLbRpncjcd4iV(>haOt^e%;L1E=`mIFAdYU6N+dAwx9d-d(OClNg7;h8#SNziR3g z(;G<9m6A`b-qE(G0KZK<>#?-xLwc=|$%}1N7AUYVB9*BAiQpcU>S0sB+3qzix>`tZ zKevqm%J_fcNH<%*MWk0AdJe~1a&wx<^A@J%f69+&=6Fz4!x4u1PNp&PqKS*gCzrH& zK-s#5Fi6yl?U0rm=z7`nD2T6{ZG-#`3POTA{pyfonb^13=(us0P;#%-;A_*&xlJ@S zA|eAqvq_3IC9l7tW}WCj7aDDtf2lSDW_l)v6?M97Jo$i|=jDS03UStf9@)&D%}mr| zHUa_aiPx`T{r z!dd-J>FDtdih(~@@pg(2XzcZtvnx#w%8uT>?_LExp-g05O2im;d_-F*GYx{B9aL>} z!HiUB>Ex%gEXjH?oN-T{C$qA*m92;0z2Aa)v@C$wX`#WXaat-zg@F!7 zI%z@~`rb^W=7Y>>?fZQvR%i86qdKFu#asshp|LW~&wS6L35;&Ept5q^OcPy2muR;w z7TUV!DxCyNC`CmT6nM)%MlRT*_t%cfzyGQo^zA<-o&S-CZl*OK@lP&{pU>2I2{%7i z)I4Re+dD{7{##)xi+v%}`z4*nD%-B_^s5hoF^P1y@~VINN4ophx>s*m-5N$Y#7q~c zoJu8~7IA(P+^wJ!!a&O~H=R*E^-r|;?;iP|O*#`a?bci8eP>^CJ#4n+?3u}0CbyQ# zu$=9>pCEZDy&+93{TS_u(r1wR`a$!kGuW;WP^+7mSbcp-WUo7%rCj&hDiDOxA!FRP zP8X_1Hlzm2#69?T1Nbleyl^XTe`f>dwwhkW5zMsDaAv@!xlyQTPx68|;r%qM0nYUi&4_se5qMb&$;OI5AAZ$RWbDW;8FM2%n zI}}}3iVUjQ9#C=g+K1Z)h~6r{=BD8&DiA%-emQ%OklEAlK%Duz`={^oa!N2QB_=Od zB(ApxzItpEdQ$A<&zA_CYzH|8a&raB^Aa-Q$;&D4Qlq=edO3ORrm3WYl)pQPBrVt5 zDSgedYYL6=qYMK-28e#4D>HG>$lu*{>lFo?7sk66*)|9D(x=$U=3j_k~i=wBG1hgM_XlT;Ay?+NP!*ep7^E!-eZhA7E028{l z>hjWG>y6`S`1i}Hqm1l22mc7ymZ5h7u>-}k{0_!Ym&Tb%v%Z(Lwh=s=RpHr5y zndCT{Om5H_D%vTv@>e9Sx>c%U!s@be;YO&7Murk2fp1ggRSxYP1M|@L)6XW^V@lXb zmis*za`uOcZTHmn&66I6eH3u%e2MtrWL7+KqfT}_-aa9hoP__}&o4%;#yH@ir!m3% z*^A%c$1i?W9?WFws7t1$;5*b>mM5eVGW-O@%7KAeXUs%)5nGuD`NS?E2m)Sg`J_zP zI*bLIk&m6~hfoDW1FwB}+S*?nRh9lYP)5 zk}I+tg}3je_TJ0(nCn{WDYwata$&usxr$PA1~9|&7X5t&w~f;Zu}2TkxgvZ?ejX7X z$xO|X9)RAUvgZ@gg1mTOHS~>>>rBf;=;oH5a6|Fyp)E1)j-eSRlMEk1=u6~aRnpZv zbBT;lZvk2^;>f7R-DOxH5N*sR6GOOe%vV@gW7tlwtFFO$kKfU_Uzd@QQCd}%%HgP} zw>S@25PuMgmo_#~`Jo3MkyfZoam!jdlj`+y2(t{#tm_`VS%#*?I`6LYrlu4Mu94(i zvj@fK(H)X9G7pBLtPMB@@U+I3RDZxYe?3=W7ZgWTjzaL}plQ3sq7mmq{^_P>VWG&FcY6pWP#_!UwCY z`6txPG$7^a_cpfVK1QSC(pUl=iDksoDDVfOQtqagEoXjC2UM+U+B`%3qPb1>&JVug@jfT?RuR<|Y4#N*p&%U_J;NTq zwv~+Sa|bO>u|DN=;XXS71jMZJBTO zx6rybYXZ9+bRcXtuC)>6&un=`Py7K!S$i59fH7cpmTptknP;D8@9LFS?VW70mUR-q z0VT}ZS5i~TkcGC^w8-{(MvetrzKwC_IG{CmVOiBSf7Pk1OK{q5c^2qgqigP5oR`Jt zma(X@MYr~|@+VbU(NXEKW%9uw2o;S*mrO!xg+Ajj;r716xLBn@sd?+B>Op4sGI?FbQVD3mDw|&Yv_rIJ+*=v@+zby zdR>86Ss_;{+IXh=u&{;dh3%o*?Kw>K`eQ0o7*G@b=lNP__;3haixB0lwPv@T}_T`VA(eZ9U|zeR?OPcpfrSWJUNWPQ8${;rxIrf z)#>$Tvn8xD&1Zb#@l4jFiE6@F3~k5c+69Ra>oxt8ZnLus9|N8{&OXOmZjO#cECKnj zQ3@Lx)ozpRpDGSNh5xl$x6CDH-Rk&Ch&~9QzBaq-Qnm^#4a~!))vgx$%&VZ;hA(}$ zYW}1cB}_1&`ucb#>(BR>-4*?$*y(LN$zMCR1h*+4XT|{eqcVv@MROhjJw|yo)iBTC zCI%<9R{OW8ysD-q`p5Vfb#$jbgLFe_wCaYZhXE%plz`Yuo8*_M4~=G4i)zG3L)87+ zy3}h^5pVaFvRu50M0%z#bgq$uuFq^Bo`XqX9i5d31cGRkvbgZ*s1fbV4L9Zaf7pBP zxHhjWZ=4yIIL6>$44CQ!Y%tvz1O|*tK!6PbV@Zf6FdZa%?#}v^eOz*wd{FL3)DJH))L6SPSvmgAucZA=OIQBd^Y}`7D7k(QyubmM11ROcx5=<(~NH(RM(*^vOum zsK*fu!_N?E?bIvz(2GNgn|`}m=Y%bhv&3F*w?S=Te=Ve1RlG(t)I=lYu~Ta`=~&md8&9ca88d$5leA$pV)VMLK-~#XRki{`sNoowwYUeBgg#Rl z!L5Xvg7vMfOJ?smEy1&aA<<6|`Ix-NvE(wITtUI2L+{LRqCkd8#-vWY@e}L9$?>a$ z5s^uVM&}88Y^X*yRLR@4iID^b&=Vx|vYr6rwXV{bmb3c#aL1r zoXeMxi6eWVLw!iK9<~Rnub}|-iqYiP4nn-U-Ic>Agb=>LAbQjl&FSV^gCT3+jR|Do zqV>sldni{=PUGhu4Aj(|Kt8r_W1FgNvpm^&A~tZ+0-J*Q5fI1g$*h$vSkv(-aG)iy z`6AhLEd_{8FGYEDGr!K2ZF8S%*DmFxj&B&x^v*>LA5<~2zq|PGh)7IHIc%#Fyx47< zjlZ28>m7K$N-7x{+6lKp3ORsGGZY`Qb-S1L!5P=3s&malXYM)r+*$B$^o?PGpOq29 ziE_ha;Pa1MM6mEqix$)%M?2EnUtMEFG5pn0V<}9n zJ5HYMdf!2N_vMrr@s-(N{ATDEf|J$k(Go**GV9w^Ct~t2M>L5||1EhQkDa8DG1)K> zosm}ddk=}^G$+B*Uiu0LC@;Gp>LyBkugAar6J#E;00gSmcSN3X=x~tMGbhlZoi|E7 zdC3Lrf?kCEzUusOpy?^G^Y==IZ|nDzxtdc)&aWb9t3QHxC^CENm@%zq@EGwSFbRk1$VEDdhvw%7KRxxSNp z@G}6xqOabAZJ&VP5~52k2;fz&-@u|L^$-oC@V z3kqtiK%V~Cy_cWHNK7kI9eluun&zrKmG)+++4#*w|H|^O9OlsR@P+woe3{7=tM5@K z{dqa=v2C3`c+qP-9ca&Axh|1nQTYk8zng z){3z49N|+a6({=4Qg3z*>J(|Q+_9Su;ERsbCyjCN3ghy~f|Z2zxO>WA>sR&#`VrH{ zW6&#cS5H-LC`M#VN+p%2;a` z2g(A#kUm{2ZFS!c_r-1+=0Vk6YtN~(A7PW1w6se}d+Nov@-t}l%upzle$EZ&MVUq* z8$BMsslTo7{9HTmX{kIjd1ny-A0V+6JgZ~_KoQbk*pK(XRArTqS?lIJD|#$l2x2AC zJ}K#QCUY{~nRDGm?fxr^CvehfIHuP(SNKkpUV^T?ab4bY*VJxk#r?uymO-wY&Ig@y zOUJ0mK@J7E74MF>UDq~tiW9prg?OX=>mQpd4>#8p{oBa3CtQMi2|Wk!3_8B>)KW>J zP!O>k-mY681X_#ZHWl1+32&=1Rz&&R$o6c|u9Q8DbX3-`2GxC^=;^&6x#cAE4x5<- zQ;8S{8BjF>P}r*POJEmgZ`MtzhQeXujs;Phx)S%&uGbLMXh8T{qiKT9#zzCoyMeQ0 zhh@in9FC;M*tWX$DXV_t=NqK@q4tiJP`N&Wjj)iZ(T>w2?i_ZJ5sRL);rJUBMh4US zi9ML4H+aL;Bin-78vU64DM?Yxrp1FL=`F@xS{Ait6B9hYzW)=`fyVsHveKWJ-V9`o zGr~hvzsa1QLXY9=ofxalQyD0%I$fLjR|7N2uoq+&SBB#8#^1~@Aqy*V0g>s0g3=rL z5!IddpV4iE6t^I!k#s?^O`8>VMU4#njyl)!QS;Cg`{R&1enYf=_e!yxa3Wg2JXg2Q zE4JkL-5|;p2)|58^(<}de1?=<)JLKyH80CW;&e&VJ|{sYUi zCz~%%x&`4G!>%^&%ELZ3C{q89Zbn>@!M0y69w)8wSkm$F(KV5^gzKxmk;3kqMtd@4 z6u%wyGFPAWwzPLTZ2-ieQYN7*_RhVmB1(P}45~smt&Dvz7N+T0yD1j4rTY_;TkL7q zPfYJuum8lfUc2-x?ws>+bnw3vWOOlen=1tW#H93Kl$Dn!eFMq3In4=PO|&28It^}k zuzNRn3Vd_qrL>a*`J%R~y@lqI+GP|8JwN>tKHHKtjjMtzti<}aSsDxe#MHh2`n37- zF~a5uqTw9`?<0r62OKKY8J0tWbi^tWI%thtedskY9fE` zA~BF1!swmPfEMeW?(~j#O?zp)D`h+yjZJFsE_D&-8xl}8Lyj&ewFND_d8}DeW@>v1 zn~)H3C~6Otf>0qYG9@(^?M#Plde}Cd#e3QakU^Bo{2F&-wtXal++U1Fv>mxoMj6R` z9Jz^21u#L8rd+3iatEERrbu13T(YI;C+n+oGM!LxuG^k^(5|$+Lb_D%NVPO84u!ot zF$b__?*_?WWcRvEXZ6yeV=FDg2c(vUT6+Re^ari^26z0KZKA))sccU+Kr5TLw6Y_H zNY3G=xacuB4|Q-OBG4uKO@o(GT0opULOer!!hOn3?7rx=d_3%}C-74a=z~wvUP;&U zG0AJuhjs6{ z+)rmoA2PnZ!2y5C`p9VdU9M3wq?1P`M$O+i8w_7-TElp7O57ehkME3vnC6lv^U#)E zE~QNwMqc8hlLk8q#t0<2F@s&Z5j?xEB%)5?H5=<|2iIF4!u!Yyvj=w`^Xpj_Bu&_cKv$nw8=*a%pWxrRIm=GzV}cVv*UFXO zhknr*9^xu4E=uiR&U;b@Y*P!Hf%LS{$0>B6VtbY%h(mC|-xcex2T;Gmtqr zIlUX8H>>hwNNQW6oSw$h(h$}5zMrIA*y%%R?IV-dfp8zGxK_v=yf=^IIbpGS{qkO; ziA)S>p^6;aG(XlbsB>Yia%5qn3j1x3>FN&#%hWwwqFU$+v{CZXfdry5c+6ze>`Hmf zm^g_-t@{Lp0DZ0Na_=0PWv*1_AAmy*Oo-ctaM4fe3%NFtTc4_VXn=k@N^?{%^jqkY*c8P4#B|kJQq;J`&&H*d zl+pwD)b=L@Mcg-`vY~(pNDRs%kb$HGasJPZC+$GZNysrIk2>a^?s`w&b`Ti4I` z+OVFhdEQ3rw;qUEmstfpQ}h^6_=yR#jjZ`Le_1?YN#Yuw-CA;mh)seo4w(m^i_Ybk zp0ho8LSwi|&4_wj6fb2_vH5mI!J$)JMUWglzf1F#-^~}Ia*9>N21o&6Vm~o$JYBk% zk*VTcZ4L;mm;j&j@1H&$HVK~7gOB)5-QBAX{YU~B&Xn#DB^<$&ey?GRQt_0$yk=w@ zv@MI*7$;lhp&yO^J`M!@6(x{}kh?m%#KiZN$6vM1&3`f=+1aK#(`WTDdCaH@zdZwqd?f&qv zlM|7jsBDn!9N3PHW#fSAu|co~4=&7}ALfn{1~fUN$6rbIZfXuueeY%i2Mg_YRx_(P zHtp--unnW<3f0|jy6^Rd{=}5NkIL-~T_{iDd2%aD;hT$M_GdN2X|XY9yJ&48IxI31pnnFG;@0yb!P6%nMdi zJGcm^o+)n?kgS6No$d9UGBfZK1~VGc+j+VvmWbn&#-SJEp%TgD1@Tq)GIT~vd0P`% zLn;h417dIUH8!_)46?LFnK(dV@~g}%lgQUBownm27WUczl%O8!wQ7^qnPDhgXx5pn zA$4hM_+e^xNP6I{b`xz|Y`F<;Y#)Z~ltpsemXiQRQf%--IhX-oG^#99DO5}e&1YJ9w#N8FaKm5^kqjHz7Q~=Y5Z7A zf8Xo|KyC#j1k@MA^9^7Co@zjK3}z7*9^t50n(2iK$pFULmaHQM) zoZZ~6_w{FhS(nCykW$Y8)bg_+WutJIuL0QwYUyoA40eB(;mBMnY3eo^wjOn}NlTbH z8?QMwr#`3Ti7Yh=H=s+YO%_Jo!#Dcq;6qHomYmd~?&FFK0J4WiNU}uH?ui3KRrMp- zA670g47w7*(M9wj?(bR6te4rJnJazit8pKqU*gFH#O3wPjKyGMLSS0Ki3hf!n`sw% zC-?vtH}!(9VBXHB=Rg+2DdK~5Wa03SVPWAPE?gIvJ+dyyu3Mi-m-ei{xCBB?k}7=> zl^#<GZDTkXid;hBAFd9!j;v#`=6RRBkTL*E1Iu~52S`SA#vkCzqC zUaRMoVR$0d5)~w{qg?okE{W+5uKcv@`^w2TIgP7&wo#KL(A0TjCAOui*hEZ$3|Nyv z&Gc0hVsu`t$F6=mQ+0lV`AhiPh*CtQ1Fp|FV0 zUIcI3?`cHWQp8tkv&vGV^e`$PnOFqh{EfNkpYhKh*be^%sh+hCsxluc`@U|#FTJ%! z&(!Aqpq6gPgvL%tfadNRq&?ePQQa<&W)ktiV{PqmF28F$PcFi65)*$hm&+KWg*R4e zU9RiT9<6wf@k)Gne92>R*o*+rx0&q zq*k*GxWoQ2O{PDE%<=~^0{>oFkS%#LqMt-8%kTxZ_fC(}{hQh! zn~T63Ldb$I%>$#p_G}Gz(Tb}|FbW(*Bpe10>;n#4!G$_MF|o_Dvz004`c7Fj9D6TX zef?+g?>@u8zZG9-7jYVLn+xu+TULw@Xq45POkG%7aMIk4ZdZ~CTU2tK#ePbo)2QU7 zajHJ(_Hu1J?_-z7{D^mT1g!P0&4|h?*k%-lhA0wOs6EP#am2Dl?}l3ZTkD_ud;WS_ zVj12GP8XLpD4q(nOKFKSF0AAuT|I1T0Co1myxQ`pJxY8GUubqMq5Z+*)(zutJ9V!hWrx~K}k)@u!rUC9v0e!6eNt9FR`kG)6i}DB};{gxB&TkCG{&y`6VdYh%gmQL$RSWJz`>HyXHZ>{Cw z|IV6zJ$O_17`?W7V!a+C9^6F~*gt+F6KR%|A|#*-0;8542}!ZhR?;&w;YL(A^uhVr zrAFn$h32|k9hMmiy=_Nr*tm}olGVp1LpBm;ZX^v>M;je*+=zYD-<+NwaoFm}0rlzM;ogWs~O}hw-pi)+A6@3UuyuPP) z$IM!Sr+>?(f|`N*WC!Je63wdarN`sU(BKvzO*i(d-S?re=O)ZTxZAWB*ThUv)cn}4 zBsfqIy=hq5NZcJTwdftG%(kK`205V?#f%d< zfaEeM{Y;$52U!4wZW*iBigN|&!QR9iR86lf25*JH3U9dh(Or&mHZ7dxA%imb5N#df zi5ag3Y42MpRYp`bof;NKXmG->#AHAE_y@(us!$e3DfTgRrg}Rs`80=tl1JqN#seoa zHorY*_u+O+`sB*b!n1MhcxEYDJ>tE%ap~K5QMbbgcETNO{ZC9s=7<|Oqhu;$rK+oi z&p9bBjyJ*Yx~$n_xP7EX;RVv{+M{|LAlY3gS}~a1yu9Ft95S(;KNwENLo{x9DV0+S{e<%tMPUcN3PPSb zSs#w=j8JV_ftys7b6{hzsteZRj*w|y98d_#!PW`)&?i2T4%jU6`g5JZYG!6K$MCR8 z8?4}mCGjbD4luB%!%Zrp9x|x&DU?;wFb`t5hc0a7 zcYWGdA#m6`o3pcf6MP`e_iPEmciJV%8NMMMfiw{?oC zRsDczTmI9d*Ej1R`!=bLvf8A}*u?JSbzB%~+ns6>-NOa|PGHYmn;lN5u9aNo*PkVC z!ULt&;>q;WXL{%B2EV9Z!K9SF$M`4-%{PS&^8ma60|re(<^WIz#kH>Q!4r?J;XWd1 zZfKd)1mGM^H7^5y?A2&2`nI!wu!dpxHa#SA+_lgKSTzoW7u*evAj~5;@Hb4dr|9~X zeDq;dw9c)Ji+<0m4z**v{O@rb`#+`%g=o z1@qbd?;K3<(>+~qsHYzTOGb2w=}A{t1dm`>mmtGz%!U!7T^KQfIWn*nv^&AMHXa?_ z4rFn=yj8j4k7J_W84OFPw zrf}Hf?+X3uSCf}3Iuiji_`Bi915Onot5aE=BwXaqjO_LJbM>i0Nd~6*i37_rmq;>| z0q%8|FDPtx;Q3`5y$sj_HGWAnn}8pWY8mLt(fbTtPD*9%Pg2W3jvntOI9 zZFv&yrKT37X)2u@F%#srVGn?o+1PHWC-Y~xWlljBYmvRrDpz5O3DjpYs9JWy)@#@n(ogUFpFBGbpP4C`$$i-a)U|n6WqeHBWN`f&e1TXI-8|^oA6s_IdMP!VhBRSZ<6HJ{mAMhGuBB?KELOsCMG+Kz zk4`pRdiJd&l6YSb1?;GRauh?&!413I_vTV8e28N2&npnE``9OD^`Xr?YH{y28)ht| z@*-L*$qTscMeFY}CRZ%|vO7n6IKagg!U|8g{5wg#wTk8@efmSG;p3MtuDx*SJYogD zBJ9pVjovzFTS@07`)h8GQRi27`qU-~3^#-<9o~9F^@18tMnxVai=H2VpaF!%)TT_p3@6otoj3^qb*d{2O zQBvk_9bw!^ss@7!-63FZb$8hWhp5=$%a=Jn705*A36@#lZOy=s?&$I=+6&SA0LFv@ zci7wZdidotw~>ZP+`6u57r~yzMhk|zYBacrP_2-q27<9?(N0#yDCfO=he8{j8+MkW~#}N2n~DzLBS0AMsXVTF$0jX)$I) z78(Um>r|W{#NMK&*DPC`yX*(jbQ$EyYImpcC=9ABoS$+$MCz8f4Vb$6C~{T*zR?Eg#+^p+ zpsa%DhL|{)t3V`NPA6ds%Pz`P{+|s^{Q-va`_(?A3H54|UV6t2uaK3OYJFpc_$5o+ zg~Alv@L>N(?f9lHBh5Y2DE%coA9dbseNc6+#Bik|Xb@yw3ihOM@Y!FLajqPV(s@N~ z!_|sq*|B*S%O=>$l&JW!`;_6@B!nwJsm-ya&#;$E8ouu^jvw}oLUPUo z)^CtWt=YJ*W7ipRoxJ57Z0#GB9J?W4FUve{I!%4e^;0QCuo%Qx8>_=+yMYnbv!^LIG(&6A&w>GTy zC(&K8^hKk>q0mSrh zulqUY-5mNYTzhBV2fSiR+nv-5cbV?2`+n4Y+9Wb}unSs;y%pZ&9u}p?-kB_Klu}&jvVZLB1ou7fbb`0T3`~mPM&ww_d^t3HZB_+ zN!85BC*O4!4o}r^4+y{az6KiQYc81j>45- zZ%u%^xz+XVuLe4mw^lz3ql_AvIl7Su;kju~N-|kY`qJlQ))@F>3!9eWq8JC6PZ5^r z{vJ+E>gs{X4D^|7_i;gcy2|%rGAx+BbA*{oADeYsRE&nH-D>U}D6%xNdPNVg;^)zS zFbpR3v+ZD>){Cco5Qe^iLe`h6!;kIrHx&f8yk(?ZU^daB4p%p%@YluSTKeGt%_)l; z+JhhfaNPyYV)_lzI*f)OkFAej$l15h1(RXe`vJR66^^%$#2u7&K&uDgdU9aJ4zN9- z)6m_z*z<|%a2cVDDCW3eFsJx+rq6TtbR3>X#e)&^hZAWCbqs&+#MJ}|2Zk3UP&Z28 zjj?1E^!6%6&OHdIy7=CpFvX(t@$-_tO*s#}cY3mLn9dtXt`JUjFbvQ(1skW_3`h1a>eVb=|pd?2adZ{9@*#7h+ zIH6;m!1Q70X0+3__s>33R>lGffgVIB@_ex(v<;n0M!x;wj6#6mga@(9z@QIgY>^T^ z9?unN%D|^!?3$y{e_0%8Xe;Ll0oejB}MS z@ItoPO^*jA5%f=0mvYojfxy#e&(2G(2i)JXpK~m@g)1!4);>9uD>09>;4*#yuylsY zEu(UUR{P%0OdQL+UeCE`?6QJEkL#et$~f%^X3WWqm|Gk!R=EG#DzEyrm~(o%r~E$p zHC`m2;#9(5%z=)Y+B)WLTF0}g#0u7x@X<&oudDf0MH?-{)A^}J(H4TT>;6aSayq+{iEJ?YzO;O+!9WV^bNkPazQ;KaMiY@ud+AG#itV4Z7|M@{co z>}Et?t7Aics9-f=`TlF`x(tg-8vkITqnlR;Rn7`I?S#hqnoMdkQCusB$E5n<4mE`` z$=%~hGvA&Blr~5M=!G>TaQeP~Hbf{86KuZp6H`+BVZT~L(b}@D*D1S6FuhJ`L}XW> z_Q3u@p_*ouz-g1W^8}#zWch(oaC7Zx?Mn6uwI*>o=71ykwB&RIoWgY6F#5T>ivNE3 z`I{+8&LD^H{3gY8qDa_;pD1H<3R+I@+ZCbeI&S5H!&Xw=zp4}w$Rz2>j zOx?p2*p{4sGKEhs$JcyitrDo3xTUMAypW_J&Ebx29D^~yRA^MsN$mJ{UVd#7B%20pO z#8!4|6h~MxV!*0b`+fD}s^PhWnQ;IL=8VqH~n+Bbe?0s8@tIeqM^* z&`vO!^S-B%e;Qj?Z)zmHhY(YfhbFT42zka`=w{U)%IPjJR|TPA$fyBkAcbn60|_=9 znSy(Z2~w-7HiP6BaT}muu7{sR?7gHc@bn`ivqJpRZ6NeudoNUrMf(n(7wIQ60->;h zee-)Ti&;|WSz+!Ngrkeu?N^@rlQs1cgC33mN%`HGUJxVT@{43O$XH*DBSVD2-$Ibj z8hq}V`WRYgDDA7#UWlfLxEnvH`^p$w6c9VE7SAS*UL#*JgR@ux=C>WA-?F6*?0ciL zUc`i^k;_r@2I>L{Qb;g6Q+M;7W-YF z?|;1VADPAeD{}nd=^LNf%Dn4@E zd)AQIas=6}8n}ADd57UIR(wo!Zu1 z1A)2`kZ&PNkXr4=XxFlgqTOsO?PHY#^^}f>XZ3&lE4_dGaLviY-*u+QtZWUDmN~R| z60!S5uz!Jv?ajfo@sq*6S}g0F>K&ngRMNze$Iz-Vt08>d9WN77hpBX8b<3H|*Gt>G zpx5p7Lp#Q4b+w!XRU3S!`Hw07QhJ8J|GDL)?RzmL{xsWDK-F08n!p@< zoaU5zIiY^b3DxKNqxVJeS>_50vZ&dgA0yttZfpf{piopKI-i^u4d=KE@E=JHmoCm% z>*ggWR>-Z4n#mhFrKZk>waNaT2xaQ-)as8k6`a5RZUuQSsB>q}1be7r-+EmAHkB>A z(8oF5-C1B(A*a?KWS~-k6e()e8blvmXN(z<_O(;4igDW7YMj9@9sK;$8U7EaL*8pO z-ACuJCG0!NMaCmLWl>{GQNc@x-lY>CtR;oNau8J5@R!Nn zegqX0vid2HJwtEczmW~W8EbDu+=`}Esr0e$b$Hq24rS$2(>;A(N4X}kj$EW#WjF4l zCW4F3h<6!#&Y;t|NHsz^zTi(KL-837u6q2$^Y%Ep5Z1US;&7*{iM&u{IL9WtBRV{+eF|Ppyhz!RbKl}Juqv8V$yrX6^NfnJ4M}m$ zqv}@@K>}1{sRn?{lxJa6pzP|RpX2oxx5OkqGH0eKl)YX*9IS2`mS_8w^_!G5I`SQ+o=x?WLocpbFEYBg#SASH47x-Ss8 zaGn_ZewC=cKS;l{Xc2Tk; z4H*;CnDz0{InP~qWNO0IcKd$XqO>Mo)N4;a<%E4c{rb1OZ~rdcGk+m_1~ud%wM_ZiO`e}RzY6~3YRvk|DTH$tL~5>^?4A!)=vVxuM_lh%)$7R= z{)N%UALn`7mUAOFx2pvnS|kbDS&ZJs)E@EIX8@tN9(VK2xkP7{>T2=Tx)Qj zO~-yT!gnPqi?v1$d3&T#xfIEvOfUxRtc%}M$`^|MV<`PG3;$UQ*cY|So}`tyR=Ce= z#1rNC`TTKZyZLpv>|BNsdR2z(>b5P&KR}7xt*SH@mAc~ybI$gJuyrgVB6+ok&0zoz zgKeGH!elWYJuPgEP3R>qKXmq$+RN%AqR>Ij(dtFHzGDlKK=9<$r^&zy`{j66qj%A( zOL%_ZpUWsMVI=$3+;}mOnLRU6DfN1{?g++m{y|^D!KZ(C-BRk3jv=@#n7ZD+_AL7E z>;aDi{xUZ>EB;s*|8=+eV^8^g+i|4RT5-*gSGDWwbq{0JcKEqXo=WR#@N+-dQ{w^7 z>{!wjkD^{=HoJ~kCS0CJeIHkhy0`LU|1+CTAO>e79*?O5MR6*RK9d`ODObPWdpyzO zaqMXFH#!IG@98>!=p28jYyT&yYuQc34l!ltCYOB6v`VYJc8w6+XFUN1!l|+P*{PJ; zi>I>Sx3K!nh4(_2KR~bcO`4dt$V`_HHo8O=KUE2fDy?FeysuE#Fxv-u3=2{uFH2kS z!q2)g-r3R;SePiI%?Nl0Dg{M$-_KliFIPuI{Yta`l}anEDfAb$_{HEKitPW2BKybj zDfjUIjN=nvD%oFr<#mipj=XT;h=7B%q*{r3Sv&oUoEHSSXqXJ&tT0(9wyJZgk%KEc zJZ|fkqpl=pw`T(M0Oo)zpKVmPdU&w7=X!PHoiihD=R&-`I5^wYUu_?acIo+&?~g<5 zf4Fz}V=w-HVlPJ3T7U}aRLipR61)jo%wIQm{#1y+Z57M;(O23G&@CaKTw;J*6ulDa zn--c1DXEJiL#QSA*o+cJatDu%9{Fp`3jP@*3t3zxxr~?@HtwTMod|Jd>3nSs^3}C8 z8(J_6ug0702hZIdMu`*IcH084m$|;;G(~xLmN?ahMrD8WyZ&CW%yDqNr_}GV>MnB_ z6ERY4pSM|WMD`UYRLvUXecO3XF* z2DK@34s59F{6yuZrIiM*iAtNQi5S6%=>GY`cb_*Nf3C(CoZc*(-?U72P1L9?bWVMnWhRd%vO84wnQxQIB30GSS+GIe5V4e|?$pB5J`xqG@PCtI1Iv-KH)X@^S$%34CA z5>>iK)-qAqe)IuCUR$?WvPdRfM~z9a?C|1zs{04c(`T7Dct8J@Fxy zy8{Oovr!r}bm^Snt#mMxfu%<)_AJC(=7kY* zw7msNuC|8e+OT3vblnZj$E<05rEPRQ+{y}FX@QU>5UTbhs6foHVFUko_ETTEqshSx zSzqFiu`A|%Wls&A`)#T>Q zC(rx8_ZzYETl4;Twt}|dmb5`QI|QUaio2wwSu{spmTlGug?%9`;C}t-ba2U+E=#ZA zO+@#BF|^=9U+wfm*{^;B-80-BIPw#|Fa2=DM(8!C3k!*6p4cd}n}Ue&ngNU$Zm(45 zo)5Roq@}*ubY1za^=kP_r|6Jp8OdtU94HkqBR7?cJ|=TxO~lOvZC32rh%c4BytH)| z!iR5fOG;ZM;Y0-sJuUfldCGEHF&(J>o}~?zH(%4Be#dm>^X!|ae4EAvj4mqOYd?Q2yR=gexD2!|H?1v1JbH(R6Io`f z)Jt?5C+I+vj>tQ`uUWyfnRWw4ZsT7WNC7+tW-91TEQzAh1V^Rp8}I0DBx4@Lpp&35 z4!!Xy&gUOf7f_e7?lqD2jBZzTDj;~?2tTLNe5xhB=Ob@6Ce45~6j~~kFHAxUn|z)7 zBENLw-3A!hQVi;+JNTV4(3G+`U&o|=^%3%1d6`RF#Vqh$97?_2@vVj=5DZlg+k^5~ z*K)D<*1PrrUpu<$jn2KnT3=;B#bul7XN2=OHJw0V3}<9193CesU5sUCIHk#)$Q*Rb zn;is>Z7nceAp9fV&vOUnHulP4^3ako-@sbEQg*q*v>L=|Q*8hK*YQ98 zBdY&WcFFrveQ@+vSe6gT&|cJvfcV({h$yMYB}_8|6Hjcv6=}pa;A5}p|2enhL)b=o z*%-f9iLMHj9|kpw(In_<_9)sZB!b;@l;P|rt&F+m9o|N7Q?@-R8CG1wjw@jSOl&5f zWr9)R^5hcs%%Q8_e6tvdksk8w!qeN!Z?KL1sliUzX8lVt*43mP6<1*B&hC9V!)bj9 zzYVHUp?j?t!7Qw!rQK%alA=Q^o`aLUJ^j)5k`94JAIxjzA%*V-a8S3FxXSL8F+wbv z=(gP#`U?G9*!lmr&OcWP;nA|I?;cTNo+_T)KN|A^^e;pxWGy2_lgdrs_xZcp(g#fE z{5}0V=HpsugT_x*t}y(>Gu%w#zbMrBdHEmyxHFsCvYAG9L!UBx!x_7ceg2LAL3s&j z^V-$-AB?AzqxdRnj0hx;fl!!*Qu2cWqUI1^Y*{Kt8_nD)GH3}LqwA}$B^1EzSqhy~ zw-^fzidK0>thM)9ke(0r^@~{>{z&A!Xi*SL4z8I)-+mFXc!k+R z51;A~)=zGCjFyi$`A8Xw z(=S&}B4E_sCFgSSI9uf;rx+>$k!?gN-sn?<`?$)=vUd6%GJAdH32f(sn%~tgPONDK zs}ubct({`$!>X^3;kFs^pbSOkF(dkcSL!lfX}iR}oQM0Mso~6a*-U0s!1Yq5-yt74 zk~!T?+;2~z#$S0wx{y+~_!E<*-yqSO60=&a7|1{|*;5|PIQjB+begdP{0-b$n~F2q zu6r!@iPArPMXIWASkhy4=a>_{#L#DezxA{HOFi>c>qqu)a~ke9d^$=Ja8&=MFq4r4 zFOeEAM&gGG5a2>V;pA|PS2eqicxsB5A?%~cEn>0pMx(xngZE;~yCffKgxa?Lk|s?L zfCPZJ-g;NKd`v(j@&;YzDejgyO)`V2=;0satbICJZeRj_W*7Wd&V@8aZg1^INAFj< z1{gEuxP3h5+Jm9~TqBxaJ?Nw{%imBrV}-i#F|K8Fm@&oKm&I%{yo(>dJe+W`6{I+} z{QD_xcQ)>~h{U22``C%lenh=FddWnFHpVMHJB z_cq%hOA~>7wN>i0OQEAzpN{66zewHgX=dhWF(s4bvl-)yV={wZ{9~XVqaooSVgdw zu{VoHXS9-wZyg$>C#L1mE2-i8aP}9@-bNy?4rE?&q0*(@vGu!4j)6^2yyY{|)2Py7 zN-!rxC+S!t+u2&p<7&?U@T_|o=ZymFU>tG}46&*9*7NL}WB_hK!ZHD}ogbnqk(u<% z^(rMvx^F(CFbh>batoDMt7F91zc#kYq?!qupUpwWEr(Z~epO85bTff5P=xs9)Vvsi zqTOtqyo>Z z%ugp_Seh`8^@!SN43>3M(3@oVb9$=qG^FUy>8Y05ER=gx&>qE1f8u!mc`lfkCd5cZ zDqZpMY6x5{WCdK`{Q7d_tZRIN=2(#s^iXP1(F16@i~n?nsYN`}+a$MWOt4eIM%HF2 zLq<(TGUzo5HC*6 zzoLvnG$N|@5Gw#3;oqcQ{gy8L^XmL_^_kZ<44P@aw#EWHyM-&B*ODdS%gttdo_K`0MxuT-DDOXQgD~wyf&qhJw^bPhJLVImr zf|tdw3_Ayxz>&N*#?fCF%qTS-M&-Hz2XJ%Z5B^Lu*tQUH$fq*6q@pP9XB6-E*q0t#!}Uh?YNPH5F*iZH!Z(_}%p-o-GtPmkfQ))g z?7a_|Et3R>`{wh|Dsl*C!QA|bPsLcHj6)lVlITR0EQGSyam}G;lilwC;H!6QlCb5k z*;^TD4RuUptr;MPCvmtn0|YkRo^>+-N@%P--pAoRA5&wmP2a3y9d+W{6zU&%OL3 zZD%P+HvzOWvEPzzys^;tv63yshQ^O6|5Bcp&Ptv%vLe0?og=4{&o+Wq;t&z$c5$_3-$_H1J$WzbA%Xnm06jLd7O6s#JK zu35_P|sTvv2>AB&Ju0Svd5b-UW3;u zUAv1O3wN`Q+@;HFEdDUCkj$l%chT5PCN( zFtV4T~ry}!`kw$KZ~hKpD^#$KcCHjibO zPKIyrzXtKBk7)87w1EsgWb zMowf1ke=$4xTmj~kZkzuEG;R@WDj64Kv-PO4(6Kt|JZx)uqM-OQJk?CQ0W~Vs&px# zmr?1}Ktc})NDEDRhZ!A^1OWj<2~C3pNFYd;(4-itJmax;6*oW0Mzzcad@ zyU)4z{+`J{U!LcEzi+K~eQUkndROh&?`}Wlnw>foYv!aILEYgNC{v|nJW*hDu z?kp1Gg{IT1xMU#r1UWHGt)J5Kc8mkl#agg-j43tXB_*-B zqMrfb0sv7|&~>~o@i$$j0vfFCMhS2l4~}~x%V!XsQD0=(KwB3nN}uFG(o`YPI6SJ=dPH$o@zEZC;`xvu zEq+k26e2voh=i%@04 zs5Q@+w3>Uhio|n%wVM@}Y+01Q(7tMvV|j8F6A;pX*g61G`eho`J`QY+3v$X>UF1Y^=H}0W4?PK`T%c1akjvlL~M{9c? zXDs|4qycUFX3^$r&07*F{GK6q4hQnRx5YR7N+qmjk4K6PFtD_LA+dPIXuZ+c9=(>= zPXUiw=zuDNiPIH%_UzBV1M48Q1bTD%FeU@#-t|m{MB1onEw31fb(!QZcFoes+77QQ zl^v=fF=ZvMOo)o$p4VuOyMPzC9WOe>;}k1xXI^xd~p4)wd{y5K%1|*_JMoJ{6iP2lyZ( zN=|QmOV3M({v4CA+rtv79F;9?Uh+4n;6vX+5D0k>)0tOpHvXTIg+6&`vkXtH> z^ByTbny&+()S%q*+>4q4gfTg1Ee&?WTYI(;zSh*i<|uc7ZV=8-T83u*o{j?|Nd6J| zq;9;lp=n)-5lk=nov^9S(shpvIX~W!?2F6%b!7R_kbJ4cX^IA_< zB}w?kD0=D;D>r>S|9+XUC0VHU$v&R!W9srH988q@-nIX2o}Ib7C5<0uPK0G?sGz6@ zECGdFwO?`2LzNo|)Ez^(iVUsa!*Rlr&RaX#EiYB#5)8@>68|0Ic zKy1D0#d|sco!ml0*0N!QWr&P{<);wI{trKY-}28W2%8Roh?(OshW}Xz>shbz5MpAoq(mc zh$bZox3V!YXu>uFIV`x}ut_%LCGq|EoZ&b(U7nTDB+7Bcg<)l?x9~GbnH4rJp~%m- zZj5`YQClU7rQgg@4Cf?Y;|LDqe8%LtF8fkV(>eV^490bfBf7Bd6&35ZUzu$nT@oea z(#;7#sTVT+m5*azMuBYU?qh;lxyX;~0i(FLqw6rP?FO8e;MK2L=ad_0jO;l&F(nUI zjUBPr78<`!%qF=qYfj;(mbu0KjQqDtC}=c{u*I$Y^PfWx44h!E&|s*(Z&zYj3|N1r zbzAHT%uunyfONP?)HjU}qtAJ>>uf3PTrdhe_dq8>;wFPGmd784wInn$KVcb!5=Stl zd;5kVrI2C>vT ztqH}pDju0qa^>^%C@rtSH;IM|rWD7HAs*1z{|%Lw1=5zp&>&O9_;N_#`he}h>MnIb zL+AWgKHUe!`kjGE`auE$j09hDo<1!nk`^&I8I?Q2-RhNn(Jrm{tu4IrZWye1kLyZ+ z!T55JX-Ghd_uhwe4Bok(=8XQIlk2xpiP|42apW~$i&;E~&^X<~;+(|D54fVIYU5e% z^hb7EWNRfAa0j)xn4ri2DX>ykgR^dAQsqZVJEwhVZ<*3Cwz#ZpQ}HPX$^+w^p`u1H zNh$`NQstM%N6f8f_hvU3OMj?;WFWo zNfD!PwWbiSWv#Ty;v8`+qt^6ISMv}6kk<0^M^s)^?UpZ5=8*#uum08 z`7iU!FqE^SXg_8Rn4Y-?G|k0p{rs=P^HPK8+JQ#8td9Y{;};3htSwVx=$_q%SM1XL zKp&Tk1clh%;EE1*u*LC!2Yh~|IQRii?GHXtRgz_FaY|$>tz`xL1%<}JqS!m1iWE+0 zxH25(d?!i4j2Mbt@Yiqkd!VwFt4wTEv73U*>Btz5<*TZXkEa2C43g|`#^nsO58 z!|(tkYB|5|f}5ROVx^qd-i;i8MN3PJ!WW~i4?J}#`B-)uf!`q|3x~FPvFj2oxO}S#E8;vvS(~gK; z&4MCQw1rsWLsAlh(M2GT!PVya(jd-R_g?l&y5fST0P-D+6#T()l7$Izn@y)-D!ph) zt0r^(luE}L`6Kst!l(M-*ZCgKCso%7_oFxK=D+HtKxH)zq4t>~-rJdPaN|CvUX;c= zOCKHEc+&hzJ`U&eCUN2zG{;?dbjp9>nV6P{We))xE)?fa7wosvS1ft4Bi(9F z2t}!{7Ta0OHFD9zSud#6eZLc>ADEjxnv~`+Vny%YA>O5rSU&XU^Wok5aR(AoY|c}) zuQ2oSh(8^_&W)>Q{V8s``d;-Z70_9aY|iUJ=dM|vRpF742U%K85gm6ur2BWKfoI-}zHZhUgqa=VNujituFTlS|6e8 zJuJSPN7VPe`qS#?tdq4K^YcBU!%>tGS@Sa zPB)$2cB``C#oXFplsw7DMUk;4nhY@Y`#=`wn!`9o@gXZpMmPC7F?!zbl-b_ql?k5F z9~|j!A$kP|)WpYxSZ@iblndGc^~Q=&g{4!ZVv!1idWKf{2;Ua>j5Lr|EG*U)oFA*E zX8m$Iqi@F71RXaqO`KMJWBTwr5dDG6A<}r+OGd@M%$vjR#UvQ!9+xFYz8+4a`W|61 zXL{fVGEmqg8{NN?QU9vtWk9zR;Okl2mGjErrT)?7A}9$-QFaD&kVUl2$zc5nC0{jz zU)8O?anPW4l0=)`Q64dw(Xi!n(?6ve6^E7b33v=ljC-TR>iTp7tmLweuV4tq7*eiL zq27@KH@9x1qA&3oR~8q2Tl)anqWed0bgAvA!yaC1B*79F>{oGbqY9K{&BhHaC=R=^ zx0JA!2jhb!)Ugcsu;44Oc?^cI%V7u|yTEbdJTV$&kqXjiW8XN3Xj!ts$8Y#G;>8#Z z_4dmNXpd$cQghjdcYH20ri0<^1`TtJql>XbpMU^^tL=DRsms_`EpffVVVxp0&vHvN zZIP^A4Dd;ZTLtC`MhO|R)fWM>Iv`~2Y>?**)Q=zD};UrwCqzsPli&P#1zvDX(LT6`cRg=n1wO5nezn1sc6mvuugrSZ z6In`fH*L4a*&lp$w{#J-#biEA;C|xQFK>g#OLUx@t9z9xo^x4hU|G z9qk%XuNlelCHNX#!u+P&ds%%dLMkGI#JoZqT$E??Oz|frpaF3a^B* zH8*+K9NG^yz01AheTf8y24uE_$!a~9+6ea}N6QUvy(3Po8lOKta7+}6neC1!VPsg6 zLcCSOtdY{Nt-c<3*R2(Se<7ZCYT0#TZQF)Ma%iVRWj)G4U?YVthzGe?jP{L!)^h7c zHBQY{LD8CX%~YC)y5x1!&Ttx%(cg*_?k>xQ&7>O_UXKk1TFtu4JWqsK&8gd4HjZ$6 zfesSR7=8;&iLNo0L_Paw{8i>6yE3VX#lvi!nZfG`Cem7mla00O*EjQi{?IKIVm3#&jiaT>oH^((qY&^0$#*;J6 zi8!eTKQO-k78?IHeu4Srz`MaD>Vfw7JN4{u#~?n1i3*n2>f8=ExeL8(Y!1oX%ex!J zTx^SJuUS?<-;G=wx`LwSd0Jw?`r2=Kjwio_hijxtuj1MqpIS&pZF)*f;7({T=AUr* zq|Q@oE8}6Qb{$T5gV9*21^8020LP^@8y?kz*r}pTaV`btM~;lh@=Bc={Vc_GuDS_s z_ifl_yNheGmZK(aw%-HeLLb2zF1?M0>iFHue7W$O&nM{kXjsE?L8X_XvQ2#_G0xtA zQ(LZ=0YIq+@5cbEXYJw+hE?~{v2;1s6(&n3JYL{qWpYZCwTAS7nXODx;XA2|cFCU@ z8xxwoeoj55vdz{e!wYoCo*sU^r&ONk^%~^X(xAb20{?xQed;x8?eocwcIkXsB(sW& z>uyX%LCk8!V0-euhdOD3ai$qU&vU2nO>QZ0+T8xF?aEwong=-E4={~$TjB0pTR_Q! z12}4p;|FzA3JXU1j=>bSPv3FvutCU-Xi^W7QrGo+5W2v8S3lNRRt$kKqr|^QW;;Al zuxzpTDhx2v!Yn#i$EmYniVU{5NPYyVdlF@qn>GH=S^^Y8IpGf*8fXaWz|hS2J#KV1 z!n^X46>i)dSqrAcFBP}vYrp>v=ojQuAJ{2m@L679C^cW-msJqciCabXe}D;tN0%lE z`Iu}rffp1Rky~;@q=h}sYcUJn4|x^(ax9mTqV!iYr#LQ`uu=NiFJjwYGaytg7`85V zF1e}_mA?46cNW$ivF;n7osmoJZ%(p%<1X%e7k`|Q>b#=IsUKa&W+fWsrHsMk(0B2T zxV9KcvMtx^M=#}*)yLKx)XwO%I%y~h z7e_FSzb95pjY(h`F*D-VYU6d+sMHTgke-Su<_ty4r&ahom~zbps{o!})@p073Cg;l z*9md3^Rhn>+pEbk-Td_Etx%x^rZW*!LD6C~H+2)9b^>0A@S=M6KSen^4*8az93_5@b zGG8C-ug^lG(wyh#P`R2S{hIG;dScmgsz?Aef*)D``cDVq+xV-Do&Mu96(YV#%EGhu z)+6c~Lff5Wf6ViB1oM-n7HVB?mpiT3fVRPUthNp2ZY4k-=SA_7YQ)a!M1ZT56()bp z&l;i6C_Vi;izWPl$$*u2-!(FL=FrVkdO+W2>%6k!t+*+C@id)`f6=CM)-@%+f6mtX z$BO=YuX1JYJQJ>I{+{0RuLgbTglN{j;C={`a#SE|+UI&t4Ma)%HEhP5uoSCLLXLrW zp~us$ejbTGM2-qd-1o8Dw*)^aWEf-~DKOU#kL=mg!TI`BO(CSoNp{XfBwun41kC=g z3{>Vhsw;Fbkng^fmM+q&6xo@Hb#Rj?dAunJKWpjfEw;J^ zXpJWhiZK-*S8slpK3Qgho?_ zhm~&ndu4T(m)`kKYQ(QGK2K7VIM3$T?bi$M(wb{5pmtvIFAg}csACQb(g#X|rkml* z;}oW-=(meeQ-G8<@j`?b~ z^lBVcT}_v{rp<=)UWOwp0N$a_S?UOdX`^F$Sxc?wpa16l>1j;G)<`Hym)^NTuq1H} zeHu4ct}l~$6NgGRZ5CE89wYm$fi?LH3{hL^i`5Nkr_D zGABN4?5e_*)?wkHhPIuoxN((rMZOT`gNY=HEh@lD3$r z-rDA4B&fGX^D3%i_(oFv@;f^-Cl41~P#azZTE!8Zw^4W1=#1?VA0%cu-$#nBU*R|! zDwb3ZMrhEGybcKd-C5)iMUEDf=M;T^~S&Nx%%A5FwMtXofH-|YA=?R)(L z;QZ^R|8hc{`cYbtdU^p0iCGK-i)1? zoS1IJR|7UGsNu@%`Ze7eVlXVwPtE3x-~*ql7{(GY!N&coG#)P2(AOBPs@E06xEr7v ze~oI{o4g`Wii+ar4UH~nhfu@nj51?V2cV8ecy4Fp^jB2zR*@>bQfIj_$Qq0Bd+f6B zidFFp7|C*{#kp+?12jP~_E6I|VAcv@u6ao{L)U%4n)QH>X{2fxCT4rUs zKu(omO{&FT?DYGF{NE{8#0$ys^kROE)?+_B48Q5Y<|_ak;wYKd><279NuHA3x@SiK;KZ>+4O)4e+dYHI*e1oi6c1I z0yp)2Z^ixnd*H*~$oU`^c4wA3us}*@*8s5}j9JKS>+{O&3xy-=`P{_DVZLh?czLF>^UzZ8QNcH*t7GWGb^`ylA@7u#aKKQEcUuw$#pY^p+=Dk6MRxkJZal^+L z3+==!I?s6Q@{_y*?1PKXxl%IUt+xxTLjJCs_B}Z!aSUOW?B0zE^dOgbuy2qTOOsoD z;7)*U6O6|0FZpC#EhokqFILch{z+%2<@hygGv_US+H%{F3~6@<{VYQDps%62O=ENQ z?@pM@IApOlf?-1h|7w(WYV`-(W(L-rkes|qg66r$kk$Pw@DB;9OfEc;t3FBfMc!5K z@vN$kitQ-fSNnq%eZRhA@@0(q2etYi`1lv6yJj_iN4@>8yZ)laA1csayfOBdr2N0U zZ?HeACzz|2^Kte!+}^S*eqrtaXCoJ#*B9sgLfhHWA2@^~u~D3!m%qan|1Fc!HIa4p z+4~8tna!cm-rt)1&yJrFYaTezmx*d6fdX|Ij6Yp8bKe@YhO+FGlYWZxF1^hN!I#Qf zk80#a%nSnWP)zU`w}n=wc1KF}{j4m~y*=9tMry-F2HrIm&vatycamyj2$+B>zrOeX zEF%B;d|H3wyT5*Fug;da*<^+y+5onhA<*^iV52cdEn0R_uFnW2X*Ghc+D1UR+DpB& zqU&JrP%&4diYwvMhb3_lxbP!}gnLIS6WaLx5A$NBLdBer_9y$hXI1}mkiU=Id487> z_NCz0xx%*-%VG)rrn#I=nYa};6D)iEFo{`zf!lc;7`U|MlAfA7Q5yJ}{yIU5llZY! zRMaxt)|c8hg;7nP*Ogoe)g+=Qq3oYE} zk8$-;*}K0kZP#Dgw5Dri@ffON+pl~|2Usg|iz^7OTaNch@#_Wq1n!7GGXnA)J%2|U z_g+uNR{<73vuTnB1fVHwhCvSwV7uG+-WF!T!IFI&V ziSupL)@BwzJD6wq$mEeV(4yc#xksAxq5jNIzdifAf3~cOjBpNG`p0um_8n0c_&h$* zX`If>;O;pe1P7)DgU5I+QsQCsN(!@TE;Sk($1QDzj4R&@5k5y9naHg(tKm`h#AB&u zYw$kj}PS$fDi#<#_v0j(WL+;W%4FzX=G($0CCfTq2xBKdZZPY@!09n=Lk@% z;yjOAX_>fYqP%`N_Cj9lPK6b}J;49Oy=HNxj z-CW*vrC*d`72(g{oKo3M=7-Qjk6E=(S{s17zsxTVU(6_Wt2g}r1RjK!x%+=TWSNxT z*Ic~gF8;r)`6M>?-`4DU%&z;ttT`gbCE|C2pHgY`pHlseIi+HL-q3A!N`;ZD5cvGL6Tkf2ZiG8nb?w=xmtYpaX8gULUVkWJ^V(VEd0+n5_n#4KNq^n;7fJr&l7AD!zXa#6P2sP7^7k*yUz@^To5Ek3 z!e7c0MLYfP_$)>!WCGinlt!-HP92m;MJE)w8mmEh1SnxTA0UZIyNV4s9!EC^)W1 z84p)bJXWY07W%?o*Fb&9zc0X5hyJbZJH#|VhI>p<`^j+mHO0cpp%Oh7#2(htBj8G< zvMBh@dQF0ZB(@5?Hq(F-V1xi5pN#%&QUBzat=xsDbVha}F3O)NDS$Kp@HlUki6tXe zdE}aQ0h!T)TU;39u{DEo`528&r}Z#2dWa8&q$Sz9G6_}<_QAm9G*9Y~hgj@v`hkV= zf{=(Jp1&aP-eaQgWvy>v(zfnf1(P5p61C^*1$vkT#W#92QF}C#vgHgka zT)&ce@5GQ)IKthgJC@f1I>aSLv2=+zrkX--nC~3B&1D@zeL`#5vSwf4 z$hW#ZrtVg6;$deYKnP(Xi}Qfek21>EF)mlUCajfjJI>~T1cwX)(#=jL!h6yv89nP% z=S;sB5f**r3%q)>h1DIuyxs8^uw8r=Pg`QS`ldqg0jAtzy6yvyX_(wn-82{?WhaSp zq+ek74mBw>8`ECXVMwl2OBymY^6Ou3>w#30Z|{Ju$q*8R8UI~H%>Et23xJfDRd6Ly z!}DLME$$pcbrtHL4CI%usv|ndvTACi5BYNkq|hiGTUIHqggVi*#BI zgIv>1$liUEraTB!b$?7oFr(sZ&T?la#V|K$-o8Wb8`YGt;bL$o^&zBxZ(a|*{i~J) z$4dTpgHvwG>W*1Yq7;O8DZ(uLYpkYs0?0XiGy$`R#KDSb{3t{bZ33l=rkzs7yNV`r z7+>H`9EQ60))&R=g7t2+sa3|47AsiC7N%!L4m;Imr`5|`xyy&O0>)T99 z63z{vU6NvQ++x8858h~85?sg=Kp)h=21V|OQTU_L@R`u#mtJ=1ko9_)hcr^%$u(0! zw-Y^+;s*?%REnl#sB>O6-hFLIn}JJC8dmxe>Wvj8t~<_Wc;7#|CTf`8*hL@AIwy$;Q$!U8GtW!Iz$LkgmEO-!tPTaU#wdky>&}1@eOG6uoUfsC788 zYd;3I7N};Om_%e)M&up8{Tj}9BGgc`{WFyh=GJ$j@qhcYi^er4*=v`Ngek22#Cw$? zyMPjiWVrY131fdmqrCt1kEsC%isEZ|+t1u>PpP2UzTrPnz1#iYU6q&9<4JCgxW9QH zzlT--DR?Xw*sH-HCnm|t20%XUqtVCFOfLGkM1Fk-Q;E*fdJts)%@{}Y>=ZJfoUD4M zR#i7VURnYIafA$uR#q1{vuj2d%*VRodR;jiIMy^aa_qq4j@uY#O7ECv>3<55KcD=N z)!rLZ++hC>BV`f8T$*%4g(d%Qd1)8kxSvv;2}#9&n1z@IjRl7srhSQ=TN6FZT6@l0 z=P;f`-KxB;eH-IW)c7KP!vjE9`kG|`gcxzoUxT11Re2xu{5fDMDr%ECb44k(o_k|{ z`q~UH8O6hI`YCdXLQ&`>UU*H9Mj(A&e4B%YEaW_4Xnh#SL|ZxVKr+g|D=1Ne4=hYF z)-ogMueH0hs}q|EZ6FM#X9m){Z^alJS*f5j>T{?pN=>On@g1q_zu~D0&yU7n(V3qQ zBRK2uHTiJ-V|57qgF7PdYA~d@ zoIl3xQnyQkweQS4YzGawJJl1__Il3p?dfCdis%DUDtt4fDV|0--!$_$dls>>F55lX zOQW8#aU16lVucB@7MBt@>%dIgVid>NC8Rjx#}D1T`JfWm=e;EP&%ULko@~PU@!?ND zM85q4+&8Z0A~d}*;lWm-!pH$*Vj0bSg@@(2FoC?_0U^;wM{<}&!J81IODl6@;m;2T zUdq1dg@1jX=3pN+u&T@e{4}q9Weh4Xw`;)+phwIivwu|wkCXKQ;5DCrO8Qh|8X5gQ zww5-P1|QMi1slh?l>8d+dpIFD^++VY-xS3y0WYEy4VUv>Uv?12#o(i{6C}L=@mF|b zTQ(L?7K8C9=t$|t$l8Ye)Khb-0(_yGryD#DLZ90;$;XBe?u!K$i_t(tDhMYTdrmtQ zo4$|JSiZ9y-9r|~IWRCou78x@6$qKi&8fsI33Br4AwS^k5e}jGH5=OR*AB;$`VF|@`#Y=h&ZlA16C&3_R3_urMSbe6Fj-m&O*qsuU^ z;BET2jZSZUR%Q}lv6TPqdL0lD{Fq#KrTJN+J)9jWU2Cu_L0^Qz7ZpHgim&m42J$4Sp5 z-u%pXN_C*?b&_z6_~H8Jh#l~uyz0R(C%_YY1n4=H%E&?VA6#|G{*F)oe#$WH8gsRo zb23qg*og?)m{S;Ej^1A)V8L9-@Y%G453`y8AkY{D+IT6JikSH7>S}MVs?+O@k?a!O zBou}3M@@*yn3xO_cHDUsoa8cQ+70q{w!N%*QB5rVHFQ?D3XoY(RDi2_@!^{M`5E+c zpRg!yD7NuBCHs^pxpEO~XP_a!%(i!5|LRzNV&~lA^b}NnLZe_|j$fwM(UBp)-tHkLnMyLM61($>(66y3JC*0wISJeD%*bk>`_KgcQ60gsHuC#qn%nrL!w}d zn~Te_bdulNP7SX?Ci3BOd)3vf1=+A*z(!62ql)si;7O_mU;yT`OL+O`5_$yzA*onZ zQ>V{jPMWsyW3IJ8|FU<(UkXxVB{G8y;)|-jWGfbne!f6TWARYj#RHybRNG;4efBfY z74(k>Lg8?DOdf;v_A;zp^7A!v@;j*RTBt5iYT`w|F<=y{gn{QH_mR)(A%?p} z@zyT+N4P8^cr-jIz&iGrk8GF}VDn;YFQX9C!WwVaII!(sa+jSY>vCR_Iz%b<`DbjW zaF2=sFxugiN})K1O@(~LrBA#@Ic-lsGpPz%`=---TB9pB?DYH)HyxcN#~d8Pe$ zt`BP|WHVB-`KLG#)VR@*!veLXQ6DZ2T7)nfnqFMklWt~7OEr|cEzcW*Y$w&9i!zhN zbIn3|Zr*GgFkr)BKbo;CqoZ1(Z^|rfwF;bHyU|L}zb?|JpW7_{HA)883?ilKJY~?l z8oWGi@tYis4g(iK zkI<02j^!isnEc97mjVYI!l@t>$ODm%Ip_r~*~ID}&-Z?gg%rArC4Y8M_hJOU3=@P! zr$%RaE>yq5kBq<7?WxGzZW47xIU;?sbLi|>}9!GB<(9(BI z@~)xQNGa6$cs_crU34NF%wpomJ=jw`fi@uJLtwhtZx+sep>B-6OSd!Ad2 zsE2Z3o-d&#VZHX*%9b@|;C3m0SeLxZir09l0-p6I9xHvP(1W}cWD!miV1PVOV90vQ zBvUbeffe17{Kkh}tPsg8hKmBNr(!3GAVSDue%)u5kqgK6<#U;X@HJk8tU0#3nrAS= zvnfH09Iz=*U+e@yarxOVrMZ>$@#2^jq15@i5bs2bN7l~(h4vgf+trxt#e{dJfz4hx zy_n!4x87SRbkn|#&lwjsgsl0~CAfO(}B;V^L5S$BCSD3rDAmeLOD2IG@W^TnExxP>$ zWL3hOS+k=x4Hc)EBQcuRVZ$YVYLysY+RobL+{P)yB#AIWe5Ccp>~mKFJcW&Gkvlgu zdi{|Zo@oJYVZq+|q8D~`Fgui7(phyw7+a!q<~sSknO^I0e2MA?z;oxi+$z^rP|JE% zhQUa|6uAj5*r#SpE0JaC=-21uTH5BZ?8oD=hCZmXLQUJ5)ULF+ETv0J`r zV1tiey6*KoS}9#dW{u)%-&8K6`8U3_hHrGe#%+gmTB%-ZDs&TtreU~!rdoQII#WqmY37eLtAQEGdLQ$USqe@MATBJ4hFbd@s4|G` z&>DRZ9>cwAv7j3m(@bA#X-@@B-7krT<`4-a5%9XBqv1lbwCRh-uHck zvtW4xf@iV|&uA(K7ITgR>x8Eb*!CSfJm%vh+N3K()qh>OEt=FU(wkWhpp~aB0(-1v z?LwE=1{MJWLBMAgqr>B?7)oaPQw+bIoJCodd$7MxCE$xV%-qbvTGR#Zk`sxu;}2BW zjtjGp`OLp*Tb+VrqAsnFtXz)I#}<&vUwR4g%!8J|;B^Zm8h3EOU3`Wu-ud~bS_!g} za>~o?(F9Y?(n;`x0ktXo2Qp7Y!gam-or+QH?yYOkv|_7P$_B<+4Go$;F|gSZ=8~Y$ zm<VdIx@KL}Q!zdPf1AUFi^@?W0r6X|$t2fF`-2` z-IZn?A4%j_;2LQ-ODkQ=4P*dCt`#;++ydoatp z2eOM}gm__K%m}((yF#7d2NzpVpB@+7ME4KJJ`=tb&pEdPBIw}PcWZYNdRb ziXEa#I~Uud4tt8LjG2sQ7hK_t?>> zIN9W-<-;u(C;1kVTFV*?k^FxdK6wI46Z{L&&<#erk!aue6}LYuBv;tDpP9^8AM6%9T~Z@9Jw29Vf%Wsgi& zqIwucNjun#f@oM;+G=$F0*(c|LI+=do3}_{B}qxp(vC{K&REd*m#lgygfFBXLAY z53PALa%=J4OH&8A0pbF5`b$GW-qVz;D{g)1&{cx_hXm8Kyk8bn>f@L~Z(=D)`p?U6 z>`C^eJS^<>xQ@46N^`Qe3*AN5IoPQvuK^1h0~a$d2t&$~m0B3R(N+$t2v9<`MWU`Q z02DJxvZO;v_-;Tq1Q!Cg^Qddc;7o8gS>ITXNGm1ZR>!XBr!01&^CSdNZ{3!#PJ zXgeN3Ql6({Ma=oYW<}sw!G>O$qZqS89phS@dBM=Z_!(S=4FeoogIccjBfe&MTNuJ? z|0s4Xge!W!8jBGUzlTbB+ikZHLj;>zlua$BQhxg_`JVy-pD$vNo}jrVB0c4|p6Y!L zkfwP5Zj^Xmlia-zRoHSPUP&CLL`MCT3JaC03?aS-N)rOTAV7)q*JYs- ze4e-&qpjrJ6D*rqpPw!C649%1uEihnkEfJzO;L33}!SiW^Fasc)p-f z@ceVEc^!u!tSGhlI>Am?4ZaK=+8>D-ml(fhUoS%;=!;$WT&cBCT328rm=4;;ZRLW* zw$=g@^OC@^zMCu4A}(*=d#RW;?DRU|Vr*Rb0*TJU7bm?Ic*QG7+sLP)@}j z_3HP7(0?!kru`5<&wTttOGE8$_Q%>HO20E2m*cW8B4Z6L!>3ff;hyZa@mqmiN3HRP zIWb0H_bAoY8S&3ds>^Yr+DH4_Wk;VzkAI7++7jOaA5XrdI-3dnBiQcf^#gH;)cS_4J zgYQt8-YLIC&0Vl1&Z8m2TeWveFAJkg2Hv-VwVdn`i2%S1`ZL(rdi!-UiDdk-zsJ&4 z%I-;)tgc8Lg!Va<(w&KpTX4bM9uiq(0%!xP%}I>1(PChz0<>Rqd45`C#hz-t-AKj{ ziDq1AolciobSMeri7e=|ud*)sMNT7n9T8ru0Ia)U`(jk@Q};@@(5mt^+E+Oxgu4La z<$i4@llIzJ7#6d>A#a7u`-L;_uJVKFQ5xKwO;DA2egSqp&UFQ9_e)XoYYQa6dR8BT z5}?s1Wg=K;K4B!-FX3uYc2Wd-MQ?IWdb?bezJw3XZsPfZC~a1JodHHdWm4t}s{~(L zR4FP>20I&5D7szEmMPq!mVpV4*7+*qe)pPJmkeXe4#VJ>w*Ga|o44j>U2_c9x}jV4 z>5X7KE+3zF4y1kbI*?Atta3h?Lztc$9rxASt^}6D20PcGz%6i2KVatzO~pw6TKu>t z!w6)t4A+~6p=iqr)p;JSGJfWhA}f@ynqz7&zqGji#G1$35v+JXFxvRR$Da<7Y1w1# z>})unln>FllK3^%>>x_v3=!7rwqcAMSFmjDx(uXiF%UZKH)%|_69OMkqc$f3v_;%& zV0mw6bJkw=3)_TO6F+L>@#4G#zP(=nup%2+`)El$bxzY4LH8P&%pzQiQP*QklEHA# zqz|`8{W*IeP_c7A5QL2yhP+*sEHs$t6&1$dXlPB4eomA#NMB9Gf~|gLtMc0iIpW_QcZ#=g}Oct&dlvR|b zPOD2Gr1TbHUC2;@^`1At;F_Ka=~jSov8XX!kId5%bc2W&+uS;JllPd!)nWGP;1Ag! z1a3zcYNd{ID&X)?cr+a8-wB7YH%9xP)Jb^y`Y(?_Ber7m!f5d4HHtrNd!w}K)k(UM zz-MlN0Hl>B*b#+XQm3Cr7lzXKek>U$TI}irnLlk7M;fZ-1+;mjC|+?}^(Y6M*yy+( zn)f|&?)tKkEhKK@4^o#NZs}9%Md)|9<4Tkbq@IcTVEP!(hpB5?Xxe-z5}wWsNnL;i z@^3Fj&yEv8Bx$g>C3lp2DD0ZLKx-o_E~JK?4v&R;ZSY*}2zY}j zE*bpT$}NdTC2CphZEDnYgVYTXhN0n0{+|O}*CM$*`_#ILJ@l+DaUDIvYnj;>dIzJs zBH0j%H{Cr`0~^>ne)bQ4D_LMJ^*XMm=wq#AG6s z?TMRiwDY*BC)&WopHCD|u{?jm%o9&&*ZdG&$)I=d zI~4#01bC7<_jdVV@%^zHyg-;eF;C61Dq4KdO2VPA!H)e`29xF6$riAAZyt+*Q>x(N zdjdKbif>vbHMcJ6axi+v))$5Mjs+MuVQTjbn#z!n zBs>_Xutf3LYcI1b+Ct=9b2w_1*K|9bLv!B^*&alim-DN1!GS`!ood{Nfc7 zgs-R2N7oox*+pWwF{&_n^)9t&!CRpw%!1xt@$Gd;#HH~a15OU=gFk5YzkmIKWp*IY zJf*uWoW06!*?claC@jhE3s-_ZxTC%HP;?Ho;-D`JmOc^fH@L%5gsmo7d6ioESPVZO zzQ$Jo&&qwQRX`)n~VqrT}Ek!a12$A z)(!_Qb-JQ66ci#Ddh|>xQPoo1qk7$b>V`U%9a%?8i!?d!9Wk$<$aoXv0 zIgCLRdu}hM@YXHbww^89KyUl&QWq?@9B8tS1YHWYjO4}KD7~XnLXtIwikUry1DD{9N0;whCP@di;L)?I7u!!m90xSs($`{$(z^6^Mo0emKC<#kcBeoi~c%#XKL zZTNM5oUAATDOR4afy-YAK-31Z0tHD|OatR2+~s}!-B!~ww>Z<<{+SZ$ETc0`V>7t^ zW{=j6=(+;qN@xM_q)8zK2caB}ArsXTpK28|eUI!6?pzV7$ti1^Q#%^01X+$gvrTv> z@wN%!+rNG2_cbe~Q3(B|EsRM%bUZ zh?ftZQZ*M!*w7kPG(?5(--crkMlj)X7LIh7H-?}D9uRbI<>LgWkbRH~z+K}~Wsg_e zKp_5ghuHCaqTDc}>9h@cSpzdclD1o#v|DL6vT@LP7pJH;x92)s88^1C);0|56cG4M z-n!I&zBMvQ=`;7g$-b+ihacl2CA-Jb^VYihZ9fRfTNae0W-vN4!8`LqlV5;#nLTI! zzadYI&*hw`4{j+N?`hNZna#0J*u-b=ny>>sL za179(Dp*Xv66D>TxD9)^KuIj5Va6Ze$!l?+xfjv0$1AB~!FweSgp&!`FtFD5^ z)GJRd80D$@no(}k2o&aQ)MCfK;zG~5xO(i!6WT2FAN(*h?QC8h*T29|sgC&GolB$Yw8cXhlMfx$7PwvNj{zYK{od8#M(-Z& zihRk*By;%LuxIMu7hb;MXEIN{#qt$uY45rz?NL#hcCliXY=iaZ7#ZZ>BNk@A6Ec! zqN+o0!zPT0y|v4Q$tA;{Dc2KGa}Q1`u^9AP23h=k6rW-HhJ44^jsPdPT1I;|li#{u z=1b@!KbEN1NcoOYnFLIRS?fm4cILJK4cHzwDO&Os`Zhzw8zpTq;-lt6G#Jhb8#QVc z^H(t(BF5NBWcr{x`?8#nm`XJt&!G;wicF9jtY{^IoT#6Je`Mfo6W23TMOt44dKXKMpZT~KFF+L0_)Ku zB`kh;>~T7qNRE&QHpkcLCMH~aqDXwGuEM`8)4$xb-aDJ%a;eLC2Rg?%4(U(q$A;F{ zsBRA=x?pZ$^WZq7Ne6YeTS6VSu?IwARLXy&SfReoMqQs*wvi|9i;Ja2Zkf%fhh%Om zda3ryW&te-PQO|UVSM!&H4ZveBnd%^4iL0>04kNpNL0*|Ke)d-9BEZ;PA7)v^SdXI z1mZ)<4{sAi^8{CmGU3BQ{T3C5WA&QC%yW**M|pi2!##JC_jW5sA)F?+Fph8U)mj>m zD8+7)PO13!kDf(whLkitR%8zu+jK$0BSfuFTAyny{SWruJFLlU>l~3XV!qAz(;CXaS`Yngl{eW>geH8%jVz6A%Ik1Ze>h${@WPLg+<$uhN@u&Y9=T zc;4$hXPoDGzVH2>?;7~yzH;q#@4a@p*Is+=wSLPf#4@&<>%JEpjx2Mn5P(H&5o0`f5Ane zIN)6pDpMUiD;!B{DX%yf@`U~p1gm%cIC)Y0l5JOJy+AfeIwNs1Eq*G@Jb-#}#i7+( z>3RFrjX6qurdY?!G1)`h;!#S|Rq@w{pj zioHD8HIf<0O^gEhHYc$(0#r!#T|FxkR)P!*p6eA$Z#3_~x(~&Lm~HU2GIli!elP2O zMpKS)0uFjH#!U7V(Q>wyad}d<<4VqSx;BHOyl)5moavt_(oU;{$kiU4#1bUNlnCpg zMKeYMsvUEEqSqt7y~n}Ki&A_zI-=EDU#5o2{+_+^{rXZ?Gtbf#F@K{7fAuGzV9yRn zx!f5QdVN)H{sZE$5B-W4s+iOdWKOe0vb#)f^vvbsN6JhAK~Zodf7|lu%bY#|;>q{C zL-wv%1Pr4_X85&C#F!MnGEyc}A)8!KqI(#^>#T7IG9ME%{rwgMvwgb3qlip;6%)vl_a)fCej-P%#nVqO!(l)gtB@7ymY02-!T+v}0W2r^yL$ z5>8PvhR$t+>KJ+Vim_$2zBb(1orCHYPhzib8LAGZZ%uCzoisSmG<$AiZSkn&7n!3+ zOn9K0lw<;izwM?laf7iRv%(=oXT{M1M)nt_*B8EDXiSy>7bP7###5$Q{kWu4wRKtC zv@UvTZo*t3`rK!fa-Nr1nU*B2Sr^F8@kK3Gc8P1-3UNCL+K22;tlTi@tile*1JP#N zv0vnkTK14&fPq>WLrYZ$Bd&crN&)r~lZ&{^>OU!x-3N;C6Al#!i)Wqv&G)Re_SMN4 zer;q9xflH0sNNK4k-Zqt$Y|Mtdl#3FZGN;@T0!A03j{SIriyR1hExzPPInb;Q^vcy zRs1dOtle<#R@Vs5!`ws{)hl&3MN?)A30JeS$KRyaQMSJe%xWADzs%hYQf6o8N&6nT zw5f7M5j!s>6O42smp2y*G)_HEL1@z2U@)+i#rh|{Mh<1ya+SWoyA5+50^?%tgx zsA2XTo)v%dBd9bCIurJMem5n-_9c`*&ZIssZ%3`Qr?sWtVayOslQwUD&~{T$DEG;n zfhv_qu3YcZFpmIxt%#K8weZLr^+t`{4oj{~WoI(6LwvG~^5o+pr1U3dIJo$sja66= zP_jG6I*`nSYv0Z>?xVAlpQiGWtSzppqsrxw?nn@PcvRK;q7B5x?6S2-ex3W9A?&Cw zb4iHttUu-FMF4bCch#4Tm|ZXFZI+k^z062qVy`o`XerBwIWv~)j7zF^K55&Q-;?uETg5ELcn=g6 z>38=@#I`D-G7I`<1vB4dSZMJ&qONNByU)V^_CID2+ImpfZ9XEdweK1mv$|$cAO4_L zvS8N?ZK>8eWmX9@K{WOHhX-i2)lLq?+^$-5vQ9M-j{f$|87C9qkmfAAoLjmZpfO~W zZdAka1-YjuMtqagazj?GqSNHN2=jB}kZhK-G2bGK>sz@uE87lV+)-=F>n%AO(0loC zLsbe^#}6I0NV?p|kX?TNv62bek@3J6P1?h>X!noxRsEdZwwIx?BWMz5%)EDzmF5d3 zkvpk?8Lyxg_$Ab(mNz)X(vf_lg2pGHjW|Qp!~#D+8wDXA7wV9i5?5zOwO&Rf$W`X4Cr(7i$-# z4cOOhMZ*Wv1aDTY!O!HmyydyyZEVko{%K=NSsmq$wu@2<{>1iEMjkNyh|iEmS~e*R zLNAzid$K02&E14&?)aLIOS%%*#5FpH1?TE=y?t5!5o-hBrFW=ZhPCFC{W-Q1R^z`O z=Z;)ymEJuP9N;~FGu8X&ONWmF-t%hjbr>C-ZtfXb=}sBA8P(RZ4^G+Anp&m&Q^32h zL9gY$*>#qSx#eNjSXW9%fcVXJ$tuQSuYc8rPiz2I^!pENO3ZJ+;Mn+|BB^nE`L#y8 zkwZXryQP6ozm}u`Z53rSP)ps4_RsAZgUf#B(>s9hEXwR|N8@coR9A2SFhB!B=A3_+ z=q9YHDcC$8ox~dkqjsvV!wkygupToNrw_&4w-fL0JscmgH)|v#b){MR=-xufnjFh-XNr=UVZ38C+S%REFv}|0ljRlLtNJ;1Q=o5}I$6+6pE#Vg+lkZa9&Y~hvq(4O+A!-T#m4+%C+m{VscGT* z9+K>#hh2JGR&)&nF^CT#Vp@ZT)sdbMU&7U&c(bo87)AAnp9Sf*c%PkkJz@}!pCj24=x*#z9-{=Gc&|!3fXh4NzjMqYXOl7 z9|0wHML~A<9!YlYpzbsQ0lT22ai<_NiEF;OhVXVW0245nm!Q=b-Z;I}Zs4>iO6_YK zZgz{`W$fN2ZT!H?a&hTJW+kN!y@9W-i4zX3m_JK8prJ?8A?&KpGtBq_VW2~O*#W}& zHcS)MxAsg=uSq$8L;9&0_jcSTHr~j1gC?)olnYjxd=rxngkpIUr#leLpt}pQ%Ur@a zY-ILQxmMyDx}Nx??M>~$>h-#S`{OzdApKVWcBlpza$o%I?WL(?fpB4XNUs7>+BZ-~ zIY1!WP3BNIv$|K{01M2})N(B8(8rQ8$qrnY>{U{c`Zn`aQrF(w);+RR?Q*cbX!dND zpwGHehgKXs#6EqmZ@IbaRw1qfgd zln^|bxuG*69sSGObkoJ;Fclj!1&1PI_5S{Lm}c2P-}yY-oYTP{KPnPGcJTa?jY`d% zr??0#fnjY*mjrttG7k(N=Ro=%_@$qORKbMRwnE#0f-!==5bfrjN9@aX7+Z_>S35butrsZUawHTZo+pi?}ex$|T(PLXH55Lqd|M)uDST9@oJDh(e_4@X5^J z)Q6kLs(bynpRl5Zgb7%O7Kekd;ANC}_6J8DAJWaM{#G#fayt7B<^FkG!I1asWTxk9 zLT(z-qE1y+-ChWt?_)fbcT7)=X;z*___~B}KCPo2YMq86K8f}AkDqFRTG~GeNpgL} zxssOb-LvJWZX#`wm{k73p#OSiSa%Nus62WLmQ@@q9vxbsa+uErW}mH5SEo~*-?TnR ztfbW7d~Nrj)gN0HEC#J#8%7TFGg{8=)=tjC!UigC1RTd^Y$~OQF2Rs4u>L+K2-r`e0_+PN=>4Ps!*ndI|GSk)ro@lSWu)06V==_1oX)zeWE%y5d_YFmAt zq(ryRsnW$@tzfatU}oH;<2kL2JH`o%6I?5fBW9xIite`R$REw0UrFjqUr^tZr^*>3l2d)YQWk_by2PRM^&ZV>^`)X@-XuQ(cynRIFj6 z6U&pw*^MdZJ;WWXGpi&gC7@{ihKdE$4}~Hu)Mh0l^yRtmlsaKOW!$EPSh~_4Y++!4 zV^_B+%yICGv$85rk4y*+1{Tm<-NRbaRNZIb<7r~Oep@Hhn@`2HM@u*b&aJ;RgP2gM zOG~T6EA|Z!WX{BvAf1dXElWnOPtkvzPqP}N@E5gk#>4;%RUwyVXd1&B_qg=xeOBRP zHWN;T5yj@Nrm~A7tked5-j{c~dBJ%FI=ZFN-Xcsy_~zy^pMt0RXsXbUe>7tMQT|oP zxU%vtbzh$4ui#u+aJmTH0WuAB$jwhj9&%hzQmkNk|0_gX!Cim$O{ctzfLUSbbDFJja2UKg0L?b7O4^CTIJK3C_26)9L-+(Np zJ}y>4@d33Ll<66_N%|l&M%=KOvg=TfUj3g7FjdsS=Bx7XSRt8omgCHzGG_yNEQ4(^ z8R3;@&p<_0pKU1??3oZMZaGa%ObC|G_k`)fch~U5LwTwz!xOA{VGjszb?q0tS!mE! zA<4lPKqF`2AC}yKmCX^6%WdNq&4*)FaiUv1Cob}-ny%yT*aYY*( zF9QJW+8OL=GzzEq#yIZH<+vvhQ=Wpkd?y&;&$D|@8HUy(9pV#p{+n{|x4*_ub95Pi%C=%w)jWi5;!o*#rG+YUjKjBQ5CP0Gl~kVVwM zl_x`uKg1==ShE|r%E%~ZUY!c@@c3oJP~mIzmhokKXN3I_BKy0SWO|5B$Yu(erR-qFEAb5D1 zmin;r(qr(D?>r;TezZqv%cvi*alDYe`?T#y3Ux=&30?RR;X9cjw-B28ez-g@zp~$Z zpsl@~NNGnuFDSV(ZSY+^=Vq(@bE2rE9u{#=Wl3PR4jAytwcp z+3*7uqH3EOKij_yw3`{M5bY63gr-7B4PY+S<7*AygbO2^ckJOg@MJfG@*=yvf_4>S zaYqZUMXrIQBzaj~BMs$324T5FYylps8u76MIAanhzGAhp-c^yI+|{XlRb=?1k%R+v zYMUcG>6@&?b5x0w_`cZ?v1P-#@U$L>mzrgrx8KSuMq&(Z@zAUhu8VQzVF>lx%x8N1 z_q-c3-+lBZ)40*i!7T|eosSJ`*PU&fmlZ%JL*y=qlL2*H&EJi^O=Zu`Tfsoj`dxA4 zXutZsEXg(DGwcl&1J^+lyn?3^3pv`bD3#>n*BP=vAS6jbEYR%F*b%vhWB{FIN)wD%2Uj!3P12+#hCzyyOZiC!(dtWj47vcMNBHRY#W|CgyD)JNiG)xl{JFu~u zLZN1{mG*KDCZi0n7l9Lb(oGm$IM{H$4dA}ofhkihFi-uydE7fYNHYqw$9hP(OIr1MKS z9+^2g*LCtC`}GH;VZYF;eZR+K^dN5CA2d7DIdVcdqMBUCcbnGD^E(^ zqH+mvit)!C`(QPoTi~r)yP;k0*=c0|RHoS;{j` z`lrpE*Y41!Qy@}BQ%|l`FTddg4jSl5zM8EypBU$qksC;W|kA49N@gm0( z2jNZO2Ks5>ziwy(E*Y4i#(l``S4}mc94eMp9gkclF~odzlRzx8R^YRnhRS zlRuX!1r(ZPwDMv&;vYxm85>^p*l*lXDSKn~5eI;3j1QT2UIWvDvZsDp_ygzEyFL|#)XKk^XawQmeJa6H|}x1Rc-7dhN&d+ zmb1?i3H+zGh`CX!Y(ee|o<4MFqm}Jw%X=C-BL=vgvIui4MPSuPnYMjqRGE>?5?yg> z$0eLsNs`##oP{))u`@^tf9bEV5rtvFTbP|iJ`sSnJ05|&Div@59SwED+-S>rGlJxv zYXblkj1X0DZhspeJp{LGfNc2~~& zs-@(BWBS#-drAdqgQc43U&G;yTY@{syCALQcoNPu)K>*j42OF;bW+7Oh94h#*kXji z3=WeKTZ)O;WOjP$yscJCd$-iQ5l@_dyXVni^bDT7tQ(kiydXtrj@T?k*&@#6hp}r0 z(c3s=GA-ogao#3i`9hz!R64k57Qfz}>>ZTEE?fNVLW5<6;Wf#3;d{2ZCAxb>QSv~l z=esSLM}h2(;p%WO1Zp0vbJNaL3@h!O@+hzH5iP@C0tQ=%@%$|^R#W#EoLK9^RB?y1V- zw0D77#}ZAB71Y_ZGXmv|joRIr+~b9Vxz8;PN@2!ED;6}ByUj#f*ybMH*|*bl)c~r} zt0LK)mPRx-8o1l9m3zmStO0YkOK8l_<7E7_Wp$P~ZPPq&UAgK^OeKaJ2l@f7QN_4J zWSJm`NB~GzDCi_35UMNK3}tQPyl2Xar||%bV%FB5uk+Z;@5auCbyUgJMUFZUO~Y8) z-Ozbfm8!gFGGYYa4gV?EGJOQ@BQhsoM_nCFwPKTf`3Ux?o3dHNl$}Q5359AlGQ0-m zn$7Q;i554QGCCfU?Jqr&-;PLc%lCmF6(USC!>9VL@CmC-`I8NEUH%-Gh~97dvO8c{XVs!Se!c!R=tIYCG?7H`fA4 zO1BDg53YGvUz+PxT35g75(<%po4H7x->eVdjdk9dtwJtb^BEH(w5zXFQPJBrKFxO|BVi!K3F=r19c$;p5WrAf|O z-wmDFP|CrAxi!x*@Dri(aUi8^f$%KXNU)0A-ZUIds1I|wveu$(vE%g9?Deg0=%ZBI zHwBs@lCVZRx{$^S)=K3VLtVbb@K$;Oe?Hpn>2p{~t@xPfiP}r-hVc^scmOFu;*nV)8URJeTmlih3Rx{^@;PlkP*$>)(70jm2spV$;x-cEXZk2d$U_u&DalWc6$upjZC|kf&o=?EeM;{OJ78)uAY8%_TXiVLdY5U9QjwF1jUYI0ryt_ zT~9LIpB!@XZP4C`svqv#_pr9RZ99FZhj`q3yl0qnx#d+*Iy|uOa6T;ViiJ*gox(r@ z@d8nE@bL!hZR5m}@suDtAZ#>UC5fE_tjHsO^sy;Aho}9q<5+f{XuEg1ZWvF1rc_)R zbs8t5lzrQFs;^Dm0ge9W6_W@GZi*16MD6BkH}#mBP}dn$WRnTayT!ZdWlJWaC# zi<=~}OD3kiN`EI;D4&^aI+qX#H6cjruY;$rE!bfCJ84tw^kpyW$?^5kVxju5F>U#k{vdt(O;^_bRY z>TpA5jsdaEi&RRS2_^>xB~OMZ%9qy2W3`Vx6P}xKT9t&g>TcfrBzF}BJ3l$L=Q0lUn0lH#jC(JlXhn{}!Ubl|(Thgr);anVIx z@u_yP*h-eGMRM%?-M4D-3tFV!?9!#akg~MQa?F_R>u&Q^6LF?oU0|R*lq1=F{?Lsy zU?x@+gcZfwD2-}}uI<_L#pWZOoY@LGf+a8o&Uwb2m1N*6JTb>8HDV=FmEHFZogEJ0 z&9dU+%c8{B%At)P*Xwk>?UMK98_mW_G@v_!R}| z$Nyv{|MIo!YyS1C(D+xIFG^%3dYZWvO!Onp>(_9g7I@wRD}cPr5l^YA=Qg{KHOYx* z7OEd(sLSAZ!_84-Y^(zxpH=K|VJ&C0`ds-BVFZ{@S8;abu!ehB!hz@{<0YW|zmeNZ zBJe>Mh08KehYGK^h4O&0;`Xy9PA^0cUj9T&pv;zmkh5t_Pux(6BR;zersm zhU40T=b{^fa)RB>h8kJ1b?$lmtHXX<#~XJ~#n#>9gASdhzrC9kit|KhD!~ElT&Z5t zcP}M_5kq8eTZ_C(8vu#72Yh-+{=4EjUiadb<_dN?MUAci)s#xwls;;9-0o4liVM|v zt+VEqPs^UcH@PoP2z8$}jcn4sy##5Y@uV+u!C>gw5%j8A^cSb5Kf+ZH@Z@$Nb7Nm} zo8&kqPlaY>62leLruoN+j9M}hGS47+ePSy^Kf6@79(O9Ck~=EmxJjPtE%YQ1NPJ^y z?r1Z1$S;IO<@LODXgHXSj!Jrv{U{~5xI@*ovt_P6XWi4?Hc$8A7eWBB#`MV1)Y9QA zNeU{k_&A#^iq^{y_!~lv7Wa4UW34rEed*pBVNL1m00ma`t`|+^8uuw4h8uO>HBQ_~ zuA4Br{e8%#>s|&FqE$THF0pnWsM&>Fhc9AucV{#GzGy=KgXjcYzpSWGsj%RLkTVQ7 zOERQ-YUgz$CABh5dyCKIPaL|s8Tk!4oY_xYhuGdzdViZAzP2B#x*_YkkQQ1qoY z@%fAbPYGwu+6{VvR8li>EAI8m+GZ5x<#FR#XGQ&&XJHK&-o&z;QdjiJdo%-*3cQDk zR9P}hjxx8_&)FVQUi-l8Y(d_f?XU^ZHZxY#3Hm}ru4_6xuH|qW1J%^r))vs_i?GeE z^qTdbYx`-(*H7i$e+lv&YLRvxI(&|rt$Au|bNZQNkB?(RL-9tRy-hx(TibbF?g7h}J7fCu`J~v{N z_sH|dAeGsbil|d+aCTuF$gjYDM-NTHsY$x)u3ct3-d|tezN~K4%iv^irwNJa5^XUfocH>5H?eqC>jg zQ?LzMXLPdP3chA8WVyjjCvihG&s}ydU0x35|GlaI!f#D)J`v8?GtLWQCLuuXL0fn0 z01DS#a(FQyktF81odJA2$askv>54wXB}PX0;-s$nk6d5qZF^YDT!FSYz7QR7_=z~w z;#ZC*7iu(kBL}3`9P;k}u~2&CcF$t#5h0kVFj2l|=9|D_`iaf*VhULfp`?;*;yXFS z7?Zto$=|wWNJ{x=y~h;Y_nShgD~5eN&T(-J@>cQ4#QLHf!_zz>4fZj6L_kF1<1Dmr zMxK3}vW)p-v< zq!^M$Q+>rI+*nZph96+4S;0saD%3EJ36cBZTF%qxvu)Aa7N+0BgXSDNGTgF-Yjxeo zQWlM$*jAgDl;??8eK9d1*&eHxuX@j*lkA?A8f`dXZ6lXIo@S@U&6HzmAJxl#}6l)nsl?Ew1)jXC*IY< zbiP8Bu@v|Ec(!lIU&@W(X_FP=;$^?^)8SGc-|I-;FXk*%I(#P|N9Ln$M?yWx3dI`Z zgYyKwHN9)v{`D*SGc@Bjtuzq0K;`TW`l$S!3y4mgLM1-Kt+cfeo@h-0pz}OIYuxtX zmoo4-I=>#_U`eL7N~WXzk*#h%Z*}Lnc^ZLl`FJ8mW{~8ctW#M~b-u$3KR5%hAMr#; zT9o*Yi~|NSJxG;)d%_XHJm2xx*?t(;&a$@^`rhn-NU6EarJfhTot1YQegT1sUnw); z=sHfr@XWgkZ>SKN&==Vlv%ai$CPzh0Wk|L1Nq?Mj`e8x*A)ewyD7jg~!gdfqvwa2l zX{g4=M1F9QGk1$gt}9(7u(6uY0r(*HKgF z4VF5{59zT%CVUH_Ga=W*o3ze=v)>j!WUh88k;;D;8{ht+68|^;j+|~gDIwE2I$}$7 zd7r=iBDjcT=SFYOf_seHuwZPnS<#>`-A3NGow4NWHWd@d-@6jJ*o$G9%|61h6pC5% z3(GG0T9w&vq8`(sltqNzNmd%gG4`Z>mN^MrQK;khC>n3y6oR9Mw>`mjJk-3jx5w8nbX~Q8n6pm$;{7bs%$R{e{0}U(3~5?3FjN^HL`) zeJz$REUZ7B--_%V?xoezRKKGhOe`E&^<(UopY#Ccx;t_@Jh#L?u@%PZF*tADwe40- zEO_!Nb@z^1!3Pfoiqxu9$6cu^Z@#d_kaF$9&eM6rS~&^2xqQq0KE;LevO@>W0SlAS z>viWlFKn#5_*${W+Gx`M=N8}hX`Df&lHPv555rdhVVwAkR z#EKI6O^EpZL!w##^4SY2JOf-_akg)`%*!K;xPBqO3wDDE2H{(as>XdA@k@u3H-D2N4Zn#(({rEEf5!e_-Tifk z_-l6mw)j6=oB!Wi%pE7Lm^oeeprgf!FjlD8#Mc++CJ~9G(?#lF?U&fyWM5HZyIGMM z6UBn98_f5&Zm9K>Vf!oxhBwiux#R)NO@Jb~ihXhOcSYcP7Op(Iq@*J;J*58CtKE^} zgsOeDg2IyEklJaT+5?^RrNp%)V|0fU=2UO&tRtl%<%p5ODI)kSP-qxe-(H$W4hoe0iA`)7#IANH@At2- zX@wWjI47e$=~+hkuu?#;?trN~EqE#!#L@n-0w`$R&yl!#Z z&hgzQ#P3ynK4lIS=Jf8Xw7q2B5Wbr)+W@|HHRd@69T^Q95l)vJHn4r`rH2LZ&*u0u zaT0-8#{@4Ojz?M&R(8_zexuL-oq_umpD9kCDME9H;rT2r1}))!ct!3{F|7J4zu_9; zDK%5rir+fe@cVEAKbx=56*1DTa_v@tYhylR+mDX;joxsR{-Vk-H$^*QUfAqkNW1_o zLzZ+_x~Lp*9uNGTp1=QE&pe=T*7d-O^e=R;yqS59p@Rm22EEab8fL%ITMlS)A6QWQ zrEccneE-i9nt8xy;agQYVK}?5W=Hy+{`V=0%KL0cKWpEoDm_QfbL+1u{qLL7dP$^S z+biJe#@6{kin-H8-q#r!u><~_Bd*bXCs_bA4UNLO>wfq&5fXzja_jTuEid@{=kUkh z<6q1BujT#wQS&c}_1mWMKY0_np~KhpvG4ZBhfhbb6j$q~lY*0uG5q~x_>BbPEkQ(# zlWs_PmzJM#{D!}#(JE_8olYE;({Qz|Nt_aSk~5huC7zuq0i0_f9;0TVZ>k+mc69&h&#t!eXbMF+5^>{Ru;@4AC*pu(H1=}smMP9KDR`PVJ}z2pc0BYAu3nS*MYzQjpO!-Ik~`dZ_mxmm%)`p6JtC82+5 zzUEDHsH9N7l&i87waWL}D_6e8xn)b`5wdTtO0v1{%blBIK<}=+=qqaKC3vnj?j++}l!XL{?)62pgBLO z9^*N_zW$g2Rh4-yJj2bMIA;00{?|TXZ+O z!hIPMIBqWit}B&{yPvR*an4K0F>*l&%SEBZiEul-vw*w9$ab;pZ77kG%;0cwiuqXI z9;PC2)vtBoRcIP3IN|jdjVLQk^zorvhOLXVK_rfoGbZmXqrTOq|5a>e@jh|>_DrOb zx&wrLmpEH}LoCxzQ$GG0aS;%JO&$+P3WA=|m(-A$`^5I>GPs52x{{W;Y${%?_nTJfv#*HxbJ zDzn(rUO5)LDYnFTASviGtX)84mL+<%ffjThDXc!3-T^lSonDYfm; z%ZhB+nJ?+YL&b9}k#S{wml~S&x<&@p4argH1wM*0)$9ty#2U!3w;JL+Is6gGNk*#9 zc4$GpqqvCWl$!*mm*N{O6=RPHU&@;owVJmYboyF}{etSS6vJ#lcXQ@~-50d}6?S~i z7@KK$A?0iRu_wAa+Csq)IoCbj+TreE+6=8dqP%;vrQ(<7Q0eP$@@0DA(l~_~&wM@} zd(~is$bn|Wpp)kE!R^)IwX5~_!%&9LYmvluG_%mrDLCSJ;SXN{-hTlPM@7vMZ}U4{(akDJ-4Y@8JCoIaV((?6>yo`CFluf zwBHlXMo3@fP0029fb%7XKOZN*aJKZCBCcv{Ibz~Cj3uJ(VKT7xQg^ZaLGYG}qdvqZ zfPHqV>j$bAR7hAkRk!|ng>k!S*GJ!-kBM7aBdu)grvHwQZ)o4NJiC(8yDM%ZS_d$U zQgI^nX(LUNDMUqF_yqDkwicz@M6A+M!RFmwz7YI;ba(%rn!QE;sRg%}q=l|7%GQJ4 zY)EC}0RNPdmA`HXnU&qK5H=QE1Lk_r_T#^6`R`=`%8IXab(&sUx3svw(%neYkg z2_wASVsqzPssg-CyU9U|6S{ogyl|S3X)Py~8;qXfCT)rojh*Vr8O(Us72I7YaDUx- z3Y*=ZCWshEMMaQ+9+63F?dUzwM-O^O%Ass>Zws)1wHAK)LvC0E?_{Z_3dbR1O|F4+ z8+HZqJ=c4BSXsc4N0mL=10iI3zu*02e(w0PP#bIH)H617(&J6hqDQnCx$A29MbDvm z;MKIpu}(|h)GiZO^uAvIYV%=)MBcqa8ROub#_h_n+< z&amf7w;t<(#KkFI0gRn0&4~WC_iE>cD>;7q>eFh4otoN7A9`k(V{Diclr;U9}trT-A|qkm*Fkn#};*F@JcR)Qp$- zdME$vI~#f@Q$xi8Kb?tdH)LTh<2c}`RdCm`-O(TaeamcYmS^!RWl_5UPMdYb8MrG8 zr(}}6`gWX@XA!iCEnmH+p7HB$oZ(m(%w^}(KZzx9y>$wfxhmBTUz*&QSJML@45|1p zx{nfm#NC*SD`&wfPo{K-nMw`$@w)`j`?D)d-XHqKpgkAR&GfdHK$sGI+pgZmoW2qW$2?ih%oNNU*ge z=jLE>O$={Hauhr{cvMKz%6EdNCs$)0qy$~p| z*s~_$jkBZ3PqRaf$c}e6?v5f{wLlp3(kg@S@>o+V6hPO5V&5jNelT|Ea^HZTi<%Z% zuw48m|8Zm(8nxlGNmWQ!-ww@*nG4jeeB#k_W1~SkUH8}E!C4!&Z*qV9qG4rYyGA^< zaC?7{IxyAn>PcD~AO7T{nn;=CCjHg|pd>7$qM}Kaos}6EPdFFY0}|Y`rVwu|S0Ir% zId}K9Ui&m>87EV1RktWOJk2mtp}+gF#~L{#&CmGH9c%pJY;^~ame~%E(&NP@4Ch4D z4M#oZX0`-YhBU^iF7SJth#i-|P^|4)>yFrMU=&-I(Luq-^bbwglgQZQb0<>0!#exL z)2xf*xYY0l89c*bPWMTOmHX3=)ji#aD`VcTPT}w0;IYd{I9>BnC>$3w57Vb;>P!0v zO|6(q*K02jb^V+{lhw(w#^VP{dxx=Ymn&Aj0=)f_F|2;e#}Xlz#)I;dLRcc?n(24e z)Sg?s;H><@DCT<@iObt;l0IA20CxY76`c6$xS0viEK1CKvgO^HQ_PUWPWT~oY}a6w3++1qS~VD+RP#NOYn;H_dSTi!KBT@ltT*4}(# zK|bf#UurZT9??0pHPeRs@ypiIHHqjqm~%(Nllt_|A%O@utyhtNwQ??0@^+eupe;PgSE0bbXS%}4qnmm{LN{Fl1-hs?H!FvpTaJMJ5dFtrZvfw5ovem;1qE?jV*-g-LYR18v*wf5 zhKQ5*3B4ImVYaw@ubX?mC2_8)>b!uoC|Mm&?=M#L6zzm;Sl=%TS5mhnJTqhAEIuyL z(d>=?F!{G=qd#Vk755~Zz}cSD5_;?Y;Mc9r1$5QymnkaWJ2fD09?kO+H_6i_hGZrx z#@j!&%|*U=Ch7_|yILDJe~c*ZI|O&jS8B`4w8n*qsgPksNCvj|~E^q2MXvS%vsItnO%fRnYgO4dU|q65Gn%?9l> z{Yqu{Tg3IE-!9JR$oedv=Jw$9|Kvhdjpae0t2 zmOM9mF*eHmC-$855fsZ(qpLz(5@Te}id@n?l2?m+mB3x?)1c_Hr=^XtGME#$P#{an zpuzB`c^dFZ0KywIo;LqJEBFr%DSxUXf)Y>Tj<>y#Mn4SMyh?+Rh08Flr9X8_tTNG6 zf#Fh+Tr&+)=2TEQ00T$flY588S6wi5}Q}^}qSfkr+yNGDk$` z6Hte{(#M!k_?g~6V&vV2Cw!(Kh?Y_%#g!sgYz{bZhYgg3xKTl^z^aM5g#n6gf z|IQ}1FOGj~sMj|cd&kw}ya6xjlAv@^i9W)frWzO27q{xD*u`~c;t)Fm20s7rqpL*m z&yQMiHs_Q0C}d@^kz-C40u098NFv1u0$0%_hkJ5xeJ`Ik zf)C?bkaEV4-S^s1%iCT8UW#@$nF_HR2<+gohdH&EVi`fsvJdVEgS#2DZcKqV#K6$g zOPsG0o5+>Hu6*X_KN`t@l%J8l)b!FM>@8HPM|%iV%>w>%ej02R!#sc2*FAek1Kfp5 zD}n0*D;9O$*XN&wPw_%u*e`D5=`QKX#xXgsiR$wq&-5jY`&pI)Luy&SXE|Q#{(a2t zr2gv^N@8V~TY!dYVe*`Zb;oyKcr;@%cGSc=?iiU~8qTc)!3x)%t${g{idv`l*v|^I zmM7*56ne%YP*~c0H9~!tO6K$i(t}K1`Umzt-<&}b@^|bTkBdL z7F?AsyfKvDky7()>!aRVHi6PF=?Z%?T>F`I!)4qe>L7T2>1;)9T#!^d&fXq);i$Sb z{~qLmFv@iZ;krCaz4wCSN7AaWjZpp1!>jH5m7V%S2>>d#H*9k8+8P*6AkpF8aQN_e zgGNs(pCB7grYBh!FBkz;MN8{6+hbsZbE6BmCv)TAd z!`F!AP=iNP#;%~W&L(oc7M#yVr3M%vm#*crn`6ymX{#sVG+}e2JqldLy@NA-%X^x|2=RIznbxR1xi;u=ZJzfA} zA{>B_6)gX$xZ1Xb#~+{uC7TojfkTVlsDuYayIuDN*1|rN6FdptyewEM&d7h%{x6;l zu8FVy7jthN*4EbT3sZNY6qoLz#Y=H0R3K0+6i5gbXmNtOLlp_OaR{~>Ab|uDEVvXe zUL;V0OK^AZm+o`lbN@N--uph^z0W!MC&?OXtvTkHW6d?@Z;Uy{2dTWXp~6d;f&H`D6BX5u|cMiMho$*@;xCdv-oKRT*JN8;Z7b$XX`K~oi*e#x=nZ!1lYDYY5zd#s!0 zi{&ZeOXW;G1qgg;y!_EDU4gVxHpt~<>hYVUFEmmrf?XUyf^dUUQuL26FhibFPJ7u{ z#R#e9Z%$EB?zo!S^Z%+B`EPnmIef19cqDSn)u2)cK1-wy5dHe~i3zGf_fSOqXxOJh znv;xO%?Z_zoMNra>kq!XhCH!GSG^u^yC?pZ9IZDyd*E>*oBmX4hoMEcxAn!le6i>^ z*$skboD?If75u|> zLW`)39YFJ)W9(Z24eQ3TAnl5QM73fq>qQfc$JTPAr-m0U2cAv^*=@t; zH97iXlAi!)W9YCX;%rhi6T-{)2zl{u)>c$hrl693ZtFoJ?m`elLJy05lZ_~y%1}Jf z28?iI=W)kXI&Cr9e11Kk&zdqMqgQxqOARaVyNscEq-Wt~LlG{fP;870_TpRa#kXeV z&TH4I19bI!ND(PKcAAa6tAkztFkd@m!+UFsR-4e>S^ynu_lwiVZ);If8GQeT8hFvy2AON=HGv(A8yI-4 zVwxS1)J71=Bdn>=>PDCA=dSlokr?^xTx-sn zben$V|8R{Lvjwm zTJ+vJ==Z`!*`h3zB+E}3hf8IpOjxQ!&Hth2@EjYNQr1d{x3#|~Zr}%iAXyS48wVC? zUwJ;RL4z9~Wap=(8XNOulV?@A8txKQc2n0huifFnubD(gGZaeOj@a6-ykYO)XL7iqHV5Q{H)odEKITIc z_3L4^qy@w^yKG3pulO_B5Q{D~@ zSsAUq(5T=lp!&c+s_5}7tX}*Xdegnv6HM((de30j@7e$fPc1fbk{56KQPd+qto}Sg z{q2x{9)yW!i;-T1VZ^`9l?A&Da9z0FE;DN8^p%d(=^L^^+}r2C$V}JW=1-X5#k=NI%=UCZ9TXPkdSo(l<&`q5fZZQz7e%MZl757O`nbY*u-&VDd$2_hh8PK0rI>n6BmPm#n!*TEp9;*s)PgxdY*To>mG~jvA^T1A&Sv3J;6>j1(ET1;;CcLTx&q_=GMTDF-q)Dfn{dALqZP}6+O~c-KG(IpMw65MKiZ}NU+(_k+ico%Fs-(pq5{aT4s+C zyqwoFgXf;rpsB(5so`Fkg6@YqSdQ7seaRM0vwNTZqrwtH-1|wj<=-7Q)=O`)HmKE| z>yr%6+gc3NZ5w{D)}B7PW%0*fFS!0UZ|7#G7qN>4*-J>G*O!vPW`|sVaep87er?t0 z3VksWhKIYkx0_OHMN@CXdF2-7>koMH!CMi2%aTE*QgC#h8bUw_NEr9Lyp`61t(Po+ z-zvN$L`Y()hxj*1bnG_R+CPnls2Qi(7_zs(7r*p>Xd$m6a_hBpG-PhRYbokWj`Q{o zS~RO~`!vFeORlZw%#Z!iQ(t!Sz`vTc;#VRm@h7kUH?x2JOQdQQJT34x$i|u?(V!sr zyyXseRUW7jH3f;u--QNVt|=~A=YyFCafK{0O2{>Ug}&Oj>D{Z)-tQ2vZL+-=z_%I5 zKkBs5uOmpAwY678B@%{rGP8Tpy3UE7Qma!=zXE~Y{522%NxdmCCL!nn8-Igok>CrL z8PO2UwR2Vqbn1*Y*an*{q3KL@!TgeIe;_2dgjr3`TQNz>pq4vQ)T@I(bf5w zixHSOf&t$dBdt5sYhl*-v!eQss3({SR@!Yg^-h$-Eq5RXLRptffom_20NXu_(9o~J zpq7?<`*At%AHMqs!eba0z*P5-Zmf7zYgiKia&3%|OD;UTP`a7;w;#b2Xs6Mb#ZAMP zB=pKuj}#p*na8(3Db~ai(c{lgr(66Zy%&NLGhY5eqxh35AfyOwkbPt+VD+&y%}6ND z&D3gVBvZnGioNvj8DTLF$#dbCj0LRvJ)@_gOgMysSMze6FcGlPcmgVock}(bS=u6I zC6NB3-`bly5(;4u5{W30Z5A=W&MZuQ z5md52vQ%S>*~yJ(ZFek;TxE%j5Qll>IjUM`MgBEwmpP&qX7X|xZ*X7SYx`!Bo2?@4 z(Yj)QlvVAP8=Rlr-`zkmItN*D*&|}guC;nJ@7ppj2@h;)E5F1kjdJ&nl=M3g0xzze zRq|Y%wlqhBc%gIYBKC2MN7ARz)I*zftKmPWsG)zw!`1ckhHtaG1X{~Q`RH%gmfBjL zu`i>(CB?d=X|YA484hph%F7Mz)yRBdr$#}ckBJU2OMBW(5$8)=WB}OSqPxQwzbwm~ z1|&z6gv@bh6_r7rxkE?9#e02Ts{K{Nf6~tN8V&g0QlLx3Y4yrU-_nvczCm)HYR!!L z)VkFjBg1mTIy>r$5UuS)&$Cwj7;qMG4LY{7Mi}xnP9KS)8LO0kluvNc1apb0e^8dU zJ}yT@K#j(4Q0kgH8GroReuRZOoGS(oI}3K))lxa1C&>@5fWc_|N6jf!TD9DPyx&8~ zzrySgUaQpU>9?RPyZvYR{q-YgZtcJEIsU6-4BXz|m0jDz6%>RFsva{7P$Q>G2eM^G z#p1&%V}xC+P-iuA=-V=k!)*4KTpI`N(wjU5AW_0eLd2V|cboUV;Z>K!^k_7R1KxuzEPv8EDn$QB!1VuZHqVQ+RgQ}2`*(UwjlP9D z#_CMBhd4YQPu+!&fuf6j5K-Paq379AOWe7wXboEPnLA%;lWK8Qw5Uf-KO9ys(zi_! zTCD&RU$T@4`kG)2eySe|J=6BmqWM31WBg68lw@Uw-iAdQmSV5Yu;_&5uT_pR#UDiX zxLZAn7glbi07Rp<(OT6qG_xvFja#T<`k~2#CFfeMM$csg5k#6IDVG;zROk04S;id9pAuEzH!23vjTwOGDN4`f{rb^jGdl+%qBUK<{kD@?4@ ztV(}EfjbKRj)niAw-gH@ht(3LFsNP63R3>2zHJ7?#1_J3!O44pxc!{sY>tm0c7XuU zS>SbZbX2%yRsUQ5F^v!N_GL!XWdkb8`mRIyymPNc^J4sI>0@n6AOYn2cVzkI2m=-g zG&x1a4nw|frK&uAMndi6eC+2prbYV1Z}1}NO6hh=*(~*}%?-D*(2e*6KLyv)QHPk3 z#R)@wd%&`4=%564HW&<^9bE<2-TSig&$>gwzdujIC}2_iheccGTU#+R{6hSI7pn7I zv@lLVvJ9D;mfl&`5|%r{i(ohRzICxQwD2ty|kc^#`)sa6PYjXcoZ^KXjKVs=fO2ewCUW1V*)Nm~h?f~y?`HNvnCDH}bbdSEXMhosg-r7~maJ9D|p z37dA`TbJ;Hd@e@_i2?q{Wc4$~7o4SUQ6{1;{U#Wup7fDtssI2}iq#Qn$LfxqGq*5WJY|o);LKCh&!fN2nS0 z(yOAKHMDB)s)4KXHjWY#!L0rVUiba*6%V@8aYOMsh!wpwns5x z6ic)X#g~`31+ErJlo>Oxc|=-fgtgX&Bqy_ySBu6}k|>*$)Z*RsV5p*^Fr2VU`;h3} zwT7Hwy#es(?5-~UBE`;0bGvr;ue(g4UIDJWNg_*F7uR9ZDxWx`^J|VT%~fbH^1Hz0SAQO;>b(Vw1O6S@%)H z%VUhik0&BgEN(!Gy;n{7Ggss5)+@F)2^#y_Ff!P*3OoeIEN{jf^Tn%gR+^=Jl=bKz zu0NPB;uh_oxM%;-EOqmlBuqqu8)}Ss4Bo#rj8~78C*Yc3xemb_dCGb1X;<^c6;J!h zJ|w??XVq2vVL5K-*uP(3$@OxA<@1=g?Kaxd{B;c+pfMke!x|qaVi`Yq;C$g}aQv(p zd9+ofGG(a=1giqd*p5r5f%42j-&lb89OBt5Hf(WAkjuYiQJl0A4l5+?-WgLSN_zWRVvy_@8{{TP zV-_5H%SnHoUj3OHsz%>7J2OAaN9AU(P$cXp)f^mwL~ek<0OI`$Z;^D}y!I>$%v_%GgP&APW!ds#(4 zU>$%cSSLFy9?$ZH2R0#9wMqeo59iZP4zJtkKa zd}zSL?xx2Hf^~1gW*LHS4^|>@w{J|CQ_7;s)rAxL;oh`jAOH~4+J?YXb?L@i*vMoe zWO)uV3C$yiCII?!RD0@5ree?2z1FHS6Eo8{UyCv&^B6N>6DU_3p@9`Z-XE?6SJ{!3 z6BOV6F$pP@D&7OMB(?Od8x50`bZ$4Sdll8_H|K}XtG~O@_U~;frv$yJh<*(Yvxo?Y z^cs{pCyftNbCuhrpCft8NT{?!T}8ZaO5;`YWF!J)%6C9x9M67YlZv;CDtpU1#!RXu ztPWA|geiiTANB-#9S~34E#phnHR7AgO*9o$Zq< z@NzXkhPN->wm9&j7N(Ss1SbG*e0#pWU!|zSlHFNN$Z7&7p)zibvR95ij6|UFA4Ubd z8XhGCUPIr(e*N_FwsD={rYc&-OJpsIF&?(+H`_#{mIgX!f|j~v-SWiiBpw5NQ<%nB zRrj3~b3(f`;q%@7D(lzuz&ZfGD^f~9E?FUhxgq4F;uXv6utfwuj zf){}AfPRbqkbZjdQ=I>mJ59JBX^H7o;8fSu$hJtwIW^D_ZHp7tjkbTQ#Q#aSES#Lk zLi6H-P_HG^3qg2of+|y`jo0o7rzzn(Atwjtiom4GNa1o(xjhdoFSB-}Ft2-kK)ciH z_V*V95|A3Q2|UL`Uu4Ogoqlai(#ihr)B8fRBCvKD32ARWYoZVHl*>X&w=rK%+SQQI ziiQIC=Jj%SYovJh__s4_YmsV?o*S9(l~PoQ%(7OEX&y!6Gar^Wz^JFSdW@!Dvf=Q^ zbRkw-7ImdkTG%FxkQ0hLQEP>&C;cJqnCulMfX}bex6tP$_Y&eXU9!L;Xm7vUKv^8{ zQSE&&pvvpcgSVqih01=7M8nm|;mLqd!KVmkv;OMZOAE$vBJe4?B!445w_X{vmHAI9 zu_Pf`3%J%-EFjA^qNZ@F^V`?UX?6c8sDJ;1Bh@*@%|p4(wy}-X!j;}bC9Q=au{Ko} z?JdRAiu|JVlPYAaphH;B8~f;>$6Q%P9CBaD<##?T@1r;F8ulQujpE7}NG4M{*!Z%b zbC(^pqig0K7?wUBhYs!0j2>mGYk9sOwmbckN@oZX_KB$NSvEv)JQM`p(qw;dZu@vW zF@XpcaV-vsAlRh!icoKYG2729@9hRykh2?pQaLmck{oJ%)4mixf#<)qJQ0kqD&h#d zHUVS_cy=vX%j)(uEJy{mWJBwJcIhXTuO$5JmOq=}bX>Q)lU0#f!&@={f8Nq2Bz#`F z7v~bv?duW}!-F-- z;JX)jv)d+xL-3$Zxuu%fpv8I)zeb{)J0abuvN9d4s9piN+FE&MiDf&EU|3?BS;M6s#GsetO{yMI3@|DrsD=L}HF zB~nXa@Lo9mj*Jeycm|zwM9hm88El*_vTa=VWnJu4VBn^gGc<@f$Z$Gg9M&SY-9=qEKMYXQ;z~%ANA;Z+jLm^(pmOLK2BRT=Rrx9Dvgx&c)jqqaf2;376e#ssH&`!cAj8c(WFmB_H&bV}JrU|PTY ze2rv!oWQH6M#5osKT0ED`8s37bfFCE_Bi#%%>@7}heD-{QTx^q7# zB_(xJom=|$*Mo3w+X$z7EO!aex2%7Qi&el@pkH;?mILO7!6c)SF{TJJ=>$FuZzv|W z{o%;d4efd^4fW0-20c8*B8aeM3dLYB8;XkS(dn9|>ha~!LJe-+Ruwg70~rSR>JSYr{x$uv+lr&SI^%Ay6cmuFZJX_)ctX_(_5v zZU!mAQDnSE!N%153LzZ;6J>UlirbjXtAcA_17qx@ z0r7#7bmno*F$ctM!EfjuWr~yVpeNa_#W}6yW@JCzKCN9X#utf|dR&d=DBkKtfYeLI z=$LM*T@X)5fih}`q?!kt%;@f*TT)f*CLM>ETbLcen%7?AL`G93Et?m~8YH32Np^JuA z8-DT+lQBLw{F)9KwB9J$spi)dyS1MZPGAzsH^qfpQRdaFE?%wiW$F^Sg+)=)Ms`HD z!;#?!0h%||e5`w!EM$#}l`k3^6;^JMg3;6cB7N*Xsj|}WTS;j%Pm22XolA{y0vIl&3kL zj4;vVl%V>=WZzvT{tZ-mxONXfdr7@`Kt5gK<-WY$aSn+B+NaXP-FA3)Sj9tiOJcLn zH^o0qsi2LgcjoLTjQ2+(7IA5lk6F{#=qT^+x7Z-&*8Mztd&ISb8@pt-`1qVy3c9xy zp$r>hFBAs`@o1`k3ldEzN!km(K*|-BN405%PDiYkt5}$gD9$@pxyC3HaEha&LmGlIA^>|HIn$yMP^xK^1 z7EvPs$3_~GSr)wFfrsi~jk&+X5;99RCnt*Nd&JW^ZsPR|Shx-g^VLu46=mt~jU4V- z3pw6>_t(C>bByHp{yPv$dCNWnSGMC2e(N|lOG2!33#-yITE?L&P*;IAhp z3iaHkan=WBaX+GXQEx-LK9oz{V7+0$bZKuP>_2=h%^fm`>zxputN-g+FX|n({ zg9SHChpjoQl`k0T9bK;A9aKE|S0FZl{i@;JX+fAYIdq&sBJv&5`B#Ty3V&@IJP+o1{(`Zfuk{rxbY0EFgXl<eUHSaKNjJx;7bQ|Ar3`Hr4XyV^3R`*n8J=GeGbr1`)wA#x)pZon!_I6+BshhsROIlRm5x}O>BC?c zb0uXOnp#Y@O6NGnvg<%NA*;U4r)9U3$h_ju*RSo!v$`AC{s3XLV#92 z@7l^;8T+B4mpfMeQRK)k&x)nFM~}ILmAv!{pfMGSIpkLCx4R$foyyc~Zp6Xj$<8L)jmBmOymXwA& zuWe26o_)Xfjr|j;(GsxGGkR%$$+6T$11n)^9DdgElj@aCz>j-5>;t4s%g+lvCpCx8 ztUP(r+yg0Mc%|=*?pxC^v9s^jo>RxzzbH1?vA>Y`K^uTBvkO=dyez68krKlp04SK9<}OP3d=y7 z5~ZHy-gIxjT6GP;GS%-d-f@5TzFNaL@s9q~;#UJbqoKy(OJ8lzinNZtihh5So59FZ z!`Ss6(iW0)`nFB9pEGTAp6-eX_rt8+cUDvlv9epxv2MpV*;^)yauhn2hdxuH!1Pdf zptj&tOwS!$)DdrGFjg4ZW&D-KR2h^h-I6!@|5ass#ObrW<8rUb4j+Mc@MB< z#D4tT_swQ3GENex5fV6E!6vtop) zy3E?#se=iZj(maKUB7FAg|ZbjuZ3f>GxXbpb=?=LwD2(={%`#MIMiOYH4cmC`$@H( zvYQ$+^}L3*Wcepmm*e1-@7_ZvFRU8&;3=y|6tsy+$+1HqtanmTarzgGCxyYVKcEw6 zl`^}e&s}G-77fs#zf8a>tMDIpnz^s0R=RnE-4wyR9=3DjV=-Ktph0BJY@fQN;fIOyBp47bQV2wDCX5IY4KSr&ZZ!`GpI|&}_S>C5en3~&C~3Sc7!~CWy=x361T9IV zyrth)v#^*yF!0hKlz~qOTMR%zQ&%n$Kx82TALZ2S$h=<_Ne}f>>;yWMGcsljluti$ zsue`=`8{u0YnHsMY#chFxL}t~hrYDv=$|W&7>rbT7+tKuk<7soX^W`j2g}gXS7&E` z%SRge`pe&JC2CmIyG6ohcY6u^-=o`W7N6c;@O-(jDp}rXc0NU5onG(g>1J`MtgLhm zsrLOlZxy;>sAKF70buCMQ&yHSfoq_;4JN(&|38~E;7l#$Svm|kaQjOU=CQhceIh#X zxjvqVv{?-ui15XshMX{2S(#NVTwq2zF)crz?!HEL7FpdkaX7-cl zRkMg{^K`&Mq{NwMq9!{9!VQ7vsupWXIN!D&JDQs$qsnwDe7fI95~F#@(t(UiX+noI zij&@l!Aa#|PbkTRC#-tIiE$-);Mv?v@R~t7?G&~Wq8Ump;#%9_1QQaO7jz>97_ZZJ z7Ip^o-^1A1x#=q%u4eQ}?onOd?5Z6RTw4tmiW{n8^(%27h*Eio;OaG~TLXcJw3KLT zFaQ7$@=%|5M~hk;I^t(@3UA4Zr^nMPb%*wI8tkAy*9ac;!}}B#{wRkSVBeOHz{uGc zl#j~&UTK3pX&G8tnOhEALHed*7P|0E&`&Dq6h97z(uRCdG$o?@nclEq^aqA-D<@g4 zg~~zB>e1TMk4CZ_HJDj_wPaCf1@n#KFFuBix}{d~-aeJ2(N*sD!6!*)R(CK)>j{#_ zk4g(trvq4HNmSRDpZ}LbdhWVqw_E}lB1BJ6&Cf&ytg4afX0m_@KdEAfXX2Wn*Ek-F zT-X?=%`1Pw{v>pZ1PkFSyy5aKE{IH-n$h0W1;1pjJ2dzEx(`%a91{ z=b|;_awR6!a7!q6>w)vWq0Axy$&Yjm4WC)JL%Q}+U3>S7gMa%u_jxV|_Vxr{l<(iw zrUjMZ(|Rp(q#|3*e<%PvE}0r9x&gLDKgtLs8#=yX3dhwFMRXHFS?hCq+uL(Ti;X`m zx}ZY8V@Pj93+1*Mj47B%P|dD;{0(gST2NW_AX>p7ZB`-h(;I?`rC@%E{#l^VShpGL zR#3P+cSEBFx*;Rb(ei8p&1B}M9JTH;QOE`Bl0DX&alHD6Wi=ynAZ_l6Z69Uji~ewK zTnixK)_h+{>kh)e0Ag!2WFy_VoP6`+MYBBR#G&%_a+l(m_?o=JXJEL8=P-xw;z@2F zJglkpD-LdNgWwOJR+Cj-u?!l^z7$+FtT0qxs~81^!>n{MF~&ke1dZfqP)E2Fv3HqF>CbSzEmU z4a%eUfs%J_seIJhUQBcp=kBbd-7jLEpwC)4C@#B{t=au_5!Xt*Q>6buQ0T$u(;kR)cGrQsR52wna#N;VWDz8#`WrsF4%8oPxa{X%8o z&jp{>gL<0d#d)zN`cp8^kq28!1{ab_AR$1n&MIo1}StWJsNtDS>HP>eVK;!jLuEZ?Pr!Cm~CRaEH z%7y*p79R<_w4y{gKdff_aGi647J?D2i_U^A_`oCyT^E5)NH);^R&5m|IVqeVw zdd+?I1vQ1Y*!lM1WB#?H&aB;r`F#%BHjocImkVp=2(sTY#;d`gu443E6=+~&^XeMYa8fx$ApvJT?hj->9TNsX2E`)$1 z7RSW>!cJ_E`|Xt~jJzS7$Xd1Fx!4Wb6-Wzl=u@YLmzOw9)?~}TgH4%I$QJMHh6^N< zfW}J|=yi(fw$^+`U&h^BiW{YpudMz{@pwrMF;7+37IcMd%K6&lny%^%%y4e;@nt!e zZKhTV-`--!EQDav6Li5NLv$X_qM(J42$yXF0of2*LP&y}sdp{~4~J~B#$MCM6kcX8 z2LN8Y>N>QD4h*HH2}{M+Ga)b-h4rBA4$4(SUC_j_`Ms=IqD4T<|6(l%~3hwIY zfck4VgRG77{2VD}*$~ft&_<%{ZyxZh*6)pLLXv=`)WP%+aY(Yl;n^|f%h z`;z0lfR&8ZvQC%C5wPu4Od|aHRPk9~XI*W|MN2M2GYTl4egj@gZrWiV;gW7Mmo!3i(vh|w&QDuqM(Z88vn7s&af-{@3+W{W-e4TlP!x;XB7$Cp!|7y{D}0zJ z6HQ{&JMdWC)fZ>F^U|^u23iY#lf+o->}WS%in7R7pBJ~?Po<5v}pKv$>xQs z1HNpn9Edp#jN(aolsh5rrjdNBM59$`>0zT3M&I^vXXF@c)30QFXjgAIXWMfz)+G zQCnLPW)4M%s3CE_d|RwhZ76mb^PnB1+r!_#nZaHW7y&w3be88t>gIDDP0=kag^&^# zPYf2&Nw+K{_DU$gd~WD|J7Xv34Q|)zFyG!X-50LG#q%>_hXAt3093_4$4oIqz&fqpJ`=oC*Ihi z?B;OBu#@o8N^L{?z?#EGQkYNfP`2IscNRFavU@EFzMbI~eG*Hp))A@+NM{i6lZ$6R z8F-d_xa<4*tnpq!So63m%Cl)Dok)VgXQZeuHNE?<2kWYpoX2N^Mb^Ek75N3*O|kHw zRP@)Gnqq1%XihqjnMWzr~37-hL?qsqp2ObdUrSb z)YUP^#eKC_8KW$#QybRmypVQVaSMq)zc=~RH)#989fgpME-U_vX%uT)F(F+;s+A*< zw(Ud}!N-S0W<1`CY76tb-XE;lSC|I2Tfvr1J-d1o92=nX!>rWrdTm6BE!xpuE`#Bq zTailIQ~SRjoIj7gJd91=HsVUC4_bvHYE1S_a5?(Y$(B9o|H1SL=elX z8tlQ>4#-Wc>qH2WmMIB8I4X$sXD}yZJ|GKm1QS`9 zRWNDsHc<@6*^3$kx9xlkpEPwB2xR;yC-4=suqYq?Hb@y(t$vs<3>~0E|DX;=CUg%B zx6o`iWdF1Xzx*$Y5CU=$z7H}!dH|^}#NLFpcI#VX#QS^LM2aAGtL%NE!H>_C`}~Fc ze~}(=kyh;s4Piq2@E_I-xeP@bPjO?mOli9&KdA)O`_+d;G(=K6XuJYy)^g9Y?Vb7TlLoJVvYhi}6 zLNiI@w;e+J41c@KQXw99qd#6sI&h88q`=uIzKyWhZp2V)cuN>7`uOs_iia`XYem5q z@rif(e2U?-#;@=|;2Za?sU=NaE2^8+F3cPdH1}h^L#NdTSSj4|*_S)BsPiVf4pGG9 zg$q>Bj3>8zTokB;6K`qx6n|J*FFvly3+o_mO~Hjhuby9B^>7(p92-<1lMbC~?qH;Z zx~gRGz!&89Lnp!=45!mYyDBle=^EK*uS z|97biy-Owqs()Pl;sG3v@Nv0u&O0b&g@xWcKM8{VZG)%H?Bhzz_wyXk=u#8o)K6c3 zQgI>f|D@`3g8uGdY@GVJ{uviiI4AMz-K`bhqUoJkiJRL-fm+QT(!(}BE)TAF6F#+2 z1wqW93G`_8$H8sS`{65Zi;8w;fi#DYN`6vxBB<_SR`iRIJF~j9hrHlt+fqW!%)G)t zz*JOB+Jtq=^Sd8bREj?A%vv)2q@n~>l{i5|B!I@L5sev7G)sZcuL^oF4~zJ?$lf_g z#g9ng8Yu1>pz@CZWnc!0rr`W#=%>9`#;Ly-`Na(QG{RRN6g}CQjYv7I(ah&5xOl$m zl3hrRG?(=e7?LlA`#SPa7^p%zQ*Ey^(4)HK4}Dkq+&DF^^dx>a_q4FyCu8J+Fi>^m zOfAAC&`$65B`;(2U~5=^%zz13U)@kDeeQB0X=k>ECk@9|UHJU^T#Y7cBtTS^R3|dNo6hIbiPbj2Wr7uv|0yFttQvG85VQgP$(%;={{LG$|`I;r^ib|v;Cjl*-2pC)}E?|=NT zDNK;+6@v#wKj;a{cigi>`=$?Ai4SNvNTw2J2CwMNaINUKr0N{-tL}lA``* z41Y4Hcf!t{pZ4ej8&HZI?ah=F4fd9Q%CHIsv!v2PS;t-NjdBV~%1|lI`Z_%)bNjib zbctd71n?N|6oe`B5I>qJ6?kznoR0AO8#~ck36VGl@LRhr;3>^Vt-f!Ved~1Eey|IY z8{>PW*SQQr;zySnEplaJQ9i9=PYAzYUM(%n)Fc1+G&&G~PAgsn%hM{jDkzxGha*|S z(!7_cu4Mk2YtA*EGY58i72ngiY^e|;C{(VJ2QFP6DB0=#R_{UyqXGyD>iy!i?&Ss5?Ux<%yr>yHVdDyC1b~U4OD)Fiu zxUtBt7r}Nr9{h%E?W$J|FADk+m%?GzA((2=Wc42fl|M#)Qhm$FmYEh;{)IEPFSGRBv~GdUghLVj+OI1P=02WML!v3OO&v=eMpPKNh?RKY`~%Bazoaz(*DFru z)1K1Nh}A9AD9UqVFnLL9#o2<%Q#vyxV#_pcm!q&Po_BO^(5b8qp0cF&>-tE$0^q#V zc6_b6?!;?ZR%yGmZVxLRzoh*1KL}s1XZ~337+7;1ksXSMTPPyBU zv$a3(?>U*Z<`L3E;m^&)gEdNkJFTUUaVKNh&BRmC>3q(fT*0&_v)X)LV1D7z`yWTe zJkBM1{yayd9_>Fb4>asACnd_qp4vHLSib%NoPl*7Y3}CB>D#`eRZbG65PK*@iqmcP z%41B^nnYz!)=w&f#Fd2db0F_vXl%vE6$;(Pb3i)Oq`!QGgYw7P`_F4j9|33VPAE4+ zYUa5zweXJG=Vz##6?g1~QTqL~)w$hM)^5J6BZO>ns*rs98F1b{Z}ZTxPxuTuM8y~N zM7@P_q;uuaQPbqqELq+X?OM9$dQt|#pB4Q{ukHuVJKUT(bh!PC?qSd4T1MySM}XIn z=zg)5G=JVx*2S`?L%xo5+cLR3t$Va0cdO21^_SG2c5PS4rd4b!kYU1mnaSfml#78D zCk5hxgkLh-mhUN9^H}b5Oo+yw7R-Gtx#ubCF?XlK(ex*k-7l%lg_gYZl=YnHNgz_@ zM?2{(d$zRhafTUku~Oa0pOVR56`&l^>me63)r~~ji~uPupo9*cR`^dVen|%rIbbuo zx(W|461o19YVUoQ4vaF42Td75H17kCU;KGW%iy)q)!h(zqX)pc(=1m*(wJ;o?Rucl zb+pM@-=A#M6PA6`Y8^Vr^|-&3@(Fi9>&KL9kC4pLb+x-kOAK8c3I| zBGbCZ2sg;}_tOi0DOcB!{iijLC7(klxd$UG6kGEkmEjXFy!MY?dr(FhPg_!A$NQZB(4A2o$DM@{ z)%IGWTaLR5qh^?kY0MTsSSgM3o<{$914qpDH0HNct=>*xdJNml>FZAmr1cy4#LIm? zf2u&m1CXGML~(-}x#51>X~;g$QV?2+=p{aG#0AXw@vDRW?MKLKy#(&7o{85RGJZt4 zoaG?g?4{qck{dRUVt%PfMIuOFMk20bcWVme6TN0nWB^8FK3ViDcb8N7lZj=FL>lu; z3v6|{zs@oBnm>^Z7=GGu#oG?3xk6EutfZ~&GF`n^H3@;9lhSCIaR^D3|9Tr}&vryE z-_0Jz?qxKqc^Uh)-dTdbNw0fpdHhk8hEu*P^8%I0c(Aj@Ry* zKYK|uJ)CQ0P}%D6c-707W4!AE63;~n{C~8)XIN8P+b$Xlx)cQw0V&FoDqXq|%36yi zEeIrpj#7ott2D7IARr)}fPxSRy@d`UQbSn~LT@6W*U+nb1lRlSZ=dUX&)(O*&f$k< z%sEGybF^pNKPQfqaCDnq+GgKflOd=z(Y) zld)p}>BFpr!r;=5_r@XT%s9eaq|987SZZUp?M{?085!zaPx<{!y88n#4%4`HO3HO) zVPe)b=>f3Emgiv_iUlYLzeqs$ym%wZQ8TFgdu~mOk%!jMk9+ZlNR|67>SB+=95m0E zhI>?xbh=z4AO#|S+l(cvapW^c=;624i+dloTBOxNk^M4Ep`5^of00U3{*k|u!&F!` zJT{ZlM~cm!4PF{qaV`{S+HT&tHu^&b?bazeQX*8pZ*AVRr40t>8sCeno5BiNUJ>xI z`lG#8WKg=>0TuT7_4$wCDO_-CEmcW|c2W<$G7%ZF2VYWf-XG4|s;4|V@jib~SkcFn{SzuiJS24*_#UlZfi_Nz;eAmNp=?k(I*ZDxk4BN0wxdf(>TlM^hszZU#T zq0&o3A9LH?D*4rJA@fE%5_kAUa z$OuCxl8?ryY*7L`HPr6+{n1J~$D#9^(s>o7x_PEj~mRM6>B0Jx8_fTHK`1j%>|}8mKi{ zPZJF;SWk;$-qGR3VsnMRI?T1;CkKZD?;&owvpy=X8dUuh5I-JG40o@#k**q)EjtM@ zRZ4f*1wSFSZ1dZN zu*CYtFI7TM)2Le(JewZr%n2Jj4t@{BhW z#_LsRF1#mtP2lM1tbHlg$K>1(#i%1dv3)?P%2~HkKOd9xKO&+wzzp(0W^DNiy8r9- zo#`so`jer}cf#p3xMK8zYTPqI%>QXg}KCQWd&6l`0i z5Q(~jGFccyayi}ob{xa%07A{a01S8pO%Hyyi_Ky17H&=ZsC-Mc%yA4_h9h<$-T0%QG~x*9w(Yld=cKL1N3hpOLD(bm;{3^2Df z{U7IeII`Nk#I^Ocn&4gf)Qm@!Yt4*B_uInm(A=poWzY4frx~%z4fR!IHZCq(8aRwm zo*P%V*}9_pL<(v9BcQ@a-feUG+#dt|#2%|9E4Dt*(p4MnsxY?PSi7`^Aqxy+5tEAY zypP7*_(E^0bkmY^zjQ+8qD+fID>_oKBh}=~@@ib@XJi0|Zzjbztb}bMzdlfRDPnrc z$H)y>w%>z(LL8u6M*QghQ=L3}u3z`R4xBL<#YR|1b4FJ+7$r^!Gg}x!xrRW4rUz!T zE1_Q3U5p4U=K42WhE7AQ5wur;!?@(fGKQ3=(*dF z^pG|*XPd(%wo&n9VpvLEibwbJ)|KNev-TqvykIyr^JEKO9iec{Qf%olKgVX;Z3cvF z<^hKYOrjbS+l1JrQ71|cUGQ`3?2*Iq*B2Vwyk?jW4m}QGV~mRQv$wR^ymGM)tuOQ* ziD5U5#y`y6vg2BaTY6F}^Tt)@;B_^T(amX-nxF)$GfdiIGa#aTyqq#D1cmmW=FSrZ z!9vi3qf8D5%sxF2ST?K$MMx;KCl#8?t6Rt7ZOxOkukJmt>vJ=q3ifj>1tZL4$NtlN zJ|gcR$v2%oCYwG2*1E3Ppqv4VYQ|Hp;n#e;UJD73(n6P#na(}f z@iElvs58D^*LsEDOBE+>{%%?)j&@A{C!~Ze8Y=|6*VzdM3B8_6J&H%iotey-ZvdRS zk*Nb-sxO8Ney(Q0K`V1lTCezdDdWHbdFBnN*tBlN9hT+YBG8k(d2Cy8G@8UD;(Bp& zGC-lu#9GmMs?seke5LT_4GW=s+Tydq==*u$1L?AS3MSf(eQX3QbXX|27}FX>6G0S-?QJ9 zTYmC6?e|k_u@xs19z?8$87+hQ;7PPksF)ggWA7{`o{KgU{$UfDwY=#PGxPx}qynYIfaFo45W@jGy~? zkz*}+O$s{Z-4RN7Z%92|NZ>twD#Jsp7AsHqnSgPPP zBw))u-zs;3Y&d`1*5s`^^vutl{>)w?d-3_fBt6I8TGl^oCh);ogaf7j2bVUb`j%r& ztqk?^fF7nkSF;E}^i6)<5X7CYm_=(Ol{{4DC-offqA@3L-zF6|)Z{1i6mLVetfDo3 zoKw_=*Cf2(g-+v&XatJ#@zjLK>q^rf9Zs!g_L|66S9W()TJZ3F+QM)ROWR?5WY*(Q z(@obDN}C6)Zp6f4I9yZPlv9nGyoH8z{oDmE0%cR7*vnx~yREryxjG9T-n1=@#4zpe zfE>Mc`X?l})V%N;(lYD=h`CnZ23sw4GYgiwZ=U?F(Sl3o;165%)S)Z2%mYv3j;zxu z6yD@8^LMjfa;Cq*pA>#YT3(Kh!*IIJwzkp#gcvn=v;9xd?u?w)W*e`MOv|%@wzu{a z`ffdUT)K3j-kvBGZ!YK7poMkDeCq*iS86{S(?j_vCJdKg(6WR4gR5e82HFLxP7j&@ zuQxjoM2x%5lrCB5{u44$TJIQ!d~g&Qhv9OZ;M!6soT{c;I>Gw(__5Ik_qnFKE`2tC z*ZWmqx|R@F0vN#X>VGqUIm!mvt-0shpcZXL$VHeyA!DlmAu4tP)9*LQ{j$?B-^U~2 zE+QZoC1jr&+5w!ojc*d=P!#KEuSBe;W;4t*FS*yshyt|8neQiL7?MPP zr|{yY)jNec&14FTc;|F=WpgY8+4SLo^37VU%9 zUlgk{*5=@mpP(h!1JSe;nCo^*pYJ z1#=UgS5M8k{Do@5v!~?qHZtY1KTd3VlI|rB7btjDEa`W%>Cm>o_X+F+TrPcCT7b3o z)hh|Jw7blY@TukH(kT3Di$GhkEViZQrw zBTa-!T^Uh3B64e-%}kttfLkN z*jm$&$hvFoR-NXuT0fMTmG6nr3p(kxC#j2f%gxKaVCCQC#p+jbTff94T!UiXd%6Fk4iE!+sZoD{_9=rF-^D{kTR007-2090js=sCf|5e;C) z{BHHpakqnj_%HwpQk#OD2U@SKxG`Evw*|9rpSQBRMW}4@eLum&?K5~1U5YFNO}0RSrt`BrG`e7sMl%1>T*wFPqvk=c(6+XOpyJ!)%$L7Ff{q^PTZcThTnT3SN;gA zXny+2&g4m#=xgPD;Vn`~j7PFj`vecaOV&y1vSK6a9wo9#(@lQ-yKEodbd1)hx=JcW4}hA0$WUXo6#stwu-w=v2DkRfvmdDIl#-*;oM92ME& zU*2-pK?=UDT5K?{3c59WW2@ACB!{=Wo0pGUF#pvmL3>sb!Qi>-dE@-7zaJLcpIu^?G{dWDAZ~pPHCQ!&OF1CuTEP3%jSy53gos9~yrmp-W2{kjC*&o(Pntt`VpG zcQkWNk^ExSz&sX}h80f4{JHF%n2k$&G>~jl8{d!n9Vwb_SvPcc1}d1Ni6mb!$}l0PbwVvHGKHoizc@SXblWFv3^cHIB#u zP+narrCK`covy8TuVh&W|Mq$7MN;PQ{OEGu7J1T75qA=O1GnLiu8a(*xEZlb<1*r2 zUO5uN0B-+IX{{AJV@@mH6Q3=F&wbi|Qvn-SA6+hY0illvzk@emcU`WduN*P&132QJ z3oR8X6Z1VdbV5J{b7VVTyc&%x{d?N|u;33@d3X2#jh zQj747rgmaxG(>(zx2Ksjooxjq0_ZI>dS84Kg8ma79hc^D7wf|x{_PVRYD}c2t-ejv zCGE02gy0c2C$T?0?Oq%L$$Mj5SOxhg@k&|yh-=9}H>#?qQyrQ9vTVuS6Ocm8 z$meEX?2ZdUSrsiApw9X&$KzxsykMG)VxFE$5**Rdv-^m*10@pFT`BLH~t!N%fc_3 z)pmcjUGhR2P3WkW2q%h~H_LRvRmR~c*!`8KI*szyP4Wt@U07ThwMWzRj_G1X_#(wAuw-;|_>6X;ECOzEa-=#K%L1c8DnB7U?hF(2qk)gM?Xb=hM+AUDZU`$> zP*PX|sHEZ!?=7?G#2d{= zLqlaqgqrwZ`Cs?NL05oElE`3pjQ-%^$|nlGm~e+>PgKtS=w!AS)5mh4p~4T|_=>{$ zjtX}S7vAu~+T$h1wM=vtPde}-`hMyBkoa%aZK3nEt~(YBFL`0D@kRmh?a}?uD4%g~ z|0A%iR#+`~B+_)2)v6WYmu0;r3!!acbNUDODZQuK0)9%?Tc{WSh9gIhc3em1Yx|p| zGRRhmw1!l#IuHdhx5HEIK@`^+9UvJT-zx{-GX&_VcAvAoZlr{}H#bb@I z`cXIfh|XU<`>GAOXbupiS)z6IIa?Bf<6xS{#?xEgR;FA(A!idu)ZJ{ZHc(gFpshV_ zhP<7TtgdpX-d}8taFNZ!Mpq58Uk!*a2HrcCW(N=7C1NgQ@+LaqgThfeL0OauY7v(X zz{q5MvgKnWSdWJTkP*Ok6p)ck005C)*-MnCmZf6BQyn&Bi!_U+^U%Q0^i_jU*2B20 zfddHTTS05n^s5GyZU)2|4jj;R9X#S%!CmcOkD6>c{zhq(-RBiS41Li$jpl-F&J-R$ zkO$5tAi6B5n9?RUTDqoJa7-P*RnlDj5RI?z-{}5EnQXGO#S*19{?7mKbTC#VEM2(Y^=1Ks@=I z(%w_?gz6y?5EG=e)uK44Up=G=LU0{JO2SJ|{|4A2#W=~FFoyn)vtHSLK(TY+Lnkd+ z{(Z76dc2bv0GA)0)Jz>`y{3JI-AALvhZ%W2_wIZaLOqf6!0OT|NQ!HV!$~ZI*sM%( zw5EyN8UdUZr_~X1JFy^2t&*i*k{&RP0m+J@BQ?3F87ez__JJ&>$;QkwFW)l9!W4b6 z*{4^8Ht^_1SJsk`EH0vY=7U!8ARo%H!ppD)uPIx^@4%kM{~6Dk+=oIw7tQxT==&nZ zuu^OamD2^0J)V;jMZa~`dJ=k;Q^qMQt4LoY>BIOgl15Zv>k zq_s|#HTY^;+Bz!IOT}R>3;cz=E>@@I^+>&9BlO)m6KP}wB4^z-L= zqx)&hP-g<{|zn9aBRJ7DZzM}%tzi<7gJm>gxN{sUnBe3nahgvn=4C7 z-(kb(>GRni6_=$Azb!3Eo=1y{Vhup`7i&je7<(w#<`Q=q3S2O${>kh03$a|q{V7Rl z05Oi+Xky$QR#Iccfl{$iNt%zrlJ|u0jp*eQ)0cZhn%7GwEQ!?Edt_B?RU+%7`ObvY zNIn9XKjJ1pEia5Az!Jjsu(23b-0OqXx(^^rS4yw6p0JTvDX0jmGr9B=avxxpiRgZw zdT9z~N$FO6MA@Mmer|#DayZ%4VgMU9x8@MSgy%^`h`^^phWy1|+TKd$$sS%hLLmi9 z0I9PnzPR~gF)C<+*!Hs6XM#xpC09d`Yp zdMpC0glC+LeI1!-_1t0E3M~SJL7e6{y2qr3I^o!UN_8CsNj;NQMvkGHlw65nqbS5 z&t@%_f=8YE$CZB_h+NA1+ zy!^x$&mNXPiv9_?!@Z_#U)GOb>`8shPO53#4p%S3b%4n6Or+X|?WeKN=rj9GL<>}( zOo}M#AEhTcnUwHv+HFJj+^9rGP9x45Cc&4wYMBA(S1-)@S?9=3VmQt=W^VY5@Uf|; zYU=Q*+owgfv%FE}VISRRNln+x3#XG{j>EOAf7+C1z!gd_+@ULW5-oWS6z;M3=_b#c zrPE33OA9Nrieldb;;|G7`*R>+$NBnrq%!}Ku-}VQz@=o^2*#@k2(QBxJ|!Z|v$@rZ z-nsi+TXmswPg{>>M`^N+D-FdtW2sn4^Q;zaHaPZe&j`Gb1!P3b^%IMBF!z zURpMhSNkMh*Lbx;h zuP`U4OW`o%n8k5-pW!Ou#pvgAwHHHz;}d%uD!Q*svK}dLHA;46=Dc{0(c}*E91mAL z7H3i>DsaJjbQy%ZES#9*t~b)QxYbNS4Q^D3tHOImQRy$#<_WAR*>%J<%(c}tb_Q~K z8&vCNc8ysHw%La;B%j2)f|flVny!zDecUPPQ$x}&bTGw}CsaDtGQW5ocf5@` zcwqgpgb+KD;chQ!f`-7HBbeqb@Bg|1?x>5e@yALYM1276}io0fPnz}6110PtP?g#y*vr6NBeubZ}?ZZ(j2_`fdp1Ph_2 zb0ZdIGPxVWS6sGv-vaKT7N$D@$fG%py>QNMZ6Jn)jc9npHdCkA1NqT8^@*1 z-m5>HIkMxb7#T>bLkC2aFP@n{uVJ7Et;D_xh){~sIa8gGZo&DU=1UM=r}-O>y=%vm z@d=oW>@&wgUQrz*lGl>Te0Xw9r{}HZX)FY)=%>cluBgY_h7ku$QRdbAE%&n3Ssv4& zdjq!I4>NfJ)Y=_YbCu}wJ@zHK&&l`vkTqU(*!8*xk)Sq5QiH%DHopgBgi+D%C?m57Xxe6k+}j+@I6hUj zS5?K;0B;1lhcxqcK?dtK<>9It&3O9ZZF#y*Kz)aszfzHOhgDuK4YWP&d0n4bQ_}nf zLRCp2WbcvW8n0$L(A;4(y;hKbxZ}&p6wa_igPC8%#?LNe${js6><2arxaEqI>Q6}L zlKSusZ^TfsZ{?;#)q}ZD`RSFq4X)(~a0a73tIg|2DG}E1;1r=Bl?rTcJRs51J~?A6 zD;_KU^gqg){!>N%@2=mF^ztmdR)R#ro3ypHSu+yt&EHu&IylVA;2Y@Z7$_QEhSxtK zM1djU#<%Pbx0hWjaJ*!9S}!!ABV+cYQQo5Y`C2 zqFfH@(v>BMbhW?#ZdpjG@ zvH1Bv6%o#MI;I!ehG8OeQTEOsmf`6IR$iVcLe*-!Wr2TfZzA8{->(yqa=A{MJ$nJw z(lU-dZ3`~z(xG*sI{*MqaSs784^SNNU%bUo{qlQf~&dCMx8$ z))+B0jUzXC|8l6BU$lPR9b-83u<3dopS|O6S-TI2M%+G;ekSZI(ILme=w6c$Sy|0M zE{SW`dh`kUMMWx?v{Z|wH~^gta3Wyq9Y3y5n{5-5f|Qx);!OLy3LdA4F^c9?ZL zSp$z!Q>!hs)4ClCP3)Jp9j<51WgA8|UefN#(>VkrFzh;56HNs^Wz*^)%5;_Y@MZG7 z&5UpV9diBueSrEuXd$;8H(L2ky)IRxUQ}X`x)oO4tAZ7i-Gpt#eJXy;R>SmZRKmmd zynIB3ORxb?ljoycl_CkbuYxCMtejiu(qU z(*EO=WwEp!uc_?F^_d$ixVV?4-j%FrofB#u=oz1$)Ue&ryRv!Y0~@!Jjo6ZvaNix_ z(K`nL8pDE)oD*_AtTxluw%yTFTQ3-Y+~s=S(y-Z=lVhE?#=kSd-qO3W9sCXFSz6i$ zOobjo%h@ZUoFTV|!>q0cr%7fd)6qd&tc?35SpeCQ9X zy|V!OJs$Cz$!2D$v|};FchB)D;M{i2!KV{9Ap?>i+rJw9;P(Aj#uxHys*C2AsYORYV$ zH%i_oIh6y8Y4!ie?q5Af@Gj154ugMF_D>UYoDzHY5puKR>3{pi|GFsP?eDl0ouMj@ zAHKn@ZIf5_b$qq1_^-az9bzzHx8|{sjg-M3d!&+1soNUw%%07sKi_CJ#!Af%E+R8b z$2Y7krrbB@s<2z}3eYd@tA1!U;*;p9Dbb%0o?YMZd|gZmy0&O!s2Z1fCV5RqQ|<%t zP90yGU-7+hA}W5`jDZ4pWwHbc*heKtzd;Z(L6L&>d z95}>#Xo|b0RlDXjKI{_iJn}+&#)b@t2Q}^VswdWmO{j{f{cxL1=~7+V(SA9i6Dpb~ z;l)&URbLOPrlwqbJ7?T8m0ihyxZtYS-BGI>-)DWQy2AZ%+iIb8U*wWDe9a4rFo|e1 zh05BExesvZ}MpcQ2b6y3&jNp zT~USkzrQuReZcCarD6FWWd&WJmv*&|4b3UKe2KarI5Lj&N#l#dSe%AtD9G!7QL}3h zWqp;;>Wf`Qu@-l}Y&KSjZ z4oBLT3vOO3{ETJG8NqrQ*}8Yd6wlRvsJ(C)_*+Kg^WW@0g(s#+wOrFy6%Es-%Tw;5 zqi^`MNqcLp3R{+Qr8FX)g>N}wK+*Hj!2zRlpZ#~uLP(&b>wo|1|Gs)E#Fod@(Bo$J zk{2;KMoYFTs#prccV^(2r{J=24bv1{MI$JzQ2r<6l(~g%9l^Oe^b-SC3+XdHl2`Z-d z_t9as=$S4dM~ti;ym7|6Unu^DQ@zX1 z6hF7^?P;WcO_y2O;VI`rY(P`S!N%UsZA(e8plbvVt2&8oZ5cJhtiJ^HhB(#`A-ypvLkmvzc|j9Db{S zuGVnhV+V^ySA3Vy z0`AqY9lx9k#x7=zlo;h1`VDB?6yH};QM&gn{5pqom{rh*`Tj49$wyaLcf|fy`N+Iw zW=3XMkrJ@U#H1u8RLio#@e!}z`lMcLIs8~-g&P&nzNSXRBtq>Rw^ss3AY{Mgr-QDJ zn*)l*`MyhGkwY~Qmh*r7r^$u57FLUS3 z3Bh!kl7XX=?j4=4w!Se1*X-DC&!~JkLvnaPDaiSvSFS{7{+dRIbcb})YJz5F_O(Yf zruBQgfu2ge&CR{*_S%#+XP53-&qc)X49oPK8CA7{CwI5B^^dsSgVNO1 zy8l$tc1(Ldp~9j@CE*kzwaXHm<{NL6Rz6ouT#4&FN8h1)4apyvgnhOmIpudWlwY1JbVQksLjvXF%@rVdJJm_%k{eM zbJb)BsiK!`yh3AD-EFy9);128exfrKYpAlH)LE8{q^pBkCEZ=#MLjzF^mW-SGz^Ji zRZp|?+}2UhA6oD0f6Nsy(`K@*H%9m{kyk{l)q6b|Hkm_cQ^%ZZeH*$iLkB$Tv9hrT zRhcijY)gy_Z@FgYQ2euPH*Oq}XI)%z*wx3F7vMP8z0Tr4PT3fOS8EsB5O$NYwHSKX z=vm#K2>3YrpCx)0$7+K{(E{UgdCN;H{T?VMxW1NsLW*79t5+E_y-BPrwpfg^vPZGt z({Ie7wk?~bmA+aFLns8R$zMDC`kkjmm^A8xtMjvtKOlM}#|^5E0g*CfQ`tLNmkF*y zj<+=+sWP`GF%=oyt8}Q`F*C8?r1;r;9K;=rT`9WDlLOp`Reo9v;x9_NQp=tzbqolouZe6)r*RkMJWyXoN1xi!;mFa)8oAw2!3vJ^w!*4_?rGkj4*H4>@*93E0ef=s`)gGg`m@Z#K%+QJnUet)G&hlbs}pLXCk{f{Al1O z2ni^p_dtA6uL|+ixloja5F1eA0&cB& zvZ%d<(6u1zt*1A|COdA{-qq`>KR&}WBx>66b&2-_M!lt zr#nwJI9HtSRtk?4PGSA!O6=}nLFDF&rxPqrzP3bvclZ^XURMq(tPIUE6OyK|`vLWC zKHlJuQ)}l6f4!*KQgP#T4?r&(aZ|m4Gk-Lsu@^=Cipz_xY;Gn^o@EoR#v!9`j%KT) zr{fk3#@#!JX-OSJZ z4V6f2gZe@jb)+xX$|A3;?4IiuZ;trWz^0-HIq&z_Ru*|&|B+-1|7oqUIh}vTLYOsu z%hnI_g~@L8CC~+bp+3$7lI)PB^^$#{F}4tiyVT=X{3k>WRg%(;B1AGjt}_);S_l^? z@$Lc&aC%`R{#90>E+>T3W(Z@)Fy9J%o(f+ByVVRs(YD0-p&g-G5K@kXyo{#%cYw62W@Y}z&6ct9`}e99p?#A-`5->P+)Z1nJemtlz7hBV)5N>4WC&^Zi# ze2O-|Wkgs6ru3jbipUZ)?P?Z|Gd53t(=fq(qQ{Q=mmWK5*wyTvw}E+b@K=k!baE3R z*K+L565Z=hjocQlICIN2gP}4)&A=>sZclxlG*IeLrmH6Iio$|W5 z8u{&=Ep3Ftr)k9xOwfy*G-a8$v34qEd_(fpG8lv40rG@!Kx&=Iz}=V_eKS!O`?==9 zB_Mbh$dp7*p4yVeQ<~SA%=|{p;3>_^HlO083~Gy{BL61W`%f!@mlu+xpPn;ab2HQ{EJr7Z{iU5;1N}Iz3HA zn<4Vaq6!?jIgjOen^W8Es}w$V$E0R&_d5dqDBY#L#PQhqMcdN3oiKCG4xMv}cG~{( zW7VAGhj*b5mJ=4&nyLzztuIGS_{N^A%1=q0HQokGpR43irn+qGTu$ajDKXINUqsP8 zVM!n^e|Tz*T4SoWGM|G}hRBj$3}yeAJC`KO5uA{mZn~H|~sxc@&f{^xNsY0(~_r(j2~O^F(Ui=N{pfep zVnEz*1R$A#ZBeTwpe$woCPcQd+i$VrwRySXbT^?+bMr*7(`-&*PFmssbCRanyCZwF z!#KQ*gUNMpK z;TY0qBd+OBhpf`cwS-a!huSU0OwIWImf`h`US5usZrQ#fgsdKHgd*WK@GlVllM#|iTVLgT#_Q#Xnu+D@W>K>NhD%nF(2fD5Nb4AKn%Bk- zQI;X)iAs1IQS-LTJs@nsi?mS2G}a9@#3o{;8O7iHgb-54TWn7Qo}|Ywo+RFswnrPA zwGA!Q@PR7XH3r02iB!|Hgww%(JX!+$0uW*Zf>r;U7531u43BxmexTomvP%I8ZSp@< zNotDBC1S+EhgFxtjttx4jK3`QZ>nS{MYi04fQIFI%-1hc_#bRv9RLq=7SIzMEPz-Y z(DYb6VY7~xKyDcm)*f_qKryWVxC(#&gaG;oAWtIcdEIc{;7ZT$Gve>)D@KqYu3g;X ziJa_4Ga&61r2sZBR}6(7d3_Ix#+Ben^{w^$CwaGSFaUa_csZ$-LXWf_iUst^p&s%W zpikl{Wos`{hoURQqe&H&6#8UkA)rqh)sy?N!0EzC=^iG599ohrg#Ienevy#k0Tj`~ z4u{34qil*iD51_9Tu^v)m=$`IHRF|HKe|jvNEN(YKYSw0OPTHUfqKm-;x&lJgC2hj zpMs*R#i>aj|EV}ST!$#^)(Mah4275HMaoj|y^m)ihMTo#^1P{WJzB+m1DY<+ak1R)4n?0mB$2+z@I{7N{v1L!*TJ*p zzVTV7eFR{AvS*bTqAm@ty^2ku{XP=l36}^P3+LfouWYZO?5yTA!MA9;cei=%LML)+ zjf|S;ptCsNl9Yft*@=&Zm&6FaRrGk3l_t(et66)H*oF=z0f$s|oDZ-@{{S3OrERqe z=ZOoW%LS+t4k=asxr9mtyPJG{(&#eA)!5^$xeDlW`MUK96N#uXZ(V5_UvQlMVQKW{=y3hX6UP}7u4x?;!rrbIwt{fCd zX1ZtRhLg@#<6qsPkU)Ll+Okq9U-HS{A4eZtrN}CQ8XX}k75jyn)Tl*yqJY904ab)O z*60>D&_%L)q+|_yI$e&%lNx_Qj=%Z;Pu3{)KS`9{%s%aDS7%U-w~kaSyxHUT*}ez8 zcfZa=F8k;ir6Uci!4qV~Q*RI8?Nj?`?a_K4<~k2kEQE?NeUuR>Fw0AWkS|JZyd0%^h=z~+sF4#wC=4X*8Qf9#x6{U=* zBYo?+7UoNJhR%vUH@}|fuxs}&t{x*=e&rByLVNTDw8z8h2<(lAL}?%eenMuLm@^GD zq7*UDFLU`PWHlVwQAV(V z+7pgt`Y(=Ug!MipnX#o;KKnlG#wTUB!aAoOWWUb`rw*D1x^DYZf-xt-(Li5H)+0=C zqO2>Ua&?=otIqM?@+Dqc(HP-knQ;y5^zkSqlV2=LyAzfrX8Xs83%p3yy?}?Q%{6C> zGM}+K%j_)ExYxS(3zS;(RHr%^j>VT825s znQZ=9XPGioD$L32ZUQT^z=C@VurkxU)aWsG9i z2S;eDPl%SfD+5Fb3>}&qI^6;koG0IV$7N(0nit|EFx?_?v(Ue4c@C(8aU=@w5=W_z z9lw#X+Wv2F6u7TwxDzyjuI+E^TbypWb~5?9CbDB+!s9NNFSo0 zr3=)V+mv}B0(t`zT{S4cco-kf0GOFS(3!n}pve5LPV-RnSBFE_^VX>#54@*oeS zSe?deik4f!2T(5S><%OTrR5forLP*alQ>pgJkfHiQ?%UdT;MhSrRBD#Xu0dTIVf80 zOa~Bq+b!S&jl~jZZT-Sy{wB7s#oN3e_>x)ghz-Bq@d)8xe6^jhreZ{WeP=7@Mpa@? zaz9uQ3Wc?0hGbUh{7uudNBc%9ygez_*plUqZk&K91DyV^W{u##6N~N2Jm;4sSMCq*8Q^XVw%>@$m8M>~ zU8y%Fiu*k{(x6ilOX$%r^NC8~m7%l9DfJl7O3X2Sn<$MmzW;0C`~Sti{|9c<{%^Cn zq$x`7zC7a;|XTocJ*1gOD@mWwjUVUHtvQ;$Gkc!)hkhsy&&h&M{lHuctnrcpw5?(ri z?EF6IYtk8GN30D)PYfL!m0pRS-RZC}(SE$BUcc=qX!+S8xQRO^XLtOZn=--7tWkY( z*mCd?anp8Qc8j>L7OL}XPgDZYEYg#MP|V$RakFA(Wo2_zEz5e_pZ4f&@VL_Z^BgOG z{NH}V|0UjO#m?juuxVam)bqh7(ObY?V0e58dYGL0p%a;&A&G#+sJuV5Xys(@lP@HQ z;d>J{wQA#6k|gk`D*;u&@Ey8xv9|loIs_RS`(yMqukJt976k}$E<#i!UP_l zdm^H-J<9sUR4Ginolp{yk6y{?2FQ9&)`X1)CDEfDjoH=2&1(9vLIi$&2lKyp}&yg(>&LIYpOMU{T13X#TlkhvJZJmdx>M`BFqDFY! zMRvm&xh*ah`N@UBm1cGe-fu_3haVE{ZZHqroS!`)@3iOn_zwJa_H49CWc+IxhTFn@ z^ey8?(m&h}--hdu6eQXlZ41WC3zZKu(4Idb-WU;!=!!i0hNO#i%Zkx0ok+Hh->!Pq za}z*br8)D)f8(FJrBP<1cj%2kNjjh{vh-6k=XHKsqvZ3kXSeRbfnb)oc&@mzJiw zBmnVm^S@NVfB30XIriRD<^@}P1dSBGoC+({+KlyvJBKUkkQVkbsC9)!!2amp0v)_2 zQVR%lY@8S4r&sw|IXDGLZJMffBmKDOs88Rnb@V3Y>8rK}_gt%TGuXY+WYP=H#x;*V z-#oJ%^J>Z?J<&U$o|iMiS4MjS+SxBwIveg#7nB$?yzE0w{F*|vPmj$n&Yowx^KEQa z9zU)uOrt){T`j^9ab@aUlgZm@JE|3c-N1w*zHY(5tjW(4jIAcN)x?zA1Xl7d#PTow zsn^MmqJtXt_*sUU-|ky2pmJX~qgVYLEBemaMP|@!mS1Mp1;1f;itL?~tTMC3JnW$+ zsi@crVH?T&51;41T=q2R(Hphr{*?bL`cEh#N_CpZ7V>BOqJZ;Vr(V-Mp{U})#7YFc z(eFBAyn%|Islw>JITlB&Gu2j70jy>Ws@QbX$1Qf#8>J?{~l`RM*c4^|Z<;HA(m_wJj!MzEP@dBfGsD#-xg zV&6FUFtaLx*UfnL1tUY?zM@0`(Vwm;>fxpH{!JSgW3^V@vSCdmC(^C%nhOa!r4w^M z#!*J*)v}KD&UsCbgeu|aM}uW+E4(_9i2GfiUh_XrI7=sX_lGjduo-_bKd3geq=xsU>-EHiW*R_|!2ZK)AU8yb6abPL+Ym`ThjkSFHoL#&77tiMl z&yV*g7Sdjk6+g~^T#byB8jK*fdCow7`@8x7$1g87_>25_&(I zyM#%tp~1y_+v1z-?7N-n5MBil`7&sYy581SDt5;rxdmVFftF!(u+|^%yEmps-ZU0; zkT46Ci811`EWQu{fI^_L5nLloS;P0yuy1Kj;HPH)`CgX;aJsx_NhN@U*}H4XW2&W- zvODQuzQTn%x*OhF6RNYIjc9( zmoDmOlBin!YtxcX+rT_WPW|zZr}2Nd`cw4NaOcxfsBy*WKkdu7n?=Xq-cyd-uk|0V zAKd)uT+u=F#M$C3-bSrno#~KfG}ub8$&wE41H$U6%YNs2ton>N`dVUSDzLpgI&25j zl##k7KVA>FFvmra6r#Iudr-|!9a^GGk)|s%c$s|&D68;d5Ly1Yx|00 zCyT8h3DA3OAslMUqbF|l>9=%_+YK?ht-z5~FgOxWyuxle5ux)Ev(UXwI3n_CDK*-O zPi$c=qBoR&w>(BBBh&S?2-0EwWa}C_C(kNges@D9dg5Z_3tfe0e?+TK1-z>Fae23H z4sSZlDIKnWsv5cT@KpZ!Kg{@lc;j64j0oVZeH^X!&K}>y1hXl_?+Pe%+$~*y;YfusB2s;)5zb}Fu*93%eazA|_6Lgv)niwk zpa@Y=qt%7lUf~0_dD{AZ0(?kW_l>5%>c-AskN|A!)y)xO1+|;rv%Qa!t7~Sz$pEM) z7~>XdX$b zbT>D&XTwKm<$=SO#&NaIs+=Ibx|c!zJjY&C{D(RHy9=kQCSxeVy?sWlE<}2B@e;$H z3l$X9SqwQMz^|GXYalTP_RZ`WyYdl>xD8_D{3yw>7MNbIEtpy|S{g96)KV&rpVqB> zS4r&5rN?>G?Kw>2t9cg~n-u&&I0Ago^=#&XQLit2#CiMN!k#B;Om}?Mq4;EZM$}FZ z>rxuaMgZ%|E_0Hnpo@Ymn<2DZB;ea`gj=-wxHbE+y)HaU8yc{fLyO~zQp1>O8|YV= z`|bwm{wGRUT2FtGj<8Q`=(#aoU1j$?F)|;MyDyil0TVuWU*4QD=r_7&furRvNQJFc zZv)hsRw zyW@Pp>N>lxMTbw8V}q_M;4nbUSJ%nA>Zq~IS*b?M&c%;D^ckdH{!eCA)Ja;#82 zRj5bUr7t(WJzjJWHnQsvM&0hVUtFlL_jW1BFG%c$o+>mcfq=Z2SQP-ey!qkIh1=r+ z3Vwp3J_~@Ph+c6?WN6iwd#x+wdaiGaj9-4&9w`ZF_LwiaukG2{DOh=Qd%93UoclDe z6V-l3xZQuCW^O6??(tx%A$u*ISAXe=3(5!iPDR+Z^t*h()A?uf)OV`l>f4X)I)-=6 z5s;` zn~tCw^5Yyokxk1K$qbr(s67QNIN00Opt2oqFbt~F!p2Sk)IY;kz6PX;op z>spKnmA8ATFDgjEP(Gfd()$0V<(cJk@LdDOn(`LnTElbOgn{0 zw5hj1yzqp0?!_NNIT67Yo688KIC_eC5FHul6TZrV6lu8N3h^Xsf(cfbV`h{-412Upak-z)5BhMu~uWPFRk z7+>SRexb%Kc>>?}4Lli(r^i-Q%a=Sk?XH)2**DQNE71^!VV&_vF<<}jt{H!XX#6IN zLC{rBv@L%??IC2~397p|5$F4nS}`U5rCT3q>gJv* z&#c8=%PVRC`}DA?Lmzqfwi*@*73-|@%t28`-OMx|eTk^oBhx~=jw;{)dhWe>+Q;b5 zIqa+YkMh-H1(Utv6CFY2K!={!KYAv>wI9wemUp!E;d``F%7e?4&nJCt%77j3fwz z@E{ewmR)mUXG;#VRsF_AQ|t(8M(ly4)Kta0^$mQYwn4!7R@J>!2UJbGGwrgxQt<7O z#Y;YFJ0BsCru}4tiMjQhf#gBKkiG6$yC%5RZltF_$G{-C(As7}S3a8O$TH^n_aFVI zf2ZtJug>s!_&zW@EtNmsi?V_j^UG3F%~#{U?JPPT8gA<-Y|0|0kK3qxSg%*!USznU zw-7M$PQ{y9t_G>bmY#E&#wbp$Zwga6J+pG^AXH#v1aVWthr1Z1V&ov5IHrU}*W3jI z2YgsWooo%Q{LQNF7zJnDSvfRfu_8*Hp8Z1EvTc?q-7XKe@)f1}yF0yHNeYQ6d;6>B z>08sM@@u3KHTqvIO>;?ckK69AsEq@*X~e2A^%*!>aVzd_9# zqf~XxS09bdZ-z52CvNLVYAqaU3tf4Cbvu4saur9_`oAG^%7#8)1K$r*T*QBCrEN5v z>2?}zwV!oVOnTGjc={eufIuH9MzigFLY5gto zx;U>MxT~L$8ztp-_c_mpiZ}oCf&TCC!D+=cv0209#+>@7SnU4}1Nzq({wrtTNJ4V6 z;@@TBW*q^r@C#V^{UJJrcUiUE;RDCcc0~zSF3s)B*-epNZ=CWs)3!qH3w;!e5)-YN z%t+D;%@JT_a#d$a!Yk@667OXAVAtpU`6*z8=ya5Nv;Gpy2j9X=@j{dwhTrrGcz@RG zFj*}H=ofO0ciazm`jB(tJ2tgsNJ$gRg}N1g_>N8OH2;oGMc?NVfkAd z+FB~+JSovFkPS4D1WN+JkPc9pNYls;8F}oz(+Bj&8is%>~w;u9!i-{a19= z0-%BCvBBddw(-v>|A}PhD?L>V}9vE_~@1Q$Or?ycTv2k7rS2Bl5{+KJ{0vL5k@M zpvBlYIz2tbN9W11Q(K=kbE{T!U7tvBnt|(cBD75*YnDCryjHbh`~_cPN}gR(k}b;j z7rE!(aau_SG2Wg&`0ikD3z;eJf|vo@DngAm7HdnW$>)f#?!t!x`Vxwm_e#L;yE`I> zUIwZ>X3jLvI7EPvYeS*mVYpMBD>b>6(#W!&(ipte>QtOKPwoN z;{ffzuJ|j#{NJ?$YZbNg0PVm~VuYB={r0yJfZhb=nA4o>mG_D$S;6NO9VRjYJ5^9C zfv3Yl%d{G@a(o>fB&CgjMeqw+xjccx`!;SWzUpljTNY0ucDP8k%%Z`9Z8-{@ehOn8 z=nxy6a2Dv5%Vsj%b?Cov^~4L zUd#24d(!EiMOHT#Y++Vg~of><(ZVIi_hn{M%u);@oUL7@mT3 zj-d4FwbzuDqKj8PX9QQYaCUac{5ccHrz3^7#uSOSi{t2R2@{D1y?)GZmR(1Z8=?{_ zoj_S;;vbiDNUoue8gvz^dy!8+6kKBCkPHW`x1Dc3&ElJ)(!I|gX3X46Z*P*zx~=}= zA>B^^2(?8GepAx42|sB6eDBs@Jg8?vIrLt1z2<`hrWrJsp3ibP3u!74RcYE?wVJau zsTYy{I**v9mq94;{b_5{wc_I6_M-*Gwlp(-sH*>huN*_;SLc0Y)fW@TucZW!Em0ja zj3oqRUXy?}+_1?9(qnFc6%e-Wld$8iP}N(;YE3X+9-fweYB2xpgY7^eiIVAdF!Ex9 z`T@gBL8MCYs@%~H0G^LY4u)gB05T9f9`X7%@Bd?wQIPjr ziAk&%;UMFIlN2lLQbF9Eg2yRMt6VP5jvuXWgNlCBR9H41UP&L70H_`6!bHnGqr7?1_6%Qu|?9Z;xD{oSB!{;OK-Qe=@ z^p*efCG($6&HtLu|Fz%$ubJn6{mTEbGjJqcC+6^%*+9>L2}$uk{*S$le+~R!Gw@$F z1Jj*TuZ^_CZALX(o?QAb`;~wFEQMd#eV+6*^a0)9`EgWL)_aM@8V#5`Sce;Ovtx?*>s`9C>G*a-#hSEzjCfCLKZb=bv24NbgN3QM&n>YWaQmB~ zXwtTK0}`+BHD<;lpnSAohLOjhCQIYP9Q%T#T~i;Dm;i2WT|U0CXLv3?f(Yk5uq5eVx5Si|%`im}$)) zu@7J8`c}_&2D*G?Jds>n>z;~#Sw7!i{R>Bs22lwqG!6AznH+bLzrW{KbniImqUptb z%Q;Qx8pnn1-K|$V-F#Ba`l$He0v(Jmf7OxSPTNvVH;V>yA|K<1#d_&kru|+CCg3|R zA?sMMj&DSmGT!lOe(iYAs?(4CSJPdBc#g;Ze^|F+PX|P%va8>P+6N`D5-V&J(~1g< z7{UG#hP(nO9b7CcG?^a}b<9Q9^YVp3@Wae8n*!+u%R#J|Z2G$CkdSud2?U7n4g^4XSL zt81?DaXnGnp{smmEZYN^3i$EI_lsYjf1iEPv-#=O6^XXi=$C}@7`h%zI&O)Mj&Ed{ zU!G^-xj;`i9Iom5CHfJz`q)_UH=Ww+-o-ZZV+cExI!84QAVUJ9wAyIExsnw`{U&MKA`nL0Tpj*Bqzoflz9Ub;w4}$7J&8#;2b8~EyH@-ORA4WD; zr+l@E#Pyy9DuJKdFTdIq-`cwB=+oP(ATPlpwVO#Q?871uMJUN&)uwj=S)*3(Ccn6< zYu+Aut{;hOda&+KskUX@DI_x=6VGvfxsgQh%Iyof&@6Wx3?K)r9*~Kt7y|8r)yF*8 zDv~o4&~VU?4nY{Yz3l&aChpVPO+B+=rYi~u<4;WfCPWUDx3M0!8+cQiFqdNn;e+(; zx^MTUxi4o)Zqy)!O$&{QyGf|Kb0Gc>kNr;k2Qd;pj!v!>oijrYy3fB$(sIz2s!*47L4M%5?e>#!`Gvm9 zAb0Wnf~MWgw@&wpu-(opX5$3|L^Nr6Rr4i`>bDEk^y-5L4Tsqs^VNtCVYQA>TwQgJ zlDi$Q$1W?rf6$-u(j2di_J*~$>9yAuu9@ek8BIoRVl1vLY<<$2ZHj7_VgCe%Vi8-@#cGtv;nya>ioZQCg=|6Y*IA2e< z$#|4{%*Cu>35qF*VPsSwO$&w_SXl5z%iO9p*96>7_Lm}x0*wU>E>T>&pj%9aa84!c zrz7n2p&^G7^9vMuqi^nJ>{?;us`Xtwq&y;q9c&{VvHa(|`1)uV0tLs|(`adcbbC4d zGWlAjyTK8QP(LOl92#WfV`FjOYjvcpzyir8Uh~^eCHfRsI3=YX{!;uIghO3X#!b^t zRd(1bT==c4@vJv8)28BNuchogv^e+G*5}Z-Rff@4b3~@D?k8WS+r%m|R0Ciy2`$%H{=>b$-xB&5*`+Vk z)ThQk=uyH))WE7>n1qbluw<SHSL8;}@k{ooEm{Zd4H8J0&S@Te za@+~K#(hFA8S0sDEl_aF?9uXYi=-3KlCntyPO)rg+b~0<#wc3oTB2DY52)lHS{88e z$Jf3NhCk)ud6R%@7rXpxbl(u|pNSW5H()E$Qat74&PBG8>GWzUj?ir?7r6X> z0q2(DcxBCKiWDh*HP6j9lfF!hJ5II`8axXVls5b@{wHgLRoDmVnYqNVXj?QI4I1XbB36y=`M~99(Mu&awYs z8}eqPRI&U9IltU~(W9ZVY2jqw?Lm1tAJah`{3cxn9x5eD*AlG;Je)9uE=82*<&+$* z*L`fq>YU6^bgCqvkf3$U=+@^E5 zA<^r(ZKe+!d_o8GtFcjVS+A5`naX^xlr5cfJPQ5qt_1JP2^tvB4g+&jQ zWVpnrGjex(39)^MsYwOf!C~ux`Bf=-PmO*)w5J@>>GX(7QT^f3bW4|5+Z}>Vdt%$FMv3lU|}@O(NY!j$HMm@W|iytpqJ zXoPT4d0Z5V=-$6L1{^pd%s%k?!R)wLV!2`yl zlm#v*Z=PnzNKEzlW)V$sxk9b2c{_f4S;H7IhWfimGLxQ3@yMKa<2nD&%n`T_soE{m zM|>Q4s8>Cof7qv%(((${`<9ndztXf+fKt~Of2vI}|^Bm=>3leF1SKauCIU2T>P z_GHL`NpJ+7TiHpyDGf4Cm}#dFbFob`6VJ~~MycrRWs zJqL{e%{!h#1JD|C)pBk{zhHv+{HQb`yo|!j@#QX@`>y$+hYY+n;BMdVxd$@=dI^#Gaurr&+bz{vNh#? z?SA=*(VdJhxv*R-k3-zkFdgs)f_mi@-O*h^AB$CY>Hcubg{W~DTfx));gBPymB)MLudF8{44=3srOI1OD~{RS1&X2BooC+ z3Zn%ds%djjz9<(*rXv=C)H^Vcd*xn|j4H#=!4M9Ta!m&lKdN*X_N+f~R8iX~1jI6e zfkpTFq3zHKZc_aqRlw3Yd+*IJ&iIHWfL?cwp5N2cTiZ_AHL?u(nDlP1YB^_biB4%H zr)%Z8eP|hyN~X>0G3Z(V@)i{QVkQhwctuYRHyN4x-673z3*Ddj++h1@+hzd(MA zha@^X&${(3BkIj^$ArS>ss5;h)?+A3)#c#`#+XqG9L_cnV|wq*e#y?O3|{*1?0w;K zH`3sjp5dUn%LO#w_0$wbHMlhhJ$;BS8$qMI5y`QLp<${C&0 z(_*qpuk4D=MXTNhmW?gBFkdk4k92qalxU&~1lMes1uwW1b;ONzgyR8m8PD`79(Fb9 z08zGQBfg)X27(|g*s|$WlN3-fctzd z3SN#sW4LQFEHq3D0m~l%jf|}-b2pS+!-8K#k@Fv#AcL?#v^NMxQO92_T((jSxP14w1 zy{zyI9|lROO2y-1d&%*v(>ItCQ&F`?n;Z-pON=oN z=NQc)8j^XHl6v+uZgoB;vNnI1b+pi3v0?s*la3+I30tkgN_EaouGe1_{8J%QZ`d}& z(oQM@O){!x$UyMf2>t|kx9z^*w+Sw_%WKU{X#f-;VSJqL64kWD!{W@8!!y2b7l~+~t+pP*MXY0f>&wZp-4ld96keV2rQmZx+wi^i4 z=}ZiX<;Mi1W_&Us{cY7J=i_g*Ip^HbrlY-S1^I=AG{VWS^Gh=6s5~1nQK0d1ZZa0g zfzWS{J&#}wX`~N`W`onzPn4crxV4M7-9yMI6%fpMTRS)lUF2_uFnqS{uAFlSyN3I= zgsLu!bqYYPJ_=z}t$L>oD0;`Ps<$Jyx+8OkP$vEpH?o9gq#rN6UeJk`9zzVo=Y_<^ zy(y7a@}U>Ad{zcd{c+^|-`U>3z0_79(ighiLK_`r%5x!w{Vn!tkgbG>h3>Bqys z6*_V4gpR&UcZoyc^E~JH*NnI@VVrOtd`TTXrNJqf3b?D9C4SlW&-2Qr zo{%G5UpVC+ckM^r=w@zG)oP-4@@N=y;r%5pDC)&?I)c%rnN!vZq@ykwB+6 z>lVW;C3mWs)bTmZyDFC(4+fqOLIfg7VfGiRHNVG)*=Kl<%tR?xg?K~}Pg!^ntCLJxqvVC1%H(=TJH*&p3?A6jad7j}lATEQc{Zu(-B((97az-h?A zrRiD9(on0a@C-8Qal+6U`r`*7u}$ZyoCzB#lkX8h5zXi*Ty&73DEpZTub%7#5M3(-rvB!*m(iS<>-GtgG@R%%{#}b_Z=eV z(phsTJ_+4lrb7!;TBW*yei&w06#^zOW7#F`B=s@MwPDK8`_d8He~L0VDO1*kcml$P z?4urFtIxD16(9Yni^6)w5=t2}Q9!`n&mjoG>n5`J1hmF}1o?%H_ouR4HvHYe>>vp{@9V}J=LgX;uoWNdsGut-t_hMDb8@)%~$lHg?EF)F+?=A ztV_ouh9XOsdP&JLLXpw+yA5j^<_=h6W z#8o#?+&6_X!DoBj%n#Fx+-(?P!INRIRsmZEhsHwsgOSKa(@W@==sUhX_07=lDis4mwNq;}LbH@$7v#IJNodlqX znP_^^{gdhCLg|8s)i>H~`aj=i`fM$?PwDD~(~8~H9Y1?LIEwtN6-F{O^|sGBC>S0` zeEixwCc2!{Ns>QjtWO!Z4L7X=6W6Pne@%Noa1@_2sh5GpI z1aM-hY1Jt`()tc3!Rn73gs~ll2xMyYLYCnl+UA$J4qSMYU-w9g+;P7uK_ED` zI%Lmx3+kx2H9GoOPTkl%m&V>Hb8wY$>B&p+TwBM+HZM^hhQ^t_w+)}Trn-46H zQa_G4emf1ZQI^0TN0CcD7+y2Mr9;!#h z5LKbeDLtQ_s`Ac9Uy~&kMvdh7WVMO`suJ`7^rm^LTfSLifB%Xq5NcjqlMLcH8uHtJ zaG5-=BAJ=i*DhZHkEm{++(@r6aE~kLM<`kltqGCV4G>kqPL$p%T2jvJ&;GqTIFEJW zK@3J8;`UIX;QX$y9%7Ar69lq-me^nR347NZHmV)GXoiX;)~;xkP>q7NRj>Ur{2SPp zm}3iSo))z;51kVP^VM!)5usv7jk5DWE0nFC4tf=T1WejQ5<}JsQ|`R7_G^jD$kFO^ zQ;ck3G3aw429O2hZYUtmHO?>i20z{YTaw%8JOSguI@W4`JotS=W9`); z*RrN05(2u=vg;sn&c|FOxf2dyYa=3C>7<^nOfL`vDm7*l*hcg;4aW z9m%62)%8Wuu?yt8mMPWt%yrl`Pf@At%vfI^(a{#=LPycYr{vTV3$K58c*4Z)>Tm74 z9A;0CRV~VBCDsjkFjRCac7Lfzh%8y9e*Ijrg@D`xNUM0FN%2Pq+xen%aQM>i!tqRI zKZ~!>&1io9WD>gq9tl!+s)0{}%#=cuo8j-{wukRvdwRReA>fZT%k~43pyCd!x_WIe zd>|BVNxlgLnWo`W)$mzAAwshbQEEKe)j_Udh&zI(F=&1AH zgui(8@N_P#)y(_ZsTm!FHUc?>mb;m$DAvLy<-(2T&J%)QE#EhMfTEjVrweBnv))ya zd#*n9v_6R|KMv1QR(Gj0%SabDP`}#r;i?vBF|WWh!YtA;cK+qIUsbpR;SG>-pmtK_sF)?+H{}uKd@8 zX)(W_WJ+H5XL_^K`3f2;ML^7bF?hm*bq^L2*Kv+ujI2h|^QJ=xqY>V$m1Gzl-4mcx_T=D`OKJbO_V1H3o=@`!ZWJeJ<9 z9h#SF3;~OMu7%y+dsRI=j-DKXU~kRVKJRTbKxXONVQ-?hig;T6*WZd^Y&1S2aytIv zdE>B}`02R_j-8h3j417TT+HSJaV@-aLpu0wLE$Dhq3VD<09WvRknQY1%odRI@s9!M zKLb{%Ca(Od3YI@ul)qd4bFRF7|H&k;VDey>xQUosK}9|CPs1%WaVpa!&;p*%iR&?J}q+M&a@=|Y&gRReJvm^y|kwlL3jx8c8~ZATw*7Sa!7l@{;W+n= z+zT~*)+J&p(Ph_vWJG7zKxJgqSms~gtNx(9yGv_{IP(SQxsB>Er6MaLQ7ctT-IC8> z@IUjk>MAAU+(S=x3@@!w^8^=;D6g`y2q_)#%ZHuhOMDl>Dz7lSCTP1jjm&$d zotF$lXxP-VgQ~~Xg)w#=_F|ViZ)Rs4h(0LUMVF@YKAdf^(R-*sLwqV1m0vD!hlB~4 zyoMtV_61seG~9hzCG{9x8Pwf3V>o|~tz!$T-*(s2zPoCXK0sNf>&tnq4p2yIbPyP@ zsT${jc&4t7X)wR4{2Lz2zo++~QtR%mmoe&sGz%csvHQsah}&8Z?ZfA|gtzC>`?BIK z_D5u|&5jl`=Vz`h$zS*yhP@(%w6T3HtQckW00fd3wb3rEDt4SQpwgS6rW=I@zM@nL_lrmUZPra;^BBfZ(cG`Es3&T< z7ANKZc4TM&=~CsCIVh*Op~O(#+S(QDX$*ftq~^pju^>?1Oe8A)!hj@zZM{sR-HC+y zIupg@ry|V0xgk(ysF1l#FZKtkLZaZ7Q6ef25$q~D4kJ~q8Lg&5QTHKPpp~MI-iv0g z@=ryHwYwgrge5)b-D55G22gZ9JeXkzL)b446`9S(r(kdvykSvpGbKfc&|?dZ>J@Vo z?>kMC?cDhg%V9>riuUva3c&2gyPsV2cnzCpGsZ^11Z_E(klvHEHr?P3?P_PB?$L78 ze|W_&iZKM55ajHi8hj{XFV9&Xd*UrUJAP0>EKu79X}vOHVUmSSwA$i11Cm;nL?SVS zYYb!>+O^Yv6OGGaT+7`(3k|JsOF!$IE}|igV!AOdFoxN^dBY8k@(0;bM=J)`>3SJD zmX3BA`|&?j>WFL0by)bP=Y!-~r(6`C^>6#JLx=mmmt{d32=w;~R{Hk}Rve2S4Czqx zJXK3|c9b5Ff6i~5w6T`VS!;pIL zs&+cc;LkyUk;qG2!fOY)Xc@8G-0dGVh{PPd(sX6{w}OJ_ibFXgj#LFukc+2m%Ma8Q z6(m*XPEqjFc=;=OIH7`%m6K|IeRt#H;G`sUN5FEwq7 z@ptC$GJeRq-8YboE3SfraX zAz|0CHv=zNPNG-tegeHUT5hwc&{=AGZDaSnEGBkx$k4~9Xn5dM-{`9d3v``ra&Egd z#*s_QA74x+n4fK+<70P>Hnf-sBfa(i?!|t(Wg31=HPa^J{?@~z_N8Z3i#CP|h0?*h z2rRp6Y#a+_Vt_PXRVN$`rqSuN*qHJlJB9^KC+s5|+Dv|6N|LgG}A2|H!1PFWO*cWC=i=M?+qMJbj^%y!`lpU^Z}nyodOQ# zg5hvvm7wh`f;d0pADpo23h9xR$vslvG&pi{u1SF7n(ZG+Ewe8CpajMFELSH(NOHeR zem~+$!2}VAzg3q#Job@<8H>C03O7H*$g&cA9cdWckkVE}H~JDxdHmjbn9*H`r<2f$ zjwi&}ox}SETY0(_0$S?1d^abRnU2oAqt89O+~y@J?MCOz!xaUub$5v2R1#K}W*varfd?Tv z;K1!neZL*~?y|VJ8$3T|UHS*X29NGX<5O>$Yjkm#$f!E zp@)rK=D{_s0KR8eOTI0SB;xmvD?!!QR!B7ZK-1n1`(vd2fJO}yE)!m5H+D74x?6Yl zmYKrw416Hu;#+I%Tzs*^aPEL-nHA8pX>)sZaPn~+Bbza6{%D%<7HnlxmBY>Cbi`4L z-IRgbCA$&uB+j8Ci&SdSJq7B{$Naok-Ga6Rly`-Yu^LvsWI=h zkSw+uE)9{kZqlfG6)fJ&j$EYC$lF2XoLk0)?wJBv-AA=X?)iU?X*u6@dP-ZDMQv1i zJvOyyHg-~oYJi}!Yqj%&xsw- z8V;5WX;d&Td>vW5TGNpXXtik61+q+#V0&7PZ7QQe@ZJZ#!Yd;k(*%igK*AHKEG(XE zFWwv1@?_WQIpj|GJv-&9;G-9aa%RwcMqg@^75la&HPT%aNCYl32w{a>q|KEYo7sUr zDv*?<kg4x*b@KKp6I zv>`|)v4t5V&Yk?Ost`YJsoCm4Dlze7_>_O7yb=0*ZCRW}W5R=XQnK$=AB(7Bo<2g$y#OIoZ8bId~ zTeYi1x?lGfot9PUbFUd?l>0Xdk*Y4rD3zW!Ps7h~&kxDVXU}WAiCuM|K3w=MlKxldH z>fOrM(ze8?_cukLbv?-q15z5W(9q=0C2T>FIiqmBcJ-lW85CA6e%^5i!bNmTVV2R3 zj4xPF7Mc10WGzLxAKUW61=2({w2dRnZJw`vKRD{+v-H{KJwwr%?oOth&-9fw3gn33JIYQ~n1 z@gZLb?kr|DN!WwUyg+M<_XVIZ>!4;OL)cw&#Jz+LqLpvV0MyCFRb_q~UM@q5RC9|7 zaVgYFC^h5x;37s4ylLmZQacxCC&@;nLhy+|5Xu#i)S}Vndhsb|hkRDN?S35g`kD~T zd#lX;q1MsIR>n!Gy`ea(m^G4DG&M7>SR&*2R69kf0k_$0TUZukuRsTwu}<-;I!O&o zL)bun*$PWCdmh`DdQ;@ZgTl`SxZ6sV7{%wNVz@d9=T97vHg3%4RN;!vOA1;xtN1UT zM>iVK!KyI6IZ=nf>E@^r75eeOF0(P-ys{zX5|>ZqwbiZ1WoO+vS&oT&Rj-z&e9ky- za-=Zv+_a$~?k@Rh*Lb4h-3pagf^96@&xD^}A>f^JQKeAd$6Gh%mQY%D^r9w8Q3UO9 z<&K{$dB{#`qobTRyTouco!sRg#}?>N&VF1>NUUyS)C{!r@0%_T9s1gBmS4D6?UDVU z!RDFCZ|n?f5}>uOKb#G&kQ)~4)aSSTh;;rMML=IqCc(yH2d?xK;?l@T5 ztlS|EsJ}bF%wriV7Y3SkNajO;pt%d6Z!}FC)4P(z#w~L8VH|>rN6#nscdr9r5+j69GJQu6U~r1()E20d81IKWm{z{KRYQO9gkAlg_d@^v zn-?XfyD$yv_z}Lf2cj#uwp>$Fj&~N2&T0YL@@5^=tLOmLoYlu8w-Zb3JawNAt+kZj zqP|HJLbm?JbD7cYQCQ&gP00vfqNmG;@}q|TQYe8sMSiQ9>d{s+z+hX} z%mg7_<}V(l6$P%gRkF*D=HS#e#y5&g%gpT3%Iyr1vxF{dO(=&t5dG4Z7qt5Je4HIj zjOaCD0tHK+K`@<(ME}sChk;a7;p6?R2K3l~2?}0AZkYW-8)|KMEtm+!?3&w- zLMxc1XY8|C`6~*7)g~K8_?v>A=6b8{p_>H}OK&O~=w*qp>~9I?los`ifdBe9mpmBp zfYf^Hy-h^L+kl2pVMsg-3}>1Yp8N`)C6CVzkDnN3l#K@w?_6LY-&Z=FoBc9!-FZa` zEGz%c>P?2}Q%T6{DZg|`LxD2MUt8;)zPs?br7y4l5m$kwEeuofP$1ti`JmGBx zI!91v(@G!ilx$PLtR81-j;Z%*djx;|_}=Tc=o=r0Dm{+9FTJzUVMS%UL4_*?uSHhm z^q*BN{S9AN6*TW67hcTPmoBa%mdZjFPHWX4#%G2{`ZWj_Ui&F+N2Sn2TPCs7M9Mwh zp*5K`jx09{vMq`rqw{}Umb8~KO_*eBn<$#L3mS@yn@IMv+qcLS2Y(I+F2yc{zDCV2 zsD%1>OWo2J&5}tk>5{!rSO&8|laA)6#F&O?=WNjZ3NfOT<>J5jByXYWpY1~KEmMXz z?%Fk#?G209mt8k8Z}$4L7sWZ6lEWCs*dV06i>Aq#B8gCk#K7oym5s+M;?wws{4(py za+Uq>>*7w`LRA~Bvj8_A9c+F`UA-UhT5`C~ue$$3SV~67#GRsoMqEp6wNyb)mph*V zYM*xm9K7a@dTsq~-sj^g6aA^?V#4ybkYc5dT!?bx)6gHLB3aiOE3AFXF-p=zHaAE) z0WYM1QhAJe@{>7;1LPng<|z>`?aZbfUIanLip!1EF>FPR8wJW^ZmZF0)lxgY>IL=5 zRDf2C7#a?#LK(%0mnnzZ)DCZeAyqklzV9?`FKhDmkR8r^n7B=p2NhiLI8ssEm)5gf zY5&cAaTKRlSJ*=x0Daq3;(Ck(s`bD6U;CkFI5ur@3^q)#q@ zr6D(F5$LKUXapEd4eP}J!2P4;p1+6+rZWqCwiWjVtV_feb2w)1W~64&Qe(JQm7H8S zGm0^#IHpLeD5rGxVB=hZmGAO&iqksWS$;Mi5V1xxpBw#b#eGe5e~$F{?4dcdy}GvY zD|l(l>4#*;^^hpAC$m8_X35N#J>oq}FDzsbiw!M!MOjfvkwicU&KQB1jEy01(rsGT zY}m%sGozqG1&BW7?gg5O4n)R`c=5)n&YI2BWVyoy;dMGUD|cZ;rS$;~U8R$L$DYiV z1P|+7o`&bXXx&tvg%vfb`c3dkE0bN9Cwkh;;55^ zo3h3my;<*s=~`De`9tYJvAz4HqOPV-2XHbWztP^M4qo=L#-}exo3<3?c0gs|7QGJ- z!H(BQ!|2$ku$|B{cEZM3yK>;}{?AZHLZx$LBZAF^cOuCh&}(@%=WFFhuE8C1AMW_) zR#iE-6uxXYWX6tnvg>!w!cBN{6KzS4SMS_s99o*rs~WWRefc!|&A}y+Qo7ZCf0DRX zHDlJBUqpAs&ALS9fDw@RL;jaZy>*nFZSRL8BY z;81H9RC2o?&LUwH|5RO{8lRps&>OM#lxR0lf7E321ZE?Hka6g=HPgW%ZZJPoxl&xM zY8j#g2W|U(71M%GXPT6gPR=nm`@=ZnI>v;2ZyV8j@iz*_DigQ-C{Groq*luYvX|co zMKqv$2VCM2YP7Y-uFEqR_CXm!H$dCFvu8xfNekq=A`?Lr(-_*q51~71ezm&Sgc3bJ zUu|ETR&c+MsDjq&wknrn#}1BG(^wed2&WqE(8oR98?JyTr9`^ayo?U!{y9h=To!E= z;~Xx@B$ocR+s&_Ws3l4mn|e(!S~R#Jo6adgR?xO4U31B^^qSIHlS$>Tbq8|SjbMG0|bpE#cIy36bh-Hx8bfju%QUU^^ zqx2FGNFh|ElTZ^v2Oo7n2yG~#gf@nn1QIC;5(pN0ml8@SiV#XLARQE$lmFgl?epws zKWCk1owfE_J1>4Kzr4z;`+I-y`?@}tEEUB{EO8a$;9wl}A8P20jm>U>vR$Y#jROUW zti48FY34+2f#Nmey`8c_XTie)fS?J>=j{+)8_SY3l-Fr!buIUf%u2W1)N7%f*~eh=ZQhYq{e~Q!9wxUq!9n6@v1b2>npbCfla)DW48lt2 z^;_|jk+y~nL!oVt=!3MOtHJ)d23A%bE0U<;+0^y-^GDBCpdlY;6Z;M3{XI!Trqe!8 z+%oGNaHN7r6Whz`))}ZWhgLk7Aq%KPYL7T{e8ncih3#l=2h1M64FON$DUx46-hv#pAxiQ8eB$6vqtT7Hj)5oyjmqWomQc#U5r{$yv0`1+B~XDEtO~CHaVAnVGSqFnNP}Hds3P$rHh}74A$%8u!bSd#pAH= zg|Re^yWKiC#rmebcW2|(qSVNSkElkAQ}l^$7<)Ae5_A1^KTOVDeS`|9@}x|#o>#Q%?1!OD<;#caI;_;Y2n z?`eCFpBE5BK!EzSa&CC8P_vmCS?a1LQzi}8$%$6 z$%7b(p!HDFxHg79;lA*_RA;*^8^GIg{vCrUy*%>X9w;HB;81}qmIehSb=72&M~H8A zcR_-JLQx_jzm2|CfLN!cUw2%Sk6}oTgCMXaZDP*u-nVFsxx&ENv3?#R@ymdb&NrAj zPn46EQ`by>UtbgU85OdqJlR?~yR*$PER=1K+_YTLK}ah^5YwEB>-BO_&Dw{1M#0G| zcYL~_(gvY((@kLF+DHNq{UT(uBD+nw(NSg`)1?CKSfpb!-j0_Nt#qUXj zC;D5uPOlsUS}w-egiF(E6Z{#&Q*DhIwR#t{mzrgCb+s2-DicZi$rIctw2&5M$e6QM z(_4`IkDtmj=&UvCOhM2x6rRv&QI3g?t7o}*v2Q#~jB$#%Z z5@bUrA+i*r&V!Gs-P69}9tPh@dDAsl|7b#*^m-y}tq6S!NbS* z*4WXpMDcGOUy~0Cai%UlK38#Wjl#MN$sV8^O9B5g9dyTB_T>IoU-i%T(jPyA-R0Jc z3==U~A_a!^dkkL86OUF;Hm;*VgE#Vi%tA`S>T0Hkr}tu~sIO9Fy)(p;&Pb59YSv_^6!IL=}I8%-2R|!MJOUZ7hg>!*SC1gqa=s{6edlYauZyWRJd@ zv*p-)g;|~+ZySYdYKj;Mn>3!Z{ZY#BK%?JX?3M4JHb3KFq-{{If!5Ze;h{X_=0)qW zbg|4yb_Z?>!1~WAX!g~ZHm6AHy1~D0x$WcqoOvaTI{E-8`9?_B`$*Ym7vH+dT}%J& z9h+ih%iq8GCc^aor9)=+&3_AHIXp^sp^8qhoZvmwuZ!_gje=V7_FCjASlmy-lRrY-RRsU+SYAG?{UXMs$(1J*6whtKhjsRN@EVzt7D%y3YjM`BDJl0BWh-62BFOB zYd27;f8+>HRBhWgKEtD?4zW=62e97%O(4jS0Lz0_%CyD-bEK8&I0izM#A8JMUwa3akAk(fw zxz3QSNJ%!BJ$P$5slE}V|2*i>t#k8Q0!C9uw7>QE<^0YweN~6K8g1aZUnAR|U>QmB z^^`oS!i|vKmYZ_YYK>8{Ejja(#`kY=U(WhcX84iFAmyT(CbnwWi0rN$w7A}{RCG7} z2%}>({)+zAsP4*-)d{s`lfw~2oI~4E^LQ8b^=jAn(RpVWWcYm9;E)5MR0W} zPTKzGl&|^AWk0X)r}tZdaW!$3ZIcSt+4Wfs*Hn6kW6f1r z-g~?EYEza1q~>NeZheYzQFFByF{7Vj-cds3kgF0XZeMc^NKF64#kyR%np{!lL`yA+ zq6geWr6PCb@H`<9X3hEUSl#}) zsta)BmdMvONvS{z-l?yTSllB0n<)!D&)Jj(iokmOR@>aJ6I7~69tM~Dt`^IX>g`K? z1O7SHd1T1{8!Kjyhzb6HiaCzEt>JBqpnPFa97CZg1?#Xv8r^a=KOv082SGB>ZNO_cjxnZi==RW4N4ESL!+Ys$z>oZ;C)^AlJTY-2i9Uc zC)MghOraHvmb#aQmtwWo!EQANJhylMoNDK)|8q*r?!9xv>P{c|dXa<&!)^FQ95{$!9N zVUVHFKH|zrL@eth=DuiXlSi4gW_O+ZlJWTTh?tw@X%qwn+{#glfW`-e*hA<;Q=VZT^2*r)+J-Uv59#5paD8Ri<}`G`L^q{7tFMZqAjE ztVJP;?84m6@gLw%&tIPJ7_bSssZ!cgRM8V~Yd{@$OLp#2`G}sshYvq+__dn0e&a8QwByNU>a9M0(eh;q@N>B$o+{U(D~;ih^PE zjBVCHN%(SZk1vdV+x8hfpxvC?TbrfxJq&xcCc|kuf0g*VX_d@w+I9;_1frB-sgy<}|u_#6fSJRAY!*6BPPnX1>G^)f6!x-zXFd zxK}Wxdo57NO5s9DLKBJPm+j`ZV1Lkg4iH8z5E6^99g+@k@H#FG|Ks!C)B5@faoRrl zu`&uR26kGTU*igjZDq=5@=T6%o67!XrL%fI+p#>#>L>L^9qvjz{DyYiNbFdx796xq zb~&JaH6f>tARjl<)9l{mf7tQB=w#M+4c#*ENiA=97;qO+?mbiMk^3Fx<=^k3jH|9^ z4zEGwaCT{sky<`|oHTZYygZN(IlPkMucF{p`8RWB{ZrE?-LbCB3XJwwIw0BZmOj+# z)!;^+j;jbPw7O7TxeBa5&i7sEm08I9?WRv&aFVTLr~n`IrEDt$ug`AkWX4pE`dSZ_ zG7Hkq!-!FZz-eN=D;B>A{aTnPP*W-}DEF<(V?niS6{f+QBN8~O?*l` z;b_>+`i+_R4xMw5va;Md(qXRQUW}eOBuXzrnhM=4%Oo8D6d3^f4MJR(1!`EcR#~D{9tf=0eEBAl?7WLARDhmHH#~w6t_9s2@_x-!N z$}4C49g)zr%F>1KZ!8W*7Wq=YzF#tf++jTpIr~jDcQ$e+P979Zl{16RO?FZ(%VdiO z7Q0Qi#%K3E7iZ2wKT6-rpQB1Ff#n+9rKMu(=NV0Vp|q~KhyiY?55#G)ZsqdqR3zvz&Z3)m5{@+`cB(Rq2t0$z<4(o+={ z&%3F7Ej`?x^=`WQvlBs2E-jr!Efxc<;S3-kxe*|GQ{C(|@cvM3o3a(YUvW4$&zYZx z@!PDCEa+tNFX%s~KB}en#-KTB6JZTAH$P*b(yqZ(>!iHe_O%~W=f78;LO!|(RBj)EXJAV9u{O^@*|Di4Azy5H=Qtjm6or@X>_?WlQvZPTsDHbTd6Vh#)uOoSK5$(HLGFw) z&u;w_G#);5*Z*iOrq2N9#<_T#zTKFLeid`gG(EFA`F-Jg{W8cJ#8W8ar(hcylZv5W z9gOt=G9&!8FnTOIc#10aDB#zJejvqraZe&|)#ky&C$Wz<7t=lp__f`ySud?h~W1A#wR;`h~ICLfa=f@&s$Vt&Ah z+bZ(*EZIeH6lRE-=6rW<<)`n@C%ueu&DQ0W|3I~@G8 z3(2wi02r(Bwhdc)64JRTSl_-{STtX&=;;+J_sO?PfzGB98=mPD4fU%bEK(HOwYTjn zbd<2^1=Q+hl#~3Wf^>vv!+6rgd^|Q`adfuYz6HM z%PEdE!ewJ}m9)U1B~u_oBn(Qy<~b(QtB0k0hK>ZW4fpAejP1nC@%{WO49sAc+h~cl z4Gy$tW?*x@%P^)p0k^#e9`W{dSsgjgxirK9LN z+NXBx%My;w)|iv#Hv;;joAquiB<4}7Q0wJ^rono#w}l*bn(IxiV7y-&b$;uoziD_s zK1pZn$l)nS)i3Hd9#GupfVx6%dFJDrg&a15W9L2n8W=R50kt)G8l3%ZX$?7Jq)B_6 z_8WUK8&pwSoOd_feDwIlXPx3p+; zH)ZUD&cTzfIZ~=@6ut15MQc6h=uRO!0_>BH3-?+v&2oPFi|M4iwWkZ2F=@)P6M7tl zad2q)-T4Mp3hb?V!Ko?B#nT_x!_$sXvhOZ~xu2s6aqgOy*A;eFu>I=mO3r%^ez}qQ z0Y9+VPd*u*o=n!xsic|UT*8M2{o9BL1ay)o%RRR zy`D|=gs=pmB^}jq3N@?AqekX*224RDkX_6;$V67gmwq?Vzz&x-!<~niSH;JUgjb95 zFDi2_y>0Z^0+)T_z6no^KAah!?=ef{g_djT)Z1vS>vK~R+{q)ULCiL;vK^74L|1o^ z^R1El%dzxked1(DJ8br9VD3h1#ZYv$@{5F)F-_Bf6|zeW-{69spWzco9J~}%xV63& zuT^vcN&Q@>q>1nOqZO1AnT>h<>$B5<%CWXN!OSQh+aK}YYPSypgME!*w?_`bdGB*N zye6(X9Q@|`a(SxYk%M1#mJ)0J@&|n&%;NVF-A*}|}t;81f59LL0ujq z8CP$I>UsEnwGYzesCc49n@E0DZgx@}EC%?PWjkZPiLDE4_erI<-YLB>wX~#R0y5ae zbTyM_>;YBZ!2o{fS68Mq7Ow$(7k-uN|4HUW?Jm3m&)SPbpR(a#goVHAEJPw94$+27 z;6#}vFh?4@;@46;Vz&n3iLuWW1zIK7@eEz}v#hd_8(+%5WxGh$2M=`SRitOrP2#b& z^YbHNBSDrJcY0P6_^oZi7ate4N|;K3Ff@q=yqG8%E~|6vAS;}bhL8so?}@l8>MJii{|B`S$HF#S5I6Xlyr{LHsgS}354 zIG~k?T|OuOzUlR@&N+u7!$zo5dEY>PyY`{8By97W3{W~9!}zpJbE#{JgM8^H7??J@ zrO$m_LX|;xiYmB$?5O0q|HOpy)6v*l+tnWdeQ|l3V)DUaE+)Ctfe4x_ z6^Mq6!-7;A8ginWJ(4#ejvk;e^Tj#78Rg>9)xG=mDW{j?`y;uW$vzbFH=-d@cpvZ>)2dySsb)=@0prTv=7V~;gmPfRc*<)W6qcaJsHR% z*zOkhnhB0Aj z*?ZUPO&b9FektN^Ye&kJ9;}Kj@#WR!2XcZrNo~UDh-H&6Hl-4d`gE~hmj-GYX?jCT z{+}_l^ETW1mWi~!(kq#|hks4m3A<_d=d*;4%u*zY@c4?hL2;Oh=H z>nUVTnvALfa|2xUR1ARVVrU0Y#!`wEv81%10$p%~kBfTo(GN*=7{lCxS7T?Kms{Bz z8XZNgf4yO4MZ*B0F;}JB8LZW4phH`V;gV}TzCQ~d=SwiHFuW+zIA+o^@~Y1qkB?3A z7Jtg_A57%^(x-n05%k*?2dU=0KJWSE~5@>jG8|XsYJ)dh< zC%MN@h~sz=+I0O`VTcwAR155?4YVEie`N)tUA*?fLOK)r5Z{3|=v$t!YZmKEW*#Gg z{;dJqG3BmEQo2!8^|4d`(HHnAb!uj8pP^L(%le;y9u>*bYVM-y(1%+2ke&|27v=zY8=~C3Dt0^ zMFfSS8|V0!4MN1AGe++va1&wpax=!rGy1w~@H;mYm~^=1^W^=kBvm1h$G{Ofk1p~2GL_*zeJ zNLv2OJ(;15zdFQg4eRE03(KbEdBJj**E>aTT~;K=41aL@T9|U9u(pc~|H@j;h`75m zo8An6^FyWi|Jp&G`a$B8Yb8DWZ4-MyBSowGC-}zxksg2{xz5wpdh=Z{!mZm-giPS) zk$=$qERqpo!m^4X43bTDP~3%1Vj~^}441IrS5VmKmz}@YDJoDVluE zGinenbL?K9f$Kyt(@rlY*v1*}JSLVKr@3xtkR@jrmR`;oS8(d8< z=#pcDUm;6!(}E&d*SyN?3$lU%WOuig#M5n06Bp#fcF`W)MpS(yi>A3+6aoM7b;fD!VKlff7~U(A(hCF@*Rd(_)aq!vL++{mfxysAS2Cf}33T!9Ja`pcxFXvQyjL zQ#T$1Bb1lGHajq*kjUr6d-cWPj#kf9#G@C2IzmU4Z`2uWKrTa6?REdG@1QQZu)+%m z_&^fi+?<;t<7@6jA2OYNDC?Af*h>RWkaSvXrq_atlaHOh9w#0SEb6v63m^hMllo+} zMvg!8o5_M>tt5?fBOi{)$?Sohhs%Z7d1x6<5OAXs+AGzn3PJL-HE9sB^6&DFl!<_d zKUELdk#Go~C^$u0O!tv1RK2|=m-#Q5Z0%#=!{Ons+5O0X7&jm0h1;shSss>n=0s&O z^G>#2JR}pw(T%99h|N>Y(afrZk!NSG20VkTjp~PYmG+FJ89O;nJMRpyOXQH2FLL#k z21W07L_U}CAlFV_08jR+Cbr+-tFUzPHHfOIE``Km$6Y&SXFrakNTk(Fcd!|8C96Oy zYs^>2+HPX%s%K5bQ%)eh&FK~3VTp0_mCk~pOnz!Y_u&j_ZbOoAgVx~e3U}FUVuz?n zP4Bbpr1K1T4(d%%8k=$MI%Mz(#r8y=w4(IAIQBZ^)d%&66qaCn!Ayf%xR2~LC;d#v zr#u9EUclsnaauWZ;adVQz?{t3*QhPP5=TgPbXJ)>h{19AOk>dSp@V->eRW@}e|U>? zAPyL|mtHb)SfGDLEEp*0dq`2>s6DO@Atklfo;>~uYx8h!M`FZ968l7 zuy*OdwAWYF+I|X1)QAb77AfnE**N!MfZwNFr@OmMz2elKZB$sy9C%$Q2{*1=_y+y0 zQ+(nmRYPkj_m?2xcyXYa*=5>Q?Nt7?4#gar^#}&uGQ_yfvE~|z(oFuPcmYD(wvN_j zf^U1Vb^T*)Q)?X<^~1IgX0BWfh-2s{7Wehc4(i*(YO-Y`eZZ=Zpa+GlrZGyS26Y#Z zlmw@gr5nfi4vSLg!$4C9J*1+8ax_-~pe$@1b zUpO7RpVK#GWL?yQf<@xG9>253zD|2Z%9K5^4phvBB)LVhK9Lro)dyxfIv$$;_CH(U z{(HIqVe!+k!tMpEkSxd#)fQw2CIsX^C}FZcS(jct=<Da8( zh|mw_ACwzMAoh{FIzQCMgIazMkA4e>+ow8xgS^Hy>!pxX!#2bAen~m($ui$3oLD)J zybt6p`?UwGQeB2ZH%{XHy6B9r^#yg|9TLUQP@*H+^$(_3ouf&W$w1DAhdK~^vy%*L zu;3>7i=pVKqh&AXUQE+uXK+VwRhpb7*MBbna+wekR+AT6IHwlC08kd~lqeO;0h2zJ zz2N{P)0rD2u2vtbuAQ+_EPTN$XKky@e>nkvve-_H|fkG8t1SFEq_X$AP=D~(?f`bG7FTIxG9xm@YM&$yhg634i zQs+%;h7j==MM)>x8PK}d43uOwX>`=TO0UH4NPaB*j|F^eCb#_k$J-(*9etu%ue(ZO?jwSZ$6niysnuPKKW5|%jZ-PC{MEAFVEqnvLGP!8^Mp9|CHrHS3QIW)-S|5UAmX3yvY{PJhO!w*F zS{tZje>OtUUQc|N#~#mu>q2gATaf%oQn>DB%u_9`vo1H!>b2+SI-lt(_Fpb5k%s~q ze(AnThD_C%Ff@cehI_yg0}FYpcsGdpw;)rqJM5eSMVfMFA$8#H3lPGZ@?M03)Z~{h zJ$vXTzN*U1km9R|FHw86=d$C=k1#cLaacGfrFfHZpDU27Kp>(t#wkG=VZQ;8=Z8(8 z`C@$V*Ej4IOIr&BN0PiDGOFjoN5Gp;f*g-8f%*ZRW=RIn|&S!|6|$AKD9Cu2oXmiLe zT0e{NXXQi%FPWIInsod{JN8CH95=a@p_aULqb7*39J*KgLD~!0N4%^*HJ!}Upq}Qy zTh2Ji92i?6QXXtyjc6M@(EHtjh6W7Pb z6}m|ao}(4US=P`7d1aJ>7EC85JXJLYiKIZ4y;ReqQ?f|g!vRCAx^Bg^m_|gi+nP3% zi_N@bmo3{Q+gWHlUp*NO3Sp%Un`}6soSN;#sxp4>Kt(Fp{@Umvx^oM|1iNyJ;nw&? zEB6@lJ(cjFzk6?6#rL&9`Y(KP(eo!V#vm4$l1f1LJ)v^PDz725-IX-(yoZJpLtWSe zv99cudM~_P>H!DD?tO5GU^cOd5cud}712wxyS?>rDMsuQsxaff+>|1fiD_Aw=4P7V z(*sqty}VP+8Va#|U%G`y#G#yEwC+S)HzD5I)@`e)oySvL@%N7`TC{&1wvuIq+*rtdNhf}CeI^QgCU18?H)O;DD@#$ zh=Bo>uXxm_3e`}m&MO9}J5t*$DxeAYEm-$+GPfvtDWrMq=J(n1IR--3imhgI} zgsWopgj(1)jv^?SX!lLaMI?~;4y)pQ5@ENr@~54*O@<{>S0)Rnd}*+USAJF{6+Wt)j{Gv=U+OlG0?b*Y}^M{=Xa2zH84I=}}rH8CzGbbvu&QG3^lG zw$-DT@0tGgxdlV>NPrT{U6v*ms;heoC`}?U6w0PX+pKc?BrF`1SsOu@==VswYcd9& zwoCq+l1_oVARNpD2S*24IfIMsu2hv+dJS2Dil#NpoFB%e*XIi0=!hf4N8;0{%knXz zzWSy;(^s!929YCPA(F}s$FUt^Na(~Dr|Ss$K!wdqvp2{dCa#lpX#oQen>0Iq-ufnj z_+ioeYkl)taN|c8-3A_spr;nWu5=HoMbg5AACL=waw$EwfDGAw(?5LhMn4sP!__$@ zH2m@G-_RLePD&yVvHT^M1W9*#PK(vxyJ@$!*FWm!hSRoPAu~f!E4eXcpEB+wwue(Y zVX;CDroNw2PG_5-{(d(pWx*D{-yfs=V!UQ6+MCxJZGP#iaSp?O z@O=$4#AUr(;)BYs%NKZf=DAK<^p^WE)Udm*VxUVSXEomCT1WgzbyT`+zc*OPSKd|A zVMdg~FCfXTU6W0<^*oc!tEGnJ^q2wHv>p6y19;S^lYb$mJ%S-Ik_GxnenMiTHvCwV zHVATJ_$^bo&DyA=hq*a}qPZG+5dEh3)bT0k%y%0m{v~wCF=KM2gvW1kz=a-5nry)6g$o{`Nz^;=eyqu=Qi!t$+5ZK%%=21ypOH-@c#F5nS@K{08gp zJ`Q^NrxJ3H89$shB?H5hzI81*a3&{T2^jvUdp$)}J8R-m&E1gKPRI{ZQGD{3ql|$| zuQtTfwO8&+@*J?QtUUff;nPTWQI%nioEukH!@(#3aEMerf?^9L7W5@$BEL}O& zKy(+(cv8!ZKKG-(e&FVI(b|&D{^wMC8ScCbK(N^m;gxQFrHP#^aY%{Aq&T&KO&$;F zIPhnefszf!WnJPdOH;0804pJc0=idvFr#1y1$2&$E6_;f>_0)#upV^KbmZb2Zhp%LG6^o@yC)Qex>Ul8)dO*BgMA zX%080HfAo6y;TSmPg-i@&o_ce@mwdUCFew!c=KQB&q%5m*+v)AXp>)j6|Eu3H^!*= z42DHMyW)ijbpBvwXLjX!(>vyXeb>IjI7vNWO+ok4$(1%CPrc#4njwuBo_wU1>*9BQ1p=2hTj}Hx$yi%%4zl7K&68L%g%{ECMMkS2Jx?JNW8_QmEZ)5WQlOr?!NY*;qQR|Q;_PJj+pucR)H@rqfh%_BalUQGhR zhq)^b+Uns+-@ISvtRswVcBFeArLp~5DABuHx)J9!96EY_Ppj*evP<=J_`lQF6%$iK z&$!*-#$)~fXaw$e0wI+2J$PtUy5ZgZG;FiC&#omywr6Sy}WI5&m&7dbG!*q(nwAV`_z3;R*uy>!Y1&Ay>@mWw>_J1YQIcn=!VGOd<8J2@gp12 z;~tqScAve5khx4Uks7($TXzj4y<`H3X$(rju00Zk?z$-gDkHUoO1$A-bGWCQwn-|` z^*!13GksZ-J+Ic;<{icWOn z0>vTP}2-@wenAbdT{Q!%p-7ed%YOgEJhLQJhBrOxZG`^GjF>aX1BHxkm*t$6f$ zY73N`BDg?i%1p3O34D`&BU;A~Ad5mw*6|=_K!+E0wm)56-iL6k{M-wgQ=Z=>2O(wc zR6lVpD7mP_v>caSUz(r$;KK+DR%Bjxm@mH=`Ym#LV*xiQ*=Enln^ZCpaN)Urj^iI3 zu#790E3Cp+O=-y=@8kEJwa{}v`L8_0N>*genuiu;pPoqRNrnGGYtfP4hw=6!ql7CEG-=RjQ`$N30l@hPyP>l1s7%GW*d?u)|tkx6wJpZ4Ev> zdN`&mO~lSl)R^CJhr=qm^hOs4vrO0wJgmPuiw@`aPadLCFnR z7*HN#4>gy!KN#&ICAX&L64T?0zXKESN5Ad78WwFQ)2m!o7EZ6_9MFOt1bio!Tu;7b zP2DfM@TpZb0KZ~>ND%?5zM}ua+N{E58?I7foR*MyN60gdeq_fSVFh&ay(7xsQIRW1N1ag4`ywX`+B_rFH*bG$A8pB(Sol2`K$Y7K3~ zJ4JFD8}0y7K(U$KvJuv?_5j%_uo~0Y}_9eO}>GBe$}OI z0rBb3)_lO~KJ1yS`nm402roPx*)oJsk1W?y9gpZ$Q8xZswALY}5{il?)jrMQM-bQ< zV_S&jK^!*@NW`@*dEWF3EBO2EL1Gp5Me#rla;%3)obpqlLMMa=MKRu&bK#A3EcK~8 zH65QIvF<4IuYCqrWQq6>5PvcWW9AIjNZP+6_8LZ(9*^HP90G$uVrG8RR@Jy9wfX+# zN>Qg|8Gh7&_uH2wQoY_ml}EGC3z5MQvG!LVet5R`XlLk|)H3gxVgTekzVOtTm0_Rx z2a^5*G?Uc9+IWH$0U7NPFLJ=U=Z1DdF)G0&>V&WpM^`RYoq$ zeVwQ;X3Bid_8+b`fh{3z{r++NpNHr$t3T_`I0xCm9+>nE-gC?>4~BJLoG~3i|65)rGwWy$)vffk`V;-#%Jk|cht~kj^&9J2?XorY3kM5F9?o+waGJxm zhT8S=v912fMXU4OOgxRusDZc&I(J>?-u0;+JIA{U&$S^xuDkVVL|;{tw6VvL6OCN5 z{jnTW9o*eoa$1o|V^kgq=1a&Wp-Qh4H}bOePDm({t7G6{JMH7X>NOnLXoZH-5T3Ddnx5L*k#_*-{!yKEv->S^(7c zj8AoK<~A6*+5qWEhw!b1Cg@S^Nn;NH@U|qEe4RhM1$T@I5lsHzzTm4$yIWK~1%yU6 zj_L|NeD#sqI47!8z9l z81l!b#)@v0mFBFa%6=V1H~-=@>*52S?c9af)rVOxQUe4@>cZfsw;=rEX~poi;s?Ek zc1y@m(P-ioqbq?Ab0X8}rV zT(QxIb9RJZekGO@uEBtul)s>YD#!~S-h1G z-B79d7jz@D)|x>y(0t@F)Kl0M;#8CK-qTt@AV?2lZx! zd>so<3yF|-O$Zp!0gSqn1zkI?e96G-O2`hnbT^h`GshRWi08VkWEmT-dT$?ftDue) z_;TG6@J&nT>fq99?&PMp)j5wFWz`+xK4a)y#SPQ1eb<-KQWS7A@q;O3n+$gxLmLU7gU}Xuh37IDVdXFzoF1dZo+Z_FQUL?FIACc~6=T13RO; z^(w5n-?Y3*op}hoSM`n(a`0sox3aoaR@Z@!C-8L+mUJI>O!v3_~VKkGlMUjHZj z_P>RP^wYT^>)E%>Vz~#c@4Io|1O4mAYA8sEo>MaH&k*C3Ir9SmkiY2Ul9I5*Yep3BR_rJDuCv+wnVP2A>rf_OGJS#2h9Gr|IOa7okmw=?MVgt0vmp0Yq*MD?)#?d zSr|-i=~;bpMR_yWG|{ zkhAY4d?I7C8QL9UAcf)ZY-8`uXsA5s*~`7I$z^s;;NAg ze^kS5AJ+tfo+{zfH+stEQO;ZlcDlGqW~#zNsUy1?_7qSxGyY{}1)vVs_38^)=*}%t z#omllR?T7Q;_3FIvwof+c7&$Ch)+b5#6>s<0nt zvw4#kO^CXzJ=vFN#L}B7Q_;8x1$$iqEuK4X>zq`XFxgT}deJa4X4fg_W$tVs0+-J+ zOq~pc2&P3FFpQPbE9Q;nP|iLiWTn#IS?S-?$*%F$PkodXp5h!Q9E^9}uD7JY!`!Yn z0MvywKtkc|~>EjVa%AtTE^^^!KWWx-ewf=$rrzF=;cOCTM4`Lk-_` zJ2&y#QfB;HsZZ;*bVPVMJ3?P2o}Ei@BCAsBwpliPRm^_XcSOf-B>)Ao#OBPKpi8P# zURAemH2B&|HCFn_al59!C`J`to>KBo(sAhpIGfD>GAZF?MH@&hG45RV8KDDMphP3nl<*x;p~8QLT}MzJ$T{xT|b{!UQY5^%teUm_{4Md z@X7K)Haq!C;4k^ha_mi?S*ZfC+ZA2#7LWEr{7{bn5m(VR%JJ7_-+{o12^~-6_@2))+sy{Ivnvc#F+w0$@Jc5F z`S|7`$YC2~)kg7Op^M@rF}~3A(>uzW@Tzn~({>0efT;kkf>g0AP^$(->w zI%IY{Iml(F=~131Kw1#D@08cgN0Z6cixVa-f`q!}+3@-CkxZb76E+P5%v`UtF5pY_ z`PEG?*t_reOmQv%3BjLEyRr(6>z2pRP*gJ+LHx8}Kzaw)rd`EyO0W8bS7(&W!WPl8M#7&*RP+jGnf-H0_+05VdQll$Kyha-&q6cf z%7ahPX;IP1T4jac-|IKGV`lza-2(wPz-3IhOA5o|woHQ7r?JyO}!kn zp3LbXw;c(!Z(@tp!Dg4~BCvdBr)XwwwDvv@5%4sZRKm!WWLp%fhzQah%MsiR&ulRG z5GVYcKFD;K3bz^Tyqz-L?Xw=4*=u%o=J~Z5p=*g0wdTLLz=~bWtT7i1OXA#c_r3g7-YG>@)&y zQTPgLzFUR2QWduS!c2BN5?V6rKK2EjDekROQyt@o^%{*r#X4P!0f^gAV!;noB~98!b9G1t7ccV+=soqwhW)q@To zQ02mjiHV>sbS9Ty{tl0`F)XS-nvb)3n&MrQ`S&}FHP*!;5;~`$U?mnMYW$$m0z1Ml2*KwW4?|67Kr%1%| zRQdi&&RQHRB5zmf`eMFfftNwiPH7vz*V9xXb<+Bfyi^>8Z=zz&xm~hjhHx;$k%k5i zhWac_P2}jk;z@Szb@m_8RddV7Ebo-zs|2XAn&_I^nwrFtSS{_&hTf2&ox{R-p5pXm zTFxYO<(%b2v7?|d+K}Vc z9=d(Ep7$@GhIrL&AxHD$q57O(Sa67`6l3wcjIKTVAq&{c#wCzcWE;dE9;?8%c5r)r z>V<*pd=FQhR6!~4^Ox@L$u)YcRiLm|X{)!$$?tKz`~qzJC0(>EkVF>0@5;f#k&F#w9Dgbgy*Qw2G7iPu_ z?@gA$_V)-&$Zvw4;{#q+b4}|ZyAt$OpZ2}*cb}E!$$?Ia72sk(bzct5+eBT}`-N?h z^asb6ZzgKA)P`#31^y&S3RPrf*6cM5sP9pE1Gl~3hz!*FcotWICuhg^Tt8;~-z(ZV zIq?S=Mc~`IB=Ll+Jh*quyCFa7qnP#IvhiJI9o&Yn{CX`BP2gW&*-IWLI~w&peb-Nn z!TQXj--vgZ*)!{~gSN${%4_y{3z0ye!#41jb+UeKj!u04nbS}|7@p_-hRN-+E~-mC z_2sEB8>Z`g3h;Tms_T5(KEm}%X54-(Gl4$rEnv1h^B;5xfoVz~nW9L6NN{Q=xmh~h zbXM7;yFme3d;8slk$MT!|EGmJVJ7!$Nb*jQgwD~^jK3ifiXVq~F ztAS-bZJlpp{oRb7=&TLKzS(W?w`3GQb*_nMkYYAwW}D@tTzs-i6tUS(?QSymfx6~6wr?V+C zkmK~C5&Vf&q``A^_viNn+&r3wTUH0<(Gp0EuP3K>Az zXPh@g$$|tSi<-P|y=28ko~%Ej>lnSf(@o)!iuQ`ndI=RaoXlD0&u|k@vQS>bLwbh! z-@4mZ2OTbSA`-40+&OfK6?SWIKvzg4zN5%nqGOuAvKKS<&Rof^w-Rx@wDO?Zxm-a9~+?`*kDE#J7AN{tWChH(`J<&&7_??j*#vWVRpra_~n(ApP=X{ziEc~T1MHK27 zPuwi|p}#5krM`_Pbx6Y8E4B54Ya&Iim^ln^Dkl^0`NZ2tMG_Me_~xax=1*ZxmwjG50A5jwO*k-rJp5`X#OG1)+xvh%8e) zDlKpKV%B(J|&PUB~u8*(n)~uv_ z1G5(K&=C5Ljc0zu=k)_E&D>Ul@ET_FC~)zq^Pf9bS|u&E#pU>lu|#xX87LC~cdeU? zeLhG2IBq1`ll%9vfq{Z+*n>o+?Z}V2oy+DNxQz~;SeE`Q`f_9AEq^p_0K^s+e`Z?e zL{Uf`Fsc@f28ogcJG@pN^s=bF1YdM>j;vT>wWi5auT$IVy4}rNB{$rcwy5R#I~ETPi}2q}$8J}6Pgc)lb@Hzx2I z>PE7zw?#j=oOiWkPzf~X|C79e*oJiZg!P77gC$5DRM9cihhxo)D%6@IsrQ(MKK)t<6j^$ zOXK%?$)^R06|fP8IL_7$4NNw6(o=m{aV;4Y-#{iH_OiMmU=h5;eCeVg64qdh^cenJqyl)Zve{i0!D z&sG$;P3$#|!%^S(pofkh>(JA_`ZMC~p%pYc8xzNqLqwbwbq}7by5P1e6-#t5A;xN5u+fvsI&M~MU@ySh@K-&Jh?(~=5vNvBE;r;(b}uTAPvX^vX{n}fUJ2P>{yvrp&K{Us(s}Set^BY3+>S1!EuW(*q)J{_k?DX|ypbGR z4W3#AGb%a+!*w?+%938am1rdUGTlctH3!sc4(k8u;kT>a6KT0WO z%l(1(v*{(4cXllWA@KCHkE=3{|7!h4MqN!UPQo^&OG=V}kxU@T$_m1Bw`86^NdE$H zvkafc_+(qX+}kig`IVWG%e{-TDHqHZ(7@1%vC(ko&5H;Z5AaXDKFT)9T2kk&Cn{k< zMi+J&`n;r&Y8@R#0?0`t(x&K{C`woqB0V_{ar`A=$WzZEojruO=GlM3rOnpg@Z$hJ zlO0vntkV&0e>Yo1L%LD~BK?U`o-@L@9~pWi2zAnEq>k)sa2nN1{^gkE)z4TEZJhl~ zN{lH&=>j4Ahw6X>!u?$^uC?0NGvPH2uAG-w8ihcJ*O4qLheevVe+iGpm|0h!}xG ztS*bLewDWP6cU1*i##z0)jT`-eco^3nB z(Jwy9fhnE+rKKazQk9as8uinf*<#&yqsZ2cfrNl>tVEjTiAVVpYF?bReYg#ycO_@e zPS(!Vcx5IM+2q`I?UwyE#D*MVHPhZ1z}~Gvvkq9qeaBccwnMQk>$H}3no0G5p)zXm z!>#jOW#A8=x4cZhnVd=78_J$|a{HRL!n*OdnciQTDH7EQHxt*4^Klqx4Z`z@X*BDH9X5*F8mi zvE{Y#esZpZT0&Fzk*L1sS`Kw4TW5&dbxxp+QSd6|&8h8KS*9k>sAPP~kTr+IGIh-B zhZYf+1KHdn8weKii%XPmSpUXf)GoWicn!erICqoPh^*G>(@*Ioe)0(>&ale~t^kZZ z0b^rqY=n9`_x)j&q4#C*ZLRkMHmQAB-92!D*9I?9biU8E;Lq!h+iXV;_?l7x*^(wnLPM$JsEE+C zzclTyA=nT`2@opDh|x}8;KabmJphW2LrF;GwC_@f50wz3Oij2yzWn>bq0rM^WlbTO zb=Namz9r>8skVNh4$!f)^ZPj;quNM)u-HA(`1_>X-PJGcy6^4^RmGUG)N2%wh`(!PxH` zpglegpWkN|s)&kwm@W(YioZ8gEJKXU=d7bd0PaPnr_hVeJ(z+s%3o`)yyx%N1>@?g z=yOdn_v>vxA}*zx)fd*QMPpI6dz+s|n1Encu%;u2K?}w0!ckBue^zqCkGMAz=gxc5 z6zXmhecb2{8-xt}IJHF_IATHkE?-T7-ctUl;!Styt*NO1ZUti)?l|-9ath5s0)SyZ z;N8f#CF|JrMV5X^*+`S%{Pq18R{4?xw_=2~*@Dv3#u#i@80>;|-b1oqSB3}wSq$&@ zvH87b#Ilm34-v^dIO1a=mt`ALb#%6kgQb@P(10W7x5zU}@T6Bw9z|PqQZ{Qc@Ic?= zN%p3957tR5hkkJ$tIc!cM=JfYcj<%pv;0fNt{)wNhk#6CEI`Yf<$^2w< z5FYs^_JKfcK{^tdX3gR(H+zbG6Vwe38+Q4?+_AOwr(902H$2CCO%tE&#*UYE-TT^wtRg^&cRTf#$9mnz;kax6IHk8FDiDMYGu!sx=ZW@fh?DynHfp6%`CD^i>S zcibB_JHn}ux8aEP8H4X>M*Hi7?!H%YMMD!-RWyIn?h;2WjgFY`AW)T+i4T4P>@N`@ zj1)8lsRrp$b^T~4Gz>4?N z8yoAn>xbS4MV7UH9s?Ht_1_nZ|GGQ(|R?|YgIDnh7 zvP$B>-f|8@*l}4!R+db<7*8y_DghpiyfY`09hAz?eo3}nAc_h0OtYRW%oU!GWA7Oy}f_)5mjL+i5qM#Fa!;i0HiR#41|YOwB(#N zkDc)%W#^dfE=m@8wjR=Df*7S~IBwAUOBL&y*tg)(5#3)OV0a3l$9rdA54xU%cNtPE~W6F+G^Cw)liBF~@6J=8+9% z-it1(_lsj!-@462bT8{7)+UC@i!;VMtSMj8K19?;Psy^sFgx!Tlkzf8;u%u^t>2ft zh5Y0n6KEePYOmcNfX0P%v0TcaYJ7;=X|8%uO9J!bv$oAy{6!|PNGx@QWZac zt)IW^651uX`d4BEsSyj^SdA^|Q>$xe({Xq9{%k5yE}(!`I2C+)R%W8MAkfo01d#|+ z!sQ1u%7UsNO;)R2Hat0;EqMiXRN-)M+=Hf7=kqA7dH}ni5zrCiEAGSChezn-KO%-Y z=CDOqJAkOM_jKh*9l#`cyn5y?_v2|Xrv6mM--Xa&Gzky1`0z+PxhH0>gKIM;sHq@5eXR?!|m;b)j%K#txD zYBg|mletnt*xe+vXyIfwtA|`l^{$U{cy=`~S+x0qRB5wkRNWX4t-ZQXN*HcDlrBxj zSr6)0*|ec6ZT<{?m|V!T%V(-M0HxPgX^m7y zM*24ck^Nvn6J^SoR{#6hwT~JqZPjzqrcXA;_2u7D_4&InO+lVX1&JY1K~hS4HBth; znCPZa!KnG=zTO%!5>#{1Ua%ZQP*Nv@e9oq3!{P9i33T2i8XJif4a7l29l-{^+yckLiXs#0gW;VlW5-6UMd;L+*+ zT3Shac4Rz}ae@5J@U61ah^=F5D!)rJ>MHqR20;t!d_#(R3FlCg*#~Oy?my+rWxGb& zZl(`lE?0#&6+5P-eaf9gzV#0<55uoDj+3i~mM^CQO!VZ|2%Z+eIfl^EmS=^1qC#q1 z@{l(Sg-xIrS8F7+!HM22kXt{!$0>C)H+E|tp8pFTQX#Y!5#wG(B*|sYS;rqr@bwVd zQ?cT2L?DJ(;3v)CQM8)ARdA7gqL@f1(}C42YP&SrKske%K^;z?S4EcOmRaKc$1*j& z#k8RzMKEx|XnPrkMk1ZMD^Dip-+U08D4%+F0b?tmX!KIv2#es!MD;a-Z^EFbR<>X? z9y5OJV^p<~5268Dr&7Xqr^3Ew7*9WUx;lV*;}&cky+-1*;m&rUlffz!&(e~T6mQMg z0V17!&T{Rs!s^24cgAdTb6Ie6>s=l1{xb!=l^uosjuUTmeeUz5`zx4}-V1mYJG4|s z^_amCB?TY9K)6_xM{3~8GG-3oojzATz&o+QCOa5W%LpmEHKz@Nj`3n{c15ypa#`oW zQeN_1MS_ER^*H&q3Kld!-d&#BeABzw7Y1@!_r%51$L6C8cC>_s>mo?&Pqwu0l@{!# zLd`n=KBiI#YSalk*ADpm*wDSBn)^U^g1459S^(3<$OkK5u+I%$>X(SiIpupLV*<|#iA#MVVXsh;f_!pi zy?z9AC_yv4+qHZRy^++ku~=}kKm)z%@i;D@&SnDH(u8tm?;`eAQqaD=fYCsrJtwTv z%AK2jVCTKn*{CQk>6fl)M@q*S8Bbg~5+7ww2jmfk6{Bbore}{zcZd@OB=QP5P7rR% zb#@u#zST-nUPzbc^?2&;F5dl z=w+tvlp+gJge(hW?-U^yF;JU%n0BMxZ8yGYej3c^?mF#8zv_I$>$hEg@}q`@BKT?v z-mKFZg5YQY0Q+`s(doxpw@vti+{Rbg&91R(V|%-KHlgVYF2+%VmY*8Bm#aD#Z_#}! zHJC`h=*uVjc9chfEgNn9XOuEts%*csUD^_5cDa;bQSQchOM>L8JdMa)LECY&VbIu8 ziC<``3;SpSNCn z%pVBk#)w6l|FtW6Asq8;O>_*}h`7CVZ`!6x5xoswA*ay87-SkQ8MhwTEZ9c%7-Z6q zPd>-r=-p4E=M<&p$H6M%@-x{Y^}u&qa#M#+GpBaJn+(S>&`eNO%jF>2qPxzHB`%Gu z69W`LJ#EP;Z-gzWegTbR$92-l2_$Sq^S-{uJyl zDMgjF5TBTYfRKqh1xmg+cYADH{-R%0%D7FVCCAdvk(ScUx;Ceq61l>vD6ae=sYc1& z@$;*WU%9iGj(W+JgEi_d6$T0pEy~Y_p|@Qpmg#UxhYb1Jot(=Z2KG_MzW%8H(a+lD z=5}%I+Qfr;b4w;SJVSfd&i1=Cf&oW{rh4qf6YEem*o28$bzg7tme!k%{18_S-0N#& z;#02%qzJTWTu5lHXbds`)X~FX2e`>Ss!#tsOXI88!iTm;NA_*wx=tHneSI%E>e12w zGY+ks9VyIJ+AheGPU>~^XIMr$TsJr~3Uj2ZzcpL$=y3S^m{J+?QwH2>Sb!CBEYB5o zS`xf{=Y~6E6bw$tU(ik|4zTH*Ah|qLl_bi>oEHsTE7I5VTnC4Ly;w4J47l*;|GL(k zW#RD=dg17`<>ZsUxfW;INfTTp637j`O#+NR9R6ch=fU_H_fFx)4^5u9xJftqNJ}-7 z44;$s74W`RgEK;m(P)~0@e79;L0+nKCFzytcyU~!j86Do`mwel4cB-6l;hxsgAG9*3E&J44^eX)U)tEA;;YCg)^3Tpb094kdRgg!3MGtU311N; zj9^?)a1tSwb^4cDyoav}J3ZQ#xAooEc@N+=0!uo9N{P8@f<@?h2Q`N(PMVKayIIsML@5;Qd9v#(X=v$A5PVXWldUN}k z^ZF$+Qk3P=(qxZ@bbh2nwZ<1oqFk{{$oCt9xCe4wN~i^IvZKCEh&PK2@8hzYf}kd? zYMJ{rK~$>MRGHF^?@K=ijNi$ZflXJXA5Qema{E_f@ss3lVoH;)kJ~9Xs+Q65?N&p^KK0A12eCR@lP~LQsR~+Tv&^$o|3J6xxTBJ*szD z&Gjs_*Gt0L6Pt?z;oEW?;_MTZE0JH%_t}}&7pS_X9T57`f3Eo9#lB-pPv4B+ym{m* zCio}PW!G#~(aRg|Hw@&mK=TP|sb&jXz$8L98UJ*f88<#*z9n^EDx{b-_E?O?o%w&0`}fom@7OA=BXJUG8zs?w3( zUDtCzR0>=1O;csRI8Ps?XRW@A(w(5>VQ=hNqWoOPhY>095+uuh6<_v_6HM8J#c5tk*42G&BuYe zLM%eGt4vGc)H>KVYB1=+cNg0{YF*u<|LGwa`rOWMag30dss@DS-Z3% zQPRt;ygVZXB*^@ZoFZWC69fUcp9N^JgV*1VhVhj;Q&!K`i>Qp5t8-O_6$DW!gIkp* zU9#wS7LW#-&-+B#wXB&7a`rH%=8rmb&!36dZ5xxK@C0fwoRT4cqrBMCf~|z~+dy4i z;fzWxT#x`pbti3qBSw7~eWH$ZKIsucC83 zMKEzBVr=>Js*?5TE93uiD;WY-!5s5=m&Z1tsyv z@ZQkmC%j(yMWIbV?LgnJ_T>%IhA-7{zmX7i;2RZ#Bh~T;BhGKVa)oQ?Lf=pOihkT= ztdRvSLg?UgW>c5=z$;u+Cu0vEj#<-?NC? zFa&W>=tV7AGq78ArXHXzJ+T7_??tDtOa2KC0oL`s<#M*=c*g(C+r9aJ=Iu^;){ON0 zA9=fTu>^QZk8-5Y);%fNNDoiaumt$?A$!S}l6t60!?{ z#!tljhbP9UHa`GLZD|`09M>dCWDgnneL3Mng;aCQM(zDR8gF@Sjg%g1 zhE2(9M(;EhhGdy2{VXd-Hgv6M*T1lY6_UfIN~)+V&b{l6I0~Qr``BY$(V`m9Kff9| zf89Mt(GgAl7)!YkASkK-a=u7y6tPG9VwFqDDOMsyL1mrse47tOR=$w=t+3LWor@NO zk)`K{HPZ!({!qL2M5wQ0Bas<`KeehMwi{GszVs?DMRzg7)hc~9`>?WI?AF`K0{s%k zIC$Mdz3#I0-5DUNn`2MGkQ7u-XLm{r^v+^-6D&HLY}{1lc>Qt ztO_npxh$dyKuH4iM7`O+p>Erz&scWvp_2@&H(~bVdE4d0pSjMe;w8_cwJuSe38Gx( z!lplarBStek#+$>QiA$GKk){=1vpa8%ukDXNG6+jlf2kCJWDQrNw=i?;WN78Z*Q~h z9%)Eq?rW)s1)p}f48OMrUe?J^%{LGj6hQ*ExIm1DhsjPLZIU&4#lfw$gHKQqSpCb@5lr?a>lLladz!T*>z6s#_(Fo zmMm}x4vHv(L(4fN`-UmLhM0&qAk&G z1(Z=%1p3+c)h(pH#2?6|Skr`Uxo`17AV5tz9o@~a+!I$tD$WX9?B(CBx&;oX!b zDp-~rurk*2OgEg)q*r~9a@Q)kx`8-bJ{T1l>(dsG_RYwR`>msb?>EfiU+Nkh4;m@W zwFx?&0i9l^+`5Y1s>n&X#E-PHqluf{b~yJQW?>RI<5w9)2cFMVa3Y}e=se0ucd?P$ zTD4~vD|uKsO9wxQ=*s-4$16fnE(c{{cl|!q-7SPUJ-f5@O9U$;{QOkuBrQvF`s#@4 zrfV;6YEWP&^%54Xg|5${>8Kkq+zZpAe;+&esvo;Y`S#HH0=9SQ&$EHo|JRo9pL;wm zhbw+^qc1(nr@zCxOa2|ho2v8e+oT3y6aDF)Zfn_z;0*mtz~+b2#GDUP;ZLi(ex43o z(rdBdsv*#!Fb;f>FWD*h8jb%EECmxb^{fx- z(T%Jh?W))R<*9LrIk5qwmJ~mF4I{7QI_@{7vWJ2*27|K_a~I+B#mni3a~Z&8G_`s0 zwsui_h|b#65;8G66+kzmn#duesi;u6_@mrAjhIL)AY9}^XZ$ev?`u;Q2G^k#4m21pHO6;VoymLP2jcDM?=&SU`=~Zz$CoWX>FxlS=j)qN9A^>sV76 z1^KGcro~h*c3&wzMK}4=mHSNXwWn@_UW@9)abk9w%iEXp9VRlOT>ag*dRN!;q@We> zGt~{1Y3ar@!O&15e^aWFhNVpBA#+Ly)LhRuNhR^aYWrm6=(0ARga;O7l%lsZZS{Nm zcwzw*dFF1y&h97KjM4u$MKqE1pDM0Ryc2HjZJys=eq;)@Ux@aN*Z4(YbN755b{IZJ z2FgY}bPSZ&)c-&Tc@JiJ@Sg>!4g=WvC;?xwDuIT$FqQ@5d1IK-9_~eMj%iWj_=wY$ zA^YHAeP_2S6@K@seK||@3LM2pT0)U1puF{)-MczlW!*jo(6k0StXpbRA>a8;T}gQpX_YIt?rei^b<2%k3@+0T&Jn7+JmrG0FPG_qspk{Hd!G#Y z2?J)?!fyIvK@{>S7 zGZ)S8{`**uU15lTu{ICDjd3Amr)C89fVS(SGzWY7GF%s9zh3&l2~!?$Nyc?O4|KZD z!JipaKH)V7fmhs`(p_9dP0GCEFs_Ncld(|Gt1&v(<ZG(3h9k8fmh6s+ zL?CM5cEf#wQA&vXPGK4ycu=f1vi zrJp#@U}Uhr7v`_9x-IeI*+RVI_8zlfjl*y1-S6TZ4I1FM`&* zx2o3NynJW&7cSh_T`Vf*C?=)VXh_3j8u$O%qF(ek)@J~v20-c`DN0esh6-Q#>o`bUGJ(Ubu{OAr=mSq>I=xUO5-mY(te=Gl>#1wLw@uzS2eP#d?-D-@ivd&!Qf__3e} zndZkD(qc<5K#*`(VaFtNPSk{|JK8t18bKTleXQhq%Zxrnm*)?MDoi_>WsvjKV`+$W zGO2k4coQfL5T?&Wy0r`(u(ix(+}X<)=k3*(?A|Abd9Uz$D@bFqjo~8@62*aHp9F$K zmQ_@*{p>OH!$Dl@;o4<{-?r50ju0DMBlNS}blKryk%;7?`%%%JUak?{((~SkuH6+9 ziRL78rmU(gPq3QG1(MH}KD<)e)`(u5V%HSkLz)KEQ8FT&0mnBITGc3$QKg^hGruxC zEdSN|-uwfg&IJR3&`Pw~*2?oCez1dK8FG}@!{ERZ&#yB*2UmTu!>q}~pzmL#KQ<53 zwys&Jy2W{rR-2{vZTG5-UJ72PTLIyTm}V+3Klq>%WWVz;eQ0orH-6+}&S=3*t;(CU z_d}52WXo84>|JrIOoeNN|D-DgEWfyDl*r5ipbr&O&k3JDA9)ez+R{_pwRXazzUyWrHmd<33f+fVb0!#Lm^WAg-BT zI`S~EZJx|o0wJt|3=pma!Tfd@SyFknv9)YNt6K&wNOqky?&Tfn?wH;Y8S1NU19@4` zT7*i|`{FerlS3wO(;uBWg924b*BzI8q$G)cbQT!^jUV+zLC;jTAJVHW0d2NAkIlX` zt9tvrhPF?ysz^cZ^|-qV-=rKWc2m)T!6}k?ia9s~?!)bBTmb0hn2uYM1LkTm!%2Or zN^uQudZ}w&iY+Q7=Pd09f}uhXA5BzBuM?H<_Hfs~j|DHjqS(*zhsT=U9)>>B2=A+D zTUX{EL}Z}1Y=f!`*;2LiIyOF9?b?40YD<*-x6a1#xd9~Hgk>9(mbAVhxMe8l@huCo48;kCMm z0mGmFrCGI(!@R3XbwkTVgxc?iXqxLleRZYow(J-$=C>|I5H7CxrymRQ{`21}i?mzn zP1g{Cekmws%fJvYDTG`Ver!k6Nx5y}vXJ9;oEqzmPmNuL8EIB1W*qX7HE!>qMwK?+=P6;no{A(G#ZS4%(Ur6TL__t zrhpDnR0PLGs>YiPWeXf)P%<5z0>)Ponitsrq>zVl#QxDsng3HSErR*x&n}Gx4t@w`u3`Uqzr$sGFZbS z!!FBt%}T~xu#ORq2&zLj=kHVr_dN}&(c%lZkwS9o#l@v~kLK5!{g?vE#MrQmoJg6| zL}EmVop{KQ`b&+^2k4n2-uLt5=fb?zc^8)Hh*)!4`#;BhuT51`$`hNGH1$GYMS*0$ zah3`rsdi^?#UrE*IDtE~ipPNj8iF@ZRkrOyy2=ubbvwK1NzNxd1*;c13;#T(5y4}U zqy^`)5Z_tW1T3)Qk6QQ1?!Epl5&>@D z0uZLca8b$R*A4-@zXxHCElmG??3BBc%cQ20cKeu?!&U1JXBjudo(0=2-{dXRm3nZ!*%%CWd2@ z3oAb5lmh5u7=Z&#`t3`Kp{7vt*!Rg1eL!M{08TReb~oC1!0D@hhMY@O$mS~O&NSbh zp>uN5N{y_UFBgTaBezEzJno&;b+2d3hJ-nY08C63^T=Kaf?%S?QIWx&s2!ZW$Bj7U z;gkC0P{ytfcrmE~@_2KlKb%m3I$wEh#N3_Et+tPa&5!pK6+JJEtdk|t0oz9zQi`VO zc38!*4-UbF9WR$ssITG>D@UjAkPQ;b!gnZkvImkAX^*$AfcJtM7d^uHrvtd+z7{((x41wXtcY`W~)vHs}pl`Xe zL5p+!j_t__DDo&3E|Q-cMiR^~!rB`5-92&pFfKx}(@K%K3OY`=BN*Dqxt=O%3)M z?oN(kVGi7lUBgs$*;xOEG5Q2)HxstSl>=BD>&i@KJW1_TZmba*Xx`Ub*n}O^Fu!XZ$ z55HatEHm=LsVY(~`u!!5FP)0#par`-o19$zAPVXbXh=eN2Zr&b?u_Qa&5l5w^6%jgV9XA|!8$ zJPnjx_5wsqp}}62knd=^d_kv*z#X|%3$E9FQe?gbHk_K&)`^! z6xJBV=E=R$mW~{hn_u@kq>D;YS*uIGZ)mLYnno4nF;Pz?8fzcnv9j;A2&T-C@qA9{ zI`rnWWAR%3`~J!Pud11_aLtIiA-vxh=jGaBqw(JFtHoeBc7>!02_x`Qj9;j3;u+gb zLNoGiZ!JCb?v=^2%TWj62EshHk4FwLT_yeOVibYODmhhY;SvQZqIKo1@fBWLTNfWx zEP>5&Zz;EgoSv~xm1EISk<|@R@uj^wfA!cgA5D&4T+C=rp>miBDpZx-VZEa~K2dD_ zpnP8|4Za0f^NP7r^F+euO&%wzyUyNi&qfH|XBEIe$h`^~2Fi$nwBsu({icyh7vQeL z;vmF|>)B*L0By^P^W7rKbQsub!p=zN90AwY6?|Zyhgsfkp+*v8?A{h*kfG*O22Q_o zig3Ys?j?S`@w8sd>04ZYAz{TQ)SE_0zR(|)-MF}CdEdv}yTv6!iRUMNy7h{5i1w#C zoS#uj%4W(Yx`7Z>9NEa@qT^$O*Dwo0<9d59Upu+i0T29t7z4%ovCq1E@|L%pDS74; z8@z-;Vk7LN6T3o>ylcWWl?_Lh3?hMH4G=%^X9JrpGBMV-4f564z#9WupUz47CKkMyTO;?bR;;6E!#c9M za6^ytMpTzFhMZ1o(}Ebpb;>NcG=9V1<&WW(4!@_^D}Y=P=#<}Z_&@`l}MNGEWDnlQ|;V{v5Hnn;1;P4*p?TZr9& z`ioGj#&FAfjDyBs9#n?M`Pu49Ojgi14juZds^w&{4G&hYmT4r4{t$t#ExXymwrgN26 z@2ODTyJZtq7L`t@pVxK=7-&=Bm^{vQ!-zSFv_}hxiips*mx!9ZX(Mj8zj06l46c}& zl#;pM{K8j9RmLwsL%j<*d9*&Uh6%DZGV;YZu``YBG)L-7UwnS)U87)HC}(^OW?(uI8bVG&_~D zFGHcSa&{MdjnO@_4B;1lNQK%wma~tKPau;t4)*LPm(Tiiq~W3j;(9OnB^0BvyE4tL zs=v$mH0nL$kLGBK<241Fb(nzor4UBm!tUr~c%tkDxCmfM{9v&8{U0+d{=FRi`%3fH zSpQdf!~j=CS7y41$03pz#eUDreG#37@G#o{Bgf zef*r@VOONc378OqjN^U%C-(7pvS5x(NYS^Bv1>UAr2F-qQAj9%y<|JN&Q8bHnWC($ zkgCw`F9a(AMNXwU>RMP9M9=ztY5z|Eh7bn9ToY-+}o^yl#qf?$TtRp3PuI58l?B7a#==j}aT zi}B%Q;BskifU7RHUO9b8L`!CgVm$&Vl2MWN5jFZxln08#pjryuX?NEc0bb5$)JZ+G zUXp1&53_f1W2cOCsUpM-;F6S<&d=m)CV%d>qZv%fO_B>f1f0O$kuySkv-_eB(inbe z_O)^(f9}a|WtgTLMh-B6%fC%6rqg%y+E)5O!4Gpy=H~hykNI9jv}6RWe9!#!rDQ7= zed`qL{TmvqFM*n_1C{#z(QrQ}wng1f#vRBn7p;>_-G^_IP2}%2L=LzXkDD@+8#3ZzM{qjLg(v#8la2IJRrCWWGqJk#lC4OnSS zPgLvqlFfS~ZgT;u>vOxIHmS5B{(0k}Vgt%D|5O+<_lHNCG9vtmXD4j^(o+HU2de7t z2BcDKKp+gaob|HQkAE@sPzd#mdRUiSaee9~$#kB1yHpt^op?&q4QW7t5h{AMm=TQT z>cCrx`4bK*_P(j8wY|i?x;N4oS!Rx~^_T_K*l9^3e^t6kPngX5_>Mj5j?omgu~^+m zCz98)eCFbGYzKXmlB<2I=Xics-Re|S^pFkbCj*O86(Uz>$Yc(=?=*L|9k;hhn8x6u zll|D?1FxsQ{QCRAQNMRa24I`vP+9}G&y%w;Ug77*QTJ*F9cE!x-c8rCCKcSu^GEL_ z*G|a5x{MD6J`Oh0A{TKrMIx~SaCaUAn?VVJcz=0=s1(WCJHsk=u@W%oDtzcV;L_)h zPfDGVEi(~g0F3-&$P|64lgy*-vN{c);W(OJLRN1?R5v^#K#B3=m=ru(& zOeM!7$M;+6+?)KFal?RM>No%KUo895#F}j&p?ZD)xHALjTT#Y=m{WZ9dG4TAX?aq$ za-I+t>+N5=Yq$L9nr*=)}csY^og_1nl1!> z-ad8|QChmyJr7;-@$uWC$pOD~j}{-34Egil1@8Y>SJHM39{=Zm z@A2T;pFne{qUz4M|IyxeM>Uyl{d$Jc@dy^A*BNQjkrI%m_UQ(7ORbNN7s$NEZ>kuiu>WUHtChuKDh|>v~)_|3F|Zc=r2yo_Fv4 z+j~EI$A0Kr2r9Rb_kwq5kpjkopP~2!L@jH?uxdV5y;QCO%J7V|-{la;C0cv;YIfD4 z_~!l;fuWlFS^^q5Cmv)VM4#7{Y|c%(1auE=9`~a=+Z7hjxv%NN<2UD#*c+0LqB7d4 z1-VJ020n4-Ei0!WIn|}a;o)ibWY4~rEUF0u4Mb&#PkVim&Sb>^ely}aG-pA_*iy%m zb!OHDC+Zpv<)Bz>Xh%WxKrkd1mkPope9{j#=UnJ`Ex-2C1LLq$CP?jWjgbq*REq9| z_00n<9Id&$Ys^u=7t%YF^dP_w=#s;ZR2#aPn^oQe?AIc+?R4vRr zv>sm(iPjJwUu%LSqiZmw=I(Tlp7X2XXjzU*s$UB#xUaHG~KAx&w}mpDZ0H7RMfxpy{jUUi8P}V$to3{r-SJ9til$oXX}_-gI+EU90gv?z{UZf{&G7 zp3^?-8oL%fU2+x-i7_P<#m$B$*UV1IhvAYg?bpC1=W67tJM82A?;p8;{>4v9jFZlv zPLwrT8pl;kuHGOqq-B09j5h>8!1Z4o-*_sG+bm&%?{d#X}oxQ1L&e9vjMq#96mu@;uw6) zSsT4hs71ot3+KG!M9**W+JTMhURc9?-o1e)L}=$8V-(1m4!FrR4qUyxM)i(^shT<8 zUqIEW6*uQi;-oV&a>B!}-zspySmUp0OsO+k?>e1@bvX|r1M{jcJ+KXX?(L&simw$1 zrc;O`Y3IAa`urnd4u18HTZem#={@4bauUi_9ezz}Dc2&CAJVhKBxfc(xSJWiAofnk zXliD9C|O!WS|mY|Te@BW34575r7(4dq;xBXUfKJ+nQgi~^<1)9slcR`={0>bVjPSz zn3wXiJ3=?pUSCRh94!iC=W5H4NKOzFR#n|d2zY01WYTG#xBHBp)VPs(rmc6i>0;uP zig2;^ujIMx7Z8dM#XAGiGokQQd&^*RK^z#u!y1T8GanMP!P3(T*EU znK2Qik%Q$@L@0Z9E9puU-OnQz`%BLN^S|EBca`e0&`tLtCpvAc6^I**fx_}Ir|MoE zl~2_`nleKcrrYa2&qh)6q1i|q{=OE09_{J??+69>-rBeN&jaz#?=0+1TQzY3Cb9DE zgAH|wNcjlqul>onPFk%5Rp*{;RaYzbqZ85uTHYy*9%gvi59Tvk60urc_Iv1L z<@=Kvgq+(&BSE6$<^I|&{8iRB8_J=l=Qe$Xd@t@OC))VuY(JmZn1A-s`Be2Xbkp7i zn%y0tUXs&CV4HjJOh|^K^UFR*<9qH_frk1Ut+&%s&ia5#$5cEji4i1nZbsE8pGZ88 z)d^JEbfHO)RRr4D!ZMspQbAJN8cd(5fIF&=R7u`QYFE&LU+>?wW^n}nVnSdA$~O+Y z{j^6?FX^aB*Sp82GaU~XGk1N?8tV6<>#TKN4j4^Ytb0CJ5;BwedbL4qC_*r>ZGc8* zt2*8Xa}I8#E5ujal(|~l!z+TL2G1OiipK;?J-e>cA7zRWO)Nwc2sXjFkCv531lG^0 zK68P;KNvHV3I1X?~m~CJX}~U5dNCbd9mvuLoU-C zkM^kFp9=S=;&$_hSM7Z-Ln>16=94wn+=)BGUgHX!LQq_5WM7i0kroJP`ygreBkbOZF?)l&4V>O4SzH_pd3IzITX;%ylLiQ(cO{Rk;NN=C&j}xo zr8!!u`@PiZedBnxxFUWEI~M%#dT zTb=d6x!tbJ_MHiy?GDZc6`JC)#*5$Bo`lD2{gTgf1j^oFFq7AX(t}yAYvy1zAW@Qx z#sYvST4%zMU?c6Zo?qgKvyA0f3u?Nqxd`;xhIva(?)x=v*`B(t^gyAB@}VnP=Vhjm zLo{*u2nHdnKsd?{h@ty{5xFzH@Yb^q0Z5>fypR9OzR)=X8%yZ*RX@Kk`~Ft^+^BKe zzpCd|DZ!2{1E$(#so*f#Zic;fHqPI(x0@z|dgombEm2g2nyYGU%eV?;u0j0uNThBC z4mWO2jU}ISZh21#Q?AP~rTKePUK zz!g@MqF^3by;JtQHr``11?|s8Q|ANk`zhtOZ%@&G{&ZCH*r?2r<0U9ND_B5A8N-bt zyY53RCGq|isbRBO3FCjlpU>y@f)0NtkRTibyriHG*~;fmi#8)GU7T&^Lb>de+Th|| ztg3p9nhRkpl_sKaBn~2dbl2OC=J+qpEcmZo;HZ?ODi%Zh9SG{A3;u&LwS6ZPWPU9jv{YTOAatZ1k3 zg@VNNW~JC2KSrkgr*r7SVq32z83Om*y`$L$S-2MzL$>!dI9lU|`fL87X_JPq$d~43G=Gn?7#De&N?SwlzK`UgFiy$42>8^?(4LZZTeO8fXjjwKvWmwYyBo zZb#y>2gawm)0adv9{Sn&=vkNcnpwXE%czB|`-wqj77H{Pp9~ol7~L}x$7{_Zk&G%x zQ86KWURxTC0#i6b4x>)&-VwDu7P0S+7`mUP2;rvI>pAe95O&ZuJR1zP%~d^1jt_CF zwtYU?W*($!>G-+V4E4@6eF8-79tI|ln|GV@2?&Nx$EYsOaCk$9e2`;r>-I8_0+tQK z!|D68@m|8yN{RNC#uEzg9yFWNr^b3si+W*y8ru!`=(W`wa+4+l9;F zS~Y)bnRcCWm_^UOo~U$O^qN?=`7K5~*m7rt3)V|3;K?q;su$kpsf|`lY023jpKy2{ zOsQmfxU|*}XPMGveKCw-pELF#4bRL|r$CqzWcU{f* z27Oc6O}+TGyZ>tpHHpZU>-c(%?YT6R<=u@{OBQ4hpdegRy;nFFCg(6|UM>jg09zvl zvBw3Defxffl=ZbI3ZSbG>m<-`1IoC~aet>~fwes@n9m_DT3^6oJzmP9u-jBVC6AnG zY9r|Q#wdKY6ep8`P2}87*xCCp(}UJmRjOy)x5KW#@`x?E(QVdxthQ}ia-y%L!e;5- z%H&cgL8TnGR?({;n19E`Qbf0(f;YPymNz6&#EGPuKJ<@MJi}X8(Q}mc?t-~vW)*$$ zkw$V!I6*9iZ_Lloiu(4&mb6GNNAG@v1x#5{CsM<=gf@J7R@p&rWeL=@-~N+%uvE^C zm5Z7&gka83iGypdDK92!=9Y`jNz5>@+0?#tyxVTDm zSokCLGIH{!3aAAQRRtOGgWMQ^L{VPiDq9{rmGX63m)r>Icu-ewo)EU&>8LapMt~2_ zj^$Lo$x>{Qp|&Mb9tDIVSmW zUT!QK-XV_O@<1X>Z}vk*c6JoR`N+X_Of*k!)a+XB5kdDT$ozWjw)$o6w}ZGkc1xGR zypQBcp149n^x3(SNkPsO(6!2c~QbX3ufvwG`jC9tTzC-%rVS@M(j00A>9D$%}PX8WcXfGGyo6)AO)F$L6 zbz4d*hQxYb&WBt4>0G!$XdL_oC@6K99u*yd^HZ?-9PU_UFb{gHiL^5`l4>V^g6?-r zzVEg+gC>L@kTn!}VJbQrh?|`l!(BbGxXYJS<+&jPhFc@4T)NG6Ue|+8Qe1gT#9tii zxpY16`SszV<4~5_Irqfm;gYPY#1=v5IM8beaxH3_iX05&(BDq`-1_9;V8vSe{_3%;A}nCEQSUjRdhK~LL?53Zh=HUFf9-cc{! z=_PLgE_&0J%dM-!)@G#GmtF%`YjR>b^yF+#W_YjY7<1U!XQ3+brUhoZ4)m!4?dvy6?FhzTh|I!?{sC6~3$o(9S5UUMQrRw4E(1nHgLQlv!+w%dczz z)T~J~kt|YxgmFm`jb3fDkc+!A2bPXDoG+pl>wA&TfIWl{t;OXPP@4Rzt53f#)!u`_ zrA5xZUNSz=$;bnY|ApF`q9HNwzDGgsd}Xb!_5>*gp}VEa-{A zMR4d|8pK#CP<>=R|9xcJLw%PsbnCr%_&YZjpK3={64A)|kxR&?i>qjFKO;E1yxk?e z;y5KNGqPB9$FTu%5m^(tXs)DgE!dna0t{0bH#+Qfu@F)9iz|OyxS?hFXQB9z08p^Z z{Sx&!&6!r&PUsEou1BS5du+f)Nlkx$&&v!(bc6h->RPVakq!Vz*^TvA7TZ%;1~ zUsQ!0MN1L5X43@A23l|;%m2v><{Y0JUApAjTC#25HfZZyAD@-fyAy;ijLJEJ%nP6N zC`PJ14gf)err}Y$-b>lOE=_HqGu6rtc0hjCy@!FS#YC-lK6?ypZH?5ESmmuBTHpZp z)Ya35bC#^2-lj;TQNNS2{?nf#{;LA|Td32pIo&HkuK0kdon~ZbFfB}SNXHcBniP#7 zi6cx!0b-JmlZYq)V!&`6g##`)mqZ-se;X34{xc+q7f^KF|2Rm}-ZEaRty=GayP7~Y zek0605TBha@p>jB4w-*g%dn<~^)wFWQgmd?(WbGPYR`zmJca=6MBp#6`zJt4GeF5T&sMfO>SyhHe0jvOAcv@-8m0U zyDIcC<=B|z!k2wQX8`X|myHdaFh%}mpkNQE8M*_wh$1IYq_A16Lr#zRW7R8TpKKpW zEHcev;2Y9vp4j)O5v@GFoq%*tT|b?QxIgy zd#KO1FCMwodQytf*7DlSrsd8lV&;K&WYum9SHvmHyh|S7tAEtn3#@?h>(_5-O*%QN z@B7=WKh4uOU;p;&81(6ijJ$$-o!OUtr%(9`Rw+qbm=(yLOi%WX9BPYuh?S4Xm?m>| zp~*G(NTk=k4-}(FX|H@MWqszXAwU}s%Rq#3AjlyaBT}jMD?>Ubc~0Q;`>_N!mfq#& z>shPEtvcET;^l&uKw_Lmj-+>Nr&c^gGJ{NCuhYWk>LYjS0J`<$jPt9qcVF#P@JUtu zlA)!`*B`$ZcR%p53i>uB!rhc-us~+;8P{i9^2~Crpm_bU|_-#vH z6U73pXpMnR7`xuH-Dbq7C(MEhqPYOghjjQa4*jJt)mFfxb=l8+pc|?EpJ$;%d*}~h zQ(@+pePlp+^xxb42ev4;ppsNqS2u>5yf<1zqT;I^9otJItM-*!Hrn`p<(P+0ZEqx$ zuAlbJjXKo+vg^Wrolq%}ajBw>R5)ZmMg)o!4Xm_ku?GqeFbp!f3O8hGQFP?h_Rp%s z5`^1U$jJGJREpA+t3&v(Ap4wjhJvvWb;d~WG(CL}Xadb`=4GYcnh%(=FW!}htM5z<7)kFH!`9u=3f?x2{pBQbi zbFqtIr1~d}w5LQqIkxgrR-n}5gn%;E%g670V5&MX0XJLgYP$Y>j zjJf9L*q32iV=Gc)lEg#85^z9PEUQ{Yz-&Gm{Va!MNxIu+fHpX7{`0Y>&}l~Vn4PFa zA24SDxRwYu4lSzL<8*Zp@qHtbWkeiy{_cfuVy$8iWFk&Asy{ceE9486+iU{`s`nB% zKE@jxYk*ptWW?+WtTU4*2@&1l_vLp*9_;82jV70`g|}%+ATCuFOqBHVsdyI^#g%mC zi*+RpEMhDo27sFt=&NtC{c{$eXIIck>45QZdiqo5e>Fb)_8p9H!6%(krTX)SD3t!R z9l8+T%9`qjA~zw~lv-p&VpNH9vL;0HEP}Nf%tx0{eY(%)+x(NNX*#xpNw9sYAS2^?9RY4N;{14dS}ku1O!2`{U# zsFnjMQ7u-3$xE%mHYe+N{rE3`{3I12Tjm#}-Tez31w+=y=xDjmV3MnOzU&hRBStTN z^6YhLwwxHoL>+4SP|60survPDPu!YKYD=+lnyz-UEr>Q|bNAA%$osPlz!af@WGGeC z`9_XYm*&|~11ont*0}_!wT^UbHqBNKe}aZzDHk%}IKDj8tA$ zUU1(76PvIqH-u8ZP^xWF)dw9$g@JUAyt%th_fX$9S-A zb6<^sZWIbfWcNl`gDCK<>Py1hvcAgFEZ025{&@OU&Bs^_Ug&_QTRinz|ez7D81&*jKE>kW^(^1DUJsboF*kT((|Us z>`BpKj=S&|lwlx0>bkUj}hqlT>WJ`fnVNkTU&B{#uBZF5@c8u9V7#2~ZiAU97@(A4Rh8_mN9=e4w zat@{vW7`l!kF~wCu;7if_@yA$`6su5xu5$P9zPFSVk>GV%xyjEds$&B;f=+3q#cnx z62k!o&zLG0- z`1K7TPP8hi#>U2>Ozf0yh6pAM@Y-1x6r5+TE*J}PCEZR>JQQ-w1kwz*T{xW+ey9(e zjMH7mR>m}jk@XOnC9ju4vAYT`FIi-qG4f5aI^1ZIRL)f5C7KTBj`z8SNy@ zbI`Hn8Y_#yJw}fb9`qnwPy4#>5;n%LIy4f9)dL=ZG;VPgR}i)r@WYJt%l^4{UEB~& zUrZ3Dwjomk%7WF z!`do)?4P$L9NpJ!ppHL^=UpoX9iEBQlR%&L9+4GoXeA3!d zG&}6LZb@1cVr&?z(0G2g^Rhc0xQ5%ZM?jU`Y~XYt&-HCe^m=-g=K3k+++)TOd8+qc z^$RbfHrr71XT#;@vvF~4xaN-mTpbu9_2w^?Kv#y@g8bCIf|;)ytFng)Tyc2VnQ4{Q z%F7G)1Je<45%N+4B^0k*y(LwCnF&JVz>AnE_3pU|u<@g+%CpIue;ZfjbUNIcI@DTq zxI92CCAvPAkc>k>)%CNz!?$d64_g%gX%!Bz$md<>VfTXuTH45OhPL+gRX+4)=U~me zUu?tM#C_-j@~-Fp+D)e-Oq!vsN1nslYNiz)TcRsXWB|qblt9?U^#?K%B`K`qP8Q}$ zxd))Oa>=g*i%n|Ds5XtP$7f7ED)DFqH_17p8+(@D=eRpb|pRHGEVyFc}#Wucl5w%LBw4mm0{~@+#TMCH3va-K7+}D+ho| zpJ9`lZGC%5lu)upI$fcp_7c+RjIEuOi)SU3FPk21hcm3+ZNp)wFB`HFjP;Z2> zD3W)=My91Q5{X1Yki899THajg2Ss$Zj z^ErESe`vh|g7Px_&#H-#7MC){yeipHJZ1=b&g1Fr*xs@-imK$LFrXJPFw}+}5BMlR z$>%Zr_J#Gc*dTPZ4>O@zuu;77Ck7zsnMlz~#XLDg&t0T%^EVEnIA zUHi3U@pxJEJ9?){>o*2o^IOBV61T)K~DsiR>AuyjZGZ_{Vk$iFrhj< zCDU9X|7o)Pz0N~r3>xGHHtD0qs-sy6M?R%g{&%YxPq`;-)KM!v@S;ijQfRIl;?Y@a z7zNx{!mZ9z8K_sA>}S2wc}va>FNb?)VT9cyX?pPWHj%sIgUzaCh^Iu*TTSck0nM2L zN!-#J1t^d()l;1JqF9XE9Ezxa+!~N1WGI)sYWS-iTT^|xtA`NnxRpd@pKAOJ%L)B# zY-Mv};i0@CV6-;BYmD&62pLY~o)q`(itn?ikD(cXwQubte-V=|x2qSS) zCN7`4J@1g3vw3yuJif|YQ_SR(d63*rOmif5SP#Da#z zVw&+-k;<+hpd%VEdEsrSuJ#`8XFt-#o6sqXBNp7{&y=(`z%&i$&fiY#=U|^$*mRL) z;VS2}kOA5Un~VlZv^Ps%_BN4q_eu?2!_XiooX8AL;hcWuUm;N)UzH{Y_rEY*aPc;1 z!pEcl(?l~brK=nLe}{S1@kj^Z#gG+@_7A_xD(Ddbcb+kU#!2KwL3(QMJ>Hd6-(9Bh z(7e`+$_M?AK%!m1u6PtmHMZ3#C#PGjr8uqWiWSFwPoz-<+^57Y@PN4e<7d=kHC8P` zxnntVv|s`PtTVjJnckhiZwQhm_;OvHUyu&lJeO@TZ~1qhvor2)Pma4yU9NZo+HNz} z_a&J$PkuINo)I&S#)9qM>OP+r zn$l@=@aq*b5y;RUd$e9&ZM~!zhsVQ(r$r?AHr{OAE#~f~yTIcTS6v2A=m6o2JNO=k zr**A#a4nCAnw~+78f4nqqFQS|{IA6OE<5^H^}}D45(%P12jJh-$7JP~`l8k~NY?Fo zlQ#Pp-9uN&XNEwe?u0ryApEK?F?<>3?~^2)rA}4=3_g9EwQyR>Z;E%Kbc%rkx`-^>)!Rh=()NCHk1wHEU9w^Cd zk5?0sv7(*a59HJ#Mk{GkX(6uO{`N-)P7PIdlVf`H4zsb!M0c5u+9_7GhK3dZ6%mx9 zV4y$b^uH_~+Y&1%r)TuQIPueT3u~Cnt%2R&IM=ht*oQWJ|7(g z6{LaurKN$=!1oA~2Tr*rEY7Z8H}dOwWscbi9+_<->&vYfazWYL0b3TX&T&J9YD&~s zgQ@6d!c-KloUjidR(1L!9XiePB`)|#sA5|`=|IChkv>zxeK75kSB8G)lRWftb<&I) zKXW`Bt?6{WkF(Ap;?W?$ctP3OPmBEe#*VR!@lWT%n@97>)KV>vIok9AeZNjGZidO3 z%5WZsU+lG*&BX9GRRuJE$g*cFAUVR_tL}JG4pE@JuvQXkB`%2;K9M>6Wgi#Ueif|y z2X)9W5L+I3)c--duxK-dA0V<5Y>vl+Hv;LRqP`9!jRe`NDdt}3XAB5iHsg7fNVVX+ znKEc2A+#!*_<+jp=QDcY7FR(Tu8+Xwm0A+K5k*%P-^eO~GgkkoQ?tD&8Z#15-ulRt zl1a8`;UefMB7Fvftbo=obM^U(KAbCI@=~%}Z4o2qa2OUTDNEJl?NOp7W&5uE@0-Oh zY`(^HXo`S55i7qqRcFvMS@rLihxh@lde_sTS$Sw+u>qIxC)m;n4{`-o_ zl#GeM_droz%!TqQ4nB~ksoEJm~wt61ej#x zI|0vJ_J=`$Nk)E{tzruLeGp)hk?(^$bJZUP0VWywVYZ4X==VW@Nk+a8?#xwx90ZtT z9lB%7BzWL(!o z**cG%3%_~u;nZ(Jx90xwiTMjA9?avwd>j5lEijbG$7CK`$W diff --git a/docs/api/img/api-versioning-timeline.png b/docs/api/img/api-versioning-timeline.png new file mode 100644 index 0000000000000000000000000000000000000000..5f2b1d7292d60077e4103b9d1001e744d51002ba GIT binary patch literal 185242 zcmeFZcUx22w>FF-A|N15q^Zb8dQqAL0i`OvhaLgxO}ccDCLo|l?>+PudI^XEQbI4% zL8K%|C-m}8&ikD6T-WjW?Q4I4{YM~>WM!>6N4dv6?y*8ulw^qsX$f&~aEM>NkW$0J zAzH-2!FzDyD)^83b5%6>b;U_dRsyHAkN)xxDO2s2W{Qe9?BMwgoGT%gIM*)U0v@#B zfrEpaaRmn#{JwJezl^K@{VLI72JU}9$9r)3#{QcR$8d0-;k=Z3uJQKD?-{rG(UFx2#~-+LD1POE%Ma3j`USUGCH-EcK9143e)YzEKb(K^Lkd$)`VZfFfCykaT8o^w~86fKRx*yw+gc(9|8KI_zfkAzVB5b?=WhV^zfk92sPjJ{`d^IycX8z3;`VRi z$iKzy-^3BXbNpM}{zv@sFRSx6CDXsG&fkSRS^v_R|1sp;diF}@#(%%+ zPks$~y3_NCNfy&mVTxTHG?_4skD%INxq9Ol*&R`jy%;uiV=m{7>3V3HVTHuGR0ir= z+QkCQCOa?LuE8G{zk~1y(TrEOX0f>$Un2P@JEUvys=;zNuliW9{QUp8x{9|yOS)I3 z@5T9s2MH~|Ma$W~QxDs79RJ>{1`W;*D>H8wBg&A+R<$YQ*Ct=S8aHrjKA82K;qq8X zb(@xuo7DDej1)X~oZ$a6C1(&{yK`1ZjFb}0eC5B1Jh2(XrPv$N*-Xx>0dtQ4Y|MnFtx2B(Guv)#&o&U`C+g@_7dR`GWQqQka zuqZv9_rtwy;5?`aHK?{8FYP|daC<~#m29R);I-XOZJz2f_PB==@iUCWb#u1aygw}f zpY$OX%HFtNlEd(<@e5?FIQvSpmaZl9`d#xh_dM6w{TbsL&X;}&sc4e)Sk_ii$ZXCBcnwl-ci=egNTU2`i(;hvyP!aLkHiHEf8Z&ouyW*s^i79Q-m&^vx- zyyvy`MeO7^#qGy~gV#zMFolaz;$qVnW%0AUHXfX@Xpa&|B`cY3w7?q?X%`y}ZemEPh0l>KJSl$}{J z=B?OPD=sRE)h5g@>q?dpWC3!MmVXtzMs)Ey%i$_vL|8C7kZ1^6zFsp$K5_e=M?KUadTl1WQWXPqsA2J&>x<9RrnaTcRNX^fCCKBb7>!22A z=wUg0Hl}AU&_l%2wA&}*ZEM$n&O=7A+K06cD~sE5yG_?Q%=w&@9FYaJ6FxopjX++9 zxi3-8$;Q;ywgwVVc+stjn0aH_>~X=m*lsb`bUr-n6QAa*>OAPt`p;NtK*irRa)fM} zMCA9Y9byK^9$0TdarT<6U^+WqI(_%0*hbfND<3H%#5MkJ(e{I8r3^6BZayNfy+K)| z`vtbl_edwyj-Q_t$!8xoSqiUvI9r_0xVKf{c{v+4)%;nnTQ#ClO z#Yb$7j7jEDjJ@!*of_tKv=omTyBPU-`5SnpT)USv{tO6hFtF7?D6HBb& zQU1Y^mySg77};Jdnf+)DJo86LT~{{i;skbV1~HTR-{$*&?b@GaDmgfZ{uo@n+Es9jNv_&y^3ox&h0VQ>djfsU5?(wxZg5$P%Y1HTX$jVY>kL~x+)eG- z&+Dv-ME8^?rm85_cFLHWdN1;MO zuE?Y19-4I{L3tylYj%z6HNfI{ZQLV;m%ks)a5ZhUVaS9+#MSSc)!lyxd5>crO0pvj z_2mn1Hm{q1N7NBPM{S2aUMp+C6cz>hKK{FolkLNSbIB0a-nN5OU|J&ws^>eM_k2%5 zXyu!-bmqS2lu0>8d58B^Ym#*-P0{}6^wVE4>Pn$hJLUn`;jo*je9z$V}C!#n<;_k;Xh_p{D-g{G_bBjnGb*d7Z0OC#$(-?)GHE)lHf_g+y}V zVN1qqT2%jc&;NK6Vt`r zvL7GxVn;UHgIohvSmjV|e`CfIM2cj4WW7w=P-LbC#P@hOT?vBDX`_}3;9>;l&y38g zfpvlN@AyD7ysvL_|3Bx28&Y_azIz#hE{n{|tkt7iDa{UCG}l_4if^n?zwQC>hruMj;bs$*9x!ZFxk!Pj`FqFSg3i)+(H=fqPcvlF|kJjh%}5@AnsEb3w(f=Nj=6(DLJq z0b9L5!_$-GPuqEXjN;VagHKmA;GCgK&WS5QdRD3QGj61F=F!~=E`Rc8cKsg*e!(-q z_`n6?g2}0ZJnTjZ%{{f9yvC_~RDlrC}YmW7Fb$X$>8h}uZS%j`qT_{`6QNyC!j|8emD|3du3h@4|y zq^5~_p8qx%=WF?J8EH8C^%Ho{!+Bn@?p7v{fzRf@Z~gv>iKFsi@ud`Cfc>i5oVQz1 zG5cER-z>c}!R3*`Qu~B3xblvcwwxb>(;Yiy)yuSBEy|5I^r&Bo>lu6K#0UVa=Iuie zHPH5@JJjDA82z5%;TeKt!t7Q&A66mvH{}sX7bN`T!*P0c?z8SI^-1Z#J$_V}2u;6{ zJjlMu{Q03`0|?K(Gy;3EI%%0IsXsS?v$tIA+IPpW@uB#Kf$8zhdF`TG0O}g_<>S|z z=N!&c^t?Db7`@2x1qPTp<_uti?pBCzs)$>f+pIg4i01guk$I8LCO)IKz$o!^ZCGOP zos*y8JR{3ji8wQ^uK;KWS4zcLA?jmUlu}sZNW~6cVMs54EAZJyzTQ)YrROgvm_#m@ z8kIY@SD=ehp1N0_7rBfPTAQDsNiUW`2$rTc&?wRk!uBFaCL5h^;UyPHYR`qs?YUTR zU=1wp=^2MIV`fbF%Az9e)>psP=@cgnfrg@h~g%0r6BDEXMLzm^lkc^jZEE94Mr7W6itZehg>SNgr)&u zfc(oh*N0uC;7jx2!@k%V&2@dUQeg`6f%c1j-*cx?)+%Z|sHDL`bpTolj(Gk?Vu0Wy z;(6L;(L4O&jeHlk5~|^|;PaECmGrf{_HjC9gUpth_s#{*=*FpbOKN9_$_NY|xyTk0 z#qEFH!j~R~^7NmpEV)aUFf0NO^jeG%s*+z_hK*C^!il%4J%8yOVJ<$PYFwzEwz|OJ zyGNugEa#iz5HGVdcQc0hhN#i)5}vA*dv8qmgXQq4X- zM>Ln#*DaQWhj;&BhAQu#;fIZ=$|Y~iG`4KD5pl15WRwgG8=(Pka>_>~ONDVxmaV7d zXgOK-p0_iIw6qoSQM2UBx&Xxh^q_955p`G8QS4~w^EOyVc~Z^naFNxFfCkrfS}p=O z%o{rz&VxJzMFye#bSPi{Q>S|u;R0|J*Qh>Wg)WFgR()xC?*yOEWf<3QG^}yET(I<4?oV3d(`9kVl_s7K ze^!FL?EjRF6?mWrP2$Gw2owAL3y7PYjV^U+oSkCO*NJ&yrjhTJC(l-M!N>X8iM{BSPj0lr~ z=X$jV1m;waxp|l0;v=xxGo{fCNSG49cu8FNRCj$27k<2a>F?cgake=#QN0pH!zUA4 zZBmyW%sk2LI_=PT1^2qeCLz&hmJyvSL}JYnZ~>+Kf(?pPq~OHs&nUsE;!IIi3}UcA zbDY!Q3dNZ0J=>=34hVG#h*@F1@})X`aE5(OvYkR)myvwcNokij5~3M`^<43bqkb$F zO__=?8MSRP3*|0YX3U%Y!W8wia``usuz^na{BV)##fsK|sB#)z$x52168v$kj={`z z68hD+m3s4mm-As9rFF-cq8YP*=wT%hE)q7G&sbb9P&ln1sI?Ps_X4+RgZ2i(rWy86+<25!43G zs%^9w%7Y)M;m($g>f4&iVG}pm#T~QBRKu?$p+Acp$SlFt52@c=emc!6 z`e@)vX|^8AP>S-+Ho*V_gS_gZwTFBtcNxU0M)nl$+0QZJEkcfBmEYK0m(8~(g{Ob! zn{^i6)U+Qpb6Q6=t319(;gA57@@V|iDH}xMy;05lS3&SJkM2}y2D%C#<60$&E-1{~ z1(f$_e-}s6u&K7fqS8XejR^$&M75h-6t*_k;#*wlffxy==g{DZA5$?HtZ+O~c9~@f zk+G~D$rcr58*`Fz+mB(!tj~JwqE7bEpC6;c>vMJEa1KD~j3L5ms!s;&_KU-sDUpN( zOWm1{!2SrHUNC83G3~dj#tl7FJun4>5~3)LeYPOjNF$=4=T|E(>9lR_OpM)MldlYh zH)yR~vHUE179Epwz-KNqmPIDc=r-_j{$N)L26Yd45#2O1-A9rq8;xZR@k1I)>MNkC zA1`1-`G3w6fTaTLR|N_fq%vPj%i+&(%y&wYV0VUFMsw{JGxTuq>0 z7};guxF_z@WcZ7i$R%l%M!{3sz!SO8y}pm>Cz^6#8Bxx2%KN!H9Yroji3>kukC@Va z+Z1VNtyT9Lb^oc`3}xAy5mnhsn7$#)CQm4ga&1LOeJ@%oz8X71N*$MzqVhCENgpB) zFHUbsdi-d$uhT}>oD`;=rX#MKug5uKAuZo#iCtf!2~cjv0uQnKq5FhUh>w-`YhN)h zlfeh)wkU&~Hq%j&%+^l;OH2yIyXWLn>~(XL-85GvDG@(ID}yS-1Vu9QChnC4Tnx|F zzIs&ah{@T6>*Rby^LK5_S;?DNpX`5ueeBXipPj<5tHb`ofk|R~SR+9YH}lKJ_Z;c=;@fgl6e`XkRJfbDw;} zg^+KDjJ1{S6*U(F#ln3)tz?z&QH>b-d59I|?QGmr0A)hGb=WROzU1TT50)Nn3R87> ze8Hn$<$B*>2hUzBke}l5*(Pds&N<9XSsVT)GP`>FQN*7(?C=_f&j0(kTv1FT8OuUa z6ut1{l)k6ilh$QNY4&yqlwe}==%Pt`_3F&tP12^3&pAFZmt=&O9{(kC(Ko-6g zTQ)I&oJw03c3M4Zg_8a=i-PR>+Kja*Rts_)i$ODt1u_fnG2tOu**f&Ogy+aRgp()jIQ`rvERP3ZNb%?m^%;q*{Q_JaIiN-Y_yEr+eWOn&CFkF zql7YlP?|CVdZlP5MA)iC>B+)1hD%IrK=e@!hN zX32!exLlujfpL9xY9`{>Dw|mxhAoxmp#zEmQLL}k$0u$YL9C=`C`TlV{XUd`kx}ME z9{vmy=VUt5>sC`b_IB8Zb+=a z-peN?97wH~?zi|-UORuM2jvc-=|C5sO?f6o!<*#wwH$-*qFz7hl$OmBBH4cfe#NNz zS15+QyxYbB#OSp#CBKHoo-G4>J@yq)T1u|7o~iBBz%MlLrHd;cSjG@2tTgbi)sLvj zx106v!+ES1MGvO469Q~(lbqPJyWLhSA8tIRW6R;~C`y%j)Y-U+^h~-(8C-HQ9rr4b{Xnc^dD%qzFTbp|Ttgdw90|;JG_s zKdepTU_M8Hns{2%C}aIl!KpLZ@2l*epoqaglBytkaDYnY6=sb=9nnK0x%h@|E@g!S;^5vUjG`v&h0TIXRWEI5o0FSIf z3*2>^iL{Vl`SITvdlh>XZM7f*;_lnU!O{4ue`VaLNwLng%YmKm#6u+bYO^)f++u{0 zGRuPU$rbgYC}~@>A76@DA*qb03Nm$W`DP}}wFqef)`tq6Hhm_~jc9ah`I+92>T6=3 zVB~(ub3&c=%ilE^@juLHC}@k`PspFwc@U^MUKbpwG7i;_Hj-d557MId{9S=TcJq1$ z>v*||bw7^HtbP^ut4_~_z}#BrQ8jYyUDj}AHBGWLC`-cZLaE{|%x@KBJMfO4C0>M; zaSai$AIY;>(Zya>^e-{9o{%6#=zHku8j&`Ln_e z(l|4X)RP8M;SKv=qgT>>4G*LT?@w+qIZ1@3_U?EP2^>ddDfia%UyavED;aRhVXe$; zRfw=0Q-o)iCy`sTdBWQ4f0Uc?Rsizoo1B-g*1mbMeUN$_bOlFz`x^yS_GiZK>Dt_5 z&HUN`=f95G|BB(5mFI~|$Tob~8+-ami44+g{++Fd!TvF4`h)-7p#U5kL@Ot98vo`U zU?a_4tLpLyCC5y1o5M7Hj(Fu@{cX99j7QWlU+=ruvx$#pb4#~A1!$CQjRi_H_h>Y^ zQ|?E$zd`hxtoUev3+#b4HgeU-p~_Kp7J7Mx6oE&S7CLBJR+4O;qSmi?{lM_n>nkx$5=Iza>PQOfJ+_Muee>9p_=8~4xMbfnyq(<&!}8H6FJe1@x$v{X-{ue1YP2f zis*S|gX)zeYwq1_3!_{TZG!}7ywFlZ#^IJDlzmutF~#{|bg~-%XmyRWG-egr1^98J zZq`P%^J`(xdm2Qy)^+8oO}U#Lf)?ng?U6@$KDozAe#?Xw34bA;YH2T}S5#=0to6$= z%p*14xY()|SK0|uexuo7tWfs$#rXS0AHODv!wM8R&ggc^Sjp$pdwpZDSA4+!2fur{ zowN+vv>{v| zbc&Or9*?ms=_)t+N_caaphkkm!E4){Ai3ZdvE0k(X@=2ePd8@L0naUJ!?&5iC93qX zu8T3vObc1q$T~Ghfs<-M{m3irKB@Z|pKBgKDXUc|-w(-K&_Aor^WuZN2)EK&&o|BG z?wQUgRh&%qg67+xtYRrc6PoDEt?PB1G%=iH5Ax@Vws6J(OQ7!1+8sj8o%@`k8~1fh z@#+;*2VQYGZiPF?>cJsAwzk?1S_HVSfrf;AR1^ndbiBqkPV`RzJ@AE{x;Rl5)QZj zXl#Jq`7lOpFqZJh#Oq2to0EXFUXL)tHzO}lGa8Qzj*aS$ml{})l^yo~NLt%0QmMxE z>K8rOE3ry*j6fDPWx7;ntoF+U5?eB0np2k}YfE_||Ez!qoc(E%k=L2aTIrp7Gu?(! zub1Ume|qW(q2!L$k}fWJ0+9(z-S=aID%)M8OwAre|An3b)<| zLOxx~+}J(CRNZs5vTvbbM<@jg#wbfBWl)?scsrDh+O3%`0f9U|-D`7jWSV@?+|kfM zYi;3FrAqrzqWR>Q9Ok($fG1wS#AoCx%BJJ(ij&pT-G1d&YBb<^)v%m^$F8VXRrjDo%#+lqc0!Q!>WnxvA@LRP_mu7tT&l?odjF`K~yJxS^kSI2vrC*!EowC7ay%4SSi$aWG>R-t!rarOE)I@YvoV$! z<6gR754x+QPv-psJ9d3@Ok}^jGpo67AV&TG?j5dmopVmss9q@waGWlO=G~!#*|Nz3 z-j@Eo-CaQq433NI&R*zu8-4k8S5ld$ceF!!Y?!sUj^U0y(ib0;WXleZH=K2qeA~xS zetn+4CsT7-#J9yn&-R8n4nh-AO6D(e_f>;Zh&1VwC*HkrPJiV?d0T7CZ+$R3gd3t; z@rF5@V$#<+u(Yz9JuGv)3kGY5u0=;0)IMt%9*znMbb60;U|xmn4M=7an4%>dNb60 zHCZO=lZ^|3_^hw(Stq{U<6jIM-t?yjH~$njQT&_~1n4QOf~2^lmvw1!1K?sYTdE4l zB=^oV2K#&GSI3^`tXXaaB_Y!ZM3J%@ch^%JNwBYsz{G| z=8T;z$wy>0-KT9Wc>3v-1>TT8;a5|KPC7N-KN}+@4+a(*a@Q7VL z%05{ygsG=qv#Xb*ggqWs;7h!BL`ZcW{V`vLv}A;)Y{jl(;*ukv!uW3{nx`EBYGRN& zJ_9+L9SOly_Hc)z49C--zy3gusdGZ3laE#Ro+|a@o1_=wt12(`t_*sZUSKXIDQ?_=} zstCpV_2#lfbu*#FG3Z_U0CpmQN+VxXO85wnv*xg%y`^On4{0(>f$4Ib*u9Mz5et1% zFJ)2eNT4>oHv#D{T9WG7ufITA2aSAaZI-p^gglLmTZ(Ar6RnoW9 z9-I}ZB;Q{T(|aCO-VgkG9kU^86neafZ7$+aZTwiTih1#3W1BF!n{Pp;g-twyrXYK_ zBnx+!vnX@7VVfgtMs+-!j*ZIohjqLbb<9Net>Qu+esv!DwIZEY{&>cEInOFGq!_5I zbS@$^Z(L~9u7VB{*?FR)gn`3`S@14~KFfm6%`;xxn80O=bvJBZd;Q{T2q~#~s8T*m z{SyS~AekjlByM|GMNwG(npQ)WrSFS3!!Mt0CgEo`3|e8FVfM|~$fr9mh=(!IuAJk!sr&toIJ5*X=y z@H+oHIp3342QzNaUeiA2ymW&Dn}(l_3|TG)+b(e`PfP%LG{hq$sfblb{sfs6b*4+K zgb5qf6ZY_mYxbsWrg7!NCUCV*)Hu~-;R2>Q!yoG^8dqOQw!QV3xnO;u&q7Ec6?B}L zX)V>au;BbtGqA`V2lF#O~P94r}N%vNt`E1Ma2q~xVNuN>wIjNAw`x)2`Aycpo&Smyy55%lXCdV6-?W*g0Y$SRyg&dSc;6m$l}FsCKvW^a?uwW?}O7)k1(u+vOK03#>TRD-B`6^3HOos z%_#-%Up+W612%h1q7R_FVU1lLcMbqibXiK+B}AG*L$V+^d#+|x1+OL#qHFJxVf@R| zs2hzSc1(!g$KkW@HJ!s7hOoa>Nt3V`LjqNz3IWxN{E5XPt7DlxeszCix!ljwOW7<5 z7%?a;uZDHZ=Mes&bR_idxz0#n+8_ttFetcIelTg&dgs1*0@#v~lGv>gLrc18nj)1f zs^RU@@;gEbEDavV8jTGkZ(xT(?ADu_AzIF*ftIivsb+&~C0#}kBLpq$7i!x42sPKZ z@`n^?JW94)QJ6un-4D4cGU>DeU-`vP(nO!(SmOpm#Y=XVE{`HrRW{`+aV$57?wwRn zB^Xji#*L(m>GdHEq~T1=uhidY@9bl8N}kdbF6)f}-mC1KY7Wk2Fk6g}@^js&UkNT? zGXBue2H4@x-S>Y6qou4dcCtF3D7opmJ}4Ch?X8rqen7*&KCAk{DK}2WQE&vG2;Jz* zb;@YanAr&=XFhx+uIW>JDy-WZSEQcLfrQ9XiDQD%-?SON{X9`W z(#=Z!HfR+Fi8x0qLHGS4B8zicX=ifRpneZzDK@6xl?Hah?Zd?$MXZQ3A*|f3P)U?^S zO3u@k@ZbH ztY>iIr3n1$x7dEoczBF>_`B=%ivmV$f9Mu2`-b0MFqqa2iX<&lf8H`q)Dh?0!$YnL z*Hw0hj1DQVp0-8!5twNR*&c7#@4Yf$xIn_~srBD{sj?g%Dvm0PY#=bXhc0MH62NsZ z7MKwqrI^26=&6^SvS4fA-HyrB*dbUt8c_GCUFwMaJ{?c`axN$;0hqGHJ9 zBXWv!GbL6Wzy72D;eCT9|0rv`SnRQ%lD!38rE%&*9*g- z(P?y?!+;@d06ih^aK2%-BlcP;cZz;;|ESV(ASJ1=%*}spAh&1MbYxkq;=PUuBl6ra zPG={7!SYqxsKWR7_%K#N@+AXCH!gA@221rTsnSdZ)r31JOG{N+>Z)7n_$FH$I@|b* z1F7ar>8WfSeY|gu=Q={ybH{qljjwF@t)sb9EUEU4^qP-$7hg=YT)k1W&|lZH#9b~v zf1DfaO;{3)R{0q$!{#V`)S7igh5$i*_^B@rdHP1qG12KcQeRPIy-MA2-luQr*bGWi z_#;Zu0Lyu;{zA1(l=iexlS%-4X{FH2PUF4MSi1(aT z+)Fm_J;to&soGE0VXfm>0f!>tO&q^=63!v+j!*WyYllL$5vJuQ^JO=ZM~zsS6N|ihe#S zXt-P2o<@xyKIPcMWu9zXlN4U65fpfBUQWpn>Z@ID@LarTlh_gO{WNG{16D`-c{7<@ zuAzNEn1o92NBh#k+_$Rwsx>?k2Kq=_=f1bhfT)+z863umlTnJ zb39ELoLJ+9O4Y+*0X+V^9}+}d8VKDg35lKL@+9Pa>55f>z4E_MQW8C&Goz4n`yHe^ zZ?R`HH*MVG#F`4b+7p%KClPTR@6%ogLxh@#;>e=A6`0pm!`_#0_-P)oP~Naew*``$-hC`Sy86n@-IJ1CUwII> zJ4StT`7hWu5M{-B&=uDr9l2JEgjTv!Xw^&Dd_)D`E7aWxQV$$nmTD)}UP>5w;cn+h z>!dd=ah9}|ySyV^UmuafImp9+Cu43n8Y920xl1gS`#DO+br+?HI0aj|6S1Yo2USOP z5EWz~{C|GOzLV-3(>*Y^*$IXo;fy<7CqBwqD=w|+(pxyu*yK6t%co756oP7(l2v>~ zuLjP(e}6u)YPs>2j!WU>kK{RU-=BoGAp5Bh(p(J>T zvhY$26;yxlG~X;Ut=UTIZu7d;*hmJInR{>>pshumEMgwGczNn}v&P-zNHL0IihPn) z`r-MYbUtpE&

mAo|otDPu%s3(n3Gp~{b&z7-#mHjB~OvZR#8xYudLrVdP0&z4i! zhI2n?+-R`gkzxD%1(3VR`kiMQ3=5tc^>DpXa+iR_CA-YWdKS}HYW11Vj~B~Ud{dvd~==vX*M^kN6euD-P{~0 zQ1`BPR{~N?8%9c}-bW#u+YOEtO+aFGbfAHUi(Q`*QWgPi@>t+m`4o_r!$VRt3hV4w;y%pp!rpz?mPJTEI;D4;1E@&u(!J$!;l1Cqj$od%LfUUB16H1<%tGi6MW8*FD?Vm@lB`R@TJTCh(V6^mi3%Ca^{j2 z-r+O*K;xS+D*v5?s_En?-s4y4PJke-VyqdC2nGE_g3~vtM`$845~D*ALOHjF}5R?r*2If z&}RgH=)0=Io`p+GP<}7`6x%z-ul2rcs-sxkw3~9SjsPp>kCi@MJ?nd#$t&lvxt6|5 z%w=y^pp&oaxfj-QqQZV500LV7A(PAWlW2QJBM*BDLBGdHVvEe7u6Wq%X=>nt7lN??5o zlPf=`WNIyV#+j*9R#e*1y{GC}-5XE7{;QknwV;UWZ*4?Vz65gwubc1^k2}y>4{=IM zzD{}>Oj(fqCApX15=qDB=72<9mR8f>|xo6Jm#;}Q&AM)~a0F-bG~#fOsm2!>xcP+bP6TIJofjwU2WPciqjfO~jh zD}%jibXC9~{l6t5=jj&=OIa#?bn2%-GtAe6lGqj9%*fls6F@Lfk1m{tMLk3mZgmOYhF`}xnP)#EW0?}~f+W`wAB$~!7;mf#VQl`v^i&f<9oc49( z$p$hgk8PaQ$E@tbGV0!Oq8T2o0UT`}Dtp&mYFm55jGZrHGq1hGCe8+kcg*TL$}F9u zCe4y<&A2DsWi~mh#0^Qr)CCS$5wc7NW40jaPzgo&fdA?V@QxUrg3wPgJxI zU9wO69N2bLbu$2ql&&T|F)H~nHPfnatRe&q}ooN-rLzhDWa4In?%izp?MBL z4aFxNT0L=)zJo<2#>ZXtNwl>QgK?yydjqTK?s?vNx`0L(sI6V3pO@#Vjww*(gLq{I z-F|F-*?sTbX(Os%;YALMTfbZwtv%VOI(s<5)%+ zLS02p=~j{ccsl03>g#6)h`LzsGuLjBB`xk2DM_-Uj<7;&Q=k$y8&lrZt*1eKW*I}d zMYH9s^iKEgbMz((e|_rq^5t115X1F-U7~wB_**HGYqfqQEj;#`FFOwu@X@_dL)6z7 z$n4HeGt=#ond3DUI2RfzzTZLWMO+jAW4EBs4`2SQx zqsUhW01cx-=+V9D*$LSfWs?jpv#*?GDF@VpMDg~#aaiutp`2w+m-qVYZWedXgcp)dYbqC1YcPK&jS`;ewk%Ws}dTj#81QB z@naUbv0B|P7uEz`Qcwu`oW6BJcXcuL>P$<(a{7QmWmC(pB$_>i`L6G&0|l441VeQ} zhBmA`lDm3YBAlH+z;fhm(xXC3{5K#BHdvE){5a|eQlKc!^dhk9VIPbL(V4v)bhOyA zG_c2kylN5F?VZ&~2_w%-0;aj+Cve~dv(ZWe?Z|glkPrd+gn>A#)`y_9sCr~(N`;BI z!FRjdtn?u)pgnG-w}RRrQR|e3&cJuhxl_2++YKQ=x+Ug)e7F}WcDxFd&JR%rMP)(! zOVitVs#zp|q$mxo3`to`FW~Cw?3*f%W~M#XO3d7gw<1M0-p2;|9_x~De0%7{vwqZ& zVT@q8K!=YE>RVn{+ZHJO^2F=jsNP18eU9ti2R*i*q>$D7%_oNTh}=jx_wd9k3 z)KMq`Rr%SI`#SjA5iR=r5(tA{eW(NGK1=Mri;6t-=USg-?5R0{hoZQ= z7ogdYo7_MFE;#)Zub^qrgwksI*{+$)_yK4?FfGu55eJo-EfOiX2;Vi-hs{u~HGllO z?}6u)0{!5BA%BUAkHnV8RKBf#SC)fWuiAj5yDV$AFyl678)yB27iMFp(qcfWtU5BbCSNS(38a{+M%4ZUeWIz^ zOp>kMGGdDuTi8HOpa6Yln^hUm$bm=0!?!hr$i{~oZxQZ~ssGrb7|wxACYRTuZ|0w= z>oYzph2WWOnY_J5j!;CP3o&!z4;{#4qB# zLXxFUCv`EqUw4$V6TW~;OEWFekhhO38Y0RjYmbmLL^LZswF9o~{c|RwGtR?__mLl- zn3*DY`&I4((Qd|s8ROtxWG^9*1Nqkv+-3)O?k9E}CWLTe(|?ubzTCxw4zILw&WRk; zhrV$-yXU>9ig?O7@}6(O`AH^|8xZZ>ytpabMkvppnYQ@r4RH`Ol7{agM4q>V$jvid zVrn_8Z2O*f?KbiT!NHnVsQoGjtf8~~lc3nEueO{<4|=0C+bY$#v)ndk0a1~zr!!Z_ z;~%1@bJPk(aUO!&LGwFf&ZF}%xetY0R_*B(%TNlgUpP@#e<@t*mzKB5d$T_3pLIa1 zF6G3Ra#5D5&+ANJgX$msxj`CIuR6ktWf59Tj3&EV3tuV7n=OI_hC=QxBwBBHqQ;Bq zDU}j#wPx014ez%0{Y*#DOK8X^LQ_ZCz2{l_3VJ?NC0gTE!Nr9_<;A7@9BRT-K8C-$ zPa3+Y&`T#~pP}=kP?!M6YipEEVKY&7>RG#8f#GBBnlF1LZ0bog>zTLvfbeB+{m|-| z`=xrG!ZvD%eF->H6A;Gb#o7pj1sCGg9iH=H%okj-7elkaL7?E1S1rdFj#R^u*t@6dR{ZVptW;U&=?rID3M0F7}8!hA&W746(h#7 zcY$kTj^ZX?1(Xvk0&w-mpD@gSc~mN?J$^i&5qS=kZHRP$t@^%GKKwLWTmQSVCpz6{ z^=5WY)j6Aj;`5K)+FCDk**4yOwf86ZW0Ju_)j#rXLAFN!6d1VymE&(8UypV{VKwvb z9~n3F*$4GZm!I7((>yBu*S7Pp+ z+kzP$+B-#C37K!6qglKN2yVl?w)Y}(3eZHH1KHZlzm$jBmbj(ua~p%!q0z!+p8k|b zh3n?&-Zh4Hr9w=f(wac#&t1lpfY})^&-BQ@W1ULzH<3^P={sWRri(&Gt9Z3OGaH-W zJ4EZK{IJI2eh9xjG*wyb=vy({RIra5Br&0ft9*dEwlIG+Fg*V8M#6~`XK3W(Q}mcT zgMS5;)*`_t2v8fpDE8S}0nO%=Xv{t^)eeN`08 z2uQLH6%4!!$F*}(iZoJ|6d-Gn5H+T(G8+j>M}!_<2^<65ut_1mc7w@S4i zq`VS!A(wwo#Y=%%<)jTi87w*iR8DN;LibSot;pX!B-LZO*7b_jiZ8*QP-PUKJlmbB z2g7@)9qmkeuLtehomLILH3L_Q8ok%Ii4V=vI?Y`(N}P8y$kBuL1FIr@xq} zH})ioFjLT6s9(M!sT=m#Y9wFVXv-X>uehuqM18ww7P!;!TX3Y(xlE6M7oi!HwS@{M z$Nm}qP4Yy;1iUBMHTbG_(0opX=3_qTHa4W}HUyFZtUHH$?cWj zw3CpZJI7cq(vg0i1`n)fshfe67$DnsjU=?D0;nI)xExwBPt266!f1!Jat6u&*0m|T|+@E7o{@1|x|GDg0ft-Uq zZK8qHbH%v<=#1~7c}<*3f-s$&L~_LWi%0kodf&h>@D3<-SG%$k{l3-ei{9RxYq{{d zf*Z3v1%*FfLcU1#=;V__cp#O&^^$UM44Hp4o7x?*H2x*!TusqtLHP^*TScIyvtRr| zpWrP&w`A4C8{L^+3^xL|2!~NunULs9_WiR~)m(`r> zg?c)p?%Ai2qNJ!j1m-?Knt}JBI>4ZkB|=}gt9Pe{jXze`V~rB|yYW5=ogkjMl)Q{ zE-(jR9>+rM1MIPj3NjDJJf8#7uD!zMvLj$Y?e=bzp z+f;W%EDqmKiJT}lG#2|^{?%)$^tTG8ckC5CV7S8~Wch3-tGYh36zMsDJSn!4;^f73 zx+9!eKnh%Ei@T_sTCv zA!DW`zFK!^iF{38r=E|!{=9z8_`IDN;LyE-*8?iVO~9|~*R-#;plE5_Yu z@}iXG{=hp#%>#*fLA@?s1iFufw10m{g}BfjeibLand5)+asV%89R`4YnB@SgE}``c zVfi#GBw0b#xqFhp3YOU<3ePoRS4|tw|8frJtL>qT%z$U^g0QS|1E50-U3|bM^pZi0 zle6vWbK`W`wZ5k_C}xCGQ)Yd0+^`{_>7(`FD+hAXU;4W-2#y39VI1RF7s=e+WEs@^ zI1a(Vo1t1af_SI`9oG|PR%kf}7~aZ@z8`GI8zz)}UlObr5=}_RS`_F`S4O4^Y;g%p z2u|v+I4pJ~CYlNUcoo2H(2#)mM#$mWiV0RRID{IwXxap!#HDM2x=7w~A&5F{P5i={ zb5$+Nw;_r+@(F|frMv`nd$LXiokR(lx663f>RhxeLOtVivcAE|u1Ye_U!TGdTtQ z{Fl_^ee-6PTd9vOoPi2LNo1XWX|Dmy;)6-3B!2PNRRiFT4a#JWUoxS5yQUNeq8o2_ zHyNw`w-y%X>VG8K5kUEN{JPMug0# zML2d#z>+=olPd8F1)$G#KE<%fG2Krn)0Z7rB&}8#8z0k`t6G#Ny>0s$T|=#+{GmRA z&bI24ha8w-Eq?E}*(d@;zn2=Wu;SNgqbeP=LTa+aVmsfNDsCnEp6{k(N}b|!Q{3&0 zRDQ~b02SZCw+Al#!5KrF_3IYD6k+3ydWq4P8>?bEiFD2hbwxRc(TkBHeO%B`NEB*k zZ{iWyRdyK`VFlS15oe05gd6||I2MH7qlYsIsdX(FgK$Xhi9M|u4cl%2?7xdGAD@teHRHe;yQf1sK%^ri+CCOuF7mrvlCfm)MG?`V z;iIxPKfe;Ysa5O&R#-9daqeI^H{3f2FM-Ho-XGt137J_&zVi!B@;pzRj+o#uzB}^iMrB9%$Hn$^Ut9@-qh8N68a7gE)0ms8fomXLWG5PYTl)Y z+9Fg0#ZYD~@&9Nv#9gMC3vVuPbAwAB;%KRTHfMzQ|6}j3!>U}`H(*$npoA!mbV!PT zG%N%b-Q6wS-5nMop>%h*beDj1gMfshG$PXJHw)c+Kl^d--}nCc9>@FqP`EC{ajXDYig4FE^n%Yf>?&6D%Sh$ZDB9Dx4XFw;&~4up?!j=pC~u zLq2PM1?(z@LrhPl_`*2UUw7pD-}VTLu%FU2oBR-vllpN-WB|Y+R6pqu@TAqdN=}BAI8OB*StuatfBmlPydunQ+F6*0`$y)GG z4pIGD+DCTUvB=CXG{CZwQU^PzYrAd1a|ha`o4For0*~ALpMF#^+*aB1=L0DYqfLU# z`VLfvmmnn#Ds8-DNje{(j9EV7ltJ@ zFx;9@xV@kLmtN>elUzIi>yyYvR{)qU zG7$H5G*H^e0OaV&Z73arh_FdQrw!GB(vElwfYDJG))ss|Wp3Vot=V4tBR+;6Xo}Qq z29Al+#;=J6J~)d`fK0`5RRBED+Xsap(Il1=ceVmAbO%u;0U`j5BW6+7t_41NHjsZ%MJoWTDy2y`Pxg0tYH3%~ExpWpG{*FwE z{TxoKZ@+GL5)9g>eH(u-f^`HCLWBDY+)Ow-I1;U6<5oDjXkn@Co+-$r0qm?TTFYxx((;yF zk7|^LnUQx%Ej9(33$L8KPe0XuNGDF|8DO!T6gt(BRWt8Ts{n{sAByLwYyg+3 zytj3CkdR!p7LjmFOZfYVn%>Qc>S?{rvuIwuv|C?(hX&jS#QWz*NlGi;i{Di5iM>SL zSVt*7xu0}8YUN6P;U+mX0q8p{aDPN3R4o?Iw4)uo)VN?mSqxklwIhDjz5J~?^vCyp zX8gJjpe<&>dT=X=-AYLV6QQ}8@Rkm)Hd(Vv$?+q;P(L^kkjE;?c5MibiWvGuf!PfB z{g&6=M{A=`+J_8n&k1nX<{RDihwV=R2<=W@LVmhG6(=*Ke#L_TLR7fm8nIE zMVFv2GyaPxuH`XXCH>+4gXfUKCh$m- zg#;h-3^P(&-ww@BY$LQPHYj~v<~Lg`V{ifq!O{R8>)@Ag65go?cJ)FjBLj~K4?H#r z^9D}gh$B?=`&8Yh&3Js~pXUs~W;Z(jsM^tTz$3Vh4r(Ho-Yt)e~ zBmDlc?dQxru{;L%wr+@cNA*GPQ(Q|qI-NSx6wcCgFHWb;%enG{Dp1%%CU8sLubaRu9?Mqc zsV1XS#z{koma^?RsJfciazeA13tBdcL85FlQAS+{=JhOzLfGf&lN;!To6jyo>~htZ z*F4KEJ!@tNPYrLg2aO%?F3(vT%~?CavExpma1txS9wqiTCAo}~8%qr^{d27wEvnVz*&bhS9{X8kP)uAH)v+}4j(BjYl zdUiiR;W?qzp_F;hbPn26TFzeq&M%qo&#C+hZ~1+Mwe@n$9VkD;jIU?Q%HTmYWyLPL zk89ZY=IPvIseloKi@$v8BOb&ES$OM2#p{O4eWdcKNr}ro(74#h^ZEdA`;>AKdv5~} zNmK^$f5k_DT}237Q$pq=yOF2pnoNd!u^K^M8`i+{L;2g{4~F1=DTb2$#a1?1S%4!k zU5p`Y1ZCG2(9kYZ;`%mWz|1=^9_nH#%)_1u8c%~yIYTxGBMxth)QTqQ6fkwKHLz@> zuGvqKtJ$6a0Qz);0TlYAUOO9W@$ACX1T_>(!?Ga9J0s2SVpBg<3w4`asBL;R`}Pt@ zZC7JTKWLTJUr1llDtK@17Q_DF@o5I%z>DyPTxavw=T!n&bN+2OV)8|7}s*zG~Y9tJ;l7-M;&<&014eywBXww+c`o9iM6qoVIk>)Xa3BuK{8a zE(;eKf=Y!H57W0Y$IxmX^-CeX>;;e#7<3&dzg1}}ltJkWJOXHC2l&@AR#`(f0N|(R zwx8(&Vv?*Uda6!?*i(J@_}{yU?5GC1#L=gA%J~!*1{9L1a@w(=mK)c|&&hp2^#sFXC&ytw z4|V{PTu_H4YP_(7`9QcOz`9p|Kj3ouB!!~kUJVK|bJHsTNioN{Om|XK;nI(L?Dehv zX3}Pva*rf!im~s6<1@IKZyW-QCPUZQR>SP>0 znH!{H5+{QuSTx6QHjr6|eNjh7kLjg&oB$hE{We{O9Do6Q_?}3u%KLcmF1Jk=aObt0 zw7qd{K{&zH^j^I_tRD^q2A+P$eB07({m#P#l(2p13tnmM*s3pAQj3yMv40!3lClBh zeejXpN48U6jsbvuKW=;482L9!+jP8`QoNjpX zK3b5zjuvmPyU90caB(pQumf3e8n;?7Q$vn_EgUWGj3UFT73>5{0VPUx? zRf?cZc4phBnS*9-@yJ^~xRzCKpAtwOPAJRECUKTfPc7<5>VuAnBO1A6^C2MvVI({~ zcY{T=ukdOpH|QdaQi)Nhi#=lSKN49>6tLjB+LhMtSX-!t z;{vt7VKhx>?J|6QV52z(lx>ld zKkeK7Gl-7mR|`16!3Ar>+{UL&^u*T$k?0+X-5_%!>TlkFf+k3{zAWoL3R>LKAKtTH z)UCnW_Ig)JS`64P?g}a3E{M{ZBQRMvn+KQ ztXATLEK;Zy)Vf&NO7N;maNFqs)d6Uw;=9@DjlDt}9^$@XwHXPbd=4+*FFuD8Hv(Te zW@o&i&!r1M#T<1jaa27@s;5|!Sj(17Nzp*lcDdbR3%pR9jW1P%4MGj;^7b1aoqMr$ z8(lf#^6eYo1Y2Z^8p^N)T7aM8t(^tDQlQMISF6J^1vpzWwNu|@E8Q$+=A8g+0()N@ zcXB^umM5CB7%6w4lGq4!eoiomMuo6Bacl!^GvmlnO=k^{<%SSS&2bl%As6QZ-*~n1 zL`=2^>nqopGV_zQ`||US@ID-jCOxz@D1OSja2MI{_txnmaB-87w=&2}Br~&xXwPvi zz0zir?FAu=BWQ#_v)n+4g{A>gywxIw%5zXvP`s0t8Cn&#QdyqJ$etOPy1O2BIH{(+ z{gQ3y-T73RnoLSKoNi`pxQ?NKHfe?E+;%XT+B1Gl`X!aUi~GbJBh>r&+f$8XY&mYh znPaC?w#v8%Ev|5=MB?;7K zs~5?;XHpq7sdyYp;MhC_-F#~qdze?c)RL+`j}CH*aXBTDNsRAaGLJ5pEKnxKY(ff# z5Q-30RuVUzGss&TusG=JpULg4P#7^~-ov?XGXVOfKiaM@ULJC>X$Y2S)WyuzW$XHN z1O9{~UGxK@J-`7f(`vPjC&z0;AzYc_cX`6+bvU7^GMeKdrse~30^Vf;)aMwtxe|C6 zA_M=S3d;yi*49qHH^FoXz^)}taZo;)3)IeZ>)}X!1usGe*XwD(xnU+mH;R^HL20=N z9`@Z(nR^NpTu#$0~$L%mboM|xV*L<^dE>Fk2y z>)GFk>e>6zH;+4lCU?uEy`5UK?5VYFg~VSFIhDD)v9;KM!!l4GFv;^6yJN_?LjWXq z$3N&=4fKJ1tp(-plHQo{!bvmy&_)!(YyFH{3(a0aZ8_Sld{VRD&8%HOa}!;vYbvOU ziVHl%4c2xNA4{+YDb9%tgTcgghBXXsz|-33vYAW8C&i+w9-?qTH|0g&f*o%Abl~HI zd6(tzX^srU-)$AMg3^}I0fnK}`&PdnaPB9ywaay{qy7?2_258@Xl`1H)xmtSOL}4v z2S%xmjN4v0r_*Z(gd-b(r$s%@>R3K_^Wc%(&a3Ha$Y4n^u9|+}RT+N6aYWkD^L@$D z4$zxpuK=y_eb{RIO)_={#Ah2ZGRIZ#BTPZ_^_PTie5xw7FK+NO0M}}QZ6Z%T4Pcx^ z?bgK9VcP7b19weE$)L{WRgXAJZpNXm2MrPxb*9DODtxESVLQ=3{CZu-(r{<_So(#q za-u(ZGd(9xxgKtXk$R-*brqHJqY%Bhu8-eeGD6*9?nnnGMEQLRu9i`Qj z)ud3$-B&Blx5-;1=X+VpnOu`zy^S-lar}VCmxL9nYR25`b;M+kOE0dt7SCq*HVD!` z?V%E|XY73Apn=75g04q(O-Ft*>UE|^mFD&y-B-(%fdr^~p;-?%rtYDr<9*$H1&RZo z%<*-IcF9iga%40T(_I!}n5za!+gz2!@_U!a`^8LO_w%r=4=^)3MMbc2@D8_u&wTvx z1tBSm;cI>^0o2ix`q-?tcJ2;WbalDCEhJNEXmnf!!c6;QZK>RWk*K{EemtCtlIh{z z_wSS~57F=*C}bZ18b^||((#PW3jO>bA=LBZjYYrv+sRHtqxpdiPw`Wh=UAaXrpw*~ zPEa1_wGnRGSa`3mvo>*2J3-k!w1nSW0}Okhz>>KX!U#DgGDOc?%$$cCREyMx`t#z7 zcx62k^n6y|wwfFsv7LH&=I}RHBe_|K7Of2zrrDmXuhi*ztG^3hz^_UrE4uz##IkJq zER#%v>doW6J-QXxD?LJODm9eClX1Tv7B`A4JdtZHC+~}@b=7NHFw0i(zw|P>*;~5L z(nFk8mUE-Qv39n>t!!=|6-SvW($LVE%AxlBIEP-N+-Y?PIA7r$NeiRXX{ju0yk!(^ zD%zrWi4ym=nL!38qWZxJJz7u$V9Y`aCrSUNaFNr5hd1!l-w?TqxoA1__}OM}!{w)8 z?6v|2Pp>!AYVyR}WZ3dO8$~pkPZ7;RHTt?DPI*S23}~#fLFEefu9wKQ&p@L_H6w2) zLA4+572SEFky2H!(QExc3Sm50WTWnGFG(cHAz(BP!Ywee5l07Yyt-YW+dl+~>=SER&mYS3F7%L%2=YeO_^Lc(IX{u_i3Q5J;R@!BFO4|^ge6scraprs1= zk%21vtj*ohA(~w}iRnq6r_vc+z@b~4sWd}H%dHP0Em?QX=%!~VPc}}<)h=yF>5Hm| z7+mLn(h`fxEB%?r@D2KCvwO2bQL4)GJ7g^&twP)A4&B?_g(XXn6d9|^`)xoOQgAD* zl^~#|@&UMD2YPQlM`=YS_~0urYkDf>i0`yazdb-*qxK4m%Cs|0etmGP(3Tamn@`wfJWRuhB|bZ&Yz+A>@-g4juUX#J(Ka)pZ3kipOJ5s zd(xFE>x(|=v8bb2XYu$X@YYae@$Rf<&;(}6>Gg2~o=eqWPl95dddG8Fj86py%`eeA zZkJ*nnrrLr;+jcU8t1_Is8M`oU7 zS>w=$cYa@E@pOCpLaeI9Wbg02yG7X&DaUNtJgRQ)2k93e=9Q~V*3r|6Xu)~26z6}V z>D+)u3BWy%6(QHz&s^LX;c#<9^wdDE7YS^l0DQuR-9@KlB|e9jJK z4FvIetNc%yM>B*YwAh*{``mP4qc@;xblGhOuYH&m=6m0k3HJ%>Yj$lIc$|O7z5ki} zzW8~LPFkU5zA)=_Xigi*#C3}+tkQLb;D!pwzfpct-U*MdnOxU0mm_dTVjl}=^oE$s zpA&j;4%IzXbHb5(<+ANq+X0s9z~|<)-4sAx;OH&)9gcZ4y4n|Q&cJka@5_i^H!AR? zXOCiAz!}l_-B_N3A}MWdQ$wRUpl2=aZSb4O6b;o-p6^pn(zMy zGsQ)rLB+ivy_6h0ockiN+4G*3Q=x2bIqayr zqK`o%mM66vK+TUosggO0&%tj2Wz`K340y~aJ-b<8=F2?&t^o^2;ifcUi->+O;;Ou5 zjSO*jR3WU+Y$_tiS4ziw-?r`?{TdWhMP+4)v1wD?GmU%$6Fh7AFO!j;qju?k=qdnV zTEufThYDE8YyVHu6YVm@s4i&)W|n7z3+DN4-1Rt>C+02FjYT^`RdvG+;51(oHAu(B{ z3BI^Jzg4s99y!%=4x;daOVZ*{RVwQAFvmHYS|0#FoNsWEwrtm6+w_R(kUZ!*T)D}j z#^FezZx?&CIV~?dY%W5pK3gR2>^U*r>gT5}C0!CZTW!^|?kdNE2lBS^CB|0tDZ1=- z3yYNvbWy^h1VU{a03iwE;288?bkjhRd~~{& zMR=3#%c3DtFpH@_Q2(% znJ(Fap3G4OM(rAFXVc>3eXF(i#JEIOVZAFosIm9Uqwa4v0b=FgYN(IP0jkAdB8SyP zeunt;?oDGwE}m0VM%@OLMLJPkx)3<=S%nlFH^<7SqQ76r;hA2T-E$3fS>p3tDNWD% z3HgQ1hDKl^iB(yIt>POVBwsSr2M?#XO4^Xnk_FG!L4K>K9l@n(64?h3x;q4fiVUQ` z7raPcYaf8$-oQeC*`u*k!5L{}LBTJ@T{E3pz|ROsSh-y`R9u`hY~rk2bxxJ&N5qNb ze0uYjVP3tyIWEQSAYde!{@NEDdm}ak#KOTZE{WAsByt(_P0vCm?(_j*R{A33neqCP zMH&u6Nfe^h1Xd5h*rGCVC`ZEjk55UNtZ@olcBt~s5A?I%bFVbUub1jPldzPC*^UMx8Jj+X6w`U6ku+F4pp}rBk zrkr+I;W%0@#rHI5EOEi{_j9w?rO)>o3T0|A2RysM`dT%XlTs;@7B?eWpyLH~a#(7m zItdeQFhL7X6hXhe)nRbg#rw~_QAQUl-Slcb2=iY?cBM!%s9lmM23HnI{}GFFlB63OJ~;XSz_6b1;uGTp9be8kiPF5%1X}p4D?DqVwQ9ttSse-i zMj@2rO)s1bVm0V+dP-TNtPjq7YSdL*5K2#iszk?mAzEX%SlWCHJX=NU_CnR7sbWp# zCU=MJcc-?SG0qo7*P~O>IBh??pV!`7pMK;fHG(OLKsF0Ir9T0gs{Nf1T!x8r5? z(qs^^Fcs2r!wsNXhoFcjpN+Wk8wl^0G7g&f$O|9SSYZTX`0NiZ0NA}-3xKD0lwsr{ zJMcC_hU97UL__hyL#<%MJ>IN88~c!p{KY)SkPAmk#x)+oGqukAJjhgZa6kfdsGud0 zeIRm~>eui7zO=|7$fATD!|y7nqc1n^#p=N1w7H#+zna0`|Dc5}u72WZ&EwsP6x&-1-FP0+wM z`I!L4kO=_9V7zKTgP4Ly(=l0u1`>>Xi(=kF>6Lga(ZRCAe@3qU zypV8ay`nYX9oAJswCRh~%UpGIfex~9di6^*1|ZtCw%ec~-w3VIdHqwoJbau1V7EY> zCfw=1QV(2Se#aui<)cjzT%Re9ceRIZh~I&oMFS2xK9O z3_72e=+v_|=$iCJ^8gq`)?Tk5xnKZr8#^3^l;wDGOa~LgqkhTke|v2Rh{Q-i6As1{ z@T(o{#nUY(3&WAttF3#^quCBrz5{HOiw=mOeoY6lgSOnHKNei_GEkul2ogkhKXsAN zz6yo~K!7vm4U+Q2W{vw}((vv3eWa_`HADd-A^qGN{-Q_$@N{5BbcXN?=t^E}z0a8| zpTF~#P&ya`_*7CQ8nHrGk0B35bp86l1Ek-$F9{2Af%Y88tWlVRp@4l{0Z0Mo;xWOS zB+ekM!7E4kZXN<#Z_=Y_!Tv-!9{l!vuRCv$@^cYC=`Ssw%&@1NxDTD7Vc}v?H6HxcqdIP@W9&$b3?HSJq z|5sVY&`%#J)ouJV+^zx_!T@JPaP3Qx*`o?6^U1=rrBvBmx}~m zCJ(y=py*hKLVyQV31}*M5&|UuSq1z1XMuwp{@`i}ZBd=KXI+4CcaWOcytJ9CnN-k> zVNeJAWC*krSi1;H(Ga?L$4xLqjrAyodh6u{m)Q_;*V@}VBNb}w_DgM`)<7{NmGBd} z22(?(GyOEcHvB*_Qv|%iq-M&cRLuQq_g%vanxS}>dvY(swepb84!4tV2eV%$js+ZgW=v%B>LpiX@ z^z73>Cl!3_ei@Yi{6roL`>28a?y6pFFAbaj3^s$; zWpm1d&dlvK#2v7vYriDKK++su>m;n^99H?#2 zR$teXFN|}6ppK7T%Odn++_aQ?_FK35&-2a=#y~XFR=@^h)cfmgl7YLF&URYi_f#~_ zsi3<}f|h0g;nV|=9%s^}QpTLCw=qs>10CeN1|5hU&Tnixky<-IuJa54n?bM=sIO`X zH+%o!kqY9`5q|Dd+I!fC0cnYu3ANEC5gb-uA=MN zbAF(S2VZ>hTab;N&!FN21$VJ@jNF~Ypb7x~0Q{0VpqK>E%zEc=w2Myt7`uYNs~0~m@~)+TVqTIr7BUW9x&6lu zfQMf%%GqP_DceVyD>rzeS*TTQ8FFDc^Tq@ms3MgD!|%UN`0v`x0u`emiiSM&9{7J})ZfIoq&tXM{EU=vj~b_7oQ9irmjT#4lyeV9NrFp*4}Z?Zd_LvZL{U!Z3q31Ysl zbI1yGkpfd=t4LP~_56pO0lNjO16mVh`Y@a0pSJFwz7xcyBc2FRWd4`q@%xbxf*Xc> zPTH`4-l^Y@7;-VtQUUYqDz|?B**_mi75JI4bQ-(+|8PSx z^nWk$*IN7^pUD5W6aSB7_J88^e+bcE=kR~x^w(PaU!VRbPX809f7LtxGj{*FG=KZS z|J;s$bguqe@BB}k{w6j5x@P~M6(>>QNkYOuneL2b9?yl#Vw&JHyvBdkDGqYKCJ5nJ z^-TvBypRQC5n?lL+}-CX)#Q;p2(B9gGfJ#~iy<+LL4+UJ+9nO<&MiTlaI&F zUl>ki>2*aF##pJf7&DT_bWu{01=yoeIYvjqmhYQ6MI#?^1x!&yQXuek={K5Wphoy{ zWfm#fs;+>xZdA_DRNAB zu0_$1^w+n@t!)$3!mkM*XTmV`%$OsC2r%9;A=IW;C8#+?Kg6NJfWaW8WX38qJp?UU z$j5Z$Ha)o&Y-RSfkgbWYo=SgT@})Qs@%i>v{xKwS2#n@yhPKVJoTow!%K?m>FJOR# z`YtnbGh^o%@>6kgYy)WQZL@nHPhv-27h}Eq(0iTNMa>5@-?|*J%18@WtI@>Zo zmo~hPi=|_O1?C#y<$*Z&m2!hKIS>5i;Thh9XJ*jRkK!?zy z)Ge&WHscXfZxLo=zLP~55_5EF9N)k|D_4HuzC2b{j6HIhfAdG-VfM+LuEM6wRgMCO zn92iYMc#_&cVK#u5HKiVqf%9zGN&Y{J2HrSe!^OST{}zhqk!|MEt}PT&M)Zu$t2~JCmj~PK z9cWgK{5jI!tS6x|@pd1DT4IR5A0%~qB9CKT{9%CKTmr{UE%IveYhF=7(-l^cVr`-b zuJZUS^r&#)L|=D33I-c6>_z>vo-(||0R(^* zh&Z?7SDfBzQ1h->=_ZG9_eBQ#hXTQ4GE~BW&?Dz7GvK=kZRvFK`>9N0bA&)GAEZppL2!2(x$T7Q3o?dx0I?m+WoCn2~C=b8RrHM>MpFTf+ zu=rp*^*(2B$V1+rLm0mkUS%%?x>Zuz=Q~5 z+h1512B7czh9Rj16JQ`m`7^iMhsYsEQP>EQn;@X8#e9FWi%+FN+j2)4lTLv=>!U3J zV^dr1A9%5KPy>t#C++{0ONZ5D_~E8z zdTnP5$Hkl_^KTyRg&CnEBkGcmM{KxQw1I?VE8+xmK4g}U&C{WzgUtsK`99;pRb}Cw zCs@TdzSv{eu8tidhJ;#MnVC`P(SDM3X9B1MV&N>&y&}h{1XoG-L0X(Y-ljT)ffz64PLFnCLT!04C7LJ=j*K-nTJ=ut4Y0N z;--e!Z8E9;r0`rBKcO~x0uoS%L1ynEmj)O>v^q%jY=<&;|bJ^Ak zW_wb5Gwp9``^vQl_=fsTL7-_aHui)bcAS!STFk4C)U>70!Fj`p8=vt2P>Arvt=)Q3A0C9 zi)5~wd!A^b(Y8#=TReq<8u_tAYL^1@o5|6wV3NTrujU;A*gZ#6<#B~yyLa`igiJax zyI4uD>cPwdR1iaOd!46gD&YSXh_5K3BPW(!(L?kAc3|qq+l&-{uG|Mqa*1~&;!;;a{!IkTQ9fSt z4+028nYJ|E9gL28qL%G(b!08jj=wL2s#=k$r*IM>U8&5^$v~=jYI`jn z{#sWJ2DA%{|+``Qs$V;;2A-8iCXXD4=q*eievkE$vr{3A@GpYs z@rz6=2HMu@%zNTIhq)rVdvFSIKX&z|%{Pe!ZiCs$jqKB_na?o7$aP)q1S})KgFeT@ z=Umfn!Srj+?-Av!#)c2+l_i@yzJ6gmli_&ci1|(u!OnKiA^Ke}Gk%!Z<63{Nk4;an ze}5+2#)jZ(Ih?Pl7>;)A5+h6I!gJY`brOtxTJ*H5F2zKrIYRC{ai>@J4qL_o?oU4a|Y@-nPD3<}SyGtj^IR z%X`4RK_$ay6uK6GgUGtClUDf(rv@pMd@1A_Z#CRofO#Wqo9~+0`xMG8;r8r!R^SA| zz~Aok-n|(z&vyHE)Rp`O(kpxh4f^P&gZa3>Hi~>H0rsk+%UQD3X}V@IX|>^v65rju z%iIhGjyw#omN+AdLOZKAa}~W^St2Q@CB)OBpv?R^7pAw{mmKzaB{y%<0QYg;?akO6 z-2kk7m4@9iD;f{AoO_mw*_)7IwVn`+ca{N$qEf?}C*fwYkB|0WCgNTl_&RC@b8so3 zZH(w&;#q@M{DIpEL`7p3&p2Z744~_G-#mZ_;z|6V%b3C(!2c{OGmr62_wmMS3McjE zG&v6LciCAzZ;dNQq78gITf8k4fm9>0NDzx*M;xHF?0I0l(Nf9Wy6Igk4yC+ zLUMoqRmhYuYYFFNr~5o+zFH{(GoZKg(V&1_qS;4(^CMEYj@ZEz`S{)K;qRT7qUk;# zF(tlz4oHDMN=lA(r%dOw+8SVBt-b&08mpOfZ#{YBs0P$^SmzjZR1B_oi{W)9m;Ny( z;K?Y$9C&(D4?`lt#_&j1I&RX z9;NvV=GX{1Tpmy_Qsbc0Rx`T?#U0hUi_xQNDJ9%S1dg*^vZnM`Wb?E>h4R}D*Xs8e zGjj+)i1W1oHEk-JjJA_t)*dJHN(WhhrC?>0IRWYj38JPD4sqTZ<;h(jJS_wWkCiOR zV^*qIBUzak2{7hO2zDHEp$==ALwyJwvkO!jC#rq)yY3RP6wG%_0g9ofWV$(~IanSu zsy3G3`4zx681+U*z?2{%HzW-FXOD{>YxExT%ZLK>i_BK4$S8Htu=SNj3&5o#e4nVu z0+t9UBy`6d7oO+qbbj403BoxlV&BkoX-zq_7xxbo#Ahd4T2J}l7W|>1|D!0mM3?T% z0d$e#6J`0tACb$qdQGu%ql)kD-NTUfpJ$7`1zrY()8uVxS09gd}5dh@$y}9HV z$7x`3UQ^g(Q9$vkiZsLBqkcf|rnNES3dW>zBjWWr>+T@p;-c55AL`CLE8^ys5hCA* z>=$64%F0~F{HE*wmCJh(QRNzf8`ArN`GahB#Ic=bVHW61*Fk)g02$=$Rk{1DBZEcUbXehg>y5#yxP zxZPGw!z7yB2PNYfGKBNedZMW4$JZ}VrN6gS_*S#GqqkeP!$WrNxxhqn3^fGOjTb=B zN|S+#7@Col?_|3lsRi>lbXH*qyvEvKK}QVYv6kysOM)x`Om)i*@EP_9fx%c@-mKY= zinvTm1^^6xAS$`vNXuc7EFf4_F;c!KT#`i^tS=#a%b~ zB5aa|`o0mhbd4)*Oa_mwG1F9k+DU)dACi-T|5Dwo{WS(#RBf_NnV& zOP?$hw-?Q=(}D!jj{o@R)+J}=^Q(m@MZI!YJ9c)oxMFXmy{6oLm>x7ZoG6 zU7L(Qz+~S<+eAKFGwaxxy=s!mVK`MnR|~lY8HJc0ePAnF7-|(uH#&MLMtOw_C%1-c z3!BifKT;+?-Dlah7>#^^IA*16xn;-T1r2ADoPugD@z^)wXdY9>tsSqMEQ);?eXA#u zWC`BKXIoIaG0`bCeCr-$f+E&bFx9-u{F_JhGh+B}^L}OH!9O2>ACA`-7t>&ezl60t zDzu<7UKUT)6ML!W6LDZwi?dMI)m1a6{#o5f*IF())A2qHeI6l^Sr!}0)pP&)CmKt$3WbF-7P&KV#zY_In8X;V&s_<$M6@$m&zcHa^;slSt0!70TM0J@ za|aINv$LUnKkll@GnIG%LUTYTlMhEAJUVLsAfA4kdtw1>6{ssJbz&b zSm~F1*!_>J2D0@r`fFaGdZ-Ds8onO0uvQ{5nSsAh^GxDG4^@G#F9}|gU9mpn!AgIp z)_+VMxdnJ$e`Xi{Sg@bJ@D3kY{{{5K<{mC3g1!)fx28oR5o05?@68L;oSAQL@sAj2 zdMmqU;lp4r60Z*sM8;l@!k=-v^ZpfZQrv!agAnB(Rx*HW^WX1yL{60T}O31HDv@;B8&e z$Np=?|M)M+1~F$`YblNaqTxF6%0b^{k}#c`2!-=Nva1 zKgv`_dCSMzT155=^J<*c2JWN)w9N2c^pm~SqD#=xV+V4nv$b~mRdkAUNOtlsQ8^87 z|D5Ts%^-IOkfN5N=4W&IbEU4PRf=|uh4uxkMjo1Dz@a&X-Nw4Q%xg2o>aurb-C!0@ zSHikEc=V#0977r~xFG;@%%W^I5bprGey!&l0D!%eCQ9T1u#$$rko~sY|MBubb&?}C zMLhfN9#%P3g5|u{*!0FP0c^qH`ODl3pe>6l4slN=-@mjKRCfQV76xfoK7`bv@lwRtT6#ueR*>`shkqB%{NAsq^!JVW>jyzN<{#>IK^uT~AAQ~fy{0;eSCkx9Q`VD(svkR?@vu?894Gt* z;Qj9n2hU+fydU#!&yb_|`rn4JS0!g=mVX5;#YD8H>M5XJwOE>uWv z3!U_zM=JvZ03-L_q6iEm)<5pv_dvscP@>vs*(p{%>&ES{L#S$4ZP)pHP~UfVJi5$m ztyL*Uig>oEw|$VX`cbiko}OfnsLJ=F#lch_qxSvvJ$B(Jn(8~e-ak0ah*j(Cg$%~^ zeOX-2dz6b`m(`d006JLWX(15z8_PZJ-C>~h<8kSJc`}|is9ozSd~t&#>8pO3a9)(r z_CaAV-e|z5BziW#n(3wiSuN7u9 zG-p#hC()frwePt+O~1VSahw#xpvEhwv_kQMvp~I7thnIwJ%518ehc*oQa(vwTk*S? zbWTYgNNRL%&2>p48LJcRzc3_0SK|H=tZ~5XgxAcnl?57U=N+bVFr$uxV5KP8<-!SQ zA;W%&)fHk3=NkvQ_30YTo)<56kE9d7{Gmbe#?D-y_M{lM$ ze>VvK5)};lhNSc!?R7Ks(t9i-Sf50CD?(t(=lD`x+3(b3cA}nI3eRq~%66HiTAueJ zpBsOx-7WX0|DSP%N&%XK1u4TT_ax&!bd=bB_ZnwY5#l z&U!nlYI(`+a7s_RU$v^eF5QrPIpD;F&v00#PJ=V(qzm|2tjRqu!&BrvzCP2Ij(tGN zvOa-bcCyx4c8_(i$M?dnv1*gx3J4EE^<&yQ!%d#69ZGXUr89Jyip^vM-aREg_gD`U zdm@?UhpJZd>@Tq^j{BLzJa(UrLS5-wt!J8Wt@vdg9>3SSZGqT95jlIi+P?j@vV6l- zLpq&GsYr$o!*+6$2KlJI5uQkj+&kFh{MyNn>R!D{>!tgcu}FVF+tzzlXEX^C!TsG|P}p-@xu~$0A^^Up zb7=gR=2D;3d+zc7IDPd(@5EutZIrO0Gl5xgX-G?D9+53GdedHh)}0Wh5aOTi zQy`ox45J3}XI;P#G1b@dJ^D01f!Tc4!q*aY`z^LdJiFry_yQG%3yxm7l0`(R5dz!V zwF_UDl1j8|Rm;2`_ZfNETEBMr9iE_J4sQ*rQ15##uIK5P`H{+JhtI!YhmayCdrdJK zEhJ)Ci8ciPxR{_g?|{$q~G$j33@_eORtc=sv5!n<3myf#@B|te%&Ki4rOKT zA1wX03rz>#OYgMs?_ZC~dON+?oXOw0#RIC%Bmp?C`Dwn%S&I&Puu;;2d$sJ$bXedT z_-P*j86qK&{n!&7d=^XNqGThwfiqLJ{8G8h?N(gv+Xdev2Ny?+{nyP*BY`0ZmTn8% zxle-8j*42XDbxMG1?$wU6+uwTHw}8pk1U3KA z7h@%xt2Z+0#b|?fV`H_KM)SK$pqYgFq~O6PAT9Y5>SrGKjPed~S>(BkGXPG{dI*F%6(d zdL(4_ORY?4_h6Kz;T$W=lk-2!Rz}eq#)r=%43}iWv8E5a4f|sSw!xNP8B^pS;5i}8 zV5t1zCwgOyJXE@K)S{*SU7pXW)2@GEzF{wvxrNmJu)Zgua80bfyMdF;Y$#s9W>#m< zVW5uIbeN=KE8>oA^95y8!7lk!>HK5<1$!sjn8nklc=~b#<-5bdi6>ogJM79a#~;sT z4kHftfsy;*y2o}%3_`=D<~9`Cnu(&Sh9Z8;fh@mbvQ~pl#O5e7KUCY+*0K$s-IIvi z*A4RmZXeg|{D_MYXu^4F5_S-dkZs(wd$ani0 zMLP@beu<7dZS~I6#>bf~R1e{1DCg&&+rg_;A|alw78v!W3V?AVzUC`fsIlp(^jUal zqyEFGmB~XK{}?*SmC!)(@MGo9V2^PbnyE~hndkdS-=lf?vO;fkf&vMM@=ERE0ILNS zGNL}%=*RD^PDog2++DoK8B@MQE=}$(sV{JNB`}5M{W$M_HyW`vw2&8-%4OEEx60`I z<%?UOoizH@UOOrP(t2ALIOO*) zPWMux@U03{4AjoYSC>t(I(?7=OD5~SB&GZlss`!u{krYZDiL6R?haS=Mi5g%b_R9o7B_UNsPG4cJSi`7!*5=--2 zi8pM@wD#Ly>TcHDH+!4^|6}j1qoQoTzfnaI5CsGjr4=PaK)OQ_5NT@hVEwQ8eoQ*d2fv8L4Q8q^_+Fide3^-`{l1$!!`F6yFYth`{l;Tr@ zMf3zfX_T)-YzW@@Q0U?3WF}EiEv)xOZGKM4-clNj(3?&*SLep^%-5-zkuu1a2g^NQ zUo;x~Ut)U)fN+9`#;-tD&PLcBa;aZU$eA^6;(1L*Y<%=J*39fx5~>AcTN6 z%)M32*O=HPJc~+G(TwAt=x%PUKp+uVkDPSSO>>}X>fNMliFEDoZ4;FU$Mr(WJVi05 zDT9=+Yh}^-tD9OAX3|4k^xb1FsIzVAHLHN4`E_$Zo0-DxJ`; zs?y{~QE?!qScZCD90n%Y90f+~gybD_O;DE~B*%}cYo=4^IRQ&k+1r6@I3_^an|%nw z7q5mKJX;5iS@ey{8Ow(v?G4i3thgK4{BC+^6w~3^MH&u4jtx>!oIHjo>hDy$WQDhHfM> zLp;{kY~iCdGqTNPo#I@Ji75u2fzf6i-5;SXxk2J;OMo|%+7`-%8=dU$;Pj5uNC^3C zE7Lb-h^H^;@%v@|4D-3`&X{B=a^feQjyv|Fz960A(JpdD9Pn)dk-ZgsXrmP1lsiK* z=}e$?#NzuFgO+qUbi5^9Mf^A8`iOQ1a2v(FqiPcO%|yK+nj3&u6%!nxXJ0BCa+F8U zL_cTrdYD_lpfJ)Uw4gt^;0Buk@MxS>KQ9tq_z?IcsQGU|Phu~$x&2kLD-a6{yO zGjm5_)c?@(k4U=pite0hj()L2J__d@XuTr%xH>9J(LOl=tX;HZ9z_6EQCt;*$%7re zFeMvC9=de8wEcavtVZ5e`DNZKAxY5f`8i@8`#SLXB(uw0&tlzIK5eP1`w#{^o0(Z0 z`g-Sx;%6z?tDkN9mq~+6*)oh@jORf^_?DBU^ZEC-LXEwnX$z8k2qU6n=S!PmZQ*F6 zEoUudC6W1LQuh(~QU5G+Lf(IvfwwIWE zA^bM3GVXenapqeLr1mb%ddiVe-0pXb`jZ;U3ld@osRNg;EGQcq`19ak&X(_#p9#C&s}u1znj=Imm zhds7lS>CzgDEtcS?56i=5mNkmnEm@}Rl)(}+EH9?E&?bjUc_@+l*kVozM*O88XSbt zcv12LzdnJJhfnQfCyAmmKZRFq%+X(s&5{pfNY*7qWHO@XC{z`6y2{$Emiw)F4&3=W zMTX0`EMZv|X*Y@LQfSENKpSB#ww2zZA*H0X?b=R&+a1+D;45y}dmTtdg1~Q#Qp7$% zhA~S_6VY2GG0Ss0+nm=pr=aWdiopGQ`C-ggPr4DK`sj}utB1bJtl{~5a#Bnh`TFAK z)5MIm_94TJH1E5Oz0P~8imeZZ`#$m`uxq%5t{2o@N}|z*=FTwKc*gKz^45H z`?UKsk;QAMqWA+ERFohCDIx^VBLeIX<93vmxym{|ARp*G=m*GZBL%v$-Dwk+I3;!# zs-kpCNV8{>o@0lK*Q5V#(OFXbR}vC>x=maF8N^kk=M^4B{{Bsgq?^l~ z3n~d_$aDOHnh1f36j^$p23XTeVkTCNL)R2_GFQJvQ6){D1;vdK$7q=)P`(dx)=M0s zos%QJ1OEUY9($vegIOFV5?dov5myTh>2_CcHE*% z?yp;ZRLuf)X$L3O3sZ0ZRnka80*)Uj<>u|7$`(fpG$S)E(A8jVN~8J;wrg$bV?1xf zds<~2Jljl7k10kUgzK+!A7~`ySiigF45i_OVK%c{pz`UI@MzQ`mikEo0E?FfQH+{6 zAa`q54RuMLw;W~DSqK*)FmK2>QVFYmQyHxv`Ir~zXQ*%C)VAKzY{2c9rD+|aZ?mjw z7A)Et?a69H*I?1|LH&a2Dji<+e(Awr!8XfQFLomf{AeyFef{yO^7td=dupc0Vz-0j=e=B&-OST!30J_S4K8HRD&ZHQ`!3-ve4VD~J_oxhw~j7{Vf;y z9ED@uDKLydj8NsTdl9;{kC1h=vM)IRO#!z0)piw)#zWNwDV)A~pQv?NeSLS%g_u2g z03~m(@mUN9f-D}a0m(F+o1c-y(md_upBS#tD)0`Jc3;=)ig}Yn$RW1c>n%RQO$fAH z0f*x9d_|WGl<~jKmLy!}9TLZmntBs(bdK*$6DBJR@VYB#aI{7D_U8;4_TG3v&TY@2!r^i#J_om}NW%EYQ=@Su`q0w*qH9||mp>&$ZNay$;Y zak%>^W#H|%rUq2F?CV}ZnWbK#;+UuYyY{nh4&Uf|@B~KC&jbUS1@NA~b%i&;%IEA{yBaE%5&EE^g8h?e_x;fP z^WJq{Rdu0>5iWytfoBM6PZy%$`_-kn&X=rr)~eFIUkWYsjVO`ahJ1&=Yb z)?7dCL{A8-valaHb8ZRl~G9I&sTJE?PHAl<1E(;krMMK^lxlUT^W5El&8yX2_w#7;} zfI4g&f?`Nw3EJggB$+8=7I33(Z}O+dyQF}=UPb|JV#Yi8cQ^(4$9jiS!rqju>uwJc zlUG{W8g$3kEOah(oN|V|^Z;z{ifZnTwX6QtR$`TJwO1_>xjWp{Hi-66d>jQ^lme{q zNjlt0gRlvMp!jL52uf4ENoZfIq;kHJ@G*_VHAUJ^Th|wmtBCE8yFM$bmeV4h8v^_!nX=#g&x3UNpaYLwME${J?TC0SIQJ<I;n_R-`YjVPvL56yOi zc%gQD0GihrolmV2&!LA4UXzevIKzYTiR(ciQC!&fSLLCUqK3CK@3eI?>-UHH?a+>@G6rHu*evR^r zlsPwTU~h!8YtRBznO8J##ro2U`;a!9&YGFnO(SvT!HJl%d2KU~kQyL(S|yC$i7=1{ zrFBuw&ya!g_{}};u1{L1ud+NJ14k0dVwu@XR!7r3(6;H&CS6f%jjy5kxJB+s$?}ciYSV(cF%aT9S zOBB55H84MG*#UXe9AAw9K!9SI!DXp9O+2*ojn8yAVrQSAV4G7iE8^Duw>{oi^O!c2 zZ})J&`+kwG^@kd<+y#n1dy#a z)CN=Cc=mQ7rYItfGzWN5{HRSA6Ck0o1Wr{VKp`7g?@~Kr{@K={5}Ry{UWtWXLtlv{e>Ao8ylpSzN0}{};W2YD%z8omE_~oN z-OP2TX6#Z8f7BHxiMImMQL=zTRmTCg%xj}-vFWaJy-1xi;hxP!x&F|Mqvs;)#_XN9 zD<&SE8OHbTT}8y+^jN*ZsZK{Ig6$Ep9LV7(tl2Y4NJ9-2UHd>RSln`o*ub2zBQjpR z;du)HH-w*!wR#C)*GeX6(B96uaFzNnD zh1rx!osz?SDvw7&xP=Z@w3CB#F%3Es?SgF7ybso=<67C< zb8i7$rO5~h>HMHvX_Fne)~ScJ=(U-*;X&v{Xw4UCk^KWr4s^}qSWzLw1_RMXTlfzU zk3rbUR*qx zKwlRGyWRX@_1E_NhW0Cj?J~`IT(sU!8IUiBW~jOR&Rh2ZD=b2mpzlP? zf-yTEf%%>n@S9-;oz7Ut_WH_p+wsQ}@4qz1@XzgRyH4IAVt9bM+wnu-J^|Io#sl;} zZw+0&(Cxg>+00i&ncO^{mVM6ofObq3BAqz!Np+qQQ?B7V?l@r*L_)b)KkI$asKl7t zz%*0KNw*9e8A-`)K&>m(pu^1+=BaGOth^UZ=9U|soM&hD6VPE*Sg}66?F{HjlY&JI z4q%NX&f*|wOWnn}21C0KlE%t<6oN?IamEm_x(b~DmhHTvUnSiEX%`X7I^*3L&Ex#+bM{ zO4RZrW-UG(>`$Q(h5%%a8pZl60 z?10?MTbAqpwNug10dWt_q)>oLg7pM?0k7 z%1(yZ65~^osk&1~qAo;H($B-!u-yFfJI_2eEcY7Sg~kyt4mY!QqEYi5-skO-#c@wT z_+~)>tjDov_d%AG(;7YsRjTNmeOewnqsz}vr;ua=fpAo&1kQLPeC_(r!FfEoMBAcG zzLShHdz{wGEUX&{5D;GWIr8Ui2j)YU>wiwSJW`*QltS z!7+Cl;G0O<2S*tGODt$;_8is0yO|9w)7Niay)G-?MtCu9Z!j#4ju-+Um;_FQiy%WK zpQb)Y-^ug^6S2+)5a(D0=?KXWDcz6va7kg&2Av(QIw=PrdbHGs4aSlRQ4gy3KkLrV zoW$EIEUc%$a0U#Nojh{X^C}b42*J=^+y3-s{zi%963_UpH6*SNi?&~a8P%Yq zr6ic1?H83l$W?m!ksl|)^N=?r`PH>kH#Nt<#7hEIL?R^J9?k<3gC9pyi3bN#6e_&5vF5kIZ ztAZ$EgvNa|ry)39sFyf0XC}Veu#C`PE@l@>6VIf9$8PKB^{igamS296G-hJ$HCVhg zrOz-1NnFGpGOKQ9=bLNhT;>M{;`yzR-QU3D$qa!b&s#h#)($i_u`jmukjY1Jum0Y0Zk!`k0* z?jU*+R^U=6j1}Atl?H1zhYzm5)$~NRl%0hhC23b*pTe7H<4B}=#dB0zBawLeEX!9O z<%>yNKV0GG&vkL!S5e_q34E!LgMO@hdtg}R$myeGQu}12z}}$-<;$k%Vu$54Ia*Hy z8a3_|3vH$5gumy;xCz>>4xg7PUgTO>7~@!I)PaxC;f++)2gm11Rtd{gZx)2rK3&oZ zgwTi*3*ytidvTPAw$Kpm5V;JE&p>k~#S#jS8?UiR%X878L_Csr$sfu1b%nE6qZ&MB z*7pf1f;si(4>!aQ$ThSe&NMTY^w--@uk>hto#merE)t2 zD5TRr%Z$JNHC(TqG9OZd#?mgEi``V2Y?1s(Id?XURcx+=slDY(b;Vn%fiB|tq6pJe znD-zt^mU{SHbfMwauopUnXYvTJZ3xV=s8~zbCk-Hz(3t-;h20S=3$4Q*hM8H--jD( z+g)=8%H%gSle%ldTom=K%6n@QyDJnL9hzfsy!EyeVObYDWB{$7ECCizl#Nph*5N@d z-sBa(f|hC~T=P%<7*yge?iCnyHFFtOsghOfcWJ^ciYc1%F9H-dzdh2 z{BJpu4Jmq#{8@F;PX6qgN;BOMKEDFMjdr@`2ebtA-f1bSWLp#{TD$2bwB!ch(rzoD z1p#)__nAZo3XA#;*Fia|uIrk{#8VWa;sDtJwYGf;l||-N)SDL(cVxSKfc#6Mpx5U$ zG23eopfb2S)q6%jvNJiBywiKF9QDwngrPr4c29gz^jb(T{wvAJtoVZk0ve$>Y8uXj z&qTX}Ap@q!7oTaLJ|+ z?_|#qLuT^ijKlIhouNlv@aP!bZoTu%p1CH)<>72~A&ST*Fw*@?^kGLE0PvEKev^%Q zpoX3)a>PgHM^Wr^LY#}N;ryqDcFGYi7HJttmrN?}`As9T006+L`N=J=t^BD=5xvi$6gF|cmSkbmF|W0 z)ng)5_4{iPo`LknSS>^MgFt zYLJ;Li=)2i#hanNsPK5{dw9@A7O8tqi5hXAjdDE?xX5Z2>3Yz?Fn>JSnuj4k-o?u9 zRVD#&E1PN+FpT5W4RjRh=fv@eUo@=L%YTe!u+(xQ@Ad`gmSnio*ahbk8onX*R;8e_ytva)muAt{lj2d0~;a+)0pdsRWU@FY*5mOuu`ez-3VakTYe>kPp>a`zILx)BkW6w}j%8icA`N;{a|YM(8PQG7l7*J;@`bB3zF(cq|9) zI4IlZD$B!>!)$k1^G~=Kfs2lAWZ%Qz@p@)g@K}n0YYcfgBl#7jGf)p@k#eF;N9IVS zN7s$H?qn-}^t5P`<|wHigUnbx1jpeFvB1zKq0-^b*)z=*IP` z9K_Srftr;*w^TVH7xGXmvPe3hdUDhq%6)~h%33E=!MQa27KEGGXbngUcul@%C|Jnps^_v_rjD-Vo)W>E>1jt;bQw}nDLKmwvWia_R&~SWZ(bZ zb>K)Pz5p5WFQM9VCPqX;=srH~Vf(Y8;zd_lpj=)Z<7A-o085Amfm0S#sHE-Hax#%E4@l0UN@rQlBM>bi$}maf!QB5ygjUnX{Q1p(mW(qh4_A62ra z5_WkN7=U2k^+uMQiSZUzR6bezo%BSJX9~n7x zisg-=k)}|;D08T?It2)COeY^K2Z8yVn$J-DXY~UK)f=5{AV!n%+S^U9@nbSJZ zkkg~n(IpiI&vs0ckGdUDySj2&^HMFWz1&dkbzy?9&6v<3Hmxv0rc&Op9GA~}m@mNK z6JBrCzJE~uvdTeHP}~+#iZ7hxG8@=!+cX|~2qkKUCd6wnd*>@j^M96eqak`|9i##t z9Jhak?Hl1xJB+%VPmqhseb#+3-pv$bB?sy*s{o%kiE|pCn(t(l0S%wdc`|y5=fF2o zOrI)>RuO^OdC?x8J%R1OEtSi(Cu@O5D9IZ5B!gvjWWr@u@TXOV$Wf4{z0V17!F7@e z5s@0>w;b>S9y6p60yj^$q+w#Y8N)+)$Np@?UM1%zvL+>#&Z#RGk0vDfO3ECXt5sAv z`|jHUNWRYt{NwwFMvhMv&<9bC;%(CRj~4XfA7JW}vT@WT>3@y;PalZhK2Pa1GJ-Mx z_4D68C@bR>%sslZD`WO^+S3nIB_5{pER1Ck{Jx?;%p|QN@z5-#Q8f7P1^za}x5NDQ z%S0aB>&_1x#{;AP#bCn}V6e2#==NXh`VSxeyX60#@*mmmH^u-NlA%c?upIH#o_7|Lm)LZgxI-J=&s z=x-xVPrLfr9_T$@>4>2vyDW!OLv=;2C^i2ykpz8BMn2$dD|xPj;3;cf{3+?*cEo%J z5ckKCQpWTWiTkJ5Do{1s6CzdnO(yqF`%4%~o1Po-H>7_p@x0E6bfc=l=mqT7Nu12* z6J`(3;+^)FOx%7Sw>J(lun%Zt{zZN!B~D*=Cb}m}156h1qR!1Wn)j^I?)_h;rk5~$ zf{P3fUfCA;^|++f6CbN3tWEtvAN(@Ow_|!B1*j7>(_w*srA{;fb>f5;jr$j8pQr|G z;ekn7V9381Z0K~PP6j5R|7I2cUGgz?^8ec@OZXAW=UOw{pZvn~b2*ot!C5NnV4~xO z$*>PsDB7bmZ;6?ML;P`ldEu7IdeAQ;{+3n=`?L4q34B*-QiWpHILR%b-N!(OEa%CX`$2jv&@nsyZtznj8%r z8_H#2Lq0)&W>dpw02jX=P_;Zh^H+wA#g3S=+_h)*BMY+?F88ID<*IW&BVZ2AI>10X|id}^$+TT4qb2F`15>IB=7pJ5J_1d<1Xb}I2XfA#^OLR@fIWH z)wv*pAPORfuY^MI>jf(N=8bN^5}(EN()V>PA6J zU$1c4jfmE^He=bCVjXV-Q=^#GWg%Cq#g(PS7`uC`7YLga#7nQ{zH|IEJx2Q;2g zG;NaAjv$M=IJ#Io$1Q^euxv%F*<3~uGPdKM(1`d4tcSBjZM`$WV|E&(Z`>xCsMe}n zK%HdC!yY8nd!9k-C`rpwt;zy?JNy|!BsDMN2DPu7O=qoYa_Xb%qwSxZHr zVkY|NLr27um%Z6b^`#{=_S7TheoHBgME}!}0N>nR!TBKcMKSBnPu>JfWYed*GVz^f zw=}tzUo~mIQvs%4fYP#D@XFQY0?!`Ew7zcRo5-p zs*fwUtQ0DgY%Z{{E3;BzGN7{Dzc#mL75rrod2>9SR-NvB+^$lonCDDdy=a&NXN9fgnMTyBNv`$NBnijx-bi%-U;76{=%0PX1P+!AT#{Vyskd z=fIT+$dYcp{_dm_e~$KO;mX?TQn)%$#rq*rF~`%f(Kk3Rv+Gt_QT7%$F~(_Tdcw-@ zN&89&$D0rxz^1jWA|DL72t-`b`mRZc**_R5QcQcK3NI zJSOM(ayGI|KTQ!KK`lV0?!)gTF}tj^4skF0O%SPxP2q-oXdPNdqfI#9Ev}AD7*Na= zBzA63a0yqvFg`}0W0btC4>&VZyM2`3T$}IGZmc_*BA1rJ8FyJ$%H*JNJ(_ANvUGLK z736Il-6xyGcA=)?@TE)|K}?2c{mA^SN)x#T5G|&$={}tLO=D=q?&ffhvhUU&JTz+7Q__`{+6uM@GGh3)++1vUy#3_i%QVn1;cDONvq(3{c6Vy_koJ5um9 zrgkWqA!3DQ2llU&v_NP&AVYx-S%NJ#8tIStZmqLg><#-#tYhQnajtpx!Fzt&26t89t}#cr!vXwCmArc56Yt zLw~2vV2ndcbR%0q_P}OWLM+5bL#N~9vE}^D75E|^U=i_`UWh=8@4&(joolR?m~NTR zYxO~8#|d!*4^|RI^U7E}XLe^+E}hz=Gi6p_0dno;T3BjJg_xcDGOSBv9~x-SW$vPP z&mxUhdqSY1vb5l4_~4aloi5eA^*8DOcR#Uoh;Fm$+3j6&_4Md4t{rz6@(9i`&j`SE z_#o8N65IMx$r8@0zg1vdgG9(o_i_jG$idGsKD_%Ub^#k*0PNo->ElL1`8rO)Erpp- zcx-*K4VBhCrXecU&pfg|0-~6MgAgG>wpr1!(o$|fLweWGMqmy&%}+4j%-8J|+7Evc z7;7%WFE5^Ev;iaIh$oeeV>a+w4%z^gb9S&ws0}=%M0hp`)rMBCz09*UJI3(uP(qwhC)Y z2lqo<)T2fwg3Vi1mMG)e;aD~OPkSH4K@ilrOJmrX^DS)Kifs*`>SJ>sbD$>e@BtM` zq;5_6_m{UdZ~>d^wVIwF@ABOLtKuz>?Xh67_;d5I16>bfoab3h<)if|()mG4nIko& z?#;-~jM0e!x~nm%uGUqX3GwboVqs`2nHiDQEoZDV)rY|1B-2N6B23V`)oa*Ia>q*$-OJnH-~c-FM~{?D?>xelv`7Hl1PpLTlB2Et|OpdKdAS41`P!FC>of z)@;rDdSi%L!zYSFE8m~~Fb!IU2kBzaOCDb3>=un0+AW_&s@6AHetac@&S${7owIinL z+RTTBN4?qhx7T+>S)uJ>6`Z8E-#7Y|xJ@&>5FQzDt=X$eR}wFs8eC8a7;OiXfPu$e z(h5_&*W8Y;&0tYZXIj{5ftM0b3?xqpG4o;O=@j5fdF(_)$tzVW)>w62laQ5FGBfD) zoh>$c>|D8|9?GMT>$Yn~F}w05tZzs0*s_mp@yj(sg*YRlKKx_f8S5riCyAUPp^}5F zZ8M21gmD*2a$hKP>sYuHi_QYd+G9Cur&cu+NW&P`KY&>L+S-LaaNVDUzSGKxn zGcrylnrWG35&MWnRJ=HC^ao#v$bp4xi%M+|M(NOt!)8N4BLpM@Bw!{No1wlQm-?Lw zyocHV93rhnUvqcHk0~I5>vPwxz&DF@dke>>|J?y8!leJyi7NZ@c(ynctuFJSC{>Urmq005A0tQ--z=^#z;K-&8Zlr_9}M5vz+dY;}BTW3Ne3J7X35%dskJXpB!xbp7RX0SKqfMEOmO(aNh$Riczaq0{)G ziO(l)Jh1CMA617>_^8aH1sA#?t!4HqVc8zY|1g60=cgJ7R6SMb81*|yFW=f|=wwq_ zT;F|Z5=z2+`lP`}pWB4UZ$xHbFkFBA-X1~zFBl8_km6k*%Wl_+nZIDHV-z)1JI&{6 z$~U-s?Kt;l;SiT~ESXI3_>8u`hYn^AyF8odI6|Va#8& zB#!_F+jpe*{PoR$`0)Sm$r9@J=bNAYJSkrlLr1d_Jy%h|lG3T$Vv0$y-73Sk$ zV;$i$f@{&fsv)CS?#7Yh&&!JbH0;WND=I4_GYK^GR-p?BuRQ(wPMzz@m**J-INCTs z(%hy$O7gpAn3MnzVIs8$qCXUc1b+2`g6-UKW%5J&CN|)93NFN2=0i#wE}TpFrZuRe z0ZaC=qT=m$9m1>!4xV`CvP3lg^%ypFS>woWLIm073j*(Gt=$UCKWF)clHuDFzABSo zJlgX4XiK7*Q#=aasNt`Zn3N%7X7`JB{=S) zX7GQX{L}0n5%<5R@&Dp960^#E&76Ma%t`IDPQ^P`ZfVKYNmic&hV99++gg1s@_}pZ z+tAfjVGq-G+YHOmE`v(qthtr+wZZNy>AbsPyEA*+Z&s?Pe-xSg^32R-S1Ljt2Oh`aciwczMT-< zTP$KsxzSQzUmEL(O48+Pewnn(kn;F!gD-)>y6NPLsihgRKqb8L@+XvOT_NFgho zRol>B(+~t0; zEDTpSUX*n~HdYoTf7`bhynKbSlwecO-?OUMr)6yM3pGr+09%W}W67 z@fxZI7d(s=qI9wFF7~I9S~PRPXbVT3gG3$0^#??2=qV)cTiv7%eB!xB4iA2r?K=(X zB9HP>WYCn5Uud#n)tcL({<9YVE|5m#0D^YU;`No5k^ZKO*7nXrK#vDx+s*9O1XMIb zZ-AnX_tt2oA2)aQjFtXS{3Z4pXE_II&bZ>+M3m`j2~L}{0?+oF6hNZrmeiLPf>kBE za=NzICOC7&Q8q{;!py)y{!h!(I)V#XxlpahHm1WsFW{d=wwjp)!KI>x%$>OL-l%o#r za;`E4P8^C#)z4Z9I3h=(VM{N6#Q=ZUYhy*jF5*kgj|QB7qbYTHU0*WXjQujjuCY%{ zy{ps*(>CrX69>gw2jpb7x$JW3+MBV4r4;R`Fy{}N+w<}*7n=Fk*ax?lcZ|7}0yIY> zsaKXoZQIP}CeU43)|Nt#C$ihdg*nc8RN-kX%CZXl$rCY@KMKA5%zI^jao#VV0sCk^ zaY^_8+SW8z!8$6kIg;CQO7U5J%GLOt$z7@s+0Aja={nnKdCWPMInG4(X{eva}uOX)3Ov`q?QnL-oKZ2#opN^scVP2tM9s4i0><)2HZALeHSKX*u z0`f;PuGW4flLsM>$D&u{hMILXT}RO`omCvRQdJq-FKel$=cm_ZL-@~bn?Ajnb;hOF zVoaznTF6aTk(Neo|8QkH3X~rYaMwJLQ)2lef(4{O0QN{GOCR}#J%Ie}g*3s?7a38+aHsLmy>}LF?O1E`WYyFS29FW^exl( z5OYz!u4#K5HM~U)iuWvngdFecM1n{JW9YEEy@PzLXAKTCw~HdWGR-d!PGpq{dtYK| zIiWtVfF;}~VQVg;g}6Zrt4f>e<;3mf)fF(83Q;a`7}ww=(2sq0n|>S# zc#1r->Jy9htm&rh8NNEW#ky{><#M(vM?$o#UM!HuO7L`90`SJ3U`=nAdLV^YB&?>Q z9nUk^6FYQ@bpbXa`pKcIT-J>bMp-#$Z7FPvj0o$QO!XGBg{$levI+l5(*s#wwZKNj zW$s@UvH%Ylzdv^KmqbFqMSG3W80}(4eI|qGq06ibC9LvAR&y_-aG&X8G7n@D!pwT& z(lTKMc8XSy!yIj6(|pd8IfMwItPgm)jrRwrQ;%b+)`F z?+92Uac68$#$h4WV+BahgqF!DKrQ%gS?X?UnfAoR4!lmym6iRH0>R*T(X*|O_Jxgl z?ClNA@x;V7NzO0?F?Hoe^tH&P{Gkq0;v>Pz?#s`2mt!%%1_uDP8Of9F0%Yj3DR{;0 zN5YdksS|QC9f#kh&xtS-K(A{WY({KT#3qQRk-2t=oAm;Gk`GF{ajCXtXzu1`36+m& zH4aS$Grb7nPjkiz!bS!$`l8MgK|p=RpffAqw!i5SvP$LpC&&3Xj&e-8s4oE;M*eMz zVuK~Eu!-Z=b6k)72JJk}STU&XP)(+4uaLT*%FTZpbhwU8T{?n79^2b9%L%1xOW!G|8>qpH?l{QcwdjtSl|7cq3br zzBi92Uw@i(LwUlLgFCa4w68mV^|ZjJDBi4QD1v&5WxOj`D&}U}(o82tN|TxVmhMfV z2dv)&uVgQ6`q(CHj}B13kJaDltPtjNY7*ixLytqJDG zzRxKP>5B(FoXHk*9F>hYcPoR;$G6)d9xozHUCoqMuf#(px7wNfSXSpR7EykV)8EHZ zC);!57t15Cf&)~+9PS62Er8m~TVSZl&@!)wTH1PEEmaGRGHu~`LG$CXMaxOo(=i`Q zVxjkAF+CI1{N>67zv_tZ)b`<^&s5!aO!57`JBd5^R%=$QZ@d;yAB`rjmY4~RZW3)< zB=>Z6{)0fB0AC>ggo5Ee_8|Y$(|wHOC|I#2G`*O)m;Jfr855}_z(RA z1pfp|H6MTFk3UZnkO;)d|6TGoANl{xQ&tO{EE4hmp&pda;Q+;8?5~Y3pE^cwpX(cS zr-;cPy6*UV8+Y!;WN_|Br$^sa8j9>)-%!H4%nA= zUcMRZRm?XnS@-p9tYfDj14=^a`%@Yj0O1jFG{64+F?IO(IY4Lp)A7?607OU%+!1G8 zX8Xt)HagS%cwsl{1eo*c5eOY4G|V0;<|@CV!9+kZnE#vujwa2NFdY1L!2rO8^8PM} z0>8YNAuveQ_b06RyAvP42L9R~oJ+LK_H*wN1xHnp%k7kZbgqAwNFxGZaKGo``JX>O zzW?6`|M$s%DQAi2|2^lw`~~2{|Gv|>eTbuKN%gu`h3!v9^9O-K0|0x_B3}aj4`crF z00RJ+xie$SL*U=YKnoBKhPJCwG5?Ffbs0w{>}IX+536J>0|3XU!KIw|AIoZFxt*K$ zQ2@_W?Ke?70sa8Q<1A5`e9FHV|Kmsgx1@qqj-oSlFXDgJ6Mt=%g!u~K+8#5}e~x z`5!e*%mQEq8f)AECYoPzY2Qv=;6AXbm#0<#&Ao!>byoouM@6TOjfU_-9HP_DfOT@!5`PjT8SLJ{iFPaF3BV?<2-vCP)Ho8%re% zFa0r^{o`t0kOPCin)k5$(_lj_+_Zk3uNGQ&c>e++?Ct|WxNpNe<3IiA7h2=7C_BH~ zRsYGGp~ZEqm_^tPQLmRw5{CD|xpAu@mdmVd97A#j&ACcqEvyc{p0_hYxxQi+&rfCPc}lyQtD5XoKjYe|W}m)&uZ~NBN}@pHZ1wpS+OqdUaZ;2)zUBK5|GZ6PCHo(-yb&2P5>9_ z?olQNEpwD?+`n>>%q&b3Muh%U)1M2W3RmM%%#C%I*Or=74kON)!>k2?cpvI(LlR`3 zj71fPjQ1YK?KLD)vU_=>rPe#L)a`svp{rLUcPXkZ7dxHB(Gp$U#QpIYf1EDbk}-rq z9I?JGXx6c*7Og88oDrFi*hTEQL^M;}_ayQ-G6xdo_{COB!&W;(?m4PdIU169`Q4m$e6 zdGoL2njtH;t=Y>CH|d_Wp{+;Cyr!ySN1#yTLT&Pt51oRNufU@FN<;@1HI;FDN>n^c zXgcMpMG#C51bM%-v~IO(IWDkvBY`qInK{bKRqPNNp712id^%xFP0&rhC16AXh;Nkr zaYhE5#}T_QrLnSP04=7$#;QiMyX{q9+1~biSq9vU;i#>404iQrS~)OZd&q*nD#+2P zwM`(48ZV$_N7}{S*i`RMD0Z^j|DIqV&#v>rh$|NmjgxytKO$j3|ovSIeUV`{~ zb`Ml%&LL|9Mwa9E(xwBJofP6$tlyUI4d_{JbN@p`+t;Defj`oM`&^H#vg0+2E0P3tn~_jjo0^ zYyvuD-^^=Wd*E=-PRD!GRUse!P$(cCMqD;_7;LY@iwbQLN8X+5OLlE^%Cm(`tzTP) zy3b7T*K9eS3L`F@!vul7>!UYw_XdM8$ zySxwFgo=Q;j<1A7XD#1sMYhFPJB|cmchsJ^dLa%jt|O73;lp5Td;i#w>zG-%6gnE& zDvoToFH*7yXwAOFi=DNND6wA0Or^(r?(ts=*L+f%DKr>vJd*wNs!jC@M5a^dYDmV> z6_su7N-N^#<60EB3>%4iNS+vJHZb^|LBO1B%ADqkP$~?hwhCfeFSR7mnr*Sn;ix+x2 zF3{^L4)kS4yP9t0yacU}lvZx{7&PcPFVyfZeW@?KtpV4hJBZ!C%nE^Zy(v+rbG@_I zJ2GNhTe+4qkY=Fpyt9qb#Uf10Q!0X?~ z4^Coj}F&6Ps%( z(X9&p<%XteU7H(STfY|&lS6<|rbnsZbE6wFy*Bvf<_8`(RSvYM-k6;2TUt#; zVZKX^nPNycHxC2QsL%U8KRL+AfSO`F1s+;&m1Yl3Ph`O}P83X zMaRpG^%_GNvQ2MgL_Xb?Qq{!L7+qoT8Guu=XN9EoxqQmKB`s!}0dzA;@ttIVkt@ZG*uo*KodC|)G!R;A3 zD1a+9u+Bej?ABQSdC9}WMJ(ds4g&DHQrR|A5axM z__|*lEHi5@V*1exCJ7peZ;@|!rF}6_wY7C`1*QvHIT*sJAE)X79#~tH>(FGsIYer} z;TElMxhy9@`zt+aiEIY{9(6>qA|O%(1?f$?)Sw_mdXr8N6r@Y9A%hAEQlxiKI-wal1cFNMQbP+! zhfqRqX=mY#vvp?n_uJQX&UMZo=ljPiE>_lh^StdT_kF+OyuFeRe&tt1m=5O`c3NK8 z)<70Ns=ooKhlD;*HT1#vCHRjS7{E-ukr}|8YS8#cpcP~c;5Wz1YlEz(Y+Fx~#w(U` zly0jY9js9(x7&R19bN05BAHXQ*h(BmleJ%vPHiulj}>XZiw$CrdV!fWd&`i8jr7V( zay42F8zRg(4P>eNi0qqdc52-`!LZ3_7(LNJ<~2Ema-Q1HbnI^D52;g1OXeyV_utLl z8*fO0aBeAtmEhtrEWI6k_J{3Yg$#?&k_|MGk*QPup7y!1CPgWtAT^AtxB2wLQ~AGZAydezUZ7Y6QLx*l(J==U(=| zRP1jIdNT!v_W4G`&>HCRtyxgS%LfAm$Pe4e*wE0PG&bfak@>t9l%K$Jw$VTV!#?$w z_NC{_B3L3Stoh4U&mkg&&VcYwd&*{Js^k47o^vAXn$>M8B4NR1Yn-F*R4lfB%~SJ* z{%&7Q&VD`s5sgl{jX56XrnIc|;y@STfddmhYJ#0scu9lKizruHt8{gI8Tg@kT5?R& zkt#3f$Y5{iPI1H6)K6*GKP?-Uot)ih1)#_~`LbiNy-E1l;z zz(F9}#zt6j+(e~_Xr9m1zD5LxmHPg}i3S3DdiSci`%rEKP)zC>+9}VK6#dXq*MAk@ zMC;2WjP7h#yRxsTjw`{s=e;|Q$_c9TBz#p7XMJHDP7a4YtXpg{adBjr5gv9^W)?}@wcM&7 zb0oHMglo0R$WzbeG;s-TM_}Pm<;dIIOTRU?)gwX zJsmhd${X8bHyOv!dL&J8K7^t{}V4zS9HqnJTd7?7t zGjCN=uOxU|5YA1;ZcnTZEIqn15G*5xJbHsei*P=i8g<@XvCyRG$WL;$HFSsc3PIac zJK|z_LHLoE`@~xpPVZLOPabxIg8P0|YGh?9Ot{0{LT{XW;aZxP;ct)Q7DxBFCH-{7 zSst=W2<&OD7AtO`$36;QfMZzhL+oNchROA%bphNhYxn%6L^ zQfhRmuD};tJ2W6g#?0iD7ZfC5E(>QXa_e~<>Ijvj2Nn{Mkud4`W@mj=rkESx`s%(O zU*X3OC2X|<25qO50%T{E_#n+qYjH?_Ua5+ zIj%m!psR&j=%e(6%Hq^ud4*=r9_nKt|6UW=Xq!bM6D#o?*`ADp;^R3^aD0 z3P1B@&J7C(I|N6yZ8AXiUZ$vw<^o)66?Jw-tz?FBu}eI@(Vm_#+SUs%Dv}K;5 zG&W?_k7hNnh)oUmMVgZEAZ7Ad>8qZ>i^C~iHs0MIL3Q^9ty=Y`F2f_jaY!+F;0O|- z?kNbkToVXVlFar?Y}(iy#IbkJ=Wa&GfPKe0$%^;(s|b6bF(@vbVmNp{+*Z9-ic>>Q zoN|(o`8YE#iIOjD$fDApIFWZ*^7)em$ZP!@6B{+E-3H=pS6LqnXb}kT_=j`;E{+$r zbHs?&Ln(pE-i`B2PQ*zZOV5?${2}lTan)=1lS{K#WA3I1DTXhLs&1S_$fk&~A))p6 zZn^s)#vKX!Uf<#tzh>)b$EMF9hbp{lRBOjvo`=Kc)p%y_=q5M86~_84*Y+lnrngQ< zey!3|!MxKmEwCDE`R+6ItSek`?>KOpc z3Np)LUrzhm*t>HI&z?4upqTlG*WVH@d;iIrtJ!sQH;-9=lJdu_lAdNU_STAA>_yis zRO!X2lm}FUsoQbo)eR!igTc=f)bm*LHO|T)`#l_|#gdB$bi{WPKIunCIrHP(=mvtL3{K}vmqs+* zeQ8x2j}|y6cIH3SbyQ_nVj}4cMs$Rg;1K|sE4LySdFvrE_(cjKmMixzSgSIkUZ_DnUB<`cUV-`Y5tK4^3`y%LqKe-nqBr2xvp*;f1QP`o71T2__)XF?pk-W=VPQ(FseO% zy<+8wb^;RQzY+)NS2Qh)J0<8LC3~Yq^(2c0ixL^L0*l7U9=0m;KRNCsF8P-n`5q`w zl#I{z!fVQA+!`2602CGu(Gk)}=jM+mK%;8nKP6v*kSav`T?U8Z6V31L)xE1qvvj6! zoZ8o|OT{!#oeMI^%b6vT*8Dccs_iD;$V847Kiw~AVAA2)KAXvoP+NGK^)ReuAgwzr7Q`FdsT(iV74s}1#mMtac ze9zg^x#EMYkQYk1B2dx`_+?$~>XQAC9NPA51C%Y;J?2}lzdxJer_7d5S;7u&(BJXy z>rMn&Sm0nbikAu#s|tqAoao~!&;S=cW9gXp8CKqJXXt8Y3H~y;J z_Hl%|tt<{Zay>NdI~JkkrEHcqv%+PSGB@J%SZx{E6?Qo6L5w^pn%WakyaQOpM$kPm zXU@HoA%&_Qsarv&1q-W|vU;IhQu3Y7B2jW-B}9uJ-U~F)ck{W>A;2#m z;pE(sfV*p{2krr?=EF;eC161433$>22oGngU$Wd12oTc< zJdYz2!@Uk0A;YxXt=E7YX|fK>ity>E=!kZciF%rmum2jp>#VmrS<1B%fQW-U=2o)ZqIqZrcjvH2WNOa6war?*-VrY_-qyo>em09N zAgqy#o!{fD!ahBA8MlY8(mmx}i67D75nqWOY`1U*$f^KjFF~rxarkT)oKL+_)fK=a zMNc{!k0%z!lx>9A;4q}&q3cs5c{VZzoY{Q~HsA65+MEEV+dhb`$Ii9mWG+%e?%pm^ zeP02b;1Iw=j<3hIrI@7xIK_Q%)pQl9p37q^WS<*^#A(#0`1}=A6~KI@ZJVFrzOaPc zcX$(3p6u$xVCm6xn#ddGyHSOb{ku#2QOI>W&Y1P=DlsUjH$#0Fz9@pkFu8ctz@B#D zU3IOX1qPEj%$^NFkG&JRxb6VQj-9hwiYwz<{wi0Xv9nX?6h@aIM zOeF-JiQjQFx*8mvl@3qo`WjcJ;v>czF<@Z8fp`XP1v0v8E832SpIr5tcCLTq&bS93 z()YVkIk_=v0M1=Fcw-^`eq^hVuvgN8j%0-;`6~3Q)(We?ga;+fyf(PckPGCnU=1ZH zGN7?wjlP~&P&y`fh6dnW=ZP}7YlDH}Rh$>>UE`4dtY=IXEpQ-}2tpuVBW@!RmD3MkZ%a8U0rc=b_ImcQbP zEC)MoFFY<_t-yl2d39^fYblNlrSYJHyQ9~CsLL8qA9BX-#a>#U&=;BiIhXaDtiaj1 z!}fau7kUl8hfIN-ny&rlI*Uo2OU6KmvBK};#4{CT51~$0jTKX6m{6u58#-~em`%!751GyIXF1e@P8@x8ks{|_Ji_OnjrR|th&TTX3 zK2&_fb{Y=gN}cqH+=#vVbaj_>z3&s9ETXAjSl~V!(bRE6U%+L)3;F0naflbKUby+}!p`Go#xEYwfsdAf z$X(-cs6~6;aN%3MEbFAngLGe+aZklB76B=Mw@N$MRs4J_M7m%>S9ch^QCz!NpS=Q4 z9>X44VS`vVUoSBEaSV?IU+y&vs3al-dVBq}D)E=JzXiR&-uUnpuPg@PEVG}ata6aX zhLr)i%c!CfbwFE3{S^E1YEPIc#X#_ooh^oYYU2{SYCd|LPDh8BAcU&sf; z3#8@)b!gC~hj3%j^!*@1K=lj_C}ACWW9Gew>)+h&_5>YyZ7&qRUanhKVQ*P5e4$8n zfh}+)uAC89Hvyu`xLuRv7!{kssMPr)J=RoPPx3?RL$JpBLh|U)-}pJrH{U|RYcto9 zwSMTqv*hx589Vw=OIjd>yw*?;oGZ6&*;Kxf zW4F8}PR$H-mZLM(FoWmaz3h|r;<&hpSt2p5A~CLD;lip$jPWCscj=^tJx%PsE!CdX zwz<_naXq*``Qfe36o!L~YOy*I?d6qLTD5BZlWObYZzS5435VFW@MZZ&wSmKFV~7aY zVmeJSM%zPpaT<{PXhQ? zcCH)-YAjj<^ku5jq58<}sRyYv3QzV*~3O5%gwgZoJ8qEb7FW2ZOZ9wh+WRpnqm zApvN&NFU;goEcVTx`5oHIta*Fnm_=7AmQCMQ?1#Q2MBcyq}v1h(cE=!;x)+Do+|EG zM-IW0Q*zQty#C3?ryObrt!ogwlqiHz@7IpM>QpS9BZWVjI0Pfvv0F%}5hhVBct=?|FUh(1-AGa9!)f~?iSc*!!4R~c3 z@I~5d2A#2;auC7$~apXxIntm`i8*j}x>A@10)O>Z;(>^cJ-%0GRQFz2Af zUKZX{C-kb=q->)j?{a&YL8$Fgl6Q&K=V$GUm`TKo?C~l+b#Xy#82Pa+-kJZpkTNzX zEK;^T8|`Utx>KOKwN)OkT9DTj(jOBm;)FT+ln$aOSeB<+0JPI?Vr?as|D{pyXT;#- zokPgSd1eJVe^@PEL(r_Y>nfR%4Y^=thC4^AGuAGFrmkIJB&1CI*0;WR5c_Ym(YH!2 z2N$5POg-dAcmCUdZ`_VM)xnMF@i85DLQeRP4=GpK(IABpB)DO3k5irW1Lk)+o|EG~ z!!k(__pjA;g2Q8nq*27B+wCw3r;nz3sRMKWYJBV3V@Sc8&k=It%J~Am3`Fq>?i|wr zOfCXbyl&wUmiOD4Vha=fQ&jTLqsmU6luMFA57ZPOq1|iw`Ra1}s=aRRL&h2)k*Xf) z{R!7e9ci=>VZ}9S)*vf)wpNAZGUasI!T?CGeoY3ht#rz>*0G0O)FL3x&6VicG%HXX zhf9Y%-G!#p7qktoK`d6aV_oIvzR@Bhd<&0tw;YNq$KnDC3JB((P##p}jEz2PlcZYD=#yXx$GBL?y zF$uZIxDNSRmA_zkp><9zK7|z{uW&0$8lr)(A+R&412R@R^xj!8yX0Q{DuzFm zG1gKbVHpZ_uswmYP_`Bny4qr)Vh25nG^k{ELavMLTZ(6Q6<#m!l;Y77`s{c;aI&Re zQUp=|Zhx9y(g|-{T!NTx+wLEz4Er^V8GXe&ruL*dJ;M5ZclR7uxzN~M*b~PT4ESg% z30o)f@D-g>R(8L@9_ClvEfrQ)lqiF<*}lV}p8+lcG}2(NMR;G*&0iDK`9$)e!eiJX zkyIf0mAZXK4qXKv!p)_+lhu{_AWm8!XSTcs_N2T_>kenDt*Qc~bo%Y5X2zpmbXDSR zk)<6EUvt=*CYtuw3wWZW3eoFO_Q(S}ONN|Q4*G(u+uu@QRJte1?=}0}iR;9N1Xz`WV?t4?uJI{>#-W$5LCZ+q$MBbs7v|e*tDp#{R>?~;z z@)#W3e`zR0BPv|^P(K?sBN;mL^W`_lML>yfL9w^GmXeSmZUPzI$05A!R&~oHqVz4NiW`@m=`(DC2#;Bg<2q6)x8QhgK(;smPa#XWXqEG($T>+7v(wss3?rX9t=Hu z(B{z8VqCxnxxe`ib4jvbWtcn2Cl;U>CuK{Bv-q22QaNdJ?Xr0*2h$G9X zD*~xc#SQKAtGf-T+3wvFk-V;Da%Zl3`3aLfV)eNfy?hLpvJN#@ljI}HD2e1=y`_(@ z$>99Pq1-LwxFxksfh_ep>m&`Fyq*=h!9-A`+uEP4UkjdVyohaJWRl~edCZK6?zKm6 zX69Xfqd#9eehxc6CJi>JnhM&@o>?rZkC=0!>s+(Pr%KJ4nH`rkWrNSi3$sT_C|h4$ zMN7FN?nVx??pFW|)x3>@UXZ9!dM_cOz7ky~-lMRy7#e}~KlI(Q+rS@K9=fSdQwXG% zfy%6Ne9S+kZB|a8QtNU0Dzlki%%^V{`5&@M_Ks8*YtH-?(8OUGa2Dr$kCvYHyL_Sf zxwBc;_WEb84l?1B-h0wQw=%6zmc~=~)S3D`=6`8H+Y*bM@CvZ^PeFm3xO6KkM^O3V3vg=)8@yaOra4C)Uf2CK`cPkuANR4m%AbFDA$T^6 z@Vci7b7z3Bnrrli{SxcSa00DS^}0LESz#p^+2@9N#jGrpbx+U{2x7*l2^MJYt?0RRmuT8#WOWNX8~&=OHff+z@E( z3TIsjT?7fSpigMHXXpF{cTfa>uEj8Twbe7k?#?&&qW@}wXoDl};}>fEWSNHby56;l@jfAD+33O07pa%hi9ss+i3nHA>9H9V^1#MR_G(7hI<=jIp_l?UzG^RT!@V`KQ8_%#hNbq$ej26*G4L_r#?;|a^#@=eoh zQJ;ddlB4dO`@=*$WuFO8zfM`FKzpTH;4s1wA$WGPX|!#fszc1>?TW!r!@}su0S{Wr zmu0BM%l31Pi}dvZ8BgsdHw(|ooM@r|2zx)G8Vw`)+05B9e-a{GM^UBH-U;1*OoFkq ztWljU@_Uwh*^5gzY#B`SDz4^slXmKKS~~cUhoYV;dW|<)b&sreZ8PWZK@J^ClDbn9g6K6mI5G3LtxWr z$3z`tl$b_)0x$uC_MCzY>AisZ zI(SL5e!Cv^8@fb6TkAUjHDTsNJoShn4=V&7ec_B5rhdXw#=aDJw#UtU?89dVQ>u*WrY zr@q$tv%ezrbInoOfoo}!`hdz*x?`f`V@+p7?Tg+eJesDoAdSI=%bOP4jtRnRt7ghr zti2nR4D+dkak)qVVJ12JRNq3Yo2Uy*?y+Uexya=utUr5Z!HU&-P3}B}7Uy$h_WmWF z{J3yt1fY`dnEXjnzx^;EN8e8v)*>or3O#5sD9Nw$sp%OyyjwDU#qMAU7cY}Um6Piv ziC@*_;k3`WdX6(}ghaGnkJ#$!x~?FFs0pl@7)vLpAPKbR=)=7`7b+Kg{xagfFNe2} z1?dHDvPUnnH3VIc=C zm7SAU1K}Dv-4|b7l#qM^eq1@qz3kiSM3mkG7=nuS7fScWB6g)V#yJYdNrN*wl+zAt%aZ+QyD=B0bifh<`q z)0@$zhhWnxzY<`Jv{)=rx{*znGhaK#oHMY$15wT%t5?sH#Ha8IOeUFzrxDk|*@6|z z!`{XjkRLS{e}ps!Oan0JMzxqfe}O%1fG$@Qt#Qt>ppA%-@1l(p;VzFPRcHMU2xsm` zbvn*5$q?G)?M_x-+hxJ3mRrZKfCk2@g>`w_t7868v5Rz&QsM7f0Ji&n&gh%g!|Oiw zdJ;M&GFq+qM{%l`|RU|^)Z*>MGNk{)sWUQ zJN<`GY?(8o9h0cxQ7~OwZg&g2Nw(B{5PtQjv8SVwzqgXV)4f<-q`bw;a!_EeXq00A z?*RPYi($rh0f{s28;DosUzkEp)(4w&}J1g>+%l~L) zS@ZKiJ1k|je^=&?!9E5ZH`5B=RS9kB`d+Rg}Pe9`9^Gi?Lmjlc;wRimS zyt;Kqgb14O>p)A*GfvF_`+Lk(O%jLt+T{elU(yGoL1aFfk4`jC!NJcy{YowB)5v;T zZjuc=XX3ZnOwDJ00KACpLwNyMll3vISDFHJZM@9=q4J(OuxtbE zhpMO&8J2ztaG|MQ2qpvH_I&ixy#w;DMe&{XDL-xf4pn;V_A>|J^^bGzDV_=C+4z_= z@BA5x3@gn1rrF-1@-eA>UL;-N-xKk>CI3FaG-1GK%9ap1`a{?o6iw@_%T2OeTP66z_ov{PmuBj@yW0IK!(as(*cV068F`m;bI^RQEqD zeLvbYKp7ylB+C0${k1gvmnreh8hJMWOOhwq%l$xyGJiwfRctqsv1a$Jl<@bj<1MUdbS*`JSPR8B_-1Fz3 z{>LZBB!4Vj4|k!D+We`{KaKzztt|^#SO3%8z5V3ZTXQ+9gUjFPi|;0YZ*({)gnegM z{N3>XzVgQ@US>Pr+0_63)8Ch@|9$e0UGu-z`2WTlBQ7V(R_LlsW{v)b^_{~PSS3o+ zEl&P7oHmYQW#OoV)2aVy1^jac10Vk1dor8s@n(9eJmc&io8CvO<0Ww-w7~T53#R6= z=rXIo1&RMg8CY`b6MHv;G%1|KESI zvG#FS#Mztutbg@qgEZNW4JsHJ^j}$j=D4e5?$#>)eTn_smH+3SEK7Ur)$lZG(O&t< zW>V>ZGqZhGT;p%={^RGVLVh`0lMi~O@crjbva4Pm?;z1;}$7 z7?ZpdpPV1$_`NPbejEqTn7V1%?3o=OV0pjfhmn>5I{`)RF0{;&9ASHA4L}&+5WxDz zaSgJn(bsC(W2`wQJtTSJR2taa4B3HMEXf7Ly(w>fjdpx~LqzT!CLe*ILD#IlmAfcT z!f!i&`xycKR0m@yPt2Vs3u7sH`Em$u9D~K(Q_t^`q2MhIe<5oibp$#CU15o1Sh8`fkI2m}vk0)4LsD z{ycz&@BEYG&i7Y+ck|yd9Pjs!u7>?7mi?bP68NG2`{bVn?f(z#4C{P!x#izO>v(KX zbG|h_eC)BdrE98U)zg!G{_Tnhx&aS|>DKyu^3R^=b>1mzD8VlKX8K#LJLZqIIGf~g z{dL#@*`AK8Kv1@NDE4D=kxStQswM|Inn`h0S!0S1EnLPGJ2vvAi~#ACj#@D=tnZ%8 z4;l^|DumI2J6FbmjMECZlEW;UKG)g`YZBX22rBCX;e1_3iAr_4Pqs*DYt_@-Xit2e z)hjupDLgvNOthWdm$CLe0kf~bZUvc3OL!i(lLKv@N%QsBDjPp{&!1(8jiBq%EmY9p z;o+9Kt2R|Qy8K!h+xyu41`4GU+nEEi6O$>59+KV%Vm?{cGv)kP!_CL~5ZB%ELw9$z z-t9Gc4Qr3(jPL_(DbK|g%vc!Y{>577iWJR77rlb?%xEBg zeS9F+W=Q^zD``Oft+y+V*t+Qgv?oCru`qhCVW4O`$?S*-BpeyiP{D5MxCm1I;-?kz zSRq#r8;QfHws5KkQ7<+tQ%r_%8)2rR426TREMCj)(c7I8H1IJ*O+ zYxUAW+1vYI4GReXWqI>Esb+dlKzUhz|&avp- z2d>8Vu~TpR6VHS-f2eh=XJ&pnFDAnRBs67h$RFce#2}>nlKR79GADz`CO0E16q{+- zyDra3Z|saD>in{IjNc;DIyZpD3CzRSzgY((tIIUKDUHJI5M#LF!==UsLdOgsX!%R( zYjP3wlHe!qwrU%#E@2xSmDpnT}lJ+$kHpKFij$E$i zI|Dn}JGWCVdU_E6V)sbM@-E>lcEtbFB(KQsGR$O1POJ#uY)y0DV=*`VXytHfticMR znNua{+pWkHd=&X!oREp&9YKh5ft)qQBS3pft*}WZ|Bd%m5MPq61QXqH!SBtIuXMBg=VaKOf0~lVJ{_^>9H~4@U?=zh6x# zvku1(;?rf+2dp?XBMDH@8=ak;AdM)YZI7w9J+yMF?EWJ|yEsy~hpmTrEr4?XD)$X9 zy1D`{w3=!HtJ}O-xyyB}#&f+9@9*E@yPCv>68I*?_29t`om7dn7l^bCPszH&PTacJ zM!BCVJ7Yc!9g(;>Q#Fsmyuo*uwu%!_%ntp1_=>lf`IyRSUM zI)D>`@cbw3HUL~fHJ%@2oCF*uxZQ^i2SIVeH75m9?@)_{SpQ_I^E4lFdY(~!tEGM4 z2>^9?089*Rrqs)KE1aWHPMW^HMp)^tS+7`LFdRB}3Dz+v%z%rVb{8!340p%{n1X$z ziN-*nct#Kw4^L2kfBRxTudCfY^ggP4Y8|=O(K0(J@FA_+%P3qy0yS?hSmt5x*C#3Z z*e%4VtZz0=(VwY4jBEE*z2nP}WqgB!Yia>54axuTJW%))a`g=Rpt9qqG(WOe0MwU& zvdhr9y*E0edMZAQwKow*`MQneL6%ds?_DYzu%oYz(!FmyWDHSY*4M4y_}CYx5-dUJ zmF{oYYByPg=?-*NI{_7`aOcpP1H+lws%FSJ(-5L!2{WBuJ>iow)TQ3^@RVLoj>rD2 z#ZzELVU1lh>Mm&S@=nv9qspesbz1W7)0&F*+?B?ed(21cEn~WNeg*cd&+WSIrrnPG z9CZw9H$EHp-3#Tj;8mlX$a(v!J08h+aU-q>!Em>GKDI?r$uHtrt@|djT z+W7B2hZG$7W?q7*tcMMy2^MYlmwCd_^9d9*dL8b?%ceW6MCv!&^$v;AiIonUJo2)< z(vVL*iMMS3v_uxC<78+s9!(QlffuHW3S=bD<89p zz=x-AR^w1Av*I3E9VIzBJ0ry3h7HHXm_LmY;5YjPFGsZbUXP z(4fEk>GdAFqNf2bw2t}*C;i6l*i$||$i35}C_s1GzeDei9%390u-N}4KP7Z&u91=+a^9(iH2TWI z_g!_~CM%ZfqK18W;$3zG7N72QecWqkotSZ#eYpPhJk)2MGzAowMdoyYGG;z;!!_ib zW$2oIgV;T;qD4RWnj&_&W--2f^h^g;ltfKZUBrav`XkZ_KJksxX1U>o;<$9bkujA zj4?DG-Z=R7quP6QhMnDu_ILD5B{#CU;=83i6#d&%(BU1}UnJ%zIyWZjs<%JUKh&*v zil>;p8+g=c9ImrZv@$F;>ZK?_zx~Q%@-q}C6Hw<0Wy}1YX#a56+;BgrVn8fL0@$TL zK0Y(J=IRnPxQxV&O)ICS;ZE;OMf7T0G#@ z>ex)N=6|7xtFwLSEi?_TZPI0SX~wv1jave#ZB6omoB%c{HLv05O)l#lXGGToy3{Uh z8M)04&*;VQrwb6U{#Ocisf;=+OO#wh;UCnjh-q+5HJ-PWIKTTAmTMZIv7@7su<9i( z7w^KDfjxrft@tYBX2Ut|B`P{5{|}gcefidm0%wH5axQcf%)&%D8nee_dPU{b6RV>1 z4tr=!li=;Xdrc9rDo`G28Hd2uinb%+<&(xvDZj2^b#)41h+h5Q)saINGcBY#5TE%$YVx@V*~e2zZjk14BbWglCBvnm%9bbreA1r*)7?0acwZNGFK0i7f)+9j#`XxNA7 z`pvFO7Kg`2>c6h{59xfx;7M>cua6t6*WgJBp}NPAi!naO8u()8=(7oK>)!Nhvdr?7 z-hVaI3FW)74Tl=iSRc9;Bcv-Ygs}QyB77R3(yOpmErF37hTPdcI5~wn8>$v&0p1dl z(WAl0?APv3nLqXcjxB)9vuhJIh|CI(z(?_x5cY58N?9rJ2qm%s|{qjs*??8DxgtSEvv3zF=}sJ5=db^N3jH3QwqP} z(zr7IqS3>=jOa{8g;q?&ovO_&XsD8=Hm8S#N}ML9cD^(x9&(#=)!0QJP`i;KfLAVh z-A6u)n58${30ID4D&snDm zDEawRXM)UtlN$WA}AvLmyD0F3#74r@@gr!i-f zlM20mWh%HgQpvNZX4OIKrjT9kj9Pw+M6*CF%Abdisnk#1UUqnY5Yl`$3(q@KZ;GO# z0zf=;D=W9^x4tO}&0cx>v}kg>I`NW8!%P~O-?z`0#tKH}u$j1OE@GYAQiBM+T&?UF z)2WB{(IX}&E^n_atciZu)ob#ME_3f@!E1OCjy{L$(W_uWM_h!*_e?aTdW}Xds}Ls+ z-(+i`r;u}#d$l>Lr+#DhD&OBMi!%28F|+*fazMtf1+P*zf3Dv>(0;f6PG7Ns`RW(I zT?>&MY1rv|Z6U7=gdbPqFNv>%EAzHn{3dRlxJ;jMivZ~}r@Ag%!6zH?idQ0i@x5Q8VE6;4G*h)DV9w2~l>yYcD~)OK5*wDWzW)yDS3X}dGj#ZLi` z^`0s_IZO3`-&n&fYhWgsy*HY^!6m<7CHL719Spd(2uGqigD8MC25vNK>5#b4TF-LP zLZ$H9Y;EmfZd=YE)8WzGuq^FeMdZ!=FM!8%ulp_;e4%>?tM>4$t<3B|g)h?U%P1g@ zQ!Apz-T=g5!66iz`J?kocb33uQ+&6)cci^NT`t?i?mjsL0q&o-l;R#MU{dG9FS90< zKm;2886N~LAwIsDL&*wwP0#4Hp{6B#oB*kKHOP#YVCOuq_BEtxDJVf5NtXYa?FoVV zDh*vkpvO%0`dcCLg4L!@OltV+9aRQ-w|q@k2Az~nHhtF5fmbb*-y3LJFXbw8>6NX( z4}E!w+d)a;$Nq+S$_ZR*449vNFWP5yZ>Tw*4?J*1_Ek z>0sE)B35!V+CbRFL`Y3E_=^=&B6^ zl()5FG*)FsJnn69l{5ZiS;_G_S8=x8feJ_RifVPSsH3<%_wq+#zlDv%pSOkO0Dk+0Qya<{HV2HgqW}CeQ>wZ!KU<*5kbI-vH$Z%hgNB^zKERq1?el7g~sc!v+Fuj*5`wm*yd?5yf6L3vK5Sn=?@1oepzat}3HKd$R1CQ%UCrI4^&YP;?cNBj7vywTi}Ru_77wFIhLZh_Ncq}rbyk-o6RB+*`p5X+}R56 zN$7Yk8Ny3+c+{gMcUj>5%E)<>N?fmgYdV}(2j<-JdOswkI|iz&ZRIZJu}~i2Qxr z3}*QV-!y+D)@8I?>!;0QNYxnZ?o1x*%Xr}6V)A;GN}ZaiDaW+E6LW~5iI4D*YB9TD zBBNeRL9a1f*1lUZ^@>~PdSuc_aRGMuZe(GbZZnsT^HdjJ`dlg#imG+oeHUd$gQ_HK z%yc=CxGO6{&gk2N^q&?T+(6&fWOVv%hB_!@<#$MM*tsmB{F7#)iwjuL?$-<4wUae+ zr6PK(Qq;Id&4Coq;OnId_K%vQP2<5^vMC{u5;LDZb-fju!QiN)xB!(SUxl`r9gmB1 zUbYy;w#}w_dYhUu2ZDYE3|1ynq1Y4}g>1eKJ`6A|CMtP^lrsW0}D0TJ#QNq`UXqS$DE#@i@dVg*nL*`v2ejQbQ(+h|4u z9JjsVyEm;BEfE;#r(le=KJs{BeBCS7v4`{kB9lUKE+gwS;jMjRCHTJnRqZ=yPhxqV z*Oy1d>9C(3W3gq#m!@Z)}Rsjt~vUP0VEq3?47dEU*s{QrtjD4-QrDP}-ACqNC29fO< ztB^r8>M5BBqTzOw1lrRi)e)WJm>vye05GP0zNL|dCfbNa6>^$zyAYNhk+n6H8-6Cb z&&z*47wjh}b4*&8z7I`j+zWmSbE2(Q0ekAHL8imMWe&|vPWUo`xT7ST+Z)A-9*8y? zxi}fGvQx9RcTN`-`RCxsu--Q+Q$u#W%y8|}L0R5(xfk$cUZ}AEO?BsUrfVl{l7n`K zLV6wR=G&-QWB0w=3-77sK0BPYcBE8J^{T<-ua8QGzh&ne{9VuHcfV5h*W(5KYZkrW z4_&NdcB9fG#6+dZv6keb281LvIBNlzQsdyN%g)C1e50^_UBP}|@{De$VS2&n+OLf( zO%Ly8vbooeMI9~Yya#}p!8nbjz@T>omHq$ync3J(#^iH==yQ(>*KXk zR*w1&=GX;*(lNE&&>8i#htOb5fx1s_{p!W(t3{lSR^6`B0C?Io&z4@$nlzp^uz;dY zSL0KCP>Xuy62k3Pamf#Emm=!M-n!^ebNQ^%hy9}uR$2o>mDiWrVY#gCAtnqzWZ^%k zo2!z#TYm<$JWzW_{E8~)N3t{^07{vTnh=ZhWoh70H(?%*w<{}-4O^clUpa-6^IH2? zdSIg!7*u@5@UUF$n+ors^fg~hTGq2RZDvacZ#1JSp;tz#Zk{9fdghFGIizAnxAu{d z%cEku?$`9bVR2jSmD2PyRtsy9Cd9hlNZJP&V1#tF(4+<1+ClgDHyOrNDu`>Bm~X_I zTEQ#KduSREwjcoH0FK;wZ%}hqzJp#!^D70EpemP}g^09#u3gNn*U#MBk`WA%Wov z6OQ&@L}sBB^rrU#wH|8|KXj;yKZwBOKk2fUz56P~FolPXq_2oa*-?{;U~*H zpK{0;`!OJNnmb<+Ka^JA7WZFj!F#eH7)9z2__6RRDQHzowclo{gWgGa$^}n@&AE?a zuLi1UYrA@b9(?n`|0p@<=>iq72dUn(KLk+bA?LC%Nzss!S}f7KSGpmzPuIy))@rY( zxv^t+w;b%LxHaqnI{tKQ=nk{AB|u4n3iil< z%_JmU(w#4585-LuO~d(Lr$Ma}KfA5eZB|}6(T-G474zpEN7~oLN0>mjs}&r}^2)Kx zI5|Ob%q2fPt<5v9W)o&8ihF3NJ;LcrB@M6{#xwRnRw&aX_uC;uEnJ%83Cer*K3|Wh zFBPlw+as*E-|o7M#qF7FPLf%Oq`qEG*-n&xm2%xBm!O_R$qGN{&KQ44lkPLOpjVLA z?i7=#tE3)QFfRv|1{E9C=FLXvUo_Ri#&M?y>%d1eI#U9$sZo2<-!*8CR{iH4 zz83(F0SE#4T$d#o+^3w~3!hUm2?XIYIGZDg$dMfwP>6t?7c=QHF zo^>T#PDd+I?8+~kSjH& zK@sg+tSdz`PViVhz2nwgts<^T5$pOSHH5viNw(0;-eDYB*?FyH32e1=;Jrf`o&JtJ zxa-8a{_@lMlVdx;Ovn?|I-25IqphrID@hh>^>&>#UjCX{6hV@`>Xx^9yp@}TtK;LN zqk9r^wmw%VkrHid33C5w<8o%$2su!8g z25)pNnax#WTGt9$twQPso-K7MNRRGjkaRDmvME0>8#*j0ps>w4sYCTxRYdiwTrj?S zV?1BqTITGXg<`ruQd1Dabls0CCSa3w?`n^MlL^r?0(}4LDcN|^>$Jl;1a6Bp&6yFE zICzBKWotDaSl$kTrm1T)g8MR5ZmhyU^$;Pu`x0Z!aaNekCADy2onmNq-a*K5!O}J! zZ$60KUBUYv_cVBwj2go>G9_hjYhVo6TLR8H)fVTHam^S#`d9(7;;SNUyay`&phNVO zK{&}Fot)0wX|Hd^NpD=jitlBj)1JD11zVN)f@toP$gw7QuX)o!-|@P{i>%%g2W8W& znF{(+>?oxzNyX@_!cM-19X3b4@$Maq!~JghVLaLLFR@+>dR( z6cHje#zaLfXy}!mIwA%eJ!``!?wgI_#+5c5DTdo)Z{pkDnB1{aZ+KDm7FOHSeyP%n zRLcH36Balt*sMZ~AIZzYU7h4(tyN9^P>cgBCgm}=M+m^jx#SWOAD^wN7ZKO@vS5po zezQ~~D6>^#f`L$%Kc&bc@qwEZx+aYdhHoV*_Yc+MMrTJ(1}M;{-STqsdNJ_EkJfi) z`X~0*>em+|KNCJ@)^^fr7qTEH!vMBid%>$CYvDmRIW{_mmMYgY?9t@CUthhj;B*{*1%CWm?k`p z`666=(SB3!0{Pe-eVO#Vxd@;PcNN&DTu^f?JBUVE%p{V#BbN+p2qQOA_~@ zv9WSwdvD?M6qlNR!`R30N;zAJar69#DNFjLB@!7M*!t=$jQTFC>mZ6X+q^tmz`mNZUyVrerj_Sb*fG{Xc;ZeF;Q9rz5P6SrM5R5 zIR5cyk?khCq4ILIR5C`r--JzTy`^XZ-=1TfSnt`K4j^l&DPx?fg22_d<9qzw`5_`} zw$@%(ruW?zrN@awzNJ5$mZuMPE0RW7pXszD~} z@9nFEq?k`{nm3Oet`_@D-p0C_akz;@fQ;%E05HpZvW&*TfefX0UJhK-$KWoE;!iq; zvjN4>ZAl0H5?$Wq8w^hi44f>tx(720Tk;LXy}J35vn@Obf^zqpwQJZ2HBs!sYL!)M zcUGOCeo`vdnt?rdM~R66G-T}bkhKfCMmUQuF;BeZou)|&FUSB}b{&AzPH?f$eoi}e zewBU!C#bnrSqoMu8Wp}b7Qq`D`%vgbrkO>VlKR6W{?D~63|$6XF0x{Vtc!T+Ck6Ml zNe(rKi^h8L7DQoLft#Yx2a{g36o8F^8!WZud1 zT0n5_trHz^4bj5Yvj(yN7{9Vj*xtaIj|ew){-!}Zecc=(Zl}rSxVfU0t_JP%yBRH! zQG68-q8eMqbY~5(zlUU^p*q@>wc?r&Kk0i|YLM zRCmjvWs4DwY5QA9ig%*SzeY?GK(`hnF^2mL-?P{5Gq2^m#q2+85n8 zMo2}SWu=q$TH5OdZ1D~xcGx&*+MgJ0C&NznFx;eZc!Y=7sOd4hWVe4zKhDNcYRQAv z2X!!AOG&Yd1iW*jaEv1$`-=kD`~{BXF>Ee5-h5q9c_;}qavbsXs&dyi+J8|99MX)} zR#Z9fu|%1ix9FXDF1QGTP%;=OfhO0l@CyF!BYj1SgiI`8SZOKRD`i%aC>gK$`z7UA zW}yP04HwNsZ{s;-PZynFe2S7ZRF5~y1yUVU_P9-jr@<%pEO;v%uLU!dAI1y=0R@+` zb-McAWov8Op)y5dt3n64bjtuw;^60c%=9ryVY__H-KNmHaf9X?k#5F{XRfV*nUyfp zUy~fbTq3Hz>{+Ce@;L+cvMF}o8!s|bCLr!rFkP2rIl7s#9IkEG$Eq-5el)4wk7LgZ zAMK8mwEtp-ounx8AfavC;r?gloH6k=lhmTYQXm$gx5EaKb#Es5@|aG26235z>}<}@ zR|uR1fNIZ_H*yTT=UyeFIZIA&0%EVryf$?#C77EQc<1~2?n`|&(7S+}y~sw3JL%5N>l@O4 z{mR)CD3T*f8hnKQFOC1V=ks_@rXI~)#5hZo#6(W$ffF4)OJ+ZitCz`XT*$%PpSMtG z?YK$PuC#Hn(q5`0AVC|xj-Vr=mA4=~zkN1GCxuJ(IsDW{8_8&mm|nsZ0{Uoi`V{ho zZ(Q065NME+{q9+>ELL_RInKKTlA7i&2ul=HeF_g%DK`*tmd( z1Ba9R$ay#3|&?=eqBG!GG9`p0jpHo%y zOE*>VKmv&nW;xb(oJt5*b(Ko!S8SeBl;=JYdj+e%cuZEpeTDjo3 z|J3;ZVb22eB|fKT0i2iTU*QjotO6`B|D}K%X9_^Ss^v4&7NQ3tGbs$}`)B;KuS9lPksS+4wwnI-{F@uc*`Zq>60`L*NkD*(KJG|*ThiMRet<4^%OGYD3axYgFL z=ZAgQV8mQN{V;9MXu#Q3?F`hXox}Q!T?aDE$c@{)e!ZnRR1dDXge6fvWGm#iZdBoc zY2Ow@`wz_g93#{OXpBhGi~l!fI6HUe+WVxA)I5m zWKIAv*CNfi{x~ZD=|P|eNfkNY&IkC8&jgrBkV+S)@)vUc#0v2JEC^_^8c zlU2^hy!f)c@YUp1?Q=xYN<3mK#}(Kw32huDHaas+yo|?Z#T=Gd-W5Qr?M|*1T>yyh^zaj zGeQ2)a}^pYkYe(n);7KL&qHPR!sg9fjCE!&^cx&?gh0`)I%{w5nKLfF!$qnDV74m? zi|yNu=6~+_bT*_UKx5NzVfE9~Q~rehAC3ReGjQDFK&Vz~OQ7R#Fv2LPY6{GNxPN@~ zUlbiV51Hoia=)UT95^*4=|j@^#9u%MYSMscUh*3?%s(}(E6GoVwSCs3bpAVmy`ckwvh1qOh=^>oc zM+30umam16J4U{+O#duaFq#*Qp!~Z3V|U z5B^(eowCrIm+{_3|K*SVkQL{Q`}iq&^ns(V|7C3gy50Ggb{GD?>sD0=c92HBq$uc| zDmz8kcUg{uof`%h_p8(OORH}*sConVH$tRIb$^o6-@fn!&d#B`=K1`;M*l%uRKT5} zdmoAUFX{vTfje-d0qFzxQ~kPx5Nu(U&ap}IoyMxB@LK)!B5huyzx$=CPhpEtpoIF5 zq5tcF7dR~o1A+J959axg2WP}P$&)KKw(lfVXpM78>< zMSBZ0fC92qhn5}v*qE)1utAm}Q;zzvBE@;g@vM(jLKp0?%OC--qo?$zQ~U-b=UdpZ z7!BN5r&pzYTjmd)wxO5Uy&)q9yW2{-y_AB`(YkUh1I2|zjBbSopf`?}?gzq)-@iYD z4Ccp2^zC4A>Co5t1dnz7GL|~lNW_StoYHXffoGfEqj04RBK5f3%A;L!?Y2lJx_K5j zvy94^*B9V$q+%Z}aK!rHrVW8Qucf`=DcQ`iHSHd!z+LCD%FG>D-iB7Ei-_)jYHh*x zsVDrjN!K8kHcD2cZy5^0^sfKle=}#GfMa#t!Q9ED(WC7+V4d0~cTa!Vh*yBd}E9R3#Pg^TC@R6TbKHe5T}$^0_3 zx2Bo_z26zUjOqkkU=m;L#PVAK?yk4g*QjT-^|`(sy?wI$)?o{`S7)-txwgH(;ux#D zpwYE>{-m3J^WBW2y3a_?lySYFk5wNHn?xI9G=ykHHh+IHZAQ2@)v6hjrSSvvD(!~^ zEQ;e7{^>OH=`5q_S{7q(b7=vHCaSLSb8GFDCa9E^=^KONde$dHHp9&ItX!M5N*pLL zPsXbig3FaK*ZF!=mf_~(yG!tFjYPW}g4^xenN%QoVZ@y`OK&z-Ea1g$a$$a-_)E?_ zxVaN=-EFwb-!SnN9Y6k<8#wFKoJ=~P7$Rm^E7Y1B*o^kN$D0VwR<>O;K5WV7TudoD zF;ExcyWB95>e}W3l^cKXQHri!9r>!$qq--h%%aGS1thXR8?GER$jG(><6tL8V2BYH&O|pHS8_;WzdY}_DMo` zQ>V)u>uue(l2yGZ1SuNk)2_BV87!4u5ukL*eVh?xqY@phe@Z>)e7K$-aC0^I94Wt2 zHWu|-4VON9pypudjW5xgf_&p{(lWsy+?yG;m2}xA}60a#KmDmrRciwy-1%o@@0tOk~IrQ2xe&cWXC`?ho2i-NsMpMgi6R_~9#`2ww}l>>wOH4G)M)2Rp)Y+lU$T zM#f%@cGn=O$tPb`?P;Dp1!3*AkBt^w{A-1J~5S83?#{)C34Kv!VGxq$#V$_H@ML3 z%Ok#+7b*4T?#hGuLXH;h2^uv7>CuYqn}YVMV;KAUQ95#N<=HB{lo31x0NWmjPQ<1t ziF`ETY@cM}Im+9V13A$xkzBIM$jBJLP&|?2;Swh?+Jj`U(HcyA+N(cQ;fNR|Uy00Y zo6f`$E2fCAwH+IXBe9UD&*Qe=ERDbvR31*SC5|4sb&u9-^46(l;3wl0CjlWvok|f* zhkO$n&MT0 zFsl&1!Zc$?#ygbHao~PHp*fz};2jif-7;qQjsc!Ic7gvoTAy)rrU)}25N zAfLN~d7n@aoBDLOKV0-azM_Bwt-D(@t9<+RK%t@$30-pl%M~Fbfmo0tgr3RvdXdE< z>P<=gEQ{f5Ho}F}4mfNxN<_~!yzsaxE~XL*B~ld^wgf8}w6AK~U*>DSUHEEjAM^n; zAdu2aC6 z=p}&S4YC)>O!L$&yeKQ%7e>;{&^Tg-%0I~z)9Dn*xeAf_USn4GrV%ML{b+EBc$UV& zY$wwK*-7*Ha1&-Dv_TcIH96F~L~ICEbcGlkwUVYMz_{menaHtOf3KzSW~}W8zunKp zEb(lI?>-;mCXQc>D0%02s%^ zwskDEo+gN^y=Rs2j*f5Mnhxm;x9E~&BuoAz{hEhv5-uk%yjc5AD!1O>F;-~X7i@a; znw_DxWuHlc5PhrNNo=3!CBY}mZg98Smo%9KzQS2kWVSAIfh8+VSLq6wqh%kUFp%V^ ziO$A5hc0^|Y{LI;p3i|>JVh#Q@q-ep0OqA=>%{0DKW_dl4@UjTd)0jYY)tcGATn&O znBY`k2{rbgd0;6pJmw$^wQ=hI%&E)KIjT>A7fvV#!U(ehu1qm#rKt2@=NaTv3b2^D zDJ5E#n7==$pP*#DQBQ9?LR_HWndk0iwVeUY$@7Zx%TQ@#CBLMx+&>H`)A`74yQ2ri z?+xcShp1Ag{MOP*!?vyclQJA38InnS+kHt~Bht-{~0!O(pK| zZze&)@OTA+7uakG4+gMuwG-2IPckA{ z5(36KdMZI^qt$)k$YhI8v%)ydNFiw>=%?d*Q+`GFayoHvD+RZO$BNoFNbB|uw*Nr;&% zje|e1G0gIXggVO6nzi+cy{^9In`N@&P>Oup=)el>|C$ z`Uq_Zf+8SEnSmy5HHz`a!mPMveIdGjYe73vD-e5E@+Jbu$-nJiI?qiHF6=XHJjWzWU? z0XHe2Omb=H0sTrwBtedV-PGfvNl!CIMDM(;bdVj^V&xMTN=myj|Yr35Z6BI#1eeAy^IzPTFIJnNj$;0wa^-_k41&WKVu7*jD5 zIf`P>3+*pEG-C=h5bN8-lQp;jHd^#cOs~$$zPo+*5j}gE?z7&wyJ>}Xhq?qQLDKRp zD%)-z?2kxJATnE1VEU}_)aT5frCcZcj4#n=yiCLBkx8KkfpKmFMwWIH35IJYFFnhFS_1BR$o6IEE>~&4YG+F)@>HbID3y7Fsr|=b%HCX@nd6PTPnabStwnDqmvV7iW|XlcQG}!e6A2 zJ4zh1#jI1?b2?onqo3K5;SURQ*_&P)Vl+mwKaNDdlR9EFVg#-fz(iq8vE4k7U#?RK z1sKY3kIhRvLa*7nJ#Zrd-}ksBw>ymdJ=*Rv*=o86IFnB674;M?*eq%7kqr$yGoX^ch?n7wp+WZL&<2^C+SR%#`P-qORUOC2)s4+}_f| zF^NH05bM+?y5;OL^wQ)fbNqZV*SR=Y!XK@Yi}rpC59=;)(;Wdzg&%JFCvB_);gyM8 z#sr9)xfYJ2CfC)tOm|On`O)IUHTk6Io|M4|d+Al!uzdr*CB&(iUT;*p(4wD(a9d?a zA+zPEMG6$;X)9;do5%B^Jg{vIs?ruE@d<%vTu zGN4!#;~y~Br5rd)Num;-GpCL}G;zPGuU$md&F3Ork=4XL8);dJ+wGUHFmO?^|Rov<1~U4gp3fXWg~yER=qq<@VI#PE6nN zOgE2H+zEb9SE6zEQI8Vc6P~9zC&y{r%w`^nTuF@ZwtCG4woK5-9w(MjiGG#5B1aF= z?syAV;nqk!gAcJHPj2o^H13gI>2NzWdE@Wmrv!|-o_f+}v;?Q?ZIc_UlK!OYA9E=J z*4`&jzhgG{VecF;HV_Ocf+$_!0llO?O?Y6fh8qQ^elRfS#OKf+})J0 zjY|pJx>)Dp^r_mEG|jiQ%=3tB7{&0}kr(YlFV_;@cD)g`oV&>8+x>c98VZFIB}_>h zqi5P0`ncn(*|s&h<+L3Xxn5BwN+fcXbBc_}s4;_F{j>bZACrIfw^~#8zbJs)E$PFp z?az23PFHgsC>U%Yp_5hex^|D>Cu8ZtUaBQ_0Ix)h4qM242U0ku`m&Yi<7#VC!^Uo% z2r2Mlth-^NM5F6sv7)*ttr9`lyy7c?yToI?661oi5J`?U=iXG9npKv2g^r%6yq$4soDcT7Yd=hXu zX<)$#H8_-TjAt@P+KUl(L{V{Bj?KAx1+RNU)ln@vHzkn0KF+R`GN!y@PC7Kr9v!^p zeO;1IGqk#++a!p{I(NnN-ny>3xKnsElg;6_6up9sP9>obds0$w-kTZM@Ofw%qfLog1jPArDcU@pK0(6O@7VNe%m-*uQJt|a(7m6y(JeTfWCCnI0j4R z{+6mnH)zq%AuB%dT@Lj-;qh*Alt;=RhR6}$7i=|%Oh3`pGGY~DabH%XVnGF06CzkF z3m-e!9)14EaoYx5Oc!!Jz?2wSj^Kzk1HH}n%Uo?vE|m*=2H7;IUL6w1#a26YusWKU zx5i1(h(;&X)=yWi{+6vR(Jgu7k8^+1AEE1bJ2rw3SfrMf{UT}jyGykVE)IeNIL z>eLuSy|L@!khd`U^S?>BKZxq{Hn^OcFaVXjZZJM01TOb3GHsNAP3U?` z{2QO^-p!Xn*)t~n@nuXA@jRkA-Fr{)`=Gw%$@%2MESNmGL=qsW#F^u5-0H0)v0B#| z;gquQF&gA@dH<{Y4#bUEHrnIj2X%%hX{m?(avvao+m<=W$GC-~-%Ra$#XZ4Y8)Nk; zOocXJUu>L8k1S%G@d>tuR5-xuS&)j(X*o2wfgKud)5{l!$I=?lPedG}Wr>M@UN^1nf*n zDPD(}4yU1#?@vPoFYT5Mz>o&QCL?yJoBXo?lSULNmYM*`Y3>Ye0%9p2Mba=VM9vw9 z6E%tOdWi5Ln!p{jhg9si$>MB<%TK$>n1ndY)_1E&d{RZ)-_QlL6Ytb;9dm1==HN=T z5$!!y@ZR3pDme6dqjkOX@t}t*(am67wzsH<0!Rh%hso~r5J{a`y9%3~lo{csPl;_E z5F1-jjrt}nF1mfy-t1Wmx~+It^Bd86dlRd<5J-s8I<{$a-gwPIw8bY)k?bE53UK74$#fQHLfj~rMl3U za$+KfF?8$RfJGl$P#0JjWKfvIpUg+x+)h;#X~0u>RHL;W>B=D-wYePo&h)GE)F|9{!KTJ3z&=5IYPK-LrHFB_eQET`b z>P^@0(%2z>(Vv+r=sEU}NW%~D>^Me)M&5>$}}O#F4m*&Gmf0-Kd;Z%_Ts zFa=(*ST3fx2=S^viGfmnl&vT515Vu`utfA4@k6Xzdu_v`1|LN%zl&#B@vq_ffa$Bt zz5X7z!;hAnY??3ya-s3jnu&u0K9>;Re#SQOaeDeOZ}EJ%K4jr$!m7+2APNI<(pS(y zOwsOQ@~)URD6W+T)7Hk_ISI}1VWii{j*lYRdv?&bisMknZ0qw7ncqrBe<}w{WqN^* z`ru>C?pV2m0CgkHG!UgaYQd3#mdB zb~(yq95MI+*&;_U-NY^63XYp^04(bc7GY$&PSx^yARyJB9aoKoei^+rC^qO2b;fQr z3t*EurQMfhMh>BmP*_Zu!n1B`mbo*)Vp?tp29`^221nT)^@jUTMp-soj}m%XU3lCG zY~sAZN(plT+J!XsTBV`RYfrasXxlXib5R0v7IElBfoECkUly_TvzS(Hfi zqqp&1l$3DYZ&O6MM;inu9@22kO_t>)rO%<2XN4EMZeW^JzI35?5t~&h-T%rxJ3ZhA zJnSa+=Qbhjy=Ed^gjv;(TLyyFY(m%#3kE5UZA#!-Qe(;sCtR}%A7yGpCKnfKH|>ej z@wy)+OAR0$40~MuND{q>{ivW=u;5PPJ-7H8!ux527ILq&NWi$+Hx(NL9`(kpNLm~M zMfH9cAxZ-!H%!d&0E6pkH-q-})RQ4AkJdR%8%2q{umeNOd0&im!NTtKa;K0H9#u`J z{K#%cV{D8ps(|Xi@t8Wbe3;02qTG8SDFf&#|9+ZO>=zo7{dhWd@>};HD?>CCgHLFg z@iRIG#UfcFUJx0cDo6bC3kiE&2PWvhsmogns&JWp^{FJm$l398uH=i8xK{4E7%14! z9^!x>%&4qImJi6J)LZU=MtNc59V4OW}2FFCq@#Ce67X?!lIXbgk@?R(pc4M0SXJw8PL;(SN?!MS? z;f{odfx_*yK1cZBR3Cf0ndl=KzST}sDeEJWM16HBmV|ogN{`4zN|>_Z)VgNAI18nd z_khdV*U3Wr{EXhBE-LhcKf3 zj{6UJk%7IFy1@#2!e?S6HV0JG4`5d8S6v5eRS;Q(gP#9Td_Qf?4nO#GD0acBl*yig zUI5|Xc7r4hiF9!uq|*aL@;ar0y_nWWcQfA?W@%H2kc9I4I($++zT8gyjGy|i#z0jDA-83Eps^{&9EOwp{wLdt)}7aVVdT^M|)GVN}VQLJ@hERa9iq zri*^Vbqhm%ZD|?scJ0Ypb(iI4#KHm_uSMZZTHHK8J!RP*($21ggfhzRCRrLCi~c?+ zH!RR#7)_ZiYk$1InSZbu3`YUn_zVrCs>=1LEC!qlgpBnVZENk5p-#JWN><$U`X<4r z`t1Jq0?1v}o0l@FLxeo-dJz5n{Dtdh$j4cnyaOr0(M-i8c5}#n!YbUB_OLhtwnIJB zz6d{Vo(~&CX}Uaa;`Y`!KT3mi$FN?n0BQqd=7{++Hh~>aLYN%+Jx!c7rwXgpz_*fY zFT!?eVun4g)W4?pcX2aNQCqe21!Cm7)S@DByM;wCytc2hsI361h>FZ!Z^ zPQ!O`?bd=(FFiwySrH=z(UL&AM(Z2RYfj&6Gys*h9x(srPtaR2&)b`vI;Yb$*?AC%LZdNL z<bm}uUamI&LuF%ol%LX?29J4UC7PD0 z@!)h7{3)+5ISa0F>J%XWr< zOjMk0hp%qUU%Ih$h79pha+`F!qE%S1*VR4&I{mtYy2c3O;i$Izbn#t2(#s^cbkM4V z%%Ej{jbYQ1!z(i(=; z-gpHURBG=F0z?^7fwJs-jl#6pwlJ|m9w#%>3<{X<7^XowcNI5EDjH=ZLh{ST>88cq z7WsqjK4eq^2{tet(6l*A2p!dNwa+m5wR&)+&A(-IlzuU;TPGn$M?LHs?+ve60SZ~e z@E`Vv_sj?~^ zl{q$bjk<)Vlsdo%4%a$(SqD1R!9R5`=K*^5&?Zhw{H|;2Vds~cEemc;Tk*nlWS}6t zIOec9#=d}p%TKw=c9%!Q{<>s%#i&BagV&n1jpRET9Qg1Jc@}y`V6tr z`(9S|(6Z?Q)8?zg6Fab>V0^tfktczVp?iGt8hVFfhUt@{TIV*2w)2XnyAfG&T0;#})EIBrrM zEmI-Rvgu3WbwaFGvI8lwBmZ+|y_YjGM0P}#@O%Q({7EBeworP#v_uy$W>Nftclu|$ zCgWMnMQx1){}9v7w5%g_!4a7|%bl(%F1?8faVTk-OG6}?XjzS^ggqQD(|HQ5146w= z_>`UXHxY+y`C{-zDO|hA-g>0QROUd*@@f3vHI?q(UR_r3Oq0;&0cT1XDug)7bvwq^ zH8l6CGv|U8$3UW(CvqNFQZISLgrvX&MK_P zPZn+Bb%*Mj+2Ysr-f_vg+Fim+%BQk6%G#Re$%kB(YhxCHyUZl!j#-7a4~F32f@L|e&n=37%suoXRXbd<~ZXitEn_Xgr~MdArCw8 zIO2^EUcHu^3D~0s^A{&l9k+)%nszkRvm*0W%{T9LF5I7fG1yG`aT(br^K%3T*zw5_ zq)A{VVl-Gubqie{2Rd^{XSK*OE5202lPc-)-hqIOA*pB(t4HnB$rt7EGCNnHg%|rL z`VAZjnEZG!d~pgQyejBS9sN{hWK_h+^D!?W@4*e2#fT4{XeV)`cGwwrI*A7ZSEIyp z@v)$O1Zu&&A5Xo*GSZRU$vi$+;CXA#!s3(p|)tT84)_b)5iKn9cCXmUjpG@#8KCb zx@3Vh$8%~aY)i!+9lrQfk@<4zPgA3nt)c^hs1XDgV0LP)BdsjKXxH?yz>4|koJ8aF z2fMyB5rrpNGkG{UeB;ZM#XVl~BIfug z*Tbd1Ez1!iu$W&`-gbP2k$G6{Cg9pK7{6z&IEgz@@3r$>@-=LR^O)A3?%Vt6M@DoW2+WxDb5gt&;2}ndJu$2GMHt%=q7cavk0(I}-1d*%768 z>*fR7vn7B<#8;R>TDfs`{$*p~A#}~;fwTlBncRmy(uB~mJY%+7O9gXicNBNLTMTFx z9PsC~Mb6uJ&NrxlFcDWJJ1*|;sN>{B1%feG2)tgF>xcn9slx^o(P6{LykBoG;b!m< zT{PLYGjb@5*qS+<6UPlLMh87=Jl=h)n zgP~W>4-^}K=-acXK@&LpD{8*3OaOiW4u%$6)mJ;q4$jFM7S}=pJ-u6pdm)VlvKeI5 z3%g3W#X*Pe2WcPd7;Cu-{F`(11gUdNa+!~(WG|jaI49p7Am`=TICi_&A4u_%Qy(E+ z#Ha8;N}pz_VLC(3#+zN8W&N5ppbme8)qp2w5s>PVWSZK;--vm-mj3!8Uj~TitZcP@ zQT+AIALk5o6D0`aXxo_d%jdCmDsSfif;EXPzvkPcn`P`W|MXiM=WQafnKmO)pX$87 z4e|{bbAA9gob`gWj(-IXM+5-Q)lQT3Pv+hq5$lQu;QhV|*3CcS{STjXOv3X+%s`iA#!$N(_F9RD(oi=F;Y18Ssl&JOWF>uK70 zdh?9nncX;9af{?LazkZ>6go?2td0+~j$JrOY>Fx49In++p|9XEu>*ml3WQz00*6Yx z=o`*&sxIAReTe|KqN2JsRm+F{g1gi~1fcMC?-$im=zdP>rJO3HCxvm$I<7bbP@xNA zaCUGNU9ra8j?a!H@TA8loNjYYa3ZFsQ_>%DS;ay>mtDpGVhBI8!&e+B?>}DWtAG3P z1YAAt7Z#IC@Y^9(etfuOPH%E6wT4$WfU?5Xc%gSc2RnVjCcU_)p16HTB78+}u*HLO z9tBv$WgPF>$QD&Z>C2^GcHXAIAN;siS`;~EC41n&9ew>GJSFg8G(sYUl-c$9erJE?fD7QLwoL{(q`$%P6RNLIoCh!+;5d#f>T>oC&Ql=g zb@f(zBiC0a>Q5q*UknVz;Do?>_PcYK`Q-&C?^WNP#&`WK1i#Jc_lbOE;vq#qvLY(s zaR2iDH%`YV1mr}cMqkVC&wz9|!n?B#uFR`h|Ki*`uZjbS)mAC3<-hg$m$7MO0NCa# z?4-SandZ-bIf<{L6_aTMA+Cne|3D)S7w}!ZwJ0m-Un#@~>@#+Ej^nrc{OtNapE@4G zw1wwRjl_>p&!K~J{?-8M7YpyV+1GwiiKZXsv46{BT+R zF9`deMG6w$0jJZm0RA$u{}E*2tzq@1eg@;enP;c~kQB=!TkFUF$^jyTfJxe2 zCV>85LU|T<9horMTI#Q^{!`}CpH#UyCLk(Nb5gmt{uL-on4PRtiHrNy+xu@>|N1tz z8xXF=M_K-FzXMR^i~=YjoaB_SyMN_=*bDpsm`d*&*2*|L$FHVk$3q175jmWVPd0jg zfZLfDkTuK~Cg-it<=31!BzAb2Q@<<#KVfhdLIv_Vbd4jo{;WNJ(Hg+N`Cb4`3t!A< z{s!Usv45aGj2O^m-D8iJemIP$tB&&xV!*Dm$R?S4@h3hChuIPE*GK<#psUL;Q~Mw& zpz(BopY#07lg?8>r=dPDKd*17PzO*|Wx|8O53l{@y9R4uB#aZP3%}#%$Gp#hU1deU zDL&7lHb;E!=l}Q|g9bp`bS1)tKdJja{kAIt@Qyu6%Lx2mfKI*(m~Op{dn)Jo$GHUs zU;(++h~B@mfUhoGZS=B`0__J$MiH?)#A`RQNL%^U=s0X-1UF821;S}nvn|f z&2#qJPZUOp0n78!o3!WPpTB*50tzHkx@k#x|5YjAe_4THkA)-i4>=R3^K-VO%qHQy zpJsVzYyIdHiTE2ZksV{vuKfjszy50oEbd8EJ;fydiiJ7AOKvQ)YIFaSl$-*0mgqw; zwpK_s6Fmj;|Dv;is+2<8!5~{3%TuI+^vUZv-8FZiebm?Q_Jm`~4&X)H9eX)YL>v@t~=utm) z|LfeD)2n(?B!*Y=0(x|dvRtlk{c*C+Z8Z1~qw?CA(>AgK?htfD!>2Rov!WY|iq@R* zk(afdv5d>sT(FD=+5@0Ti~Nvf68^+rf;vBhZyOwIGJv)e$+xp8PW|+Pvoumo%-)l| zA)aoU1va2KC!-=1=_h%ZUsWM-40lB11wg!4_Ex?a{446B_yB6o+k~Y5O|X9e^nI{c zHY6Y(&~EIi{byX9WtDHAEU>~nu=Y}oKkNYfSx2qN0YKR~van+PD;LkhYL0BiKooyN z=TB69d(vr#DVUAn$-!UW{5s)NiZlBFT-mlkEr<9WDD2111Xg{{5s_j4EjqN^z-(N~ zbb^26JD%s>-$>O_2ZL=F!Nl%gMeI5-{eb&4;hKNfvga4j{2X9142~B^PNQ=}m7KaA z{l|FzB>(Ld=$yb{J7JkZ{B6?s-GC7>7$#D+|Jy6T;fLuZi85Yv=RcGDcO*bzw%377 z&82^xllirad`Yqh9_I--Bp%xk)f-$iKlXEoE1dYbW(6RW?Ae|CSxc4+-K#}pEKO$6 zA_ThIXE+WA<}_b%a%N>e^W(Q(%=MhRVzVT&d}{B%l%tn5n^%1ojr-Tb)H|&Wag+i~6F63;|IHA6ECvSzx)1RVxz_ROuz-Y}Fo(^8 z!jb3dNqSc*?FUaPop_pylDX1`moObYcV@y!(+Z9PCGoX+El~u`~Dh=@D<0G&MTU$jY!2Um-SiXe}Y3#`*Eh$-KoX@Vj|KJ9*6u!6OEJ*A1$+~ zv^e3XEaf!E^>yoPUc8Z^Fi@hz)`X3%5TBFhLiARzSr(%Gnz6&&BQM#l=x`Y)&?Q!h zw$;doIMY+=x2HRub%3-e+eBp|y8a5sH2BvyYN$d{0qxpA>MToi+(#D;B{_`=A zV3~^zWXa`vSM)t&9e8fla4g~MgSX}I#ma4>r^3Px%4D^;Q${fYAif=Y@I*(s$9dP}WJ1QG!#I}v?KCpG)dPfD!bO`-HbT7o{cVoCk!4sJ z`W8icbgo`er#Z2V@(j7xic!gyywiYc#OzMTll@J# zJEOq?^@zYGGzso@sS9pOOd<1#9G~Ky(b9*zy-PsK3JASmAiq+ZCI%=pn@QtVBcdcw zNubiSU=5hBahL^m_L?$f$EJ-7wPtnI<(bTMYMo}t`xj7iZf6Xlx7sDzpf^rdJw2I!8*C` zY?_fjdt!TitF7ck>`<`&K@+Awv&EP_Y=Q3rY*uhmHPc^kh;Ih}8H+v0E13v9y}y0 zz&qDZcTU!TY9Wa6Udzy~j%>vMl5Lv)R@V0Z=*RF;2eL13w++@`_;3i*V>%S*I=SPf z4d4zI)0Wtk*SuV2b7{OG=g+PCsO33g)`_e%1lv5hH;PbNyq~1Z#tnpN>J_>OWGCTK zf}Dt0(FSv9rHiZk3M%6c#Q0Wo(Djdel(t?BDa8T1h#xc+hy;mbz%Jmq7n|5>*#3z) zWO4)`LyecVM7qf&l3Aik_tJ*$3>J<6RRVfAZWkcPsnI6FqS=nS1${V(Qww~gEt zYQEOc9`ni)4Qn*7YFcP6RvYZG0lDqX@9joXfV4{9i4E=Y`tkUiv0s38)O8-v z)(2NzPufls`|5dl%0&Ij^v~?kWk#8Zd8HUvk_)em@GETRcLgvvkB<_vjk;I^Xql+iIu z2p$0HsuB#665575To=GNhzmWeR#8Klf|Y&rn^#v;iXsXZu2I^5K52}jea|jLKf|PX z@F0y)O`kap?;3xrhx}t+)2F#yVGtS7P=_9RIlg1Dtv8I+sWyvRh+4DJdq8R^b%>`o zL`G#r>B>x`LsE^uXViMGMl`T|)QPAotjp@r(8>APwNR$WpeY`f?F?Xf8P`9Kh9&j* z=D?{OY5OeS17S%j9W7gfOG2?3?4PYQt>)vTi&W0ygCU`95Ldr!^e8_cb}m-*@%(rJ z+Z*9S2~eRp8gUnGH8&Ng{@$Q!2ChhV%uJYOI@+Avn(|_%MaBBcC+hN%{a(Q2KQ915?I6Vrs-G4p z4GZjve%9Zlk|~2MHOMpM4Xu{+SxW7^ZdF4 zRW{ijGc4%3nHs1UDRpRiXLYte(j*<38s^$Uf#RM%)_whitktV4yJBFjZ1Er!AzD}q zAarOlQuAE*Fq0UTas~o&Ggm_czONBb>pXPuQ<4J8YP1xdc3lbInDEKe1$3K7NQVsn z74b8&k^FXbIwFnTx@_M?aoB@7i_i&k0D);+dDm^bO9Bj^6H&xVpmZAUrxm0c0Wq@rm-u+To$( z3tRrHIK5?AW~;@%h)ZgpE^Z!`ugl!}*I7HiVvyWh)4h z3o7BkTa@_l{5yeMJ+qLwEM|Wk6u3aHSIkz^4riE9Uw)yOe`G*Im8v;C^7|xCkIIOj zE1IkI2U20uTi8|}FtF+K8(M(FsJ2%WN56P?_g*ke~PQd zBLA3|JD|?MqqzHBmbw=IXgw>JD0(H@K>7qSKEyG5KZkLL3bvkFkmtT#y_^q&bT0vA zgYO0V20muW?X#(Zp~c9waXaLo#XhM+1ryy;Am8|$j6?@P$cbR}5UP*KV5qGakhYzL zs`OU+!hmce1S*BWP#|wtAq~17oYfaa`mN;9>S#F|sIEUy;$d!3i$mRYGth-tq^uUM z{I2fYIxC{`N&b}1J@pfbioL*iWs6bcHf||AAiXO^L<`IHYZZCK59wpZ2D3mux+a{r z0{e-z{vYUo0n`qbZLtdxnXA!-Aozo8nQwAjzf9r!9lI!Hy@t~YrDfEd*0eX4Lk)y}(zW-6YS=zJ#n%GTuc z$DopOhz_Md@MNl8H_{kRVATArxy-E<*<&afk7-$bM%PhjP~oIK63_DvV4oZa!`bh zYS&nmhjLH??_Ra`;Bj8=Ue>s_8(i7d*iwYDC!Al@RiP_aR3@?Cd=aPgi;;urvXIxr zQJdu&kS#C&32T##XZ_3fh~nN0Prxg{HL8#HuZAH1u5#b`@$!m5J}!{>pZa{eJ$gaT zQA|>ih-SN~&Ks;9p$lkuVV2On_PHw?z8_S?^i*%x=y2qAF~L6go@FQ=>ngI*T@$xx zGRnVsXQE1dgDqV)tmqS(1RlL<_FnM%)yN04HbJrJMgi+D4dYY}GT{&0^RpChH^i6T z4M=dH-e^weoD8G$yPh4+%6>3>(>15ztB_0bU32?GjgdIXYd1WBhC=$P{x?ONM*=MY zwJFHAFDfF$)vwUs@;J*`d`!P7hFk$^fkxk(4rgBdGLr){V(iJjE+LWTBcpM_YxdDn zg9pQS;p)XH@*u~is?j=5!;|b;2!rF7?5giY=80RKLe?J-rWr8IsF-2oa2m(DB0j}a z3bpf%d>@gwelau~npAt1xB3K7lPOh>kcZHeeX`(whK0g%ipVzzAPz9C{hXt0K)$ z2G=XId88vC@-sL@1!9hYLy~-*9kwcc4`CrX8BZybObM%Q^S*R6x#_vDVc&h6Eyfbo z@zFkxmYuBGy!10hSpqF1!En_9Td=Anb5mb>!8p50#f1G}ul3ueq*1E7GAw2{Ef(3^4<(??RUl8j z2fNDD-LjX0Kvze$V1`Elm|b3#4z&Nt0JW80S58kTq`S){qEyDQy)Lbxq2xc3;M@QL zdpsju={+p*_fasg`F<`O+_EAOIv3jB-@#-|^=Wv`DL0xD)JOKT^wliG1h_U^1HQWX zQRw(Ui-gNl-lb3W`beS=G}PwO9125MI2F1jp}+he*#EDu!#F?|X&$u%AM!_+G>2xL zzlG*QOgy(8GfHWO0gK@_=I@PwFq*HvMDuJh{^SbN((Dc8LMlzPBV2iMV71||i`FSKMOG<{j7sFz(`9Hn@n4C`~D z4|C3;8^jFB8JywS<3tH3{mOX3tt_vTc71i#U4lHP;}es)Zw=5s=P~2l=a35@He$^2 zjM=d`jy0TrOIMZ^(}g*Nec!J7;KU8N;{ucl&egba798u0tRf5%6Ix;~M~ArSE=rgn z27vgOl@XM_z>{C-2yZ~5m|sQ7%w6_Xi{^X$kp`rQ7YtLM%W7>yV$&4}X@jJAR!mM#KPs;#=kY`$DfN==^BWNAP;HJ)4f zLqs&cyv-JaLPIkkcum82391xXB*Llu#9p-GWbD5yRg#7a$_=J@d>vTG*86Bd9_4U! zFPjdLQ$t^9sJ1cYgf8f&aZP+v>>xdCVc51xUBD%j85|CVFYo@CR_i2F2k(!Q-#gt_ zHdjgV%tnafhgeq1Y1}BhYq5cMdZ*4DjmowW)_k#Rs}M+UaaO#n zhoFTF75)alCgzx{ph#nEV{i}9mfO`CZl}TErnCAvVB97% z$$0L94b@1vQi;@9XWL}DY+G?_B2ajz0llodt5YfyJs?(mLJAa$Vdc9BtbJ+MY6!O7 zBQ|7RXN;!n&UH<=O1q?kaPJ~=`thl(WstE>eDYyVmboU3H5=&qH;iX2RiZx@)m!DBep($bbcDR8{BC_2@NfS%V z(_oa54uGb3JB`@=B7AHjnbL~PwO&R0g#-Ji(!^W-#_cq#2!y#T3^c^@I14TTERhG! znWiv}n8h7%djE)*!X(Ban7f%BM9N!!V8AW7V31jeEKN98Dx=w1u5BnZVLdmU? zvttV@8-%s@j_#Z`I(* zAX5)oumT};irdbVT|kP;nDun*$LDi(Y55>t(UbDcxRCbn>$$N7ok9j?kR7Kkg02T4 zblpQe`cAZ-tWmSP*fk{=#=8Q_Q!Zy-o-E&zoMc@41;=S{zZi}r?_nbmy zop<$MCP%~p*Vf96fqLG&vae>`h9)Bc*V;lGtpFd&tqJT-HA{7q{p;8*4te#Tp~@k4 z+xGog8MjLXnpOpC54WszOXJm)sTdhfQ_VKm9k5`@0=ur3tpwnWF)t-e?{xC1%Hq$* z3+=XkZXFUTzEvaUKwUJ3oKI`l%g)i*>9s{2AZ|GE*mP!Kj@m) zeOPiDB7x-lM@Sc+Tlt=gt8dLGzZenT@A9h3=(GY_*7-BTfYzA|WBQECmU%g?6blj5 z0dx0Xe}IjckVkDtrLTGhA8)<0c5=H2%JV|soaQKf=D|uDK3FOC3taq>idV;+jWM*2 zE#%h!=w1=e`bo`#oF|Q@z0i-fw!SuYpnDhCS{6}Ok5#8_H_H6tIHWszN|KW$%XQ;$ zZ9aEBfn$66)FWmjd=4n>cWN(MMTA(}xvm3Z+_AEB?ETfkrh@h3b(f79->&7))^+Jt z-&8Loy#bK?(Mr4bOLH7B(PLRCdLKxv(qo9#`MJ6a?`JX>rsXv~OFFO1_)>YUGBzS9 zh_~{iY8wI+Nq*RzP(n-}DnXA|fg<^(`KeU_ARhCSzGCX6D$NUM!MQ(fZh+Ss(AeNP zq6C(vC!*+n7-R*V66aVK5X}^Io`Y`M(8YJPeM0x3)>Pb`m5w4TRSQds3?(rn_ppQ? zu?tMFtpCRkKwEq%1Rnk-~o`4}Ph zot+1Y6vDiZ3GQqc>Q1yPxcQhSWZajmI}l8hLB*D%2W}=Z2w}s-%SS~bq-fb{ zw32ukn+U_8j-!$wg-y8`$mk}EervIuQp$-5zU91R9UsQ3DzG%g@p)+bfhl-zDR<0Q z@I*21S~p|4>B@sMfarENA6Pk2-#jRBTpZ!T_B?_wJoMW0J^|0GKEuhYjXSrnbv`Y< zx(Dc$sDQ7DB&eMS{`+8ZJ^ib-KCzIO&a_FU{OP56dFRE3fNR4gnt$fOWA$Xox1>oD z#!DVZTtKs!92t#G^v)mv%Km_2F0*SAXjw7A)TXxG6^w`Lb!o|Rk9vU88p@%z3>k&V zjF~5^nv?2vKkC*^fl`OQPk<*WF?5w12$H36-pC4(S14I_m z=W~cD_I=TSin6k5QpG${jyDAt)?6jX6UV8}#%~I{C8_5NM(sQ!VPa)NA7UJ@an^Hi-6JZSGRgBHrj4mbtp#hb$k=0gk zqW#E{uYZdk%*{ZNIi~?&8!)(uxWS2k+evrmn5*n@q%k}pW0O3(Mxd=+Em2*8JX3x+ zJqxSvz`QszvQb}N(-8vGq(3pE!5L~+vM6uV4~sKH*oG~Q=m*4xh%~U9q{H z#PX1CuH(;=vm!oQ$*tBp_k1Opr?;)f98Y7(BMP+GEoBN!mk!Ow=w>#7`>l7Ppb)y5 zKa3kOQE=1MB~ZQ7+G`EuAZ&IZ{(%nqgMmcf;{-GI3UDvOA!w|p77avfthF;fBnNW| zCpM4H(<{iI#QrYZ43t82MZ$TwigchO#e>_jRASGVyiX`tI~9ok0Ir+-+WDa5B)fph0aE~>m3OsIqEzqd3h67v*WOOQ$Z-CT)f z0@B^Wr+%5|e;H%=BECYrB~eFk1E|gWY^YKDPPXVxDpGjm7K_WnB1@Ol;zASWjZ;)N zLKz^wz3%loS1*3+tZJdhZMHj}nRLM9(e2BHF1W{!Kdv~|wY`b%!29n^h)d)}@4M-I z82)P@L6yA*snuhL2gHASKL$ueivj)K`~YG(chL^4Uf6cm@R8kaY~yS( zYiD+Z8rWM*<^wTAAl1Rx7~}4IKp8J?ZhLT^<&6)dxL|EkmWD&@E<)~bN5bGKNytrUvn6K)uKOB5|k#REOqn0#!~$1;pOx< z;)&X58b4>MnAkyj$%CwS$yUiOd*I7CL!K#0YaVf$QT$g^e2_AlqLQ-YZ;p@|U;mD9 zvp{p=5iMvMj5gvBN=Q!1br{CxZVDm%s~i6Y<#y{5Ibj7OrGq~|@95vV>i_wBpcAa> z{jC$)0I%~KcT6Jc=g(-pR(hRSUG`cB3kk79}o?UeAkt!sYFXFx{cCf^$?IZdeQ?f+Om@2H|oSC z0`ZsV(uu!3R4qOB^v``=palv6>Z#F1z4pFQOR7m-;>zE!qK6ki3Jv4jl8C<^|NV!Q zNDSfC68N$y-+%qaf4>A;yYXSbG_kNx;UAz7M1=srpte-##$Pv&euG`})t=Z~`~> zLBhw;%4;E?$o@S4s2Fg9lfd+(KmXx(ucAPCR~>jbR7`B_R}Yym0yO8*qjJ_u^ly+{ z{sbJG>@CA@$MgLCms4o3gz|C}s{8%=zHi*2udZJXX(p@u&D^SgJ%|EcA`Nhz#m$=5{|1u(0PCOIk3&7I4lnz2$k2a{82R(T z|84pI*SA~}h!Vk;v1MlTzh{pi2*5(`I=^NQ`W+$s4ZTu=03K1&`)c){jB)<|Ze{v6 z0I3SngBaN%mxow3fv7{1%2H1X{$pVEn?E3&cmR(U_0D4aCp;PhkOGR+-+I~qjnVw= zM*c>kzg(I9#j75rB+33;PGi3u;|IdJ2?(Wc&-xAi$uAI~)S9>68Lj_h@67Z7o4~j( z9sVCY1rm(wyxXut+OJCbUz71l>HrpcK&~(F%gz1=hS0wS9;OU@%lUVHlZ}=tbey6b zpFi>IJ@&i?_%1eG`Llm=-eA;uLmTq{(fm?uLg3-owj}>#>&xQ6E=YOSd4DxH78H(d zl;}E2YdLZ`SNhLmryx)qUFe#|zjKw}oD&lzD|93FL;rmJZ>WMINBc~GI;9L?pI#J< z{agZ~2OtB(;#ZS4X4SXMUCzA=F)uNDe)De1Q0L&RR zW#4~)3G3xTkfl&cw1sH34CaSu^ihd=`Ok@>iaIy$D%RU%#LRtGMmHn)qBtaFEQ00$ zFgHayH5lHq9f05-GTF~j`=ieVA*n+6i@pT)KmLgJxY^d2)G0P}HUc0BI#m|&7;y!dJ+^M_sIMtk zbsb_s#puLe6i@tnbH9~NMB#r>8#dWZ>?Y@HjcO6L$NfrWW*jDW^NvYcy}otbgLqB7 zi~>&E)Uu27qQ_AJXvDD2DS63j*rih@38#yL5i~WXS1lUQU6}zoGk<>X4uzaV$`#c; z{au@Vo7Qids%E~107yeY`i`q6xi_i>iJ!nq@<5%tFc(LIv06I&+-sF%GEgK z8zm4>Lzk%36ztj-ftCs86+Q>>t#Hw@a!_(Y!wJFEq%~d*V;l&(DldHOGxp~Llw1L^ z0{Y1wUe79E6v#{uD9Q$LPB=|@5Ng@W&k#eO0Y;f}imp?YQOzFKb49VSX3PP~X?pp9 zI0s;Bejx7oh$$g#dDGYoJzd;HmhasS|`a|IkTH&o*(>U><+@1w?zZSn%e_ zYbK?Od+fXy^SL6v9OakTiv*!B3)^?q98Sh7(@Q}MUcp|ZB%&v|&t;1`(iv@X=!#N( zvkU-jVLYI5wa&bThW-eP{fHZ17XLo`#K$)2qKH2rlQ-C%p=2DJ&-fgyo7*cbX?vDF z*>(q4JUREfYEpdYw|Q4ACHe`_g}-RYz)y^|>x&sCip33}c!CixBOXPMJLE&V-*STc z8yU0y;X?hEKq5AmL$9;r{WUAyY+=A4cf|XUygf@;e(jLn(|a52>fLD>4C(}^n4@1k z^bg1*3}UYYKSm-JeI*`Vf85MxDLZ@)?x{rluS|8GnB8Z}DM<#cziAL%*ADS)fbwCfD=dkWo|TLrySF@MAXl$vNEQjd&rA&q+bKH!4vSuwFBN$763RJ{ zHJaqeJbC||n4xF7N~<`(VyQIrg@q=%D??92>bur*R~|DJx*iSVNBfR{_5whY=IM%2 zftF5EYm8~2NsnY{28f$u4#=j+=<=$2W2_BWPY;a8qBV$NZ|sgO=?MkV4KnjMuXRzw z%uyI?auw1F4A$J`T=roBxNR)jy~Tlwjk2-XBNfC}akpU3OA2P?r}9eT?-ZmABW^aj z6;;_Us(%7$JfU$_=PrwZeLN2lwnI|p(h+|=OBT6p$Vx?rjP71%No;dcrAVGi{m$0K zt^Y`eN8V#wai2y%z(ezh(N2)3DTVNP>NhVecSpGj?I}lQ*pyZ&_GVEhu8BOv_0(Ps z`+dv2a%$Qw2EYQ*|bioE0*jQHeSEm1a{Ohs?r^ z9G_pIF&xw3>3x9{Po$s7F=QXlhsz!d*YYzlHR&6Y`WQy5?t86XEc> zR~h?+Shi&p2Z=tArB;|%jOu#p_9(45CHW?Xg0oyiR_$xgya<-$M@*UnTGR5tRb{gh z>rHAWY#15ll`p` zomrdk`>pC-nWCWb0qXv6rjN>angtnU^x>t&)vvQ3YTiY1ov{Yz_xh|OnZDAw#RgY~ zemI49xI-c~^L>;kz>P?G-Tn7eOiYXkDzbhBQUW8{RicK{M^*5)96>TSJ2MHvUM=%o zLxoBd!UwjkDSeHGaq1>mgn82{^8b+|%AJFoN#E0$SgBXVMBTH9wzDC~ z(!rG*jy6XuYWc#F;f|Z!RY$dNyq1W?UIqYz?NNHS%zZ--YQQ03`Z=*{wQLfPLQX!# zPbjr+=bWk-NA0uT8n6^2e1TMs4xe<8>h@XoD#gbYffXcT2(K@RTz$R8{> zo+2L3K~Am?C5R_-464ngY?NEQ(lH-bx_LD_LHwIQWPl+!hjo00CTHD~qe(COi}Q5@ z8mdsAEYx}CRdb78TL{#tM9IXCv>(;2c-hzoaT*|vZGh&u_5+=G2xJxG$AyB*1&j84 zUd1#LBoOO?*0P!T=VrlLl$3Rzn&m6b3}%;!-KNnpKdt&s0H9xwKiZQ|GWtnwku6X1 zWKi13K8o4o)xO>Wk1D%eNCAM&d;y?z&3g=(Ed298zz5o!jZHo@*UJHg!7<27uPXh< zfHZ~3={!EH@uA@YmL|M7mi*kk2)fp+k~NDFmEbyHP^>bip0An|UO<=3!Z0$Sq}$t* zYe3z%dan;gn2$o&f-hkjSEHM*aF#`p8iCKdmz<(ya_j+4q@y`=Q}Mmwy(o0D^t=c< zfFjohvtH{cpUmvB%5q9CbIxp4aBar9*IShCaDJ-blmJ|SaZk1KD|nBs{(ucULkkMY zDb8{183U`LPR)W+OAV>_|27{OLU32@brgrj7g(HBN-)|;=@PG1ii9!_ImhP6lTN<@ zb?eB9Yk6F05@#%XM&Qo@3c0c_&s%N7;R$36`Ce;e%Fiqt`yF@y^MVvwNibDNyDej&uv1vp zkjHb4F(q9ZORV$=#iTAVCy_!p+DK(+@;#hiB>6ROt_qVtG3r zg(3jZN@D9BhP0f{5lcY-&@=VAYdB=pJIy54r7#t{jwfRA`z6PlfZaMNDRD`7Dasge zM=#3E_4AH1dN*(5o6O4V6^?MOKem_vY`b3I0vb6gbIQb0AZT5?Bp)mlVK*B~7tha5 zR5dGMZB0~}K0zijX=EfVwU3TC`aX~1yg z&`4P-Hs;h4w_dtP84|6h9ODmTj@5^Kb*0-+PYM(n3(Jim$1(}CR3(= zNk%{bYp$a0RTekK&Xl824#N|8^uXM3VGa-}0I!M*ed}3d&%0{mr$k$m`;tOOLW3rG zM60s>I}O0H3@^!f;3f2Xp0Z`g1J{AlOdg+FT`#Wj*DnO6=qwMTG_Cwh9Wvs~vLpKC zfs>PRjPw4aVRj{8pstVY*nNOIy^b)s@U4|%vC~lYG-{RN#Bg9rNv1IH?WYkN@?5ZH zlcM@e8ywCYjH}l=9-CA?>m04zD9Z==!vTc%XjC|fycJ&QXciVJTLdC5b$)9g*-};b zoOc!2v?f=Z0iZIx=7?`!^+U#=N55YIM9YpqZ<=%LnMh@O2eR%oz`2O*p66O#dFA@P zz~MN)y%x*rJ1GEEkK2xa1{S0SBS=QHNOrrZdY%I+J2Sgl+@%5MPtg-`{T0Gr{@te` z9~t~R+Eb=f`E_}Wcb+|$Mwm@i>S-ilroFjJfxgQ85zUoS-s6sf9r!>((HEP<@o>T^ zdbinvS5a2L!Nt>e{@;Y_tDf>Q9j}5wqDrs@!^Z7{vUdIX5QheXuB-PM8)!x zF%Pz$4LSW}F8%1DbwaaUOCfpY1#<)kG}o=QhNLqS{(u}~a!U?$t8}8@FhIlR?rOZ} zVQ1}Jhiek^Cb3d?fOB954SRT~^6um-Kdj1*Xo)wVXtd5z<^exMwg zkm`E#f*OMEdVgPC?E8;XypZPz5z-h=sLb`-l`I$GSx7L!ha44$8WQCg8L_$=`&wp{ zmrL)y!&}fNj9G4cx?B6^pC2b4k7UOJzp+1=CD4%%c8o9S#P%grgDQ_jY5!s zq`IkuN0-;{`CGts(sVaQKbU7R);KBFC{7|q=GI5?M7>&YssE)y69fZnM5#68hPX88cr7ih!;%snbRB0*b%+XBe$>?!Vs+|D7N!x;# z@sD=8Qy`Cz3f#s zm0un?9cah?P(W+Ky`!p{P}qZqf?g&nrph7NcA;%vL9?X46FoDx1M`4AA#6UDR1iS- zr}{`rbG%x{FXlHJm>UK7>p)Z2FnGJ}8XJ_R>0`JzEf0Sh+VR2M+Yno#j^Fr>r1rZ@ z(UT5Z&(>NTVpV*pb!Gv(h;TdL#hmVT3l%8Bvj23sm%OWAJ`@{AoECC$!ITT*R&vEt zlmWnL7^ank1MWqsBm2{E>zDiMF(l?zb;Y3<50IfbuDWJshlB8z7g}Aijl(d>3&N=t z-heP5J{#HUB(p~RY_F8>-wwE-pf@NZiJLx7_@_7MS&EO&ol}dUcQ!>5Xr1_(GuiQ} z!n;20QJ5u3Anfb0%V~2`Ye6LhPGN5f?kBR39*@dFh#m8j%2*edw%03?J~POs2&Y`B zGAk3|v+%2qMo~C$lYmP=FNQtr5;06Zf?iSwFe`s85U4%HA^WlixOyF+GTuIoMmO$C z0o4EM>SrGGQ8|iWHo(ivV>a$R(OHDw%hPLVOl8S^P&tr+7CxTk(PYveI+S;ObASV_ zUKx3OJ86_pVtTcu%o5}zo!S3~LHvb*Ac*q#FQq;D>G2;Gqo|@z-WM|g!pu2Ica{|) z_9?F;mK9YaaVfUnzwr(%M}u$zp4ak`H>)!E7^`=4sidHO`eywbba#?nQQnUsPt5)- z#)3AKwv^%toNU!N$LNyKFYoXts$B546c#iOvfR1CFb5*KNXIfz@)pzu@Ibg=o1)$@ z`JHC@*Ak~<6h`Zr+kdQ)5n=YP;6{H(&nC?5@8CTcS@i{7=q~grfC+(i+n@HgnJLPc zdr!4n_Rq5;fF4bJkeO5;LB7T2N!U))=)s7fuF{1giCq=IbGtLkpD8P-tNXi60yxU@ zK-fFH`G$x(k@|x4rA{7*6(!T}Y1u|cv#Q(PZ zFVgtmE&mTO{^TM5Bfo#q#lOpr|2H{?RPQ&BKY3ir3k<=N^~urV}l*U&`WcKVO@o@6D432j0kPHoqqEYaG9zJ2_iW;=ZaEa_lnlGuULpqa2O=2 zdTBTSwBM*PKEjvfM;_^S1J6u8$Lg+W48yY8_vU~mIl-?Tx3S9QMO?eDLnaVQ+d>~RZB=5x$E{6Rg&|}PD^qCukWqcEzNe;icQz4m7#(F zl1H-?{gAAHGO%{E<(bc{xt>dxx| z8owFCTj^N0Y_XSwXd(m2&boB+k6ZG}PuFA#$(4(KfYB0Z6r>ZWmqyT*O&aB~c{!ONtc~YdyuLP+iD@}B<l%LY|davmBPXd)^gXNDBzzKXpQMFbRxVuq6uZE#>4^S|C2V%bYfT88kaNoh!Ru z+|i!T?dTn((n0u<7L<~YwsUW#J9^T-zLu_Tr+I9Fgm?2@&7sii9QbJ{YoLZ(&{>k_ zYEzhqP3vh}9hp$egW~yJD&j4ukRUJvduWNR*gk^XwUu>I=T&}~NZmOM!}si{BdlZ3 zHXu)>?$vU4KNu58&IG5Fh5N=^R|?78Z*!|`keL#i>mZlrS%|jk%$_-=)7i}{=YQR7 z>Q%eQT5cR0!tWXSc(yvk9*Q~e|iw)wB#QhWU zme$wNx@!yX7cTe~WD%tS0Dgm?$-LP2K1kTqmUi5}$4NvuJ@?eTwtmdIu4;1hx;@cI z_`Q=g2f8MAe$&VxE^cbA7Rgu!+;0Ln*yOz3)pltK@Ww(h$Uf=^?Hq zc|x49I+_D>xF9t zdIu*ZZJTaZ5q%4OUpbLE`dzHuvOGI#`R*|?ZP9>Lp^Fx8S*WpKxly{bLxXW!aJmHe zp9eIvsz*wTkWG_87&$uK_LW5O5$%^5tfMQ3Ij7o z7$e4l4i}ctasdR(vHbo{_F!`NDC}|K2f+l>3?g`ZIBkzS8ppaE_WASPh1ZRHZr|-I zBSJ^|(Du*&$eVHdc7BqOKo>-Q2R?;0i+`Gi@3V*{j!*v;McXxXq+8{Oel8^+c}mY!-78Gy~nuJ-C+#P}Sx2^cT@qOOr@jB|OMQ*=9%DivKhbDNw;vc0&7T7M!x?lszJoFJD zSy?icnj`D1GaJn9kx*6SS}4|(=T_8K-dFoJp(Q6TiIt=zWZJ#*lW(EM$u5SjL}Gbv z|_~P4$gPY*=-Vu-PAVrP0ps^b$ zb_@mJA~86GUB$R_zA~FCTI;%Du5ZP^x;&w1G@cONhllRZ+S6Z?GC38jZ&YAm0l0y@wm}wT-OY8@kb? zSWXyY?ERy|7LH^8^|)<}bL^-^-P3&ux#YccxP=r+u^VsP9b;qZCTL>LCcJg#lKr|P zrm$a{t8+lni)JB$|MToz_m)He-0wzz#c5IeE>GyeUJl+JR!nvf1)1FbX4MuBF}wcg zAXax>Q`4 zVP4DMyjTx|Hj1MiOByMkp_D5Tf|$=gg8DfxiRul=5b~AMVZPflxy_CWlxZR(`$#NG^v+iYj!8UO zMOMdc`_Hn}sEuL`U!5DK?H(34Z(-1Yi=%tr+|9rbw`?pK)*=W8Jdm;&U8kKuhr;Pr zi##B=gV(6duSQTAepol*w9@1y3zj|Ud=?ta9g~$2cRvH4XSY+x_yMni_|%&#{prM3 z)iaY3+HMo~6kPooj;)JE9@TNf6PT8Q$H=?HRwLf62*<|Uq9XmkuTJ|!@{S1)g!}9R z`0iHC;j=+_dR^gglADK3FH1Ym*#MZ_Ta9eM>ms?geOVb|od^*R@l zmA5zV?p`ecpq$Yy@CR2!s@U1_*^)}~*KoQ|1r-P7C}N$%&^R000n|Zp6Z70scS$iy zGFc*g4dbQOo!6^7b3%ayNCaBng(;O{0(g}CIVne9Tx!#MpjSP)Y$#oaA#x;Lb0(3#7dlA+-HIF7G|#JP42^(^@?_dxXL(9bZ$Cu@c!iQbYh_TN(|MW~CTs5mjGCLh zqG_XJtKvK-tvYF*+zDrt#5bXXd@hy4(HwLQ?CKsr3W?x zEH>ewbNPyqjTcQ1(DGK%Au346@j5RgyVSyAIaA5@IK$_&rqBXrPJ>z{HI!Ez$U&2v z4rt-J`^E52uj-wcG!Vb88PdBt~=XIbmC92 zg-^|k)f^kOCEIm9V<7cgfhN-m@pS>hs-2ZtV#;&Oo56S`olts(3Ab*~vZiTF8I07{v!f37q2;(HGy>K76JaBV({xG$`_jOl|5;Kl!Rxlxh5Gt zC#hC>KiRO0Z|i}n>B|b)6&8H1vyIw_I>5xquy>(MvSJ&P%3-dYrsdn(ZjaHgtA6tU z4Ly!=yP<}wlWW?#BDNe}Y~J{c%4oekx&vCp=i&#|4pSd)hTRNeXrr{Hz-eM-Ib61y-sndA5S4Ta3}e1x82;nIFgP_0xNYKc6YdibpWA<*mGGr<)|5V zjW2}@8MH8So64VOsi`m46B&zx#p)2rV~dri0ZTdwwtY>ey^EUpNqy?GP~UUMqttGL z73MOHn&*mOl|8^>G(*?hj6JouvxJ-(#l#nERjKwI*2?k$OhP=IED2UH9yGyOzHP*_ zWeaM5{@l3(9tkgQyj9_A(A0k{8MUZ0>9nP9N*w5%((Ht^o~3DUFLXafENS~yof2xA zgrCB`x?cg@&2cn$aEb#e4*Lgv&sTgRf-C+|_ZZing{&|Jo(!6qn!n$>B@jb`PX7^7&xEAL^=uQ_)+7-IGsvP+Y zUp=CFmO_EXymMuA;_z+9W5My=V#MvL#V+hY0s8oB++>}*hnilBf>`3uwmDK?paV?Q z=3P~KsK0fO&@g=aNPw9(EKm-f$0@|*MUup0f*%180YH8#fX7$YSG3{M0}IJUzt+t| z?**0{-%ZRr*nT0KE(U8f+)`FOF^YyY$r{lmKW1khMb`w%r1lcx7urr?yVbNF+-fw?z?F}_8Ay7fE!o1P!;na$_dPHIe=P5{>QrIf zss1BG>WlJN+cq+OD7R6?2P$n1Eg)+%1FMmF|Ah4MP9P;MqJ42PpnWM?$I;GgGFT^= zQw9;5`5M06#fOi>rzp)~=$R+JbQPVE-@X8jkiGeUDT}`*kj%2IH)NOV2~-3RT|@rW z#C~mjGShAmxHiUfE3R%bw6YkmMMIVhP*|`)nterw9vb46s-7aEtWUc+?YawP z-i3+rE{IWj*=Y&t#9cB+REeKW^Yfoofe>PhgQJ;7gzcKU4_IAgWAMi3ptpCUwiIgR)$g=v_l@n8ulV36fN(3P@A+^Wf%FNT#5yJeh1UrrK5p>CpAWze@-RPc4(nHVI zzEkN9Ah8DA+UHCpJMB-tqHx|-WwqV8P#dM)EbGi?;igonM~E=bFY7+FEBJrdd&{Ug zx-D8T5P}2`?wa6Ea0?ndKyY^m9^4_gyE_C4?hYqGgS-2|-TeSvB;UR7-q+o)`(O8u zH^%wFDC(T5+I#K2)|zY1RU}VW^XoG|X5|*1$Orh&Ig<)yfCR*iwsLzptw1?Y$HkLR zeanV(G3_h(hy5+pN38R)y#10#V6F_hA^KE;WvcaMc1_l^fen#l9^Af@3*Ac zUOiqm$1UIQT=hPA?*3LS5800WK7Y0(3FK}XpY>XZ-UarF6FzA>3%r@I7Z=r-&Tui2 zecTsskBVE&*}DrMUx}qBnmEWeuQHgRD}zLwv3>>Atl7UwvJ*f!M#X}UV|dS*VdAn^ zuj4u!`%`763;T$GAYab!$N6b8Xa)eyDQF~k+{nMJ=$tFs%-c}a_H1GVc{=~T+5018 zs0{@wMJjkShyPSPX%P-up1MqBv`%{W!PR%?BWeAOX9q zS2%ZH+*00d^=pIsdpC`q-Ix=t;JzhWzJpY{Q-A&~)fS=sBI-o$$1XM+>$Xkbc#I?% zu$#~old(9tuxs_8hm3r?4?7g}6nts@-Pc=b;~8!D?F3aBj|*kzk?as@2SNUeh98eB zS=SS>rb9@nj^MSoSK!93%-0eIT8tew%dXqMnfk}GJg?>$d5JSju0pvvI99&aof&L$ zv;63(h+N@)(%b+d&(AtCC{WO{n6t(W$m7#bb_;$?d{28~-pynKA){^Yr_;H{RB5q8 z`l(PA^y=qKxKkcaujcwE83?)w7Pm?D#);(eS@55sB)fkto8 z%laa|Tix3|U?M+cCzE8yL3Gd@SU@(S=SG328~e$KYyu+3&Bu%IbCQ)f5W87vruIx7 zAjJt4D)Hvc1i%N_-p~`*`EAl;^)l>=bn@-$Sv<|31P~_l9l-ZD zqsZm|lPvfMF+e{jam@xqEIdhC7Y(1KA5Gii@l<=A7q5zfefqw(w{<9L4>5>!0p)%KGKE^`Pns3el8R!sb&`YP37EY5c-tikWiCz(Q(VXN?n zpatT#0Bn);GnCsF=J_3&1nv8#}Bk!tH&N;90gQ(l0^lfz7d_Cxk2%$fWo zk<+0zi@Mx&z)kjwQH^qci_#%V0^&o(HBRVQ-pXxf)6DmRXTbhB2}4A{Jb780di;uv z?_fRzwe2~jsiENqH+)-3cl;#aDF9+9KUgvOFJetyBsBQd?&mMf!X6^;#Q=34FO)D-!+c0Q z*IuxFIf0Yv6>GUmHv^a55HEvlh>M%ERPWLWu=n#?dsDX!;ta5^ziS%eNOhUGU6VK> z%z5#{BN3Nt{eneMBI)T2RBTf<)hRbEQ^842=*@Dc8AP|nv6Iawq%RHnuSsqL58k7Q0q7*4Xu zdz%ZCaaDfLKaZE)RNlNDArF(|%jDyL%zf6U6u2`JcEejk)Xo&hhXz)VG^xPo1j7yb zXx6)5^N!cZEgqsK3A~>l(}c6UbEwfHn|KuE2)$uZ9I}MYqRm)*g*|;#p4vzS)#U`L zodBlw?;z6(lx2kLz^$jq`i_8Pam%EnV0IC9hK@tN`&q zH7iihU^12hM$J!1t76{yDP&^L=sn~bk9~#q2LrJ|-3&2EE@=Yne1*s)P~3tzej40X z>oyp3{tJ%8m}#ASXIdI9e~>;|AN0-0*DG*19_Ixeswc_`1>N|=B`yV?f^_g_7Y&4B($GiK50{CQONoT8NxWtS#>t@=8xcpXMiLE&}2z7y#)fVU?ILMu#aE;ym4>d`5_I+V|gMj z2p(N-=4trhK^GP^(>S6o(fcYT=^B9TYjgOo<|&Csl60rO7?ca+EcXIC6N_Kh99=Fms;HBZZ!~D(qKLF&$c4S9(YS`7}Ngvlk@jImroK z2z%hUI*K*9xY!^g_G*{}YpMu@hkI;X=W%e) zC^Qi40}#j#kWb4Wf`D8_uBu7h1ey18-n6?_l4*P9wZsr1$>imF zka?TmS>D9zc`bcaK39RQnp%P)9*nVkc$yMBUc!0G`i{gT7J z&Dls%{|w%kd&82e(_`hQ&Rco^cU`T1w_nb8lUYxqaEQrdsBFlWIG}HXGMX(+@E|98i0GyOTtepl@F7^d!fVTX}A9Xa-iz(O!J4wq+=GESlw%gdcTryXU zNkA+%x>>joofj`k$}LVZ+px>IC_1trcvlc{qAv}|7Xb>@>2uc$@9^5_zt+3sD>RrF zmk?Rl*JWrRHC=ibJ1zj2#`3LTnzwJ$SzR~kwFF_^fa^Aij^Z}^giHd{v@s8{&V;d7 zQi^WM7jPb3Gd*eC3twV{((1ixb7w|xSlQ3YojQb3$xT3&__^TB#kxU&F*CNV1Gx}t zvs6fs@bRefdU!XYnl@h5t-8`G;1>TC@N?AJLIMt4jI)4W4(ybJ0YlcyYX-IlgA1LO z?Vm`%PY@NUVdb+h+VApDhrhhrj=nc;=qj3|9ZnMiIfGqU73GRF^dTAZ0R78}-CxW1 zRtk^7gY!;BZr(YKE;|u@g5=NxX&H$?bV}x1;O#Sg0@VhToB3~cvZfis62pqVDai?* zM7n$F%4RUIi>J=-{jt2k^|6tCtCKb)!D06(phWsyY5IofSvM6Va{q@bIRV4>P&^^7 z<^9JA2&ExMW1M{v`nU)fuBU~@v>kaNW=RV&2JUqA9Yyb2|M4AX)b`OQmdv8C| z{^m(u;C2I%iO<~yRCuTr2H!xquRnH3;}JmZ0o_6n} z+aUKhDi%?>(}1=IjA(;DvF-3pv};P+y|XW4RLRp)!S~S1)@V?EE;r&>p=SLhyHgMM zc50o31&vJhHMG3o<+$9!L#{|WQAOkUxWuDD!*bq_zueAANdOee&{O`GI^*MNSwj#1 z{onxdyqXf{dd!0CX2a<;w#z}4sbg9pIpzo_^ zL4NkHQOrMErBHSu^y#O)32%E_`I#?EXJab>zdgrsp<)vd&!0Trlju0F|B#(?Sm(Uk zBCz4~$^(X8DCB4M2R5f+{cXQfk^~1}ft9^Qqnb_9b=0z`YucKQ#DCwsKT=Lj){PS1;Ogr^o1+wt_kA{C{{2v$ke{&FF3@)e=+3}b;u zFerQ{KVPD7W&a^P{%iC57y0TxrusjH5!qgz-Djsj=dF;Sr-9CI4F?EL0cnrY z*0-8c^xbZgg-^fbSY!U{k$v3&Mf{JTVxGV5{yC`lA46eQE!4H+fR{aCTvJ_?aU&?~ z)V1#*Ng4N_w+?eB3b@`Z=Hh>)X#aUjzPa!h)Z&HT$IwgTy7#+ks$gX~zZ?DdBkK7d z=K(ERAKaSSr~a>Q;TcFm$ciKp_+oacwCgZ)06!ffRZV5;s46b--#1(I0qDx}K3n~t zhDQJWlpP2cCbSuhycoZDhy$nosayQ}lp^)#uRb?1`R|{6KH>QhT$AOdtCF=$XM>jv zi!*aClz9JRkbn{I2IBnMn-^dHr#t%d^+=o|ppO1ELN6me@!uEx`$rr4$wkTXj(XDH z%kCun1lq0uD#x25gKjKUEypS4lG6RPAd+^-*+AaO6~Lby6-HEUQppLe`+)O$^9M^E z0uZF0cLpN6-|ZHzxb2tCCSYq?RwbxtnAgvll$6!GRXAQwsR{!24nPLHkdw~B^soK2 zoT>{N$|^d81{C7qxI7MKwN}8X8Xl+JVRIkLXj6UU^Zz<_0F9Dy!2mSx`rX83tU!w< zKzF#5r;Pcp=DYtG$|gWK>6Znl8PB67hvNcVQ5R_B+S;MoewLsP@PS6NKTOE5$qImy zcAWuy9@YCs=Av?PUy)cKKx=RTiP!PR^7B3PJ;Ig~oszTFmcW{pHuN?6wad zkYZ8Z)J#8GI*5Sru1kiX>auaM5s;f-AFqJa8LF0?-f#gUb^LU^vXy2dVD#}`D>md) zD`r7W555J^H|S)ob6w*mR+@26u5(6P*WfNXjH#U~G4o*sbQIcWLj~oh0~!NnA9cM8 zNClR|WV>RF0M+G@wPsz0wy2giVPM{{s*Y=ZOX?<&w~}VMW3jMD*afG!bEtv8^;nkd zYW}c7nJnOJQO36&m!#@mOnjcV@|L4{TC1ZCCnrugefKCsxM2m2$9JHk=KZ7g`y=21 z`G%#}Icm&uXxk}#$h4j5ZarO*7bU=xNj@`f z_*rCqqM`)A2CR@vH1n}u&D)IjMv*+lWkEJ9bnoXGTMot-(VKu_tzphE6W1D;v+E_Y zFq79GVf?ZarVNl@Lxo-f{WgwOVPKU7%jD9Ldp_{0=zjT;Uy$jx=fQt_aeoYYx>=8s z81{jB2~PQbD<&&5!vXij3Yl>j$tuhH@fP%WSurATPrnkAJi#JIwUz09lnTPxuoxKM z2L8P>mS^}V7sIp3^=fd}8l~fkxR-I8nqhTkvQF}P+1-Z2VpqrgFri)LGpM`q?Ym{Z z)5%@aEKiPiC6N>masXNHCA9ziG%(dm;!WslP}QBR+$^l-aVe|#k1Ucp7zne!A^HDh z68nx=-djf*TC`|-e3aKWl!soCO-%x1EzMKdt5 zM2?dROIQ{&5aFRw?1&Jige3(Dy`h3MYkb|Hb%e2{gc!h4`l1ED=t>^oAa2nrN9TO? zaMLRo$@D!gd?p0$caLeWAF2RuLb}`Dk2K3_Nmr|XjMEnz%a*9*k81qcScNEH$a%=D z=Ry`dfhGV=Kr4uA9MFx};v0OX8mla)dGiP}(WwPB{Q#`ofC2g%nJEkEk9u#Q0r~9{ zx&$Hmh*Fwp(-96T0Y~Y5fUM@5>+|kd zW0}=_0PPl};rGuB^?-+0gYiNG?B-Y>qxR9}l>Mzky3|*;-wRQnTTE#unja6w;>~~Ax8x96=%=fIM0rE< z>hX)!=}hW_Cw?odsBZ#Y&dLf}SpfouE#$QKX-7hEZx`D_v!qaSx9IHDCyF zkn|M1-H0oVW#o)u2u;~uuQq^)3hbBG^jLPjghLtR%o}h}u^OC+lbym4Z0zdl9_vVc z@>mPNVXPqQm+(#A*8BAeCmkpOx0KeT4w~(Oo*s@r9e$-EV8&l;^Xzj$o3gy^gj?5lB<(53&KaK7=}|M_Myju< zu3S=Js#9y8+%I;cb*oY@Hj{KSvBD7fo&%QeOidfH`AIs>sgCEy&ActYlXh8`RC`Al z>7E-MNW(ve)HR0ImL5tJd`10mdSV;bD7*(~HIdy=x7UD4e1IeRygcuK*hLmZ_{P+4 z^VPgSVKQ57H`P4g7jSOuurX@}dv@-g8G%kx8Ds63O#pphOc?0%9qe zvDIMoAMJB>Wy+op8S1Q=ES|ugW$dYIQC0`u%DVYRxP5hc$>60Cvb|3P@LQ@bfUWfL z$Qk4gG?z&rxm~Zc@4+)Q3d$a4pZwD|j&u|OT3d^D-`{$l;%_kesYXcaGW;a+CWo6b zqvut}0T^7?u-rVvu^^gZ$F^gVW(D+&fV885SVbQnu2)E+FlcGeevzEEm<~P=fIf*1 z&5i%^gX{ecwo@{Hyff|#y-ixVn{FU~B(>gW%Ic;p@9wFo0$-ofTauU60bx^*jhZw= z-RFK9d84VG5o)^zB?vu11AlkIeCaF#ReH3y%O|bHi2U0Z1wQkh*GquoI;L%jR(1!1 zFNqTHcG_feb};wJ4B*M)h6Sqtjb%a2tjCq{DuqE^!p zt`VkCns`I(>tl~?-rGUk72LWaKE#9H*xjhpc4GCdTaeJVyL%7oGe!0z{0&Cm!4f4d zO5Ms4XF~oro)B;tla67;djpU4Drj_Z4v(9Y+RKxtK6$S<80PUe-WOvMb}XxYj~{z&H!AvjHxz#*KgeWp;DqSunr1kHJqgByS&RT)hkO0S z?9(G~s~(cA;rH9Q0Hwy$NhAI(Sdt&;w4wuPp3$z9Zuht}JKbvCD=w+tW)ej{+4a36|GmDG7ZtfwX_OUu zUt{P@jXFF~LHyw*%Y-l8klLEhGl( zuqe|WvA+3bGId^x@2r_`-UO9i^4FuB%2T4i!)q>apCu7OLQqy=CYWZe|2a<{!G5!aK-_v_zPru$6R7rUx zGXmwsu}PQh-WW;&Px9&-31zW0#t}x^&*N0RBd;$t0g;t&KQuaV?Z#>uurEljPf!UM zgN;2FdxN~X3<|_zf+?Kp*@wlR6B9@-isZJbSy;&&`<#CfQR@CqHD4;6W~;d4PsJ9$s^6Fb)8{(d}MW zX8UzzQ+cuu8f(EINqwGEhW9AX<2xlcxeLhZ-$;t3~jEGaA7aPQ6XtbXTaLLXs`(_ z&v)9jS5lFgbxbzEqUooy8EyFF1ibz^JBM}4lPv{sFPPfn)HGZMl3xEOQn_#a1SDhh=OaVwY!6%-}1*E>lcd&=R~8cLtOV(GF4u zGn|*z*KkHk=W*L_hRXS5sP;mHvS@8G_t7=9s)ECIZb^M6e|W$tZBb&VOXPMSGB%Qy zN5D*{=1z#^yU~TrSLi8Z|?p< z2nKgf zR|+`To%H6PJCO38hFYJV9vzh(uT_cK?T4L*?E&vyTwXru9B@>zQn+HUN49H7E@6Rb zLW}+LB6l^!{}qB>eC7{XrtEh#mYV8Dk1`VcCUQzeJ9N6YQlClf`?JTG<94I7=itdG z3`0@6s+Wx~iK#1MQg6D!L}6I9Rz_)-aR8kTjHq5EJm1x}4YI1A-FBS%`*A|& zd_!F(f4ti^y&%3roMy#!dgrHJVs|8Twh=G=mBHqJGaB9Fw-zWlyxQKPpFADe&g?LXSFT4`gty z#IL&drXyVRittThcI9lkQ$5Yf{2&GL3h_^5Hy3k;mgw}G%!odyH_9+DUioLz>5>st zOFN}R^_6&^d=-CY=ya< z9_fn!4a;${u{kZ+{Dt5HJ=C5|`_0+4i9VyK7i6@CBpDJKj*W3QZ^Q!+zD-#btmt@y zi4BF0_UD893T8ve6w@J>5nwn8J%0k@UvNmX^@3G$EGc4}kvo)Ms-J|i824jBIt_i- zwE^)siM&`V`LDQNKMFH78f4^0EbLydjV@}OL>i8X;cUL8u%UD%l61_hCihu71)MB7 zRN$AvsbsId{R(N9j3B%DY6@gBWaX0rR0|$AXn_{dV}s!cy5d#LuW%DqCsUZQMEB8{ zbOOd_duW$01Z*n1+{w5`g!Vo#e*Xxse)7{75qpDvV{-_lk6FWeS6a9FqBUqUPrgHi zOV>^x!H0R*^|JF7*u6*k-OsD5g7-Oj<}X@4ja^c*X?6f0PvABzn{QClxUIl*Tk>(Y z*CfJ?Mn5Z%mX#_clQBq_OZ8cM-IX@_{P3Gz6Oc^?sG@3gON(gHsVA*@zY@?2sEbH) z_-zO8hw}?AtB*BY;qat5rX){uM$@M4f|f53Cj*YiAsVmn7qnA*U3VIM#giGqv3QJD zbTU33ERx}*HsP5dzj44x=5YGUF+OpW7#Ae4qu|h1J{7~-D;73r0-;Ee42@A-q${U4 zzBrd>)2LAb)5WYc(HV!gf+V*wfhfXXe8SM{w?4R-22$(rmbc&S{V>hQG){b5d1UC% z9EdkKXxxRog%(_{4lsA@1C909)C!YdO*bJ4cHwcE<$#hYTB%;Cj$lO%m|n#=1JIX| z&l-8a_-sBrC-Y?R2o-D~uf!?GEcEX>=G^6nBj*}Kf=-_tm-J|Ak{e0g0cn-(Zd zHXw)1{>>vbq;I1bXzu%Xx4*AZe`d- zM?gmk(G9u5KAq(oGh;nrNKO!Or~|9^Yui90`_Ohn@|O|$KkM78of049Q+8$>B~DZ_ z*7_&&2t~adV7AcilQU}^j=q$X^{5wcY;a49!&2&=1ijs+K(;?6&JuZ{i0|jWG~F0t zD@O0xWzVVqgX$-ImE*Vx3!+$&%vU(Ux+4^Qwl4uo=r|Nv;ndbSUC9l~4Jrzh<(B~L zcBkGDAjJetP700gi=%t%xdp3cBpNnij}u18X-5oMq`<$%%ryG=Gmej#F^`sO!zuc> z9zy{oQs-t$uK|@QqQfp*JfJbDGyVJobT@Z&e zdLvYB1+p$X5r3xbl%GL~{;L(AyUxH9pwa}?%#YvFjeT-q< zhCH0^H0zRbpjuJDHAj-RlR8(3?aDwhz1Dt5t3Iw&!EqtZ$r)B=Xot(uhM2GG6S&3~ z$N_(2oG69qvO^McoV;*OS~}%vNT0{?`NNzF|M3S~s+-ab`9Ft5KKvBC>q?)~_dGEF z)-<-_bK;9`@^RVyOzNBSP@}ZEb<-yP=Uz_lt(9-kEQS~qhDw7>ql7M`D66tk zcVh7%`HlBk`+PS}*ogcpR_&&301WObsnPZxm5F+26PBsnRXeh7IW_3u#R7wu09RM& zAkdJIM+iv+1F0tmi=>kQR$COQRgcxLJfRb=?y4VQC>r$X9fihQ_O~(iE^p4Q!@_UA z`hYGGRl9iG-zI6rHngP+!}_l+zGk`?%o6ONxi>?SMCRXgM_OwPw&-OZaW~a*(SOln zsjEg*%aXf5gO6ZEe=+^u%uMTtpYO`}No)*G7dj_$YfYW6XAh8d9J>hX^ zprUJM!3Ybs)JG3hMd2OCeV&td2bX}XFZqUTs8xjIrwTdL?etbw+iM9C44u!8jYl%3{gt06@^aJ?jZHA((M(uG%E)h$tUw8Z z!i|jOsn8-V(8`@KOtM8WYSC3<>TDf|>?tUzWJ*>3g<^^=}y z0yt_ZA@9K1Fd3q1(d3UXc1v7gnHP65IoR>0^t(vXUw)|t{En(wt1V0JzI6_&M7~`E z+Aq#qS1f+AWatj{dH;<7O?TUnY)c?b7oWycZ<|lMR#(uXPBugg@MhWkP{cT6WvLYs zr2vp2XBGg$(a4;=+lvAUOL&07A$nNUJ7V-SSV~67LNMa@z)z8il ztR2)@?xrvKb~8+C70gmTln)7R(;M3_qmVD$hesk{H&6Wg)-BfF+Ujok`J1gMdiADU z@%IbghZJgdZYyV2M6VYLLt&agaMucR_Y-r+J47f{wsd}b-kxL=Z1vli)|?H&>8s@h z*(LOo+);T$&XuNot+(Or3G-bvC@9i7UwVZ4Nq^+sA5kzj=uOKkP6%6(GI#4is({Be z9NUteoa+0Xlddt*pY&dUQg2p*n1v={GeB@T&R>4AYrQN;l^+sMLHKyu8K)n8?y%RS z)z@X?@1T5bgst~=?pV}B$sv^S3Kzr}rSKn){P zD+8`^an|T9k*?%)s87?+60NfDGb?YYiB^bxR!w@1<}2EIXc8uMWL+0Cygo;KH4 zD&928^ro#bU3;$M$~B!Q6QbzE!)dks+IAzJqpw{3h8T;^Bw&18>W;neMq}jc93$K2 zBM7>e&rc^v7_B59I}Fm17hiOzRj^)&!nOJW`z=ZpcB4@L$QBIRMD}o1JlDlpH{!-Ra-^PCi_H`1OaZ4OSw-fuy9KUxvjmkxh8|xxeJ7 z>3F2k!nfp=X}7kZ9`fi<-BS3Y#@N}2=u|i24u^e}MdForHNwq4PVIAWkp?1YI<%Y+ zUSx2$r%~aD1yj>J?OWij!dL6zR2nwu;2WMm)*huTn6qOP?)-dnkHR->r5ez>aOG`R z^X$^whM0i&W449yIzQM4pZVSxDoMMCiZ4bje4Gzgp7o+w)nr$0)7y4R zK>>Aq>ZyE>rJ?MFA3d|^B#vWEfDR6annQkj-s$@^r!yV9c3pn*0UyWu-NYJp6sr#w zag%t85|4AIdLscv>WdZ18NPBc1{qXD{@R#u5(#r~CJP^&!3-51>w_>A2|o~buO_2;CP1uP9;hVyVPu zEB&*cNTFZK3Q1-79tpe$lAu2e?@sy!9sMyz)hD@3zT38APbOFmfv#HGxoB$pm7?@_ zXFXlZToNHHeVQ^xuOniW3C~!=YG!qZsAR?ZGYefrJ}39&vss6u#--3C;d<+0WFmLA zUetD;D5=V?>e{WzFH_J#a~W3Fn0%lLw}B1&6+6`8GPs5{H}^HH#zAU+05`U+$TZWn zAQw$;^SswvVAr*qupR%Zqbep%34^h)Qn8-$yoiIrRAg;c6qSfQC^V>8AHxgaS0C#gd)H02TW^Qrdu#c%qz4Ee};MpJ6m_uHrOfr710_ivC4^cFeKy2ZdMQV=WH6{@w=<8$Z8ln zzH8mdpPE*62}yXbD*4a5^L0d2M4;Rb2Ky1@Zdxa z&a!^C3NOJ-7^?6)^v=MUS2A=)7~!^DvoEO(l3?FDb4j>Z8n&+4CP`>{;EbtzVEx<{ zXiL3^_j4FVyEBodD5JggHtg66?BPWD6(u!~3L#A1X2Vt!2KtJ-Yb9nz1Uk1(w z){RxmzN+9f99gm%cUynDrgj=+M$TW7C<)6w(BE@R1N*XQti0-&d0v8vjcOI7#43o@ z$yX`7WC8*ayALF+05G*Z)4^g~qJPqR`h`D3twkA%(hqNIwVX^=m>- z>vXJz!NDknMf&zuF$2|04hBl53Ux$jTP*lvI#()!e0_Pkuw5FCGYfhTr4imwbiHw| zVmEhNmpntOnE0;SR)F+`=6 z?Ab1>Vr<9!1I3ZxsvpVjt^!dv3rUk zsnCgj9z=0)1ZtRk=P^-IbmQmZT$kZuZs+*Iq=Y}^#!W>(e^u8N?c=(@({L`x3j<^5 zEZp}AjG5#%A<&iuCs(WFQ*`luYb#Q`ClQ;|_|>ok|6x%%Svhp6=o5>|?04$%>p;Zy zHjfz%tjtT4FX8b94@917uk@W?s;H`bTpnx@`D{3xb2uO_<)2ngToaB9-$XJdd!aWc zM|haUs8OE9JyXQ~yi<_+t5!(j)?nFD^gv+#JMw0)4i55kzSVJjPlCg@Rsp3r!W#E7q`YsF@w;<25=u;ToyJyb>b^i9QLh z&k2@NQw9C3f8R%br8**U1ze-HOcrwT?b^_EV?l9=eV ze4Tf*S(6uby;KZf;xDE2b^~T`vym%ZJ{c9NDpe)d;T{~tlOI4kHwH@zgg4l>FUUzB zJL7$)GB;m@vEa_{T=S=Kv}Nc-`ChKFePl?BO>AaGw_ID!Tre*}5C!F8*10L^&~p9e z1n6`2f}dTEk)@fU_(Vzj)_e0>d+qT(8bF#_m#I5Q0J>_KjzIW+H0v*)2l|%xSFzfq zcD$sWx2u4LlZL=gRqpLO@o< z6-2e?-c6N1Xp zJU1V!O0ln%KP6_9XC{H1IPT($$))FLp1w25GTU#-gl%N-@+7nScHi8ecEIG+`0or% zQuFJIYaprH3LmZHoY96}|K=(est~eZYTn5eHeKTK`IW{`;&;|ZleMRask?s`6b#oF z?0LDl7+tmse)~np1=rISJCpoi^J3#T>6qy*FSnz!V=VTzEj2;Jy)yVDhv5RKP#L)I z2EO$XCRtD*4TQoWak;C0G5t!5CFUA{*;p-*kH4ij z6YALhdNq|dp?JTI466i4OhOo|J{&QfyTH?gkN)*2w(xJ%^RzJ2 z%bnY@2;H{IJ&w&2_y>T*MiKk71>wlsQA*m#{2w0ubt5<|NoCRO^e zZk_YoHlQfFTEv+G|89p?y42<08>E6b5SJ@V=QI=ka|kyFrg+6d?~2Z%q3!$D{e3kI z)@l1nD2TTBI$z%FENLj`RfC%7Js71PBfeOO7+f^Ot3| zT6T(IT_t(G0nK5d;f-1$I9r<+22pbYX(>xr3OinGeL? zC+}J^=H$#NuLIUm!g^3B_L_VqE|tYfd#O zNHm$IjQ!~)8z&B!1q?-DbI=IZr&y_weUF$t1G zDI#Km*8}ET_2>61PXctzBhdlIiDDeKQrBy!-m{C_CyV=1M9y@L>yf;PQ&>HyEkX5_ zECKo+IBPHa`oDwHMAuo<>+<$?1hyQiAt zeWRpYpA@C}6cj8S`aRzXUdk&3+oz3+L5-A;;(jv{w(dhF#;-4L*SZl5E}P88nN zNjPVT6VSue!mSRs)K*X@{LsRxZ#8P&5}sF4<|%r&^(&okaBj`Ers~uemz!C_*n2Lm zkZKP2+9`y5p&yquTlVsISytdP<@~x~_XOJBu)$`_FAQ}rQ>&0;dyxvQ^ zXpq#{g+Col0WKZ5b#+6Z@uDf+ABCsVscSlyB`a^=AC+5Q9CZRay#t&@qDVn>oQCiV&G^n+?@Fn zc_A|ZXJw15$B-5pAaF-0bSNVnca%O*li8yB^?A?Nn#WPem;ctWqsE(9>gre@l&-b-(N<3MSHQ)ti|Ko}rf zv{xk(STd;Xb(UE#E!1dMoH)zFjLhLx)5I6lIkzCs=% ztQkjbD?%qW^Qj%e;y>-eFuy84LNV{_(%XM;$H1G0+3)btZ{O>nA2%Eii;F=T?u&lk zA;tO3$d%&{nCI=lto~A2fYX7wZqcclt3@UVj+r=7i$FHtSXXJIfl8{+UVyhR^(&5q z07U0z`MTZI+!hJ%Eh8VH0`dH7&1CU2_%1(kXHKtrTR%kanwvPIm#P8!V#xh#?l0qZ zEo;Zbxn5sJy)9L1l4Eb?|AwUG}p9>!r?z=Nho!bx1QA@M)l{yoZdKucN z5+m7tQa6Y3(?3X-s2)6gV_MK3E?tQ4=FP=~{PA2M&@pj9u&uhwC8rVKe=?-sc5s$; zKlA}F`RZ#Ql1eR=MGE{<@0kO$T=~q|eOyyjdneQ3Iohd2Y;sOt8cuj-{3S&VN@72A zIc43on*w3<1v`d*cz~-Ifn!8>oY&RCoPUgF)8Ni;im2L}ULt2grYL&CNBP8#@eX!> zKq50;*Q)k#x?L0_eMA1LW;s_PR6Y}%p#G~Zn#^zOec~%z?H{5qr2|utE7g)a$p((*5oe}ds-6kq z(!T!(X>S2lW!tT710vGhjdXXnw6q{4-AJdDbhm=s5nB zp<+y(wcztfInFOy(vAdMJyP$l2_h?bguCg?-A(YCZhkc7Ju6hn{CK1h-VEep?x{w+ zjlgddCyzrdA|@bu;{l%)JW|DN*HiaJ7^@oUms(7g@!vj3%vGZ& zxa<6`tGI*YMCR6sM6Xj}r*nXD-<@hC3b&n9?K}+zWHfGR+>;Uc!r*5p2I}r+SN5TW z_{DYNNQoP!YyO#9H|JiL&ZfIsupD2G#U5PdNRDW)7YDjpSke~nKKJTL+f4+5|F8X zdl2vbG)5r8z4(qQ&0qX*@Ot>iF@bbEGcm=~ygUa0wNBBUrL-%EXZEy5uLs@ep)XC| zTA|?Cjc#^Qz^u4kxs4jKoKB3DubCugaC{}3)wLpfQQ0F59b|921u8Q1HzS2)Zb?U) z*C(8ujQ3qUzWvtW^vuBvCoUk%5CG1@OCZf$ z-|GcDR_#G~?lJ3@1a*yCMsM9w)@Ig0sYf6Q-K&5zQ^Zu0GZrN?YlI$Cepuql5UIkC!4lJzDVnp1G^$!#u13pJJhRX{buY}+}qO5Q1P!}H{VH>ziGZltJ zaluw@f3$sAFC!*)$)sfx@7*sSeqcRJX#E~_s8nJ6StPR!uD02#z(yL<_hDk7TYvC36=;W%l z_@&))+K78vz{*$G`j@TqPlt4~bzdbMq<*Xdv#kv+X>?u5+wGasW>ie=#v>%_S7{}M zPklx;fQFp)k|7W=qTLuv$Na7iLpNBPuWahb#Gw1TW~4{~gVw7#sm<}Fsy(*DaaS#=S=S5VPtvLJZy@W?K`nbspOgHYHI zZL1G;hZ$`MjrjFTN%<0M!ma#*=el%smLJX;$B?IX;-pn=ijbL8KG*!TE|nDT&D(sJ=3y7F3!X7(e=#rFM6!8rJ=gnH zVjFxz;$t82SoUZr=iKAy=2Aw@B3(m2#GAFtSuBelroS>8(#D$DsaBeXAK0G%y)*10 zWw=c!(9J+ud%>h3;tSyC)tOn|lkptr)bYKBPq@VOIcj<1hW`Zn!6=HG<{!aqW*A56 zHYTaFc-W_r)Uj1+Qp z8`h(kJwyB4sWMM^;N@jWa^)4(bXbZYO>%qVmBx4wKFyy7I*!C&dMH*EeJ{Uhf6{*^ zym7+yu8s0_8gPk<7CHwwJbP)@`SEiC@L3no~) z)x|gbxVW#_7$2#jgU*#QHTJ%cl*`&?+5|Nl#t@i#o9C5`940<|{?XYTF@ec9&m$RZ z!NsB~VG5J{?S>8w$jK{)Hkdp3F9dsSdym@*2ZenjRBuE5}kmb!7{U zG=&E1by$?9(_z92UWSi<`2?F=Oe1yIX_T6U)g!lJqU0{%UzjI)`u6M9ugSM^>SA+y zn28EhPd2L#uD8?K%j#wjO-OjPG-+%x6=&-pbMJ^orlc^8&aLGfqEQ3Aksvm);^Nc1ZbML)jGN*X!?_X&~DKDY|5MzAd4rD^J)BlLF zdE9$Wgi$3~w`*~9xd+MG(Bp)@e?CTQ(Z--MsR%jo zc|BSOtbJvf13Y{?KGtUJGS7RZNGM>WYcK|>_yxqiaKQ49LVaJa=fY=QV-Za5SeKUE5I=Z9Th;?DgsJ(xaf zzD3r$a0yry@D43tX2N^qZnYP=P%=7Rpb13 z$;1tm#ri+bPJd1iGGYUJ8v`mr~~i9V(*xHcu!T6;L#n!z-q2H%Jme|S9(7kLI!5O z=P_?^@=1VU#fPD=f=7USZR;FtGkdxNY=OOI8QV3)4m8hjld)F$emGc1_k9AH{OMM-!ppff`~LVB8ud`}drJ2y{rwrnKk|GHabG`jzD z5y*!+fi|~F83LTIn-i68M3we1BSJ8~n*N?HqVJM{mvt~K2>n_(RR zID^~V>4^$UDxR-L%A9=pW+<*YkCF6 zY+3CE;h%8$1dFYGRmWjuM*__>H7=c(c38N|Du)rm^m(;L=lX{Ocb|Qcctzfn;6@C$n)n(Y_AGDxD5}4t+oFqz z^1?=jeS7yt;@bvwgTeljF|Fm1%Bq};RY_Vw77g?3%y@XmC`mi^;7lw~bn?H1hZf?Yjqw}}ctkD~O zdSBM4(>MyhPh+NRX|kz-oG;kSwZ28zNfzavhCZvaFBSd0#9iy}odtq8^b+dt2>Bvi zj`v5zx0?Wfe#%)^o!t9}Co|}Sn(AcO_0Zk>tlL0QbptmY%W#>NU*Aicr`iRP@w@vY z=Bn_sl;(OvhnwHM$u~MUA6nst{n2sF^5G~KlD`h0yVK_{io&AQzEj?el`iN?$Ccx} z(R)&CYf_o@?rIi_Mn~cB0@2^1d`n8U`CZ%T0JCoxuix!eR?n%|Q?}vjLL6H*Ol$K` zWIQZSOns4iU%4+B6Kq*7bLfsb(fNnL#%?Z*zvjSx!KyeK<$}%e+zY3#MnjAg-_R49 zp`R6o6_@SbuLj3eMw_gY8x;9yGYXSDR4PcL`HA^HvkK?-UPoozMG49ysYk3O#O0|C zy$#?BlnbmE5Mh)>mdd;1 zzLMRSF~<@+@_G9f&75;r)LE)sM5QJ{Aosy>BoWf2C;nvJbQ)x!0+ry}uDYgHMP5NL z>?|+7oA#Dmm1#4ASuhuWJ%j_&jE zTPall^}3FdXda4`ALZFSShi)%Ce6uLvW+)Yb4k}F-g4d@qHZps{#hFjYk@M>}J9bCjdM`68;(JL|QVOay|Kf%|k;jZP49 zKt|``b4x+IZ(#^}GLLSb+Zv!d`kZmf)=*b`-*@9vm)EozmC|t78d}Pd*`hHf{Q_hu zK}OdJP1LE313?>NR8OAJ8ibcB++i%rZSS~NwyjN5*qU>}2<&_&>tY@Z<$2F8XO9Dm zwHwmTqsW8jfI0Vttn!6ybuKSUpi%fv9 zWzYO>68(il5=^XE`YB`(?}TUcgU~HPHzT8pX%5+;KyNVf34?lP?!XfB4AT>JtXx`R zvlleX+3x}-(ajAbTE@0Q$|C58K}|INo}k)U0y(e5=9@_ovh_KnOyzuAC{>7ou9Rvx zbXvwF!}RH%F*~b$bZ6o{Skbm4EJ9#n%>zP3do(yZ85?bSV~AoZtRvoMrFE{MzIjbIfy{E#CIq-t zn%bIr-62&5vA|{6kq!;4^pH*I%D1FhJM8tv(q-%I0;R}969eHog;R{od?h{T>g-UV zj}2W*zTiyT`A!v%jcKip_7?ZgpacQ)z2D<}MNJW`pcc`l@%4AiI-Cp{=Sv^GZRob-_2zxYy_37^Q9gM=FDu?Ue7m{->ag?>TYYxc4~oiWnuY^~uXTpm+lqyXBx>g1UM5 zb=IGYSA;}1@TgDHLzw=E4G_}X(Pmc#<_L0T{_`Hkn7|2ib~KDcZM?D0nSCcqZ?#4W z$OC{pVx(|g5&xFOs;MA@>w_%3EDr4OyYZ=X0|S(-KoA$+l6lNQL3*k{Nn~H&|M&TW zuCBdR`d7{nGZ6ME@L9mPCx2x6OQiopa-xoC2W{;w%DuWsRycw_78J%1!VyzZ7cx&_ z{xJcX;FZ1xn_JBsq!{{cUHYepP zVfT|1o~N?}Plu=iO{+`VI06aWD9&TaGIX1b588&2%$4G|P>fx&dC_BlOVP2b=s`Hq zo3i}tSp@RIZ~y889C^C7)4$jMe~rNyWjKEj7g&vCe5+|YiFI^S?wynVRLVw^gY_ap z=1&ccIuNFl%r?wTu%^*$B41%!uFrKD@M%B=NeKlLC7fACz;-_&1x%ywU%wC*tDm0Z zjo*uZ#?D{kfu7@X$#qnGN0p1rDpx{Yf|@4(6XcJF+8*&VK%(z1_On*(ZEy2g=25jQ zTg%T0y9F1}@acIW_o&6e|Rkao{#_jA}p@`L8=}V zIYTvgTcQAu5DTt3=R9?R`JYGEB?0nyCIMfV{!Fm^Eq?#MUi4BvY^4ao1}QB6{ItJM zegEAH4%CM!g|J)l;;#_*|Mk26{G*Ifu@hccp?Wm3>HcruN%&CRfjaiG;IFy#pR3Y; z`I&Y?8Zg`m58MnY|F`etzyuddm{a=vp8@jMfcS4e6UZqK9tr2%UZeSc`+a|jzyJKu zKod%Eu^bZGAO5@B|1X93|NLl{0DLKCkV*G%|J!%|{~14w?!CrE`|tm^BQGovTx=JN z!OQ<^TK}`b{Fjds$U2fhCXeY*nWg>D1@pguGwP#2udq)lFB$)(uCF6yxGbb$EL~1w ztqyT6w|8NPoBlqZA)7>WJNX~oKo0ANDNs$W;q&mv8_Oet^+A>5*W`g$ijl4SYYo~O zq@iDjzX9`FgVFtUum-~aXe1D7J){Ac{a&&?TqboY3|A(p!e8_ef!*3Ho zE=n5yc>{+4{N0)O{aO0zE#2WVP+sYkQaJ?Bv=wjU*LnzyL;%L6_@N$t0i-BybS6JD zc-K2Edv3&H0J0u<7H@|*`-X&%n)8CT2pc0nf^Q#e+<>C9^^n=$Ql#?3&bbpW~N4M1@Ex&PwkzZm8@u;5-1OK9N# zd8-It!9Q3NK+(`I5DZ+M15y|O7Fn!!M<&uK>j6~H%FjZ6G|mVhaoxlKUh}BW%Gvd( zzh6YDgBIBs*g0ODn!0>=QAE@=p0XcGU1fCB}_V%;G9~SdP)yR}o_OI75jBo{CVR~^N8FR3WY`?Z~6>lbfK zq_wa8A6wetP*6>8!V8BV>@^xUz@TbpwEPgv?Q{E)A=a_0(Qaa5UXVV|6HpG<@FZk( z=Zaw_*Oa|GT=T!%@mDI8Vpqx(s?jyN1>>~^XfqEyxCam(#r>6B)w6}2lHFkdbDJA@ z03w|b0f3qKl`I6$l_f)?&{b&U6t{)HIG6^?7 zvR&@@cK-n)HF|$Lx~JRoGZN-YOoIJk%jF74G1_I9s8u{2V})RzIJEiYHN|7hS*3vhRn?1ceA|Z>dihi!wU% zP9LJ!)QZ)2cr7-IKH~uZY}K+ltakm+qW1Tm&4Kx_eMC6Cp#Jj~8OtNxK7b0qtScX= znbF$^XoP{ql?y({j&4E!hlT3_d^V{np6PkF>a~-ZqH9T{Iw|0Eb6BUnX#l7s^OQMH z16ABr)&Sb@5m)9&^vl4fV~%h-oHqtNIVtht!RYLPzcH`(Arg2Wq$K8C8DeL6mQ|o8 z`BN^0m%eI5-|B(^F9$7+`gpzu2w#W~M~4T8P)XAx){zh-91*n9P4nxiBC*h`_xTMp(R{=AIg4k_Owc17b z@z1?Uz?s3HNSv#DW%!+I^{P8v(Vu+=JLLZU(9z##J(AwgYYPuv2H5>{Jeg37WFE?P zdHG}oPOg+={P#(`e}0GlX>K&z_oB{#>D@<>j$`%-Yt*j+Tr&gA{?2X_fkWKh zWAI>y`Ro;0D!TI(5<9y?6h`M)0rM$h@qzsItY1ADSXH+;TvElrQDCS{w~CPIQ#Bjw zYR<{DSR{dw?@2+j-fNJ!S4i|yT2`ru!D~6tR7i_U6b$}(uKxY^7V8O&HuC1lM&F|b zr@*HLyaAE=oGC;$V2yLk=`#+NI%n|%#7t+T_9YXs)-6`Ylin$`F^-Ji91e^jifdoX z;Drz=EKvoUBgTtrQ41q8i@NfovK0FOs^^i^^E~_`7W5X(uMDnkUQ{MX!wcIlCnZre zXC#t!CB~Iapjl-sm>!~`9Q;Jbcr=ID+o)-?%W#rmq3d9OGmdeVQYb>&yQwhzV1RzY zxXBY{&RQ|K!BVnj+E0aOTppcVsn;?#t1Am#ifAC4tg`k(A>m`;DLLvfA(%Bt5Ouu6 zrBmECT@TfUU(+)l=&O$e05H1h%L36{LRuB}oIGhBsO&&dYh_+yB@L1Cs(0jy2N}uR6-6jAK#@^;`L;UVhLrhW8F+c^TNbx}{ zc_P%ubUfkUQePk6`tKE_d_0_2F%i2S3m5B_>)pF-(wYLO){df~0}7KHI?urB6zt_F?nxR_R7x)Q(v^ian0p<)y#d?|SC?Rm;@~vldomC7Ci%AGPL%MX*Y3|#-@)2wq~80V zCT52eA#$tDe~W|J;5bJL+#c1!`}HPKneU`Im6g*k+o=<&3CsYtZv)F)QlOOudrl=R*NG z-UAqyp2NJePEU|#UzObT%Za&czLS%Ey4)KKfsGyV0bNF$D1{e?8143KS?LUAOel9Q zy1VAU==Sr$ZaSzOOtn>4CouG+iszTEbTb036OURaLf4WVp@8P}tpeaMdBzY0V$S7;y6c~$ziJDZx-$O?ZiJRg=-`M zJN1rZ%lS;b=EhrtzJVU?JwnEDFV8_y*zX{cU3+vzb)4D= z+a~0ON?7+a4ZXl*bpc@dtO4~nwj(FVp0~2bSSeTGlL8)ZSlTehGUxkgMINb317lb z@`(%=naa4a(!n_S>lM8(=!u35lT;{o>Yx}!Y9CiGsQfJu0-e*)ZM1YP@KnED!ScT6 zdf`n2Tc$ynOAZ!5j>@O{b)=iryAM~pHHli-1z@K=5H?wK%LC0qDPnoq$jGuqMiYaG z(p1K74%!NWup-3teHOTwF1G<=?b@H#4V^LhOMo;NXqPvoN>$&H8wnXQL-Z{2X&-%X zJd!vzb8dh8Oo~0GVNEGg@EDVggZknAZ_4oPXNz%HwBDYg^Liwiw zm{l^8)U`OnzHdC5QZ5sO@5LjD(NzHd!NxO9k=St=eTIV*hq*-TwceFFz7Z% z+V}VsnQ0#ZS)F3a9z-FQWU8x|1qg{y6O;O{RR_S6W@<%|MU;D&2jugRVyMvVmRur11}LWOR~ z#M6|Y8lhbRR%HENYA26p9%+3=i)kDU0pGq&4MSRFCl~#pz#D+=)%b5TrMNY9x-f~{)Xv797lvCXiMC%Rx&J**` zS3b*4Ong+n7!tF;?f+P-@sFS6pKy3A2IxS;^^7Th&YBoKIA348+1}Z9LH1t{@D4q1 z5zc%yH9g};Ya~W2=JKiuYW0)>qpu&(sDq~fVVPcaI}g>fEw>225D&NcW`epp_R5eY zLf&;O!YLw}tXVh#6%UR$y5G%ezCu=q#7QD32;NLY%Si-jUUz{sE$T!q$R@T*Kzog4 z4s3%g$S9Coja5mF!iqc`9; zp!7!Fg93ZF1*5s;xyK5s#8a%FF*&ZyqD$s}4U|$#Kz}}NkvJM-_l3vsPz+cN1);C31X^dk&Su)$H>WD!Rwg{y})>Fd?<#RorVVTlSTG$ysVa|mPmKBmP>H)xLpe}dx%#oe77mY z%g3yfClu;?V7?<8oDc+K5U;_LY})&1>_FxDEr7p{XlabAq}a6l&awaqSmGa(yIQ?S zxy-VN{y*O>FVx%SnLmFeqts@zxf*SwRQ_17F=L2v$&xejb(y=5-rMu(;Y6bS51e%q zsSeu$2~x7}N{4eB4>(-OtS@q~XLR-jF-_1=K+ZHmN2z}H?4aA+c^c~t!;IDX+nEse z0uyt8{03mM!EQ%E|858u1J%s4V=TR|YZ9>;>M)Tpm9Fsk3MKE>KqK;EGR`z7lkge} z<#GD1p+ol8zK&2>@ta@YUPCHR`oZ=-=vW*BIjwrKE=&%4bTI+%wHm)~|1SclB7XJqD zO>misdtm*~=T&B2qP>5zq~M$2m@GMb!#gqop3JeB0^2tvKPa79v?s9jMm=%;8< zSgR9Kf|m(`(N^vno(^Gc6BrUlqyuCiebem;$l!l%?x`$S@dsFr%84^l0q zgeiWHa7eL*nUDjvUJyG-u4)zEJL0pzQ*8g}*>Hv1lo6CxobU?dO(JH5pME@7&hrJG z7G6u?z@D&8U61fAsu4gC4!S}p_#*9%64H%dh9bC|u>V|UKInSu{RD;cBdaY^2GOl~ zB=Jm+MlQCm|I?V?pYHSfA7NUm@PAMb`sRi>cCH>s`qaIZ0sZ8=lV6qHhF5z$foqMyJm)K}_%_VOi*NJhlZeyMFx!;;rSt>U7pf`~F>=wlyk zC116g5l{5=MBIcdoQUu+C;qyw<jz}8Jy zefoZ-+I`+Z-zDfgkSmm3b(&I%QCJ`Wcqp81 zc1uPA-F*txb;c&sV6M3#4+`)z7$I9DNIkZv;F9k2oZ?uPT4=r-|Lnv5rG`?D;5~Qf zB0HT)fxDxshyi4(DvP_P9%xYt*7%xl$^d+J8L{S+%U(`Dqg@H*2I%k-2q;QzBDPxkRu-fA18pjrqeqjE!Zb&n?l^xFq*@L_CTXLV#4i&;J$ zxs&12Ivlf8n4Z%sdjq))nT-oTdcs80t`=)W2IqV3Q0TlAUJuFB-QX-e0Mc|af%-Ge zh`#!J5_o>gq+DwKLbHas)OLMaC&F*SW7wfwWM6w?f3OLhY2ddjElL!cc}bGJHf1>l zi(_w$GT~sx+t-dK7i~9Iot5@yVXPcS?)PK7Bq(+d1h8gOoYUUN*}%c~WHpQ(9giExg4=rrKU<6AiPi zlR@Fx{Nyz&Syt)O1o1{Dz`?KX&POB4Db6H4~dt79SF_@D}Va_^qo}GhOL>g%- zRmJ0;ExDmrI4-PX%^M=ddSv< zwoT=NdwwZW5_vyb1pFm`d~4>A9PFWCsp>e4T#-yMTMn#GYlyL%x=pOO+BqPZI~2k+ zR3RSmM|TsCR!aO#+Gh0ut&Kr695LE{;*$(tD9^iHtXPsW(cu^P!TN;k-qx6`f!91t zigqVr!@{~YrTed4Yv;{J4<;Mq%k0^tz5a_N1tkD0s0>K|6@hUSBGtG3R^qPJ#g)MS zxR^($;9obp4Jmqg= zFQk@Sf&L2q{8=x2`zD;_iqo`-c~lq(^^3ovI5)E6o7UQUXtT0lnrP;za&rM`)Nb2+ z1V2u;k@thd2Ryu~Q&3HW8p_3W zX&69V&^dS_KkEqXd7_F+ZbasEt({sngAElC|1};T7MgEjPK3Y5Y@TZQqhZHGs!UJ? zaTNPYjhnRB83u}+_UHi^OD|D)@kZL!kbbf>KMnNRLYm}Awu5zR^6^ZD9N81}_-NOr z5gS^bdxs(sp$Ku2y)xnG+PSJa>10iaU*_f-5;=fQmJFDPaCd|_ zHIT17-&dl~2sU>C$l(R;L&r_- zTysX_eo_q=@ImeQOBjT@=d*e^xPIee)1EyGcV)l*>FJBx-hzKOmlH*oUJo1dss z$s_QnYM4KdWt{5Ok{&8x#`SinCK-oNXsKS@ij|-D3w5S__WCDy|4Y{bKB*=nH2sv~ zjz7OPW(3!2g=sXmGqqVL%r6wyaG>l>XlC+eZbPeuM_C1RaUd1X6&Nxs_CQL{xac$U z2Q)ms^q)HG4b}5iRz*G7-w>Wec#ctsoKIr2`?m&H35(Fc(l%49u7 z$`R13>PrnF=7{k5COUHX)I;7E_Ea~OHTf^DlB+KeFu6L7U6Tt00t`Qc< zr;+!=n-{Psni=NFl3DAJ(MC-ck-M&?;M5RPbx1LvtOc`X1XOphE%o4py6bKx3|BtD zQ!vDDIrhn2VLy1^AImRjLRtI5`k$KP9(((v2veusqKhao{Nx9q7Qfx zM_rnsL^E4Zhgn$mT8@Oae%IB_`N(HZSmyk^>|-x^4^Fs?u6)>F zg;6CW1a!!CH_TuTB3*B>f6LH2jG3STuqJGEG&sL~{A(e}4ycpw+`TfI;t zv9M&#ZR|qT-!C9_=vnR@Ft4~g9zP$RHbJWC^n~ZU6a+06GMU|#swD+4TI%s4&KKZ- zx4DF)C7Rw?iZ)5KRpWi1_7e{2m-L?nNai<1Xgy3(xM@n{9%m&mfur$&$uDDGH^@p! zCyZ2P5+bET;~pKhM7((O?D20=z6~eUI?K%WTHhVM_yK0vBDz>B3Sp7jT+Xb?5%-0( z*%h?9t1qBQA9?U+B&qBSvhZf5doiRss-^&7nIc~?zS{Ce7k}}wVx|RNM#gzJI(YOq zM{G74HA%Q_?3b*Xsn;ZyW(Pm%Go0Xvv9|BDw{JO_oG1eenyn17a)R=G5Z3YWS>Nh3 z<&lxJv|DQA&3juce%GCzwvFazN1N)58zoN?inw+f=~(W#{r+kGH^?1X(59!9RVQ;; zB3jOaB+dij1SIZQ8regJ8Bj0d!$$jVeVp%t^gUUp-yISpLVS-V1>ZE>H%Y!uZSUH% zkE;m5pY%p%B&;J*UE&^_78G6kj?&9-!-lAs$8)mZ^-g-w6gCx{Q9_9t(1`AI1 zq3Ly3-8$%OuV3L=D09wUcw# zLP-&CVk4e!UwWf?|4OApz3R0@}lJfhB2q8LgyR)2qYBZ~4A$+cpG(;n`#Dg_9#B?I zbg7EZQY({enjP)1GEXn4DV_2Rl6ujZ&4p;J)zJCekK9%peAz zoSvb(Ouy77VnBUB^3jDK$gh87a#Zpw3aRl-^{X&xA0dw6kCI91(iPcFr6#S#d{!)l z`jM*j=%F8msn=UG7UAmqMYrq^0TUx|*R@I$b!D?DnPUo(ym`a-hITsgcN19KOsM>X z2BBM?=F7Fv1ru<{ZUhHUO!HJJ^e|+9!Xx!`i{x$U`E)3(k;tS^xR1?gH~BH#S&{6< z`2aI*03`-U3qv~lGo0ucn33a&K^qNWgVA*-km34T(MzmEgsyBEc!S0_vaf5?W<>-L zCiC0q^2R|NK?Rme_0DA#SIJc~__bC3JiY?cjRaO~{h_lHCgxC6?Bt`a)(-o)Oo|pc z%tnx(_Ae=DI4~ze{93?~AB17d5syDPeUROWXzg+-71>csaYjzv=h(KQAq1rwlqmsCJqUilQ zUc0Q$|J-z+j%9%XcSuz7N3}k%;1Irq_iba+U-v(WHY&qZowHB{30AmJinU6587eYO zc1vtT8In-OQtEl$cI>2=-MX{b=S$v&jcn2gtuJAFXFqTKV99Sxa2RbYL#D?>G<}U1 z_aWkIyC{kZ^IWMlXf1J^$_E>>I_EdH6ZGtuo)c6ocnm|}F6YeRA?8V>GpKy^#afLz zY^{55(2%nsW=tsMrgrZz@x|axQY4`EaHBl2wsvYjMmqq7xi0-w;pE<*1=}I1uQ5nt z@LSX6JbDv)iNkx|eUopaOsTME|L*a;=cSokpG#yxGFgtVBNr}Va!-#51Bcpoh$`~Q z)Q?g%nQv$+UKMzQGQp;$RUBdsPY>$9urer)mPvZa8fm&^*EKt}urfDD`fiL*=X|MT zL1c$ap7qIc$2?8^WdPFo)?8xO-&B*gkT(J&k*TKF6M7Y9CeWrbiCJfvlj7thEi=xM39YQAS)5frXRQD46e3B)v;d-~BFNJh8Bd7t+>u zmihF8et1Fvq2c<0Gxi9z&UicNaBBbu?ziD!xb6l*k_Bnyw-MiOzUHj9CF}piu^@*i zup!+-gY7SuSK#<_7@Igp(JuPh>6FLNU=6R6u?pt{rSJYX(^1d&bTgSh_|)cG$I14kZdmk!7w zkPFJ|_KNj18Lw-%{d$?s^gX%Dl38c67^_c(a9k=4{oR8_!<#ScT@~;zKoOBgiD-Jm zqR`u2rVo>%8UdW*a(*5Ne`~;;0fBtQL)17{mZ5o0ru`Z6SXCy_UZsJTj32{(pg8>v zaA_s?ybQLWz4F$nyizf zl*!-2V-_hjEEr~SUGpHYr|zyO)8iwR6rah8z`@vkA8}L!Xlv%Q^+8)N_3Jm$iAN5x z7pavnB$I0|L#yP2^q*kT_3}78#~m`R@ud$5)tM{5ai}@vvD-B^qVgF^cnmR6C+OvP z<1khA9W;RqJt|@)LMQ@Rxf>LtE4c7Efd@B`-2Af8E4s$0i5n>JQ$%4PpgX4p2lOr# zK>P<@t(@YkN(IC!9vp+rait?AHeE!g7~d_kzbc2%#X%?M8qzPUP2UlDC#Fg7;V2c#sJ_wgZgH@T4YFR=RO7UqPyge!n^#~a zJmz)Um*@{nR^^cAfO-iS8l#q_^POkuJ9FX2EiOb)3fhJo1n^JUKkey|N5Ucft6s@Exfr=ZilJ={9I3Bud7bFWdPQh={%x+Lc$ z5nAn50GhR0e+u=s{0VQTsz5~wH^ZO#vx?jpU5}7mntc8UCU`(Jxq+nFPg_stPEEyw zIN`cqZ%$L@Z!g>5s&Ryb88EQ&$QH%?xn*&@MlyDHa=cBQewd|&DN*VaWMTH#A?H1{ zJMxKGuAuF`i~|hEgg)rmm@Ke>@-0MIM{)@&X_97=&yROD3WCHgjjy1L0`viKi8Z%O$kS_7P#EZ}mhKg19<+Z|~i4}je z^orzBK9WeUTR7=@eKc#f$O>GH)8rUrdI5OdNHfcQb~TV#sY|6(TRL`;tLjiUMCkM? z%Ovoh*wPOV8Vx!3o`FJfK|5@OHDDuJHhplo9&3&|Ef+%*7R$7Ok&hjj6{pZ?|Di#x zcWsp}T-#x;D64*yYt-RBi&-oe`mXy^ERF?XqbS#fd2VF`V)vt-YZMn*CH@(=nYw3XAen6h}agM3-!2LbIv(Rxy?L6~0 z5Zrp8ha|_mlIn?b@%!5CiZQ*Fq|c0ovH|={6D;IJQBbj)`O#D9zEzOF&$ir?8vb-d--_H zY*F82g`6R{VOxF(Y`!U{N@=pY25nLS_|MAqo6Z}qx^^8P>)Yeb<0JS6JLHl&#yker z6loOS^HQT_Ky8_K4DEGA5&+6daj8}OC2rGE0P&V98qMC>)gQFd{uFJAlLLiG820T(1dYLbDGUYxJ4`FoaMVN;Win4`B$s(?k zt1fx10fPgtgWIr*@L~78ywzAYhc4mu(AJ1;emn4|eUG4ygS_7(+a@+6c}Xz0Ws$GpV?k!swU zqj8~{W&nk>@D}8?Q#Z=KS4Z{4&UcgYGiDu)5?Zi`NKbS?N`h=E7x$HhojPIAwpwpRI ztaM87EdEb65gK3MJfdG&I@B~WyPI!(P~&V_`$LDnq;}>Xd2klH`D~zQEJ)dXeIlf2NTMKLRjgxY`{#Q!e(J8nAHDmi{i;C zHVh1QfP%E7rli~~uX*C~_hDc2SmI)-zjo_?Q$ehyjI;RCK4|}yZ!oULZto5LfII&r z%=`=1KArzw&pK=Ho8NPvCN=Pb$>2!1`PQcPM(EP*f_gXyBJiFp3cmBLy?Gb!+dX3X zX$hE5^OB%c=-5|cBsg#g%fJpsBO-GJ9N7d2j!W3mC+-;IzaX?|VyvHOE0fHQd)e@0 zW?0*ty-`^Sd+ie08}o8WyGdJ*roj*D3qQ?DRWWDhHmB`2rnVYP1vHTOV`Szs33@#! zgV`1J`+a3HKTmb?H8ba5nW`16mY2(K*nfru#-dSU8pI1meOkvCW2Z+oChUrycrd}! zB%9rJR_Xf*!F0m^Mx@rr`@L(BfR%4X-PWtO#gX;SjgZ;9PpE(YDfywwcaw;5AJ9tL ztCAyN{{QRl%HyHj-Z&GJbw~}ewAexjq0-orA=$S~RK}hxWhsLg#*#EGlI&}?l5Nmr zsWC3ONC?>~OZNR*%l11{SGViB_v7#1{B=I(%=^CQdCqyyd!FY!-|us>TQA!rBXHnJ zFSA@bi614^?DR)*m-ERM-$@HnR}^|Pg!ds zWnalB;9asA&f3D_#Of^r=o9A?W!Xc`JWhZe0>!~Gepw*?wb+r&+^C+`w{?gvEOM>9 zz4JaWsfu1&GCWMHta{Qm5jx+E$nE)X$h_O0Ek><`lGOVXnQBg}4abh>wn4|pJrEN@ zeCcxYHG;up^>xeyYDF3I9Qji37%WU(tr04{aB7hM%6iVZEpR&k(*uyTzrxT^G=qtL zzKUMeK4E%0`t753CPR=Uv!U%5 z`;bUe=?|FGgT}QLQ5ESrrn|_H6Q>JE7Y_oGLZ*KD$8fk{rOA+#%ntYiKPSf-a}H5H zF^(t=Yz+aey6R$9>q#bTqK{9(~6{ z6xFjkdu=88gCe=*J6}xYN7x8uW-7yGIQkyI7cOXB@_eaWYo()zVDw)s8&ViQjdic* zZ(?oqRVt*CJ6~vHgtn5UnMAXk#vF#lV>~WGIX}fNB`C&-MATa#0}Da$Jw_bl2U#(C z?#k&o?h4mtcfahoi1UsDwoLgR?uI=vZ_HtKDXn24;Q$@Tj)^>02`Q2ntmWQk**>eu z=!6FcBrh{qY!ui>A`m^HsWiP+UY0DL65k*kkoqwDyr!DQ*~l9=O|v=r{0n`Q;84A) zWLJyuW)(C7ZGJ7VSof)_Y|zUOAL&iKV(iH3ZJ#n}TpUnV2$e#23#d+&awKtbIOR-w z@SUre)~`;LhP2Kp4CjstDe{r$s&`S(ROcmKW31e-)&AlBZ_i;mAB41H_SlG(1qw5V z6s03W#^6uY+f=zoY!fNAFjf)kyXuK+Z>1v)y5C33 zqF-OlRfqHugt#14k^Jiywfe^-YI^6rh+smeS6KE5X86~4?H1)ZHFRjF!JMma_xSBC5C#VZl7@zw7yV{n$!##FgH%Mz*V^FHVrx5!BzJti4Kxo@WZf zZZ68ZrrD)(CcGby^narm(H1u^7xMhJYg$M``;I4Q2Li3b9Gwc{-NbM|iXq$Z*4Kd} zewS?`G2;ZnnqOzE?`7eBdlEuz10))rH!K!|S=Wv{SzT@?d+(^g}v*`t>s zgMQf!0)r253g&=^BM9v6?y^iiBlKTh*L7RdKzj67AHz9yJ|$R>TIBqK5aK(I=r^<@_^vc2h=W+y1kgpI`TLx%dj?mfp`DR*sUfcSp3Obblll-^>i@wkhXp@NZ_62&v9 zOER2n!u!a3&)smBbyh_q+1&<@oBf^?ewwY;$l>VQXrYMUzAsKL-ev?5RC`T*mXzg( z!==J8AuS~Hn+LqrB!?iVvm^~tf6PQ*$RUD8{&|gR{$-iEDBf-ny?uFWA-J|NC!XQJ zVBKe<-crAFiPbcvVJ?j9S%~;3Ar$@MP;R+)68OrGs|XS>!wnCL?{nfAol8y~aW@H= zsL+h^5PCCZVOzecQ@u*}PB}XVag@+30o_3UFq2y{pG;L3mi?7bdiq{|w) zrlFGaQ)kj}nF88hgE?zHenjVD0aVO#|SE7!UkEOu+W}rXL%ND23hkG8q}Os zH+t7BuZ0aNrOqs*rVN+^9z&G1zi6BB$Lh5cV_u5yty=XUBNnpK3)HPY8vAfWMYgL5DAVT?1LO z)s?>OB6Ad5zg<*}>cA=rj(u&sRj2wC>7gJd&HHrn`kaY{<8;k={g^ESb#)<~t4|N{ z3H~%HK*9bLR=3wFj9sy%p<5>TjBG97=>_MTjR90Sv0^u>u16B}^JP}s$i>9F&IPxT z$9U8)h@|VQo(3_l`E~QFWl**B_k_npzK1i>O34W$JCFJAL+yMq)#AE&I|fp<0D!0S z=d6Lhe7ce;^b};jZPB;(H;Qc&lLGwT3R;g-uH+PkOnw;wM!ax0?=o03_$RNA$2h81 z`j@=&!o%@iWz|}v#wMtsD>i!D^a@N50bdl1e8eAchP4m})uGo&0C*Z02Z z=C^)F$x0GwA^}|QMp-{^b{8d~_eGzXDu8;5=i~`N06*FL3|$I0bB0d5!?_nAF7i3R z(c!$)PKa~hc{Hsg-+~+a0yEjIw+rMf23|~J1(bW*6PGKJPTv_1K5cCY7>#M*WwmXY zM!RHlI}_0@<~r^Ny{z%r;h&7IKcVM1{Xbu~V%-BDC+wK)R-gv$^c1{o35T zGR<7+3!ED(D=&yS=4Y>&0z3i$qIhpmJ6d`Gq_y6cKVeiUe@GILTYp}yV0aDM)XQyN zxZM%`{=ndHlA*3b5g^^`QA$l|2Et7N4|u#?LeqNDJ$oZ2T)xjJ;FMJwigOdCOY&R> zC?=WFRUKni&TK<3Yu@ZNgDaaou@-Z?I9FXdke3oiZvW|ev-kpNYbV!BE7Nx(ePdh6 zI&|Ne1wQVN1f+d{>1P_iEzE4AZRABzK|e-oE|df;PjA3a+zkjAJegIl)a{3t19*>6 zLX{8ju_hoee^`czw`FvypU+Q`YWA`YEF1!Kv>+x*{Po&=uF_Hu4gjPwi*D1C-C(il z6l4GxfCT^|ls$F+neCiFl6qUht%#q>{#i)M1u0!Kay^ZSlnKQoN`e0MDjfUc<|x&D zUh1X9dsA=7i;Mg|B&M6Q02(Vhzuahb4*&h_qNheoH6$pQ)e$T9;B}y_!iNL(rNFs# z@p6QWU8A?jy=>ekoWtwQ6O~DV@{A2iX@D)fSkixZWz2figSXBFQy&lB-`K=$; zXXcNt@u72+?2ZZ8=TsFvIn1~<&(zdS47*Vaw*KFZQ1-Apee9|&<!0x}^ z{f!`s|ENJ)IQ##)R&BG)38Abs)YiraH$phK@vI-+SQkjU3k95@|5zgayM~DtV4;Hp z3P!it!(aX;;vob5r{dOhORsA|sHjMi^{>ZDhT*ihJOU*VxiXfD`bP%xpM@S)y-}W8 zxvd+2{_96U*u!U2&6c;sk`5-doQQDRx^Ytv^hTF9)oj&EkOy8>Im=DBYwN~MLM64# zY^vEpaEc@$Sc4(GVwLR(rJU8j<6l(x_se0_X${Gaxa|mqHF&dgTZ-p_XvV8{K({4S z+Fh1yDgHQ3gnUQ=^QP(WcUd+%r^&m2TZ+F*C+q>U;og>>BIFhSWmNut`TyetWo_)3 VIy%c_ZAk@wXVi2~=bW+#_#ZVFH^u+} literal 0 HcmV?d00001 diff --git a/docs/api/v2024/api-versioning-strategy.md b/docs/api/v2024/api-versioning-strategy.md index 621ed71be..dfc1ceb22 100644 --- a/docs/api/v2024/api-versioning-strategy.md +++ b/docs/api/v2024/api-versioning-strategy.md @@ -88,17 +88,17 @@ If you attempt to invoke an experimental API without specifying the `X-SailPoint ## Release schedule -SailPoint will introduce an annual release which includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. +SailPoint will introduce an annual release that includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. -Each annual release will be accompanied by an experimental release if there is at least one breaking change introduced in the current annual release. This experimental release will be named after the next year. For example, if the current year is 2025, the experimental version will be named v2026. Any breaking changes to public endpoints in a public version throughout the year will be introduced in the experimental version. +Each annual release may be accompanied by an experimental release if it introduces at least one breaking change. For example, if the annual release is v2025 and includes breaking changes, those changes will be introduced as experimental APIs in v2026. When a new annual release is introduced, non-deprecated endpoints will generally be transferred to the new release without modifications. As a result, the same endpoint will usually be able to be accessed via both the old and new versions. Only the latest public release will receive new functionality. If at anytime throughout the year a experimental API is deemed ready for production, it will be released into the current year’s public version, but not previous years. Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represent experimental releases which are available for one year in the preview state before being changed to a production release. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represents an experimental release that introduces breaking changes, if any exist. -![Versioning Timeline](../img/api-versioning-timeline.jpg) +![Versioning Timeline](../img/api-versioning-timeline.png) ## Deprecations diff --git a/docs/api/v3/api-versioning-strategy.md b/docs/api/v3/api-versioning-strategy.md index 90fe60420..f6e0b76aa 100644 --- a/docs/api/v3/api-versioning-strategy.md +++ b/docs/api/v3/api-versioning-strategy.md @@ -88,17 +88,17 @@ If you attempt to invoke an experimental API without specifying the `X-SailPoint ## Release schedule -SailPoint will introduce an annual release which includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. +SailPoint will introduce an annual release that includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. -Each annual release will be accompanied by an experimental release if there is at least one breaking change introduced in the current annual release. This experimental release will be named after the next year. For example, if the current year is 2025, the experimental version will be named v2026. Any breaking changes to public endpoints in a public version throughout the year will be introduced in the experimental version. +Each annual release may be accompanied by an experimental release if it introduces at least one breaking change. For example, if the annual release is v2025 and includes breaking changes, those changes will be introduced as experimental APIs in v2026. When a new annual release is introduced, non-deprecated endpoints will generally be transferred to the new release without modifications. As a result, the same endpoint will usually be able to be accessed via both the old and new versions. Only the latest public release will receive new functionality. If at anytime throughout the year a experimental API is deemed ready for production, it will be released into the current year’s public version, but not previous years. Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represent experimental releases which are available for one year in the preview state before being changed to a production release. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represents an experimental release that introduces breaking changes, if any exist. -![Versioning Timeline](../img/api-versioning-timeline.jpg) +![Versioning Timeline](../img/api-versioning-timeline.png) ## Deprecations From 3c18e7b9d7e3cd4e2881f7a6ed9e26c36633393b Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Mon, 31 Mar 2025 16:54:01 -0400 Subject: [PATCH 02/82] adding registration for devdays 2025 --- .../homepage/HomepageDeveloperDays/index.tsx | 24 ++++++++++-------- .../HomepageDeveloperDays/styles.module.css | 2 +- src/pages/index.tsx | 3 ++- ...loperDays2025-SailPointLockup-DarkMode.png | Bin 0 -> 121325 bytes ...operDays2025-SailPointLockup-LightMode.png | Bin 0 -> 129286 bytes 5 files changed, 16 insertions(+), 13 deletions(-) create mode 100644 static/homepage/DeveloperDays2025-SailPointLockup-DarkMode.png create mode 100644 static/homepage/DeveloperDays2025-SailPointLockup-LightMode.png diff --git a/src/components/homepage/HomepageDeveloperDays/index.tsx b/src/components/homepage/HomepageDeveloperDays/index.tsx index ceb08fa5f..14eca368f 100644 --- a/src/components/homepage/HomepageDeveloperDays/index.tsx +++ b/src/components/homepage/HomepageDeveloperDays/index.tsx @@ -1,5 +1,7 @@ import React from 'react'; import styles from './styles.module.css'; +import useBaseUrl from '@docusaurus/useBaseUrl'; +import ThemedImage, { type Props as ThemedImageProps } from '@theme/ThemedImage'; const HomepageGettingStarted: React.FC = () => { return ( @@ -23,17 +25,17 @@ const HomepageGettingStarted: React.FC = () => { -

+
+ {ThemedImage && ( + + )} +
); diff --git a/src/components/homepage/HomepageDeveloperDays/styles.module.css b/src/components/homepage/HomepageDeveloperDays/styles.module.css index 0a7e71925..a85757de8 100644 --- a/src/components/homepage/HomepageDeveloperDays/styles.module.css +++ b/src/components/homepage/HomepageDeveloperDays/styles.module.css @@ -54,7 +54,7 @@ .cardIcon { width: 90%; - margin-top: 100px; + margin-top: 25px; } .registerButton { align-items: center; diff --git a/src/pages/index.tsx b/src/pages/index.tsx index f7647cbe7..436c4146d 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -8,6 +8,7 @@ import HomepageBasics from '@site/src/components/homepage/HomepageBasics'; import HomepageTrainingGuides from '@site/src/components/homepage/HomepageTrainingGuides'; import HomepageDiscuss from '@site/src/components/homepage/HomepageDiscuss'; import HomepageTeam from '@site/src/components/homepage/HomepageTeam'; +import HomepageDeveloperDays from '@site/src/components/homepage/HomepageDeveloperDays'; import Heading from '@theme/Heading'; import styles from './index.module.css'; @@ -17,8 +18,8 @@ export default function Home(): ReactNode { return (
+ - {/* */} Getting Started Guides below, or see what our platform has to offer." diff --git a/static/homepage/DeveloperDays2025-SailPointLockup-DarkMode.png b/static/homepage/DeveloperDays2025-SailPointLockup-DarkMode.png new file mode 100644 index 0000000000000000000000000000000000000000..81b59dfc6c3636e3031b3d58f83c1881d325b06d GIT binary patch literal 121325 zcmeFac~nwe^goPEHkdYNPYw;HQRY<6V_7LCT3DHxL#dfLmGb~dlUAA*lCxr|SUF&7 znj@B}kCG{P=g91xdco2y|vn~Jh(+$1bA%8RWld31)(ceh?B?=)Fe~Chf z#9yKiBJr0fek1XhD1=b_B?=)De~Chf#9yNLjl^G~5JK^nD1=D-e~u`=InkrNev~iU z|IlmCg0bl7Wzt{wy1m(@omSnV4+VTS(-(1IDDN{Isq2WstS5iL1kY$C-G%)v#Vxy>M~)QKp$T&{;GGDY^YVC{e4M~Ko&zkZfK>1 z^13lz(qruq-BYGjx8cvjAd9B${JIw^XhCrM>f1{m9#>i;_^D@lW{N?58(jCF9zWps z_(l0EnO9A&eG7gA^NhYVe`>DrKF){fvlAT2S;z8@PFb+xuzvuVLcgz+d;BWi;tjYz z4r`jU5T+#4Wh<6IU9;2Yrj}Go6%Pw7Y{f77c7xEH1M{a5c?N`W&SE_^gpuA+|L*f$ z>fcgx*_H-d?_1r%to?A-5xVlqfdbsJgIkYV9UWS`$9hBg?I#B%U)_FkV0^CM6u&j* z(D?EXA~m#&rw&H%UT(W7Xtk>gb|+A)&edhS0F)HI2s2ErNK%(tNEm>k*)rtC7I`1( z#%qUwj~gjC$a#o-Xo^$E4LFBM8vH*OI^T(hrya4>a4_UBapiA|_goWevi(mvniP z-TJ6VZo!M4Vt7PqVb)M@K80X$atW~MCgy?)Rhln9q!fks%MxY-t(In6g_!dbtD*MNWS>vB_fU5wx1WxtC=}u^^g*w;;mK9t*6^%n>#OU%5@8`UdNto z5G9Equ1)R47fqx$dH^>iw`71LP=0guG{r``XmvdR!mKVKEb-^?@RCA)BM~I5A-RQj ztJpgU#!d6Pkth34bQs;x0B#0uT+*}F&GP)7Y2~#+*?Mkix49EQeMtkadiO7>aKu>9 zs%s)_Y>dcj^r;gW+}^bW)FF|Tyzr!C{0VeZG+rARB69GnT-MzsdSWCYKp`k)AG_+k zzw7!2>-7y3+;-LLP zM0kJlyy$%gv?42JiNw_83uf=TEzV0YxSMx;dos;^mcqVC&|(SD@2=f#my8^|Z$v}T zG{l`HZ5HSX3gs8c5y;{b&V4uFRo{dAaB#aNh0dn)^|8^>D;W1fn`#5dRWhoOA26zgGCp( z_)j#xRF6`zzGVp!8AS>NQ1U9o%RS;6Af?FCTJ3n|0gt6W?u^E>v{=dOTO|IJs*&L%k{;%T zP64XQ0IEXBrzU9LK)Vd)BNIpw%iJXBb6SY(l*4>p?{lj3i zApr3^iS-S#X!B{U1t)Zo98JGPgoFdLtYG$c92V?jD=?w6gLnt7%%2X4J>*X{vsN*y zxZF~;LK#V<#kN>OT3D6!5pvr@)9&>9#=+FE`kWBTTtQ<4=Fz4x*w`G|etS)+zV~X? zuvr#6(kW;ALh;1%8g6yzPXq6Q*bBZwHIBZ`ul_SIxjrf9TRz2w$(11nXQ1fPLzk#j zI9T?5X-byISryXvrk}~P2|kp*le?v>U6Y(An6H~d`?KYmvSaceK8eIY4_zYWv%`DYu*!2aE{XwmzJ|Em($a~G!XZgY^A+obcj7={!2NBUB=WkO))1uocOBMC z+u01Pl0Dq~fUDbN0<0^9i*nM02FJW5BJq?4%&{q`xWmIsS!1iV8y4S)1^@+Y!t2=t z*h#{vGT9FG+L~=w!K9Hnu6|~d`u4^4P|*UhwDWxWdTzkjjLi!D>4qPgCM9&4CH7SW z%?^bQ&xej#nGI>4u^-T~%i6NL8@}GqAeHf$zBy-qI>VZj9GQDX?Fh&Jg?iw|HmhQ%2J|lxA=}&QRjJliB6-w<4WXpoQj>KT+hF z$A#ymepFrAy3)^{1s;@fsAsI5f?B01ixRCTaycsdA{EJiEJgtceO^z!bJYqKVnI#|A>-d3VYMomqM8o3*U#rUlW5wK1|Z zKPp=h9Gw%yeG@AehTBqh^<1n`==ou8)p*&4HE*hV90zpF%B4Dd*_E_ryhW^{ZneCy zzC&mD?B!*bWj-QPfm<^~i^B&dO;)*F!a=;Oh~$O~dJA2_=!Hzo*3181_xj-TPjXzV zY^)p|rt#C}^P~6o4_SFPBQ}!`2`juKV6omrJ{?9M+1lEjhDuA=rK7POymM>i%an|m zw5Eqp{NbUDV07uz!<7i42x3BSBVwz&?r6Cw$Mt34O$VVB6^rI;jbFc_3!3pdL0!u5 zxCmmCm1l!vlG;l~3=t+IEPKJKN}j;I+Z%um*w$#o8@VVZ_U8$E5mf%)rdA_6O%eWKZ~oUw)!CSf-3@lC1e>zawwcCD1+okz#NpoAJNZ0P(tohz;i;bQX z%$7J^qcOQ__kn8%ZsUCt+WHzWYSOhnPhcz5r{J2hR@D(iWoD<{?3;HVvN4a8r(Xk9 z6v0SuSW<` zay%^X1huxm)P0awf`d_JQRM0ed&W*HS`qz6=zv%$E7g(#Fvg&PB z)HlKz2Nmq#)7CZ0k*o{4fV7kVoNv6XHFm%=>D2h=qNqvsv;EK7O@JrhCJw&uN-t14 zKSM@Al<%EF!|k|BpmB&M%05x!jqR{vAv4V;mB**JR^)!DC!dV=i_xz z)FGfgXM5e6gR>W-gjVI-K|Tzv`7}B2>k&gwaNvlDwA;uuSOCs&8w81${$ZNZATP$O z%?&`U0xEJmWi}+12vz}9ZTr%_-I8v+9otn4LFb6)*U|umj5WV5s(nmT_4^LT zsJ={(;@_yX9^j+)6+jK1e_@W0w06kO9Dv?=*2aYVqdN|qEYey9@pvqva-NR9^jTck z94IQ1uVEvAl_&-}3M@3}uTW|GzjgRMQOkN7(h_^=i}<@wAupuUk5U*%V_k^hrYb9P z{&=U?aD1m_t}Ob>sC&{wwgg0`Vl^68qrSU1w0-{qtImJRmX{e#%_jpsvEZ%F=z)@e z)gexH0NUjtV?wkYE%|5{R7A?ruSZCt0GGyY+k)3~RQH=?%oV9AC=4lcx;DE@q&fp% z=4eZWYrJUUONBQ76CG%CTpQx^<@;20uO80>ny+(7(!7T< zzVHQ*K41jtCp5agcfJZh(ck9%UR0u*1%C824m{{%9w+%TSW;^4b5ZvL3LwCW6cpE7gf;#X z(&8TRExE;Mtxj(R)W<>hgY{TD1uZ}F%hRLS*rr>?Jz|EK{WjPE|JBJ{3V7d|F|v}t}sv{0)B6{lMA-i z{Qy#jMuwTDu6fk7maMnUbq9&bXpob2fHOUlhVqr1jw$t4K*H>eW6p#-SLRO0aW4AO z`#X8dQQqZvntNWC_eJc34Mu+YW*k`|m6A30eiA~w+e(YZhl+)3+07X=9vHNTbAztU z9A;o{Q##x6$r`pp$&vfNwdF-%)LErOZFHf9dR6^!hm(ES`Jt{OwYFr3a*M(jDYwcy zz;p)UtC9PCQaG<6-eofSXTgO4yeFJ^+1<0_o(E^t_NYMxHcYM+H3gqI-;y zoM!B)ux`Bj5%5(&X;JspSzqspUHl&8JN23Hk#9WlTEpXIll- zB$i>`T!X zl<5J2)jEa0w)i9)2qxX$4!$?$U`6Nl#=UHpb8$+!$QsGcrU?~WMTIW`-d!%T z>Q67xbs!U--fg4@ImTb8SEx>C2N<%iRJ6L|*RallY2uMS>&Pw+&)T}L^=Dg16f~s!B>yXMxJCT39(^aN?nXUGIGT=G7VXvyYmVFT_4bzAl z@lN7;eI4IDXmBY2-rJ2?FKOTh?}bhU*MjOt%QkeLTf-@X+s|>rZw4tnU%()})qFN3 zkDTtw@_5)jl~ge{6e2{eSg@F{9#wRi)gIOI1kCQ3!uM)FG)&IP5OL`6LQ?r=E!njE zh3d8`2VeBh^?SaZPCGS(6^ExFRsy#H`IRELptfOsLYc1)33c!5Tx- z&W-RZdh$O1=bPoN2Lr)_;}W7e3j|mi+ud_kI1xst_(tVhSTD|eCC(0Ds5ecwViQ6L z_~22H16#cj@UiiVK5yH|ylQSRWnda2Z0$y1;@K0!aO*R72gYYF9W#V5!6=GFqh#I?V1e` zjP-d-*+>kmU(dxZ%>a>tGfzSW&Attta81Yg&%UWPOa}M|pOQ))`I$MW!07dh*jQ*<$7Ej*DnQIb&=dfgVijTDWfE{(4#~f{6V)Sc6-SpyyK0MzCzKA zuHDf+dU#76hwQMOD=MMj$GzuT-f5NLLG|u{853SLCH%?Il8?mfQS}GRIKGVpUFLPg z=Ne_b|3enf&Psi>LpR99b{&QFDOkTT7Cs5$umrr^`lJZ6Om&L)tnR-Bkqit}YzPlQ zyNzxDjX$jbPz{Rt9TC#t&qR%Cf_xd&P~Ngl?*zQ}Xt-VP@!%XfAeEpR>sfwyN6^UE z`+R4q;hRPy1aK(A02as*R~xyG9(Wb7+TI^vCJ=n^*&oS5c`gE=Rgf%4ePcYnJ=tT` z4Z?TomvN;=HBQ=R`&uWnqlA)340wu&^thfhpy=Wo6)#I_fsKvEC?mZ&UmAWr7Pz1uV?v^ke_mgn`DU4 z+g_nz=iWkK&|FzyT32sm*s_AuqIv&E28gL5!YECBc91~mS^dq5c+s;LhjSyYGGk}uRB{kBfdP_y0)VPiULl= z<0_;|dMX}4%wHM?klK&q3%i*;8YyzYbIgfLCkc&6TK67*P3l{(VLisY|Js}6^E>M2 z#ESEjH&?rY-I;r)I)=R2<+*dRh#vH;cT3x;6KjFKJq+bHC;#I38X=ny-rO3u^0{H@8|#J724D_N+0%+6OBhbzQ*VKU+jQWlHeVJP# z$Y86CZ1q}|{XjH}jR2>Gjk;_^oL3hHPFn?wu&Bm89Az1p2dw(7VbH?>MR(Dm2ma`W zuHDr~*C2YfvDKi=%IoOSR0Vb*I(fg^`>)dd?(ihoXZvjPjdZ7pfb9z4og4Bp?pqYm zFs#|#dKoDSY)iAN!Xfe9hLin@S*U++@IsZk|F(uRq*%`F@#ldxW`hgyZa_P(!6^-C zxw*H#8#Co)ues`mQNuL1$kc}1w=eN5)JH284u0KLCaSuLUj3&ZpHoS{7mEMo3~#Nkce!utPg^ zbXUz$W)=z=_>Dor=1+vy+XBHDIhXfyIvSgvX#ue~i-Xj!4Z%cmYy2D91vYn4)lWa= z)09&IaRPIx-Wkv`KrTvBj=$C(UciYcXFpYXC4YIlHMp)`lNXTc#@w!YnV}-%I!yBY zReP&N7uspmPZF!}tB8rk;KO#flu>xF5iX2K7dwN70)wK%F5W;~}6_00BXP^6Nv zCa^6rw#zsB8ylXF#88`5^>g+Mw=HWn^7ow_|J?@OClSu0j4wySHJ~tD zm`ufPgoORJPw{8A(J~@2SNelTcS-9$+N2Y80=sr7@DP@+<6?3B!Zu+pz%Lf0i7H(V zA+lUdNykTApG=x-pEMIL*>7a>4Ugojq9|6_q~W$?%+oQ6wC8r-&p*JE2VMuLjffdxMBRlX=nr~De4#V}7SMy>- zEzq<6G;&wa$a8Ajy4pp=x&bjbJN+1TO!ieQMr~FW?9im<@+xccLSPzsru3;V^PO8R zSjE{I@R14tMsWpa{bIzmXa;11DWP?}H+7l{u%V@@kYM={`~(R_JBKmC`)T58Qt#z(%k9bHHyo(|mrr6bFs#}v zGA;Yp0S#m~Z(~fX)@GLVvD{Jw@uW~BQavP$V6p}wrqo6t2gS!}k2RMpcK+Lbz6YhU z#T9&SeZ7l7xQxrpecvHJc0jo2bdQ@@FtVbmEjr=fa<8V}I%7cj$Zi*H4Qm1x6h7Eq z&8f2cuHz-(XA<2W=XqeWY3E(3 zK2HzW;Uh&-tRfB>z<;q`khlrIuhq7=Fe^DXvOr=Y{8Iasq$u+2)4Inc%+Z(R*?Swq ztg4kGrRY_vP`1o|jb%=ssBYg&ZIRp~gYK_S%67;Ny87mlmKpm=<0IphfI!D$15t5& zNjJZb)B?5Mt-PRK0OULXl#jKRZnPxtF-?$d<#?@&U+1+>oFcL>Yew9UW zAH!yKbCQ0J1Dj1`agkQ^iCJ3%%MvUR`E;`ScwkG$2i+A!Dkb2F^F>{uYuIWasQOwG zY~Z^VZ&y#}-`0CT1n5A;De#*KL@dUqonSRKccNKE)Q7)p1|3SkdAyhi<=35@kBA#6 zHD3As9NniUd8_KB*eFKg*2R8DrwPy~HX}sp71M;0p&R2I``YawCU_ak%G`!ZU5MogT|myW(u&W9Pyr)E{+1 zh@tvo&2H#FQfCD0F9PeWp;-Pt?u#n|HBmBuegT6amv5R4klzuok#oT1m2S=BkFdU? zIEV~-KJ9z1OH5}a3K=&kV~p@_uTJF+13) z%%y9gqIZu!R&yb7U<^dHll_*mIEDgMzVuzMfPhc?^jK)jq*(4CSNUwNd+wSe=L)98 zsB)qz{1ONDWTD#6&JVW%tG3W`OYlO^U^o6tXM2N>dEThdO_3|^HH3OGPbm#kYv zx`U8uVa++TJ1F69iw*MQ)kf#6Rd>WI{|x4Y^*Fd*8XSO_y&QVw6J32F zyJtBW($^uT<_PRC$+4}8tk=^&S4GNEpC0z0SrK)Z^RJs(H`U zvJCPb+OJ`3J7$wd8aFuZdw#>(q5hj#pO}2cpuHUxe`2HvUKU1zr7465&|ChnQC9}f zT{1evkRyB%KZ*yGkFqbg{b;mO6%_n1?;v$3G6GZh+0i zm=(@{Z0;gFNQdM}M8M-b13owLFC#NaHNa@)f5&j=teH})o{*r9_EszV zzwEwKJcK}FVH#6!Tf9hjNIUN;!iYnJOw65#Z$MzTWLmY61ZIs?CwJ#sjoq>#BIe#& z7kYhMqUijEyb&1(UitW$xlE?6z%YKkk*4-2mJnhJe#nuk>$QWT=MyIpBNrdJd;L;% zct~v$&u5MMrP`n!4o6K&s_4lUu~%8Tf_FY;cFxI#Sq2-rg>HWCLS%iTG70yQ=#b>b zf>bIsGMKAVS9z#O%;^s9Px!$|SHKEg&{>C|XVCzqzqSB&9B5ZA>K?bugN;23J9#tE znvmV&WS5xjk=tsrU=~=%@Gi3e>mzgh5RNG_MZNX1h%_Wu)#V3!PXq;i?P;Mri?f3l z;d^9|)pM$8xdS!$4$c7x0U|ywkq*JwVH= z?dwmTKum)NtL*}Vnq6jXj|JivqgOSie7oEFG#E{}9+A!x5bKLUyQJ(I*@_6vnzo|- z&*?wZB9xz5wi6zm1bTlsr(BiW;ExXbfDjv@BGBE33>Nk@4j9=402|j+^W|5<{ms^J z5OresVH!@PVGIbPI{7BM0O3i)oZt3sk#6h~Tq>@JHMn=&sH8neumg5FRW>+m|3r5W z-;vOS0e_2VE4|$__xWJB=MRm2*iAYGk(S_gQt78s|Jkyd?s(TqAnN&Rw43y3vJdg3 zoFv(ValO2#_oxmqFG=afH6UziN0C3&W(nQQn1xyBU>N%)J^NiYa^f+Yb~YoMrtj53 zr3-ti^H^X9SBEAlY3%u3aSytI%jnmRKZ~oJZo4?O4rCQ>;&u?f0g9e^Hj0B|jCSa4F1grqtvayuca|wlw7af+E!Fqu=V_a^= zM9#47WU}EXK@g-t$L8*hHmd@8yRy7pNe8U=H@mjoEaItQ{6|P zFkiK-13Fp{a@#uQ~CJWvoVwKV$$K(%GCX#wx5B3Vg=LHE)DS22V~mmu8&-P zdjK^-0-Y*JW;&Jcsa1E^LMpCg9)FOzj)w84?a8{!@g@2(Ew>)__e68DgIjF>eT~oQ z61nIX+uyrEWF|)f>^>4gVjS@tZ@=eIv_L*{%AsS>U|uT52HQl1EHH%dE$4^$jFS0u z@$Q@YR`(9OyF(9R<;ZW0r4r8(F9yU7ETHGn1Blr(I=Y!nBi7e*?CytRZ|1F+=nS(0 zInE%Vox28~-Scg>)oL)1IXvQ@r%dx1Wpz81zLHLVXN->d6NKy+*iqY`5M&Mz8ohR) zL#llRGZXX76=>{b1P08E#0(D^?qj>w+m3W*U$Cy&5NOAqjVQ>K2EF)cFsM&0uk&rW zs7F@vYO{D!jWaMmisv9hM}Sa-hvT0xsfsvXjfyYF@%B?sI-z0Hh~{ji+sqGg{fcDq zPj+T(k2E!Djx2=x6t+d`4r9dLL)Y!_zj5^%ocT_j#t1;tTR2IR9=+4yy6WU%XQ|}t zdfw(%?U|EPF}>vhsP$6aSM3(%ujUqiq6+YCX6#ElZfmGNbp$pFhMqKG+75Fj9v4pQ zTfPWOi#A|3Z_Ez>cKu3>J={L-Opju_FX#SpLKCPe$t|DLk~q8jg98BSdOS<7X!r$$ zYIj~F3s-rds5^YWYVM*ukkfYiliL9^>3(NIa+gTZ7lt1bh#h>#@A&D=Y{DGlXq0f~ zHT19c>>E`L^E8^^S<0**Q@8R}^;?5A)p2h|lxpE&u3-`YVndP(X+qCU3MFXat;Hm; zcs&UO66Pf%w`O;G>ZteHX6MELxvKx(kiTkB@pY2n8nOEIvvYOsf!}xY;^3$|Gmn8Z zoiDfW=R%jwzM7osK3{R#5D(`#sb>|+ej63#yj}m*Cv#rze>1k{xP)Cc zcZ*etZ!&Dl9Jq0={ESA)=t)s^dLyp|7hqCbljh_W%qCeF*Wq&}L@wpi%!iciA>Ustdp4-yScn9`5+04nRjYNIfd5H0YgC zY6vw@+-s8IpLFZpQ*-(CQIr)(&gA>Zg}ZX#12!7RONK%ylZ>CtSx91}Xg$deJ(W9KtKa==xfP9w{_Kb{ZDc=0KfqZ+j-jM$N z@oxLqZby+r07@(B8~<4)L}s}l?8~~u%OY4|f`3`;M}|D)RzMiVLE)EE2aHEISXx{c zy{7U~I(@HwcTM$m1La5l>vP!tU%HkE!(=HR?4dls0R_ZiNPR2LOBbRlRb-}3MWBFK?S!e_J3C~02IakYvwmZ z{6OU$MT(EuN+!>yg-Z6z|Kl{DBpkvwWhB6{ylW=XVC$>wo$%zQm_jl^oa z5_Zoqb5SrscQh^)a8k9Z36lFI1XXW}T;@f07HG~uz$=ZP~+ zyH>I~M))kVM<9qGqjfFUMYXO-K*oR^?mdmgKc*yHl6b08a}E9q&dDK?y-$teGp0!! z7av_zRZxv&R2~Wmq(jABw{S|$MD8BnP(PzCG6gU=BGLK0c5U_5mkZp=d^kebX7mTa zPO>8gcP1snjvOi@n^PeNr1s?=bXe$wn60S_c$dE(k@T}_n8i@?&-QoNR|ZL}H(1qY za;u~_3sd9H&;Gb93q&TJrAXSsdc_2c9WnkGw&Ic=BBevDcK?yBr<8r*tj=r<{gfx5 zy7mdKQgyioP+v-MYn9pL7)m?Id~y)sDwYqcmPeH^zjG$k8r25%ov!_S>F~`moLwc{ z4s%2axz|Na z!K;8Io@?(E`^(~Qae28!nG(s=k>|=~a|KU?Jztzblv1vh+0G(4z}#D7K6P4HiEt8# zT8IN!16d(eE7!SZ&b;pkfxXw#WiSjYBmxBGTwu*W~~vQODEYyo{_`|KR~V1eu7WT z8ho8Lu$A8PAx?UguBtj zubQ-i$&Dk$I`haPdxyo#QClE>7*w+~G%55kace@Q>%dJyo@U(@7zFwI(PZT{Qkpb=t zwI?05mo;rncvPcx`^(82H&%$66lmSPw^}^9X3y>A8>O^wZ{IUMml0~Fw(3JfX4;ed z9J76ncRvp~9r0n0SuC6%(1Ucwi#1=KeKR{XvLl{wk)x6}NMauR=h9WF%exDZ@sR2_ zGRNP<`^>kJS0hr?s;lbzhk7!@8f=9~c&PGU1cUHP+H{30qpDM9A17M3Jz3IpIU z%gr+)#DA}=oEvsf;iNQ7`F*()bnDsiAw;Cqt7@L_F`pb1*a_U+{HC9yKMo8T-zUXxa_cRY`EZD?7B%zMHw}5ut8sie(^=-3 za&pb{r+1jjJ}XMP-Dn~`h4BOKXh{D}Kk+sar;vY&iB~`B5&!I(%9bKI1@Oj6nj97l zch}yf;YD7?eD;Bw%6s(k{)3KK+zJN5XW}EJ!osJ7cq_LC3nr1ybYGqy*uSrQ#CBk{ zM`;t2Avuf1{98VFcXz`u70I?;A>1tic_i>!MD0$>TCpcX&N~)vVQBo%dG})HIltvj zUop?>sF1MQ7X~Inb6}^rq6w|BNpu6l@7$dW&osfG2G7uLW$KMlAzUy04UVpcPzCJ?TvO)v{Lh`Nw$XCs2RKM~wU z*ZM`mAnIOBXl;9BB@Z2Pf~QrEOr+qjvA0LEj#Jt(t1Gj8u-8a{1Z7%JF%; zDQ!WSle!wm*w=kC>bH%l;h&rPdY%e?P2At;FdQh^)IZ|FUfZ#Kr({F9n6?3(8N8M0 zT)k}Cr7IVu4|(t}Hx+5}Z}!3RXoLLQ)z?&yW1ZjJbb?J=_dcX9Waj=_*SbABPjuYW z8#euHA)YbCSrC`8XFx=<*r@k*yD;Jw*`D`_TgiucX2Ip1noa{I^r*bHXi z;AI&NVr`C53+#E@v(9i}*!ZGYrf$9kk+$G&whNK6sW^{TEt~bhCss_s$iVK?lvMWd zI|x>Ong#3%lM!MNTJQhJ%DyRL$It53U!~hI4?@F>@gWYDsa`*x4NJ%OT6QYLsHLzd z-AXD*7E;ht7cejVKVhu|7Sll zY;q;)L<4wpq1cxSTWa^uxBRj5k@#xIm#}~@iu*A7kTt7gV7EU#yNj;44hZy-+6UO! z0mZ?x(nAx$u;=}|^;e}DAK&_xD429%&vw zf0VNIyrEF8(!qQp!PGEcq}7ApWlC0IPo63vX{dys(>@iP@0n~vq)fZ^->m#RIv#ZY z496;OZ$L6G_Z1h}I0(AdzrQieR^m2Rs`Ss1m5Nbv2hW}$h=#uc}Vnw zL|k60cK3%}=N)bP87(&}y~2lrpybdkBvDj#xw*E|GsBiEe?;J)%{*zZ;j~!o`Of+1 z-&4G9*BD!+Vc`xh;qqY3{I=r^}~U|XXdX_k8!GKu?w z3TQnlWB)Q3kPp3HC4g^&^Q2CE)L4Nns{TUS4u#!LtXki*4P@z?HgL+k;B(sv;@v|v zUOJ}i`C<=4c%Zl8xU!wW4{0(AcalIZ#s&(<~|m?ftC=zdR{1_CoK zR}>mL78}WZ#HZ==PI19eTn(2K-@PR`%Saj*3lSx^RQ2le>#3=b4;~00v}5jMWnpE% z8N?*{A8*YwFYIJFrOVcXu@00kbizI$#^Sw}@Oe}ejJ*{GncU5A8m^KH%a#(Jo2Vi3 z0dt%xfBNsq#D<||Jzs)Lo##9@-wDdJiy>`RwZ$SVY&>ta0|ckNjCWFN=1DU=9qqFBX~!V`an4>Mv|i~9_NAebQEK4#8SLBsoJ`0f@5l(tgSC)dkvo4sAIIy zBfirnFBvmeDnW0kxjO1veUW|6Osj8)LNKdln2y59ACKDb}1lrS^dITqshH`2(1BiUR_iUy77Ymi`*(T_l$757e0U zycY+KQF0CHsnQ!~`vEI0Yv@?fX@WnGrNrE7*2<-7LRw_s_M9Pdf9!IpW02N$i+kBk z7pKvCUklxpv=jW<<{UZo;FAfY4>#}Xt2*0Lv9H?|nDAv2?DqSun(nJ#C)Z3|rc92n zO$502oRED8v4Q|Lc4l-QTK|7}( zM&vrC$SUkDM_hV4!{HvT7sh)G`BuE9z})KC2acRUSB0B?4}lyI!=X z|C8?@sM5FkNe0y6gU-uxjak*4tO>1fT&SVOlhxx}9Ae@4>;?JY(t=TDbW`Bw&`0#I zLVIN?&mX{d9m@w;z$qb))ftHbeBJ?{`@#51zsU;yH{qAv-JW-K? zZ#s>aiF0C2>)9O1p=<(-duVYQK^?s$tP{VS`RNQ=qO%vlRMP~rNE(&0%RN&D8z4Wu zUa5@||= z_<@4z)dr`vKxCO@T^Motj8a;d}QKjE0Hyj!3V<_c}*t}b$mYjFGTG5DZ zzO9;TO*HsfQip|Nb#^Vb`ZkiU8UeM6E^ms@pi99A&Ap9#bOE+~de8?MH3N^ub>
SU{wXt!A{ZFZV9i6mC+Enzgv(XYH?vV^E7sb*_Tf?2iBg93iW7$}xyne>ueSzZ zy`GNrk93%I7Gbu^7&`09e;T@!WiEcjaJg8gzu5}5Nl9qo;}hG#VRX5QDWsSlCHNgAuRvtNt} zt*t!GUYBnR?{g@^m^xt!L;M`DSmmjGgTZgHg-PG1?!@$7P6=94&nwTxvM4U};+g$837BU_&qr{Xt)h8`QuA zZ_wCn7iD1az-xBfT(xZ>V)`R(D^{Y`pJ*1=FXwIbqhNR5ZA5$yhHSIFELB6gc|0Y% z#~W{Tj9#rLt8_(81Z6|~RXqpZ9G;RzP@RPmX8_+V&E$2VO2Nf=aICN2+`BMWgHIh? zeZpZ2Hhi4$(b~YU3BJ;Qan3I!F8W-OQ8s2H-75*Pm{!KQirxFbXIe*Yjc&J*d8NDw zE79&^CKZ60oY%|E)|BADBziJ)Gehi2K!STA^eXrn>t>g}tP)Iy%*Y+PS#{~tRI$dX zvapLbgDXJY;|Z6tNBci@hR>lJXwxx}H7XLc;3n2+&iqVT<)N#c(TFic&jn!9w;TDY zW3C-)S$w$Z2DU#QjCCbh85C8U*{tVaF%K|T*Tq+H5~t+{i`WzEyoBe@$EKQCbc$^Z z&%cu_Q96m0>vX>{7dG(SbV#m|AQNo&gE3l!-BkRD#s9Qu<2y$F-rsdKEz%QBylyWwPmH?4w`921OrPoxS8<bHig!U18+AA zW@&LD4x#~TuLHA%TYKz(<@U88#L;j&AL$>yI(9uBHe$VFYE3Z*B`mBBen;d%ps&05 zON9b2z`1%@9WBY(!`K>0uiz|%I#$d`Ey@7!vG|6pYAg@~ILBh0cn8 z>W|-RJYa#al2F25HWXL^9<&_btE3J%p}h~j?VCW4#s|)u!+-B!06W0~*1YBtw<#kA zT?w7kCdGU*IaNXtZ>^*LX&V%{fwyh|A#NlN>}N=F6dRj2Bf~n^4i(+Q|EC;lv7B$B zGuqj(F+xx2q{FuKz=P?LBw;`cs77Y|k3@V^m4}GORuY`L&&fo$vS{?QeE8WVE!zr6 zR}8v6))HN5JHu9no?O&UUa5i;0)}|}NG;|QkUzdNTDThl{OCCTCxo$Br5pt5slWLB z_s8r}KCAxz8^}i4^uOK+{FERH}gyH{O`A_J^pROgyoF(@tlLD*Dk?}c9z^i3H+5Mcm4vj1Pnmw z{sOcVkG~SM6b;Z{75fhye>vzsaQr3d|G@Friv0(Uzh?eFaQy$*4?-`l@_55tH6Yjc zc50XXkXqvz+R;S-S}lKjjzN_-(SbmSY4I1@q&rRceeo8kRpNJP;jO=ZrVt7K=UKuV z{yOPSG1j>!WP@H;@t++cpn&8m{t|$sYBBi+*c5q^BS&6G0k(ib&RYtqSs?Xs>`R~Y z*etK^E21<$Lfu%Axp#xcvQHaVM>`(bC?@^x+8)XM%T8^Sd|2bWV%6RYYRd?+W^M>q2RbKk|wF`t_g$oq~84Yb7F@uTm=+#6ueHO=4_S4WGLEm>_0E0{I+uO@rp3DS&haDxyb0?Kb3>zPw_J4 zKraAAw1jX|onxK992Oq91Mb&+=Fb!89FT?*icZ$rx}@1}X9P9>iuMUSFdHG)l<&5r z;*)|mV&COIdgo;%4}vqP_4EuW*DGziiWq&>}K0Ec9< zw|sKqCQt$**Ner7DtwO5@r48eLMt zmjp7l@KbR?<38Cp|5+lkrv+I>H8=iK*gQ!vt^$i#4|L^d%941(w?;n7pzuJ<09j5J zEfv_Z7>neMeEgcAZ*vTtMi+EZ-_a#-$OvBT=}55PC1`j5=QreWzBGMPK|%{He0sE( zOlys%KxL#_lI4wx@!<$G?!|7ykG#c zfLes2ORMfI>Eeh$Xqi*)Xn*>j^h6NofdCK5$_Ja4fTyx-p%-|`0SM&BG?+3YG^$m1h=b;)wTksyfI?8zlF^iyz5Si4)k)2~IPxOwver;dsr$gix9LWd~h z+w5yyFiYP0iW2Ad*0HYyOF&07(ISB}fyGvzx1TYml(zo|jZ{J3DMih-3U$iuYlkZw zEXB9GZTnAcN{iIuh}MAg?bEi@-O3?BxN!prG|lVf_0FfQF}h1(yegO$$@dzKI*kYN z9&_X63>Da)51!s=_B-_j(DkE&8JfG17;tP>t#KhUHJba{HGNI@(ak9d`Fo>Tea{AI z$yo{sokRZVDX3ELDh?GFSsp4K+6|I$fc}1;-ULdjcrMCn&AMK>;N+HrBLUhK%sLx2#%0QEzW83;YeM+^wckWvO`kLLV z=Q#0&+{(CZZ8;N&Z_i(-VAqUUuarf7M$bPH&X&= zp-XsJ{nXdj?wVn}h+bI&s3rbZ|u%F=H>+I+fwPgqK_q8ep= zC(u`|0z(efaA7zV_>TI2xO(fjCf7f1e2B_X5Y9OQqSVoYfQU#aUCI}g7Lim!5phU5 zI%lG!5(-Ko z!=1_Z)$wq!PJ@$`ojcAvu5Zolhfk);q2(S#)Kt1_OG zf9~(#-ZRdzbtih?d}5P1Q1jnjfTq5oJ{|iZ6l!T|1h}s4N#;OG%FBe_6)66mW`mFKlD zq{eHS_`z?$cH1sz?raAM#TvQZp&(-cma)pY! z&GS-ArtG=jZYaJ7uYZ|?B0O>OBvsB*?wXN#Ur(944z0v9@8s^(Vh)CI^cvgn6*Mg; z=J4Y~FH_~#*SFmrR%qKX49dOMSG6@0i&$?}_#e|2H*?ZTW#5M~x^Udq54TED9@*om zRl#lCJvptMYhOAYuVpN|#d~vK(e87p6g~F#i0^>g^vGV$aS~bZ;Aq?M=FF_}$n>$? zskcugOjC(c^fVPcMXjF6Ium!QHN|t`c!I6O*|N~~CaI0mwc{}Z4Ly?QM{XhrvqIO@I&QRc^KSAG8g=UyfVlGAL7_dUEv<=u2cN4#FA%{KT3 z?Q>0`*U%M%$3vLDeX8p-x#cg#R^Jv=6EYP$Y#LE=ltdcd_FSI%TjSfg-JmL55fEYY zXKZj};nPFT3B@LpTdmT!JtJL2-DC4R(F65cT5J8;pHpM;4wSEBc1=D^R<0tILLC*1 z4P7pj^Anrpsw?X@VXY%ZTUSocW*X2j%x!sf{5gz39qk;FWk$P)&xtt{h+0*JkrR9@ zQvEjlgYw6$djk@R!n{tOk4rHRD3Rb}`F*bTY$OuGBBqwcJ(^eT1XfT`HZAe3f=oVch;0vqk zc{;o(=QYQCtES(yl;~gFOSFzHTT|S$X}VT7o7oXzw|QB`WRfLFpA zy(5?_Cx#Pum8VIA;<-jEyf~F^%f(e{NO41hbN zR_^$>)13WsrayDtQwsWO#WPIG%bX_KdanOER~OVPr&r z>VLrHaPa)YZ#^6Z#TuJOmjVOb-x_sL;w8%`kM2KclA=VTgxa!D1so2O`#f!|)rs~; zaaZT(MLf9kD9(qbGanc$mK;U0q?DaB0^=H6{BkiRF`D_NX!!(9 zV5+E#c)Q#$!}H*3Pd@`!C@?Tk11> zOI`NQ=lyU=fo)8(7E(q=1&tfuiRFg9&)*F_`wOm|>3g(pY#updav4p3)VKe9aKbHY z?Tr+3rp>=PA3|Z)^YXhJs?xQ}b5qN{P4Ow&it@H*Kut=ZvQVR=@X)8R*;9I*;; z$3zEIS0KBEq;^t@hCUm!zg$^Q&L`g1r?;KKfcie!e0Ilwwg2#3IVvcn1C-)w?BKHH zMkx>enK>lz=^%T{L#kP|+q*rT4EK!COU!kt!>$p#BQXGH6T6O0Q_e+YQ~;fq$54^!7;yWiFcBmYS~>A8iGzHH{G zKf~-NCw8k}MlQS`ulyBXYL=>mJD;la*w%FNn+rvXv6^ni-ja4(=F*1LhzQKmuv0^+ zVqy{h&om>Vn-&|PPI;tTO{Z8~{yCZA7~wm~d)rD#!h&R4edrJH7woy(JuffG;fp~f z^JiCys7v>bR@3FWI9dj(H;xybd9c(lQRu{;aBE3);sjB|V&sH_Kiyz}YqBN#dF2b+ zcx|wGpH40$K-%wQioK>nE2SRK8J+ixE%V~fRIYi9$7AbDrViR-x>&6FVa~}f=^m)h zY0|8|+C9RLsHVxGF4D=d;ZUF@H!_PjUSUvd%$^_oUg5QJN?PE3c5q>%suKNerDdyy z7RD%HTyaW%NsF?5{+=%`~glbb^d zBUItq9CWb98^0v&ra*y`3N@C7J=0!h$^Bo6ZZy?O#a(Vb>U}Pr=2$c;+|+|#}(ecP}F!N z%_jcWQcMo$Vz(G%G}6fS4(uuj?q^tjtUk>-VA}Q-O?e?sYYh@oZ2IhheaNeRz%MMl zVx$DEzBl3S(ce7N<(fV!NG;0KB$DO24#E!ku0h#&|3JvV{Z;Y%OGS;vpXl~IZY;5iOO%lvw_x_lLWO;ud;C5+yfX51rtq=pPu~fePW0CGE4wxp z*md=l0+FHe_c;elL~xVbKc!_y=oqAm`?P&78Z~&Ur|mS>Z|Z{wYIEz+Ys;jYgpw)U zGR(2naC5=Zae&^zQF{KBiq=_hHG+3yrNiW=Ueoea`N#7mj)v!*_HZ0J=SrkGP<)Cg zN~|i2@>46HZI9hd?yKTrTIR!Lwe&b9u~;Jp<-2qL^BMLLy)p;a1Ik**Ci*XM zh4wuQ0`bYlm7qHXg$~epMx=Qn=8)q_>$|WC&+=yKN{STDoTDX@&z_ zN%Z5}Uf)19Cx>#s9PpVOM%D~eSzx`Wfk)%NcgO7~-sj+s%(Ijh_}Lsr9@(sNZTjN6 zerzeYJ+n1IFJUqCf_|CAx87&(g%c4^aCk>&iv8&xSS7Os)~jvVcNSAU{?t^^>=`6z zcvz;pA6%UeepDG;?_Zfby-&;Y$7__v53o zy0|5u>1uz8awTmS+U6V4u$Ut9@_QyQNjjmcIAWtq z?pF)0l<-V7e?foKBo`Cjw_m|F9wY96iz$Pt2$8!iHmXPT^dDcm)2^U;yk0oAC6H`2 zZ4dP?*ju}1U2j@(DFHmqE7OxJmm8R6%lk&osj5f|CY1~fn-ON3TBSS0i)XLl(X^9K zThVg5KAZP2ysT5gQxzq^^$W9_UZi7|uv0k?q8+c5pgxWBzI$#+Ic2SRcYbJZn!-ds z!+!T;Irr76X>N_nQAUMHUT=)nA6eMzGQ!~{;+>FhI0614Gw`3c?X6A9E~fpxdQNm` z@2ypN&9#;KbPQ{%4F~Qn!cxI5OMUX&Kym&%*xka8!Dfb(*2yXRQQ)_~ZNTSsKsv1&(XI#N@DUx0* z;&wVv^y^CdD$EW{zck8w{?sMUQ>Iko^n2s{abD~f!_SNTml*tPd4*0(h~f1WpQx2S z_faFFJ0Vdou*DB_g^@%(bS6^Y0}h5wp2iX_2WJm_Q4Ekd34=i$Pz zM-0PvW*sXeC($9~=s0}GkOQ+k&Mk^`ROqB@SCw0YrFS5fcJ(4vj$KcVos>tc30`9bG7Wqn~SV1-SR~i2IJQ*2L8+%K1L{P*x-9r z1DHvam5Wl7x)l0&PR`)NlP15Kv?VDpeAMXng>k4s8!>Qbk0VWbm$)(nsuo!p^m1>M zmyL2K1w-^@l+x`SoTr<0=quhai)y|lJMn41xX!_Z^&f$Sa*Xp&#rai^|bw6*0O zMiMuc{|1$IIk?J`)ygULrHv=$%s+`Yy6thltiea#SYRat8=iibwy&@^+`(aaFCy_= zkofo4`pUMH5$~a~KmfZ@R=J`~OZP;CZPScz+a&0cIfojdKM2_yqx_4f zQ3gg+$3O}1A`K%feFCuz|TJNmvx9NtVk)#9GJ2$PoXiK)}l#l8WkqnY9#?lH}56E)$$IG>{ z)QhP4Pu{*o@}F_Wiz{SdSxzQsolBdE)8Fp zsOI?$S;Lz7->#6mQ#tHUpJ9C3X|^ax|w z+3I<`PxP-L`jKYe=d*V#-Ek3N&);6RE#9mHI z|F4c}dAg4l+Kr}cjHYA4(h9yb(R)+PxoIkE{nKMrMW>Sosyfeac_p|}mYjOF7Yqo6 zJNCqKKi-TPtJ}&c?XX519g^iVRq1e}+^%k<=BOno7dG`p{)PFpq4a9`Q}QnfE$$ zE2O_#sak7Fa|GAh_id{3S?+197{)_o^gK5)Q24%nrz2yv!*qhJxj%IvAjoFZgy%dP zZwIch)1gm>m|PLO^xJy!Ahm3*cZy-FN5*Tpa&ohPW@CS1hU;=Et`ouO%$0yuQots8 z`)zdO0=O{<&_1&y+Y_oynq zmo`p*JM)PzgD$W&3aI8c$mzP-F72kP=a;w=C+!g@EoS63wfNJT5;v&ETJ~2XhKK5? zn;YWwWvMqcI)%9Tb}_ehzCJ6lRhiLuK%|ydp{CtzI9+#bO_5{%vU@e@H}!1i9JN$) zZL^fmcR=!dLagzkga_`Hy}XSH@!1Qt&!IY!2^o}vy!TVmH~XTSYNka!mP(~LmMaHZ zrEmS#s*kB@_>$<&1gu)^bnZRFZ0y$mG-HVOGsVXfu2u5{hdK>MkppkyE2=tU7r!>q zg_8nEZj=wzq;8NVmqwQSo29S?KDWc z0~WSd@UAvT9T8Hx)2%>w7+*cYZn+lq3(CSyG0CYpuU6%xjKafLw_YzU4L50w%pNs? zx=8#tVHTo^_`8V)+xOF6QKYIx(JS&?m!?5+gq{@l|??QpCNq^}4uazsjQEv|P-yi9)i&R>UIDgagr!makF& z>B<~6CS17&Ju=I4|H?$naIZ)FV)t5NZ=-FhJx+Q6isYv>@`yvPDZbGX39QRIukM33 z{FSVIN|$4e5BTvi&$##F&-k0)U1g?K+Qcs|tzjqwZ$|KKTfGnnxnd-LEE{@-mvT|&>7`oAz}=AUptqH4%@H%i>ySI2M}O1~r> zDvO^V5}Q_dK~+KwCw%+LBvdZHfjM^LOnpBC>#q}<`)kc-eWS+`-8W5o3ae;|< z%N;5QMkI?43g#HBExi3)P*|O1nCZhL`_j!`v*2{X+13$_o-k8ZbfnRh!V5Z>s1@Jo zJCo%g9Y0+)-IR&$=J?2@2Sv_ZeAleG9ur^EyIaToBa2CEVKYUUhD@L^xEL z2zl`VS*^MIv_JoKuJWv$e*4RL+Ue6>ZL|fxsg3qCttqFnxV&R=3c0k)u!{9t6# zfO0@9qXBQVSOkmxE9+UdFaMI&ShKjkm<=_(={Y$I$eZ@hpQ3-d6o)@^DWPBqO-~AL zQ#>#&QC!;d?(VeEhbqmiJeJDevJ2Bx%c0Fn0vQd~thu#)T{+J;FXPh!5`QfBoej50 zUhHy>G47ashY8g5nT=?`JM(p^elU@7?cgv!@ zRgo;wy5-(vXtM@rZ9JvapijOQ$>}yQPibV9j>m+wNKWxR$i@(R3QJpV$_RXNiX5wA zQ?}vb4pnLoZ19<`!r~M^j6WBt0S0 zpX5NnymFxOSkFt-l{eN)8hkKCw9+d+0SyaBe>kB7wn}dh74J4UN;UNQ$Pu;>S0uH) zLI?{z2E&2P2S+Dw6g{1Y*7}ICz}n9C4U3XFWfSK^Thte>(dCQk1OmdIc38s^U4G#F zmo#1Ws9n6-@K@`px@Sk?G1^~5rhLxV>|3P`3(WtIp(0(gbMlR6;;PU=m6{XMLS;Ft zenZGSu`68N?8CP*3TM5;Na>X|Jk)Sbbak~{f7Q(tKO_6MbAHf2xHuwD%F7G$(mo5f zeoDVt^4FnMbQS9f0Lja(|M{J+RKSIyxruL_7iU&BS(?L>JJ^HYI0&rO5K zr8w$MkET|nsera7_?N`M{b;^>XBQCPfBg%b` z6pKU2h1OI|*s1QjmAHSEehFkdC}2(x2L#Oyr#QAwFO5hi+)SR{pUKlyBM_i9r&4-4 z&Nv_evO86mo#bw`SBefVk{& zuuMrEH?(W?8oR%QybCIB`DR(;tGH+V{g*L`IoXmqIvxI6WoM=QS%%dpOBgZSRNVLd zeu@ysHwcO3k?IMqKmf7u&ejF1D(MPFmdw^uqf|6=3UyG#A+IadDI}r;J=>bLeZ*kTZw4mpe%HfT;COaNoN z{@~T3QvA2&t(PA9b8r!3DhFQ1&pOIEaDc645`wJ}i|bZm zIJ2%#kMN&#xqUd%ONzZB0X!>^@Di4Q4 z>j-6h#H_t06Q4mp?r&p13upGHP-~u`b8UGjr-thER7z;}^c|_B#U%xn z#5&bRQpOPmVtILN`RMaKg%i`Dvu;nE(dR73CT`;yzY-1q zupy-PxZ_??xdAwcT-V{{06+_aa3X)d4#hUvyL-^k4&GB2X>>8?!?hK!AUF~a1=&BH zX$#%UloJjvE^c+yK$$mxe>P~2O;?Xd^bVALx8(A9=6IH5_@fTL%ds^DoX;@v(#Gk& zITDYI2>L!&%BX87hjD`C`EyXII>_d56%b#wBI#C9`{UJKjjcA{m4bAb!Ab%>Hh9EiFGGk@$aMz zk3hcD?Bv2bdMnJ?54I(PlEVIm-Z*VxwApRAM;1JsN5Ad>lVDiYqkeN;iQt(K`CzXtds< zY4YY6weGF^D(q?c2c_}93)iU|jqjgKv%98_h%VG@#aE^HA8=^sKtGKJOJz-)>wR_0 z)3Lp?tnF-=@*Q29)^U8|X_!HNp$7IoFpN5u+|pfWltWsnJ6C3-7IP@KKLXunb2X>P zq%%XjZ|H4eIHYYHiJ%)Ap5g|<0y#c`Tt5sWpr7EgO|@T;i&QMs=I6Q>Z0$y_ zz1+BA*XV#BSEKlOx8EmpTHr_S+OT}XWVo2%{axmdBhn-A=&A(Zyj7fH)7>HxeFD3Z z=w0_5n)>mLrp12NAS2a)U2o`OuiuaQUF<51EXy>fss`8{49c+3Sw!)nV}C)Hm}y42Xr#!%Bi0LUbb$U= zlso>px8r%%iH4jf77KD6e(icHTXG{Z)^st4e$!W>9U~Kd>zPR7V^d{!%i2d*k(zuD ztgXBr$cSVx;b)}2a99rp>w4@E5e|vL6^4ZwBk*d!q^G_&rHhV71H=v{4;~Jww;3^5ghW+Y;kJsqP@2uWxG4iZ5LQT4vxivG5K1?c;S8?Jt1>RST?nOom5(W*Jc1R+EI^^IuD$EkJs#WR^1hb-k)4^_+q8 ztG7bm6l6O9lZ21sC*Jp%uuGkEB5NLRzrNusw=bTG7}Lv% zHZcif-V)^$|I+*jdRzD8uS)2@%p3|Xyl8J&=A(9!g!aT0$KG@Uls30#pR>F9_8G+R zGPzHXNwK|-9ZAg#&(o|(%)0It`-_USWY0M~wjN()CrJV&gSee=!J5>1V6?XI;Al14BDX1?&6W#kN0t|E zr1WC~$BoiTFLe85AE3MQ4Y#&k?~|Rq5Bk_P$)&WS3%_{EwNBHG4BY-zqX@td?R=SLmeMc#fDbo*-6ql&i21Lk{MNk)e1nShuDZOZxY@mqp$?gk#|s;} z{biA2(9F@ilvB5~Y;D(QI<24^-#J#Pmv-Kwu~B4!lbYkrgw46$7bS{b;^3fpQHLZK zEUQ3gJiRqBINfe(`f_ij251-I>6b&)MZ6u(yYpdEn{UE74;6f44R|ppZ{=zJsVgHeACdlguK>+R)z1XB8l(JiV)|4JyNPs z5&Be@OjPFzw!_fYz`AE{PZWN2G!#nn%K7mv+xlkupjyNL#3!tXwL!I4Q%#${v;@-; zbmtSz^pKSTo;sWfuAwK-t0^nF#%>y3Mm%Sm8!upk{5adPU|RdiCB+>MmRZ|UHh312dy zy+)0z(5YA%>lEqbH=?jOQKipYaF3gBS=!3092u?w%0UW*>pPt@o+enCI|`5HGQpr+ z4L}rQhWFP+uuukom~f_MY1Q0*q2RXD|G=82PW1KDrq_=iiLJCt%!O z3tUFZNI$!Z@DWE`aaURdNI^Nd3H>BTa-+K4+BHF5D9lhy%9tlnZ0Jd?rgU17?3TdP z|1OPY4J{|Oo#`NT2MX{b@gqG^{TS|cn`^8$DXX%09Nz8*+_Fqc7bR*nAklcIfqxVM z<=~55E4_SSG&lW>V`XT>1$Ejrd~aMEbm*Wbz;(5~^CMnlfSghI=z<}zv)?`5%=&QS zf5S{>U2`(XPj=8Q9^-vf;fXU_3S9C^(1+GHYH{Smlto@T$l~l(7kYcitW=a85ZyvS z+fU269g%246tKI>#-m$wt8H-cPv>Apah$zg;lQ zmYD!--+NVj&NSsnDodJk3_LDzIrPyU_gP3X0d}GTHOprf61?V8>R_{* zmwmc4DX-Sd9DEr|CdJlCH`~A?8wqDVJ3C_um{2bli=x9;j@GxdZMHu(bfUbzO>VYc zL+M+(YlSJ~+n3vkCzwow~gYw z%LWyeady*ArK7yqitgl&OZV&h89a+MNjDI|TkQ%yL-V1_WcnGx+MoDD<6@n;JdfuL zhHL9n*UjD;Eu0^JU$-=8ZD(n_twC7%UmRDn<6wIO(dmX^cFR(CjJ-0l01+9KSYPUc zqb&W^>xFaYO}`gpO*S33fA*$uspGT9AB%Q7M(yBUUC6bq_t@R(>pwJnGXaN`i%7G~ z4M}d0GL+w&iL1G%pCL%L>D-ZYl{@e_-`~GH9!{BtPBTk^qSUOx<6kO=5q?T_vGA;+o**5 znZeIUt(@nLXCREE}k`Lp~FT)^YoRp&*(P5+89ehE+`dLiCjv7DfLU~ZCtKQ_{8Y@5hHugihd+qG z|HT#BiJRZYsF*@zG4Hg$GIi8|;uGbS=6i4z5+NazDS7#UnnD>yW~lX-@F-)xcz}h7 z18d$SFSa{PmXzjSF>;H;aw$^4wnA;@HsG^ar`@0#?;2p~kYF%tR`abmt)LV-OLza& z2JOI{s2Ir|8H>p2KARp7@YB88f+0! zLfWR--JR<1A`lJ=#P9lxRE)r<7n55rPJkOYY?Okv7~9xk@Uw2#{ko(;- zy%3I}06{f;ML4bq|GKx)hO(Z8Kt{1!o+wZWa)Io!f^nUI$g-3apM!`peRZ-d2!4RC zs}Hwr7-a}@;(EEylMbQBN;MjiYxw<#epGYfhq@)i;V~c|XikOgaGw!eL{s;Ld_yKJ zJ^QQD4*xDuP;Q#{kq|g`!f0k>FZi}xAYuS^j6XB@;$~kdZ`;#$Q~@ZNF$czA;&*#? zEGiul$v^6ky$sIbp6QIoT{KC#?)L|x(|o8wP$Ho!Bl~uVQhpPHXqKUmxJ-H@Qpt~u zcF#C%A@kAC>)be^qNO<^T{{|gLU!GGn+EIsMG1JANmXViJ-DuKlSgtG7bOgNIbNf( z$A~1>I|04oFX^&=GZLI=q4Tim**q2JJ-J%yUoG|m?(;ajAX!S~7y#NFr zaxpsJG^IL^ZF^o=Cftzd2by2n?Ryw_{g@A^v)Mc)6b+1Br69s>{OR3DHuSMXK-`jE zvBcFB*cO{H9kSs6AhR^Vnyi58b3oJrv5fEfZ|Z57vpIf8p&TaI%jXR_ukfZU)>3*3 z$;qd$!m8E5fux?cZrPtc4a^@?>&oA?+D6WTL5hpp=c-XLhIy5Mt`@%y4M$d8Y;>N-INwnU2=1KncON`xy%rtW;LJQXA2J9lkfo)>;UG< zF0#RLr$qt9mOjr1jsctf-;}M7ej~$ug)TLN;i|9lop|?j*L@ti%l&V_5*WQYVZlrk zBJL0PE#y+lQ!-eKa7Jq!2BejQpnH2x!_!Bk%I#>cB*L_;8|H6DPdj*4YU0kEfvwmV zb^&^D*X4iA|AS^gL*+7IWDU#eZr|TG@02l9QCjEA>1`~VrJQH-`Yk6Y%qTifB~7a2 zjtXdz#U3ahaErgwqp&w}CJ!j(wecn8rz@`Mj?iyD;?Kw*vq&M?a&&Gd&Z;MO0eUsX zK6i>2+tP)|49th=>hJ4go%$%RACl*@r2uoR$Z{aI7%8U_uz`ZG5danz`~QzOV0KxI z`}T|p@_*^#i(_4L_(fLde}F1WC|oacXs+-ZQ17Jin?mOb zK}#+Zd`=h*{S2%$aC-pZ#3QcHi?Z-uJjQvxZG0+7PMkT=>2WpXT~`0W8snX!I=L1qdmm4vL%YIL+KXQis@Ed%)7RNC|gBZT_-LQTK#& z536LFx><{sLF2Wnrg`t6w!$mQY8+21ke~TgRmclf{dnJeOZ~&;e`K@%H?HdP~1BZZ|A&M@ZYD0o&}llJgl-}KBL*e7Qi|aS3q*hN-=csC>`hAXCH^j zrEMr`sT}U(PY)cU8pn20we&jo;l=^;dO7za9lHb7-LMR&w4AvsDs(y98J0ivTi8wx z2ySSP^F>;)nrcy`Ufa0AdsFmzv5uj?%d~)((VZ=pD1%P2pd#+vElS5&61FmE&#Erl zzInN5Ql!7KR(LCkw$Ez7TfR&6XJk*;btbN^5ArC>!ZcRGulf0-(y2aq$izz7Al6p0 z$91LAF*?#dsN1;g2H#NF*fF&CPm|@?ughoBVR_dyVqzT5>+o<3MH+oqNoSQn1s*_I z7i6-k8Uxk)T}^qh8e?M%`5##cM@~7p7+XlK<$YvD`M#ljBv$W58dhAp=W%bHnmpZ7Ms z&NMi16Nb%i%3yT;@vvCjUoV|;Ccqcjq6K?xw~s`A%2{e>kWA1xM<_v9Z&qLJ%G?sB z_y6iuW7v|fHFbN=c;h+~%F(7N@hppzK15k1j-c+U1dFrbFqRV#9Fyq)vMs&4eK7d$ z?n&cZ?Te_9d-}YC1n*e+igebi9|QNSni5@18jiy>z;X@Hf3Ae&z?WLmsijBz%{T8# zU#j+~*P&RH%z~ub=fJ-g{dk1D%y@63CdT1nG?bE# zkm2$#F=-gGgX~kv)ba0h{e7mG(*uS`P&fat7tt^MF65Tl`$KgEt_r=mbouWnzLTa# zfx^vdvzsCt(GiZ{+!#;>($CcTQGZYTwbV(zU$b%2`AA2I3m^&x!uIbvsIWuAD0)jh z`@EqWcF);#Miwh`-gj4=0yk81Ubi!h)_ssCsAi`#ifd4J)hR@D9u*+Bk?-5GEWN1* zn&FF3zOyUQnP0kw(PK7QUiD$Ye4f#w_@Q+%P7OZeKrX^(*c;CCBMCIxZN!AV4XXA1 zfIrp2^Lpp~JgS#>eVDB&s0Gl%FA8Y#Rbw+~4wuaN+ncSbv-2p4I{!ZO)5gjHdE+H&=~ko^VW}b$;y#~dcS%t?t2maARrym6Uuq|#xZV+X zOdyAQ@r#rSU;3M(+KrRQ!{R>w^*G?UcNWrr@0lb^*Lt}$LL5GkQCtO> zCRiy-akB;L?wsz{*ku|$ZeZv{0mZ~TFDOiFGmr^9HJSm8d78p5RqSJZ_Pg-zKPIcW zOdVt{RQzsNECdWuHy$2a4qFw^LdxOC$-S-)WKj^A9#vZJ?`UTTLMYh%!dmRYiU_#Dih*@#HzT4*5R}V?PNt9spJAZqyG{wY zqMA;@{~n6^kDY|n2acfi?MGCN+8GuH5l;uy!6(gka0@>XFYKOb=K~kiTnr5Cbs(o+ z*Xsjs#HX0SI-_c=(Uh+C-{`2_WB*-MHg4F54hTut*-rkf(co-{-AJOf`fkse#(%nP zTRiei$j+f(!X~iA)djYv(Oqu*Oyoy12&4;2Fc0YN(>ipYp_3 zBP?A_5s}+-d-!z8VkL5}0>$#fPYk{_pWG>-Hp~RPuEUNofGr#5)i1;aSOCQYkOHH* zkX*+0-c^}6AW(R)ObQ-+r?rFdwIV=xZl1#jxg1uMGne;Yu9>FwrUVw|;Far#9bsZcfoCCT-8W6?u*-+He(vFNqDqCD8D9R}^ZpP>H zElK>IK(@ES*QK4~=~h)>Cs2p)bHyGn*PBBm3Hs%;8s9gcA=||eBeukj`sVD+ur_GL zcrP2~jl5NXJpOs-GJ;%{;KBoW6<66AU_U6#nrb$rtUFgI|D6%69Ih-Fn|-FKD!f$v2phNOKBGVB zE1B|yE9QnwsKIw&Y>@NIqau@qS(-}{vUdXOf&WI?1(NT>Yp1mzA1bgc&IS(y{?o@3 zg2Y1$p>Cr5|PH;HMk>e=W+KHe*1Tn(7S=$*+?%7?9&wtIfUWH^+BUkbBfDsbF*{E4 z5wn&OcMgCY;7M<&zX?_i8Cni%;lxCIx|C<+&0g>pTw}UbmgZx zkX2Y+dyOF6oEIAaxfS6KK zHL?+NCx`fG_G?63Za>a<&m1BPDw~0SYJ|M2;m6bBLh%JrNuD%7nn_pT2tCj+Q zNS~GU_4vjBR4-8@q6T7x^wY0BFt93^Gxl1K02L7$nrIp)Ut7o~Qd)OTIlSifIPG85 zbSl2FvO-DED!^OBOK?N6bF48RTnU*>IhQ&S3}8F&v1$F^UI2#B+1S5O;s#FP{h}bY zZa8x2sIR;=s1H|CbXO{QV^$YOLnpYw6C&q!RXY*7UN2U!JMgmy)RHu$Nu+^=LYF<* zjZueHFUe4i%K&X8LqXMLK~T2}i6k0>pN02PI1;b3d;UTC2jxi12k8JD-Z)ugCxtHNZdHG&G^ThLD9p;D%-)ZruCM3e!tQ=)# z*M0adAK=A0DKyDyd9b;}qoewXg~w-(rz*xD;Ubz+C<->#iXk?Jh+i~fiixqvX4cka z_*7xR%CEs*@F^Z~r3()>I&d}sY#Z<{h;7Q)1MNt(yE;A9f-`*9r?*Thx$LCNv--JqKD(kHqP^c>Dug)Q}Mn5Z8H_v<=HCe+YRH@u{U77CvHmV3} zsHhtdM+gPLP{^rzKgeUWAzdM0d9X~*3W%Qa^AawC*XU%}07Jmue z$%?%L05|GF%u7(JzePJ72ruVKjpLLSmfFub|z&)~jcVi$-nIowy2sf!15w1l7b$(oUqhf@szl~O* zB13dT!<6+1+J36HRCS(%l2;I^{IInv;tT6GtSSrZm!;Gl} zl*VaNWj5=qYQ|8&mJ6#w!N&-puUG)QTv^J5FJC#WL2o!I&l1Xg(7JzmiBcy zq2J

fp^Sstc_waL+reJwWvt`@Zt zTTunvf4?7qQ_*pxj3}JA{D9)l#|)s)+RXM0f-b>PIkQj>`N8KQcFfMla&Tk;8rAgL z_#OdQB(~DkI47kS7Re(iJ{3S+#Zim8kHG1xaJ=uv(wC~!t?w-l79}u|fFI#?JWZlu z3)m)+ZnYRp9HY_ISbgZkM*GPoU}QwlC~W1K5UJeH@6SnSBz>y_t&oU}Za{5!S1w5C z@>|GnCZR$Gt&x;nQ{3TH{-`6~tLoJB{dQ-F+iWp_pGmjX1Oyi6Y^oj^F;ElRK}ES5 z;{VJ%%8shaiA2g&R1jNH>j05>to1I;l@2Ur-bE_p$KD2_jNk2!f>w)wTkqPBGJX;? zN@(ai+#>N_?;sn+{7veH3TNK?R(<@Ew}BkgL*Z(79K6+eHAivC56~(+P{w?#!WhzS zrx7Oi?c`RsJ;n4CF4D9PPI;xk>G}Mq%H+7z(%63bKV~M zh=c$zUCPY<>v!Zoul8JHwHk|0I=$laWl+B}zdOwpO#>wQ4M1SwhCy_8lKa8ekIYcD ztrZD9^-UoZ2U5!;=khLc3Y-U{NvTOllu4EDl*}*P1SqL<1x|+9#eKd} zW6?qfTg54bzNbjUu z-y-xm4d@!))k6XsXLUHm@5_H>mh3!C2JF%Vfw$$aR z?qc{oT>IbZ-1dnXNLTd%7Vz7BPVZ-;v;aM-A9w5V^-X=C$UW5_JTE7R;FT+OaVaXb zI#9b$yrDYF}FY< z(7=k6F7+wi09y5MzR=AhZj4v*ow-)_kVE0FhPU3lZ-R6&x_{ro=ad);%vE@$a;Sje z4LotPGtfc4(!U%22^`%)rq<8!H<`nT0C}36DlD*JA7{=BN92CqpFcSD=uf8ondnr) zfz^9Digf%d-d`5rcuNYU8L0@pzzAw8pB?8YZ^qz7NnPE{xQI`RuHLxYJ!6?vZrxB$ z>_94MYY=s6edxcl8P<_$TXG;q$%D|Kq3zKmD7$iw%pA4=9gtwt2O{GP@bG&|$#+9` z{6qM+sFTp6cQW(@OVz1s>Up>Qd+VR#g9^ox7Ent>ZACgaq_ow3hA+=8mLxUANs5Fc z7Dn~b&G79Qq|#r{j`N;sTM(O4f0^eRAAqm`dzl#Bp)X5J z%^h0WJ`*-=8AxoXdNPrT;<`>wQ?HtPV^EKBkW3j0)zIr0Ux;V%Tz%zg!$k~)T7Z?i z?_A}#CGEo0&*er=Y@8R~91rtUA__)b1*p=94YGvY&$hPBg@$yG4;0rL@|e8uYhLOb zw`yrx=-MOkR}?nw|8jh0yMDmDNewORQ~;a@f>Vet_+FE-+#_Kg2k4P0V;0IK;bI2LN-d+B;*9{DZM9VeL)0u z8Gh4C`SG#DrHVl&I9~7`j)sUdc751}4k>V)pv0%AYOObKoo7)-eadaM8>_0!iG`9j zG+p2S3u*3&s0YJo0hvyPFJDxw`);1Rrk**tr_(8A`MB}gA2xyAOa*K}r~Z39LCaKy zZI%W0;UZz0;+##Cpw{(exw_AISm%m1@5BwH@_Bml%{w&40%XO9Rxc$XZf@lmnzeJj zBMy#Tzp^Uc6UUycV)xubbmmaE(gbRIyRUz z<5T(%Lw(RxPGo~nu49nzVH0PL6Nk3%2-s!h4DztX9=Q5Fi0+_RLi@|634Z#~C#sUh zCXMobq3gXi>SKXU0)0wSm4h3I0GGFbVer0EAj7^H-KWKY=62XHIyOA*2(|+Y9(YGa`-p z7)`U^J~+rlACj;^aVYn9T0<^Oy%}7&-ZDeD-Kt#eDmLDYeQa6mfS*V4p0i1X!_Q1T; z$&XQIAu&PXrA<3=*+9Jn>XN*9sbP>Q*|EbtEji9LJ%Gn z$Bx29&1KJAY`Ko$Y$ho8D=+|8*;$k_cY%u-yl@5W2+;F9ijEcLjxnNOX&Nd+Wl`WUoQ(`_HSXE;z*##y(Li z_mi+9T>b1D3Uv<;tS+$WtgO3L8pcN=ryYp7$i1d;V*&=IBlzSiw$4ArW0S3Rs>nY6 zhCyzDem}|Y;`|Iu5_;r@G!MgH{RDay28a=K-KZEXB|J0?K z3F9>9$>*fYOwIP2T=NV426o|`O~o3dqcx*2p|hKWVMBxb(fEn+l}Rrzzo=n(R68nj6Z%auAe_07?R`@AL5P%M!uhYd%|%)>`xoR zeB9MG!{@p&vsaCzT?@szZhv`MimiKZ|I91IIJ{ffRiPW^TbI4K*#1!`ak*3Fthff5 z?S+AJEpN!&>?418f#l|l-#b`eOn{Q=%hG(gNwH2%r>dx?Z)fz>Eb2`|z6BL03Y9ti z-ZIi6Nkr7Sb)Mbq$gz7Bfo_%=eL^~6jG+}uqmeJ*$?tklDav)nDm#N*z|YD~Vsz@_ z9z>jmH}dIC6w0Nk!j3HS(@tSU7#&WIQ(z2h_-5$CyNs2ipjSv4k zDp;o^)%4XQR|154!NL#=U8cv%_IaBv*qqKO7v@TR)2Z@sGtQJG>Yzb4mhTqcT_(#m zt(%?Sb!oNIg;{tE#Qf3k@_Yh_c-6~GvEFkK1nr@qP*vwq9N(9>vA(~N)%Z@O3Co4| zyA`afWJ==W6P~)-d)x)xsh&g=*;|+EU`;S*44T5ZD+|3#TWBqM;8{H7(NF^RBmT)ge)Vnm5o`YC2XuzU3NWsD-cQ-{V4W)yZSetAtkG`W}}R<{B-zbT~G}n}gJoxQ}F( z75gfotJDSVK|S3b;u|=g^V3d+XXAf)o%JZ!7)Aqg`IkRoGW@4jx-o02{1T+bnho4b8VhE5ZskkCf3|V$o2VvKL$Z z3F;-rHOkldbxHN7VHcZO-9(bn*W!lo7QWIZ%4#mmz?z@W`5xYg=;9YLI=G2=s)(Lb zPbB@@=No*=zz8AW;^rtIxgYMeT8SvS~Zz1B79s56pX2$%tCUBX0JH8Ys7RMIXe@w-HRWVj=Q|Z z8B-Wmrc}nB$2hVOYW<{kOAlL%>b598lqF-n=$*EZBKsh*p?oH+`A%NRV|{ZTn0Dg_ zY=Y|x!~Gk{F3&QW{fbUso^Q`r3-)UL{^PYvkhqlw-qKNbE5kON(=Cm6uOWmdf7Y)2 zs?X*G_o*R^zOLh4$$iJrEE`7Bdj61KJ^}Rb9P~zw;18}>viPUnhEdp5?!nIsN-K_) zhP@G#VD+AY24}7Ij#axkgnM=-NGPsm;##=s$z0}UW8r0A?T>co6P{$tlZBpqJ)>y5 zo5R`qjl=fDyjAI5r<_B@y zJ#GH<<**snhdF2)Ca3p7v0}?3qCC>~E4)MZrP}G(L@_;drgK`1re38ltg5bxY?4$~ zT6*izF!WC9DMwY+v}hfcOFX6Tw5;VJsb9XM_xZtv2Tm$h#W*NUiSq1Cm=!h?Plv$O z?kLMsz1;dt1J?(wgx5wHDt|VUpMbn|2wPxCLw-su4#FIHT{I!re@2oj+}FR^5dv4- z#(g0Q;4Cwc07gvNmy1LDrug*I*wvAh(wsxS*tx}4O&0}hR34h-+x>f~Z(>?Iv`ndQ z!$r9^SNP@A?-Z!e-Xcf)X{P1krNbODeo9StZX9*u`KN`+>F0u$oYxG;*D?0Jo3E-) zxw>A*o>QCB+_aqI45)~4hz@UISGO+K0~(p3+Wg=+9Pcoxs=*lF(jpnwdcS`&nSJIJ zSnZR19qtST+kQ-0OG!18(oA&aMi&?-hLaMxyhz5y@k5d;2CeLkl}4yUC3 zl1oIOQ)oFq^Ns5`vwRptqWyIFK5xq4zP!!^nV*MRtGsP~+{t?(P_iX!<==U46H}~d z_*ES*JnrRH8B7w()iV8IR?659mGI9Nal`OULsXTnGEW}N;$W9c{KqkkShLo{aebek z_G#J0_Vi8o%1j;o+4F28k5vcbFPgIH;|h*gZJyL3XEIi!&Aj#x$0c^**o#Wgv`I2M zw(u~}HooziTRXRXzF0<8fq-wZ&S$FFaVPf2q&^=mB<-xkV zx#cjuu`D51zD(9%yJywgdQ${0M?h)Aeu0?aeuQvNz;o?(yC$`C^=81Db!_+T9=q?# z(wy)SiDbsQdKpufQh2{Ib4H`J>tU=TeqjNYC;P0aPcm81^t)gYiv||N;&&5FzF6N;;-0VC@HODz;cY!xJ3FoF+r);K0v(ID1 zw`D7}O<0tUYwGIJX&RO!Ir4S}?lOvMq6%|)HJt83?{OO-o|iocc;p?PDQj;nZl+L_ z3uTfTI)sy2o#I)TYB`gHB4znbDTv3>#Meo0zgOk&d&%aydT&6ny#S7dmy5#p2gY32 zUOhZx{p;7UV2Qq8Zo>wFbu(2eIT~b~!{Td&i&QwvwkWGmb>y!|3J`^+!dzdNa*7*9 zR>2s`8fh_9bJM)*($lrPd^&zvsxWQ`=wI5+Cl9@7PfGutQ+d$ScD_wU+SMPEmPk>wX zMpuhmzf|^ZF|O)jajrysky?{F-1~zr@HSF526T)f(&~DRTU8oXN^nu*_{(he7pJKZ zxo;K1r5G^L?W_Ax5zAre*`Y5>osJH@&$?|u*HfUGKkxOa8MOHzU4VSsi+0*+n*=7j z&e;qeBj~M8)D0baNxw1cRB8B<4~0!uU>+8RO*_^#nT>S5D3iC>AK@H1oROY=S%Yq1 zrAN%JWZ-3XhoIcmrrYP*AQfv=8%Mclt;IXuf)9&)zNV`u1O`5P#(?{D$UIxml2@f+ zwgw*6AJ!Ro29dW=zNS-0Q!OG0x$Qm{^YYMS@|Z|ctE8$?I9qsnb`zl+Lf^sYsWy*4 z@YgmqL{Sp*p5CTb7J^@MbRc)71xBH;cPkBzJ{8hGGX25*8s3MBL#{Q2`b)We_g{G;M%2v}K^fc0m)?+HgcOIWpH+fdVjf7j+E|Jb77q^ZcGT z`xQLN2-VXbWgh_-UcceTgW7&bLT=u<99ChQP=zeodVA4paDR+(+Jnn{_2iJ7WrvpS z#yPoQ=W(0bXERiK0es)Y?m{uOMmcQiVChndHJws@(9II+V~fokBXHguwYuGpXHsQ! z%Jo!%XBhrHe9`e3=R-$rMSPs=IEpKSSeGK4)JhdSwZM$ye&GBwhBEERz<9 zn)QHJeTiLhD-oq|u-xjDDz}M}c=&q9_aAEGyo(y(ZemNZA+gy%6X4^<1MZrJaRMda z15$e5;Zun4a^2=@gp?LO)E{X(_FBdd&Shc=RbpJba1I#{E;Aulyr7y-Z?9HsLb^@@ zG7f1ZsbJjrak$thy6HndU?S0k>I7t8{)IU&!p*t6Z<))GWo2m+YvGDe3;1v^P4a`w z_zL7wc~oN9wzE1V{{&I79wKP#G4Sj%5IMAuTH5wUoi=KbTB6W$1Uvk2FN0c)9S zW%|K0u93saE1Zg8`?35E8sxDUP$0HPZc(1>1&nJcK4^@xom%Y~>B)v`1ey_Noasx4 zXjV1!(9K;V6}C+0VW)6L$k)W-dM`Hz0wUYIe44fI_K6CO)1x;$vSf7X@8fSo!!hG7 ze#*+4csHF^rJ9iHEz0n2%NPui0p`%^LaVq`^MsiWyCf1y_uC4FW6Qc7$kn1lqI%{#J7sTge{6U8q$pvM??{4 z$(k0Z%mj4M7*1mWz1H^qhiF|x$DR6O&!38T6x(xefyLs7Da}e<{1PyV<2WxWLaI;P zH|Jwz1#Al*T?S6ghrH%4totrmmN=?XgPxt&QWNtSr(Nqv?Eke(x)@9 zj{eMTdIkZI{`@b%1!sLyi-yd;Y*q3!JE&K2b)pno*~tN-QtxUeLJ3FwoE|C}-912=#23iLSFeMF0Mb`-`6PftR8% zWZ<^{%XNM+>;M=I^w{p#FW+(HS#3N0S>7_T8 zQPP5S4*Z)%_I2951zU9=UtiSP%1^39+$UtDgAOp?jAuojr=0HFv+{c zW<0=S4Dk!8rJtvnQ?L(zB`Z%8{{vfRtbz9s)SL3Abx{ZH0nY45o#Ps&fw5h>E)Nb} z&7A5J2PSr*U@|*!{iZB>%{6w|gF<;y6YqfqKH;ZBc-lA5Vq{>^Y;qjP84@CV~fFag&pBfKf3PaCI;I zsdDc{Px?XukiL5@11=*kC4@tw(qwN_+xLWa&<2$2tX7x*>BJCM$c@o?mR*yh!ej52 zHtqqDa`|=?doVBuK99D?DdWdeNIZ)*o?zNRk@7lwhD;j))TH5>pR*I>3}2_cDs1)- z&0^~wdm@8x@3vp5rqegYrUpWlA~OR-qHlR++x zsS0SX+U9qZUv%nL>|XD&3np{jQ&4aZM9G7Z%8A4UDA_z21JdV;>|Wyx`ZhSl;bAoT zWFDBH?DLGZGkEG)WUKp0wiHt;9h0sr6Mj|Q+tYQ#%e^3iBR#&|&h4`^M^I8(8@oN# z#+CgMl{S4!T7*}ifY&1GN=K)k#TB-5ph|B8vJ213$spr@e%-Hvb+M!OQ%cS0k!3)| zwNxs_L3*lH(DlfVFpN)5@;FA3f;^7G;mN<;H#Ygf92VavBB-oiZ$KJ6QD#TBObhgR zx^L_m3>3?_AlOm`U+bdhw#o0{yd%@V`S}Aj4Zy(!poM`jTj7Ufa}{eP7{v1DSM-}0 zF7?v->|I6TTn}m`jfo2DJ-A*Jw<|klYpH%R8Z}_>gxyT`Y1mB#P$@r5YFDM;FBnNWh&UNbH-wO zBC>xC9CJ}mt=CfTWK~_Zm7flVX?9=dV6*6ouh^;%q3UqRcU5;8>A0UK7%NVFSCIv% zO{_$SW4k2l{Eo)?q>yRa*$gu{E2!OR7c=1|R{GOa$uEHih_4kY+!+9TGvTiU-N}CL728vuC(eZ&Jzd>Ke18tR?_P)v4Q^2x861Iv;K^1Qrcux3j>Ad;YE=kQ@X5f*>4Sm-%R#H&LX8+pX0+e*)2^> z;B%90S(fU6AZYOU=5NQofhp6!eX+e)qa!^|CfNnaAheojkz}~?a~XeC1o}f@xy`S7 z)+wUVyBvv$B}cvQ<=%`N>6u-V_IFFaWV`t3o@k8c67tl+emV%>`ZR-dts@-ZZ1bTh zdFM8`dQMfTe3{LLZzKEOrg)it?Hc)BIpns9q|Pg?rM}$~&w3PUZvDUZu0N`&>yAHL zJF4Rp&s-~;BH9IE!VswfDoWHk3l_m@JF(>u#mdkUU{b}3A!oMcSX5XLP=X|97IkAn zP@EWQ4aJJDX97~|L4HUqSg0VqehZpH42#QUyjhTa9g+iY2l~FY`;t5BJj@ zN`#-+TDLEL96RgZZ+{GA3iQo%rs=-;D{blUsVtvxDAxjw|W-=57xC< zdp?+N_2);@yfRvk?c@|=O>YeQRCdqaz4NM1tKLo9x_sfI{(Fo0!{-)p!KDzBv+kIp z`Bm?Pz~+`Ev*uNvyVU&>%s(=VWbGqwUEVU>+TOdZrz1Y``e)vGo|U@1yPYd1bzgqw zrKC0p(1wOgo}F11?hn+<>YM; zT;rC}z1v-f_fB8!zT(d0p*diKz4)=5+A^n7SU&l}OExWkfpvKECe``VL2&RwOY@o0 zSpm7vnupT9&C-peuPxk_J#4K`(7I@vT3);{)d>+<{)nafTV4SvXvj=hp85FXH^|Gw zrEejN*Kq0*$d;XVKA$%F7RoS?lFGIssa=k&A?(O*$wOYJ5(!rf75tX|m-%pQ{5>x? zi3lq@Tg67gXq<89(R(>{*&XF1M1(3B*d7#a7dWt(--UMRZ0sjdYB&2yWYD!`pMqDk z4~N@vHMvknR@^XQa9qzZbHcwmT1$G11Y>#JAK*oB%EF=$zm#8zDeoMBJp*pVk9WL-e;cU*p(gRqA)`5o3-wfYZ^6y zuvUS%9cc^$6zW_*V6r|DNtNQ582=6%{t(~Ph(|}Vh%mYh2>-3H>|n+39pX*Ha&SS^ zdv`sL=hl9I^`9^RoT?+WTz#>h4>q|9Z1PXc?-Zq>^Uc58F_^Q!JYK+Hv-mp19e|xO zOv6UN9SCRi%Wt<6ZpDyzf-+11NF&F(D0QZMybpu);;hGxBG5StnbWDw=-7Q+)NyQc zk28|R*`Rg8D^Z~R6zF@M);+AVaX&06#Qc9~Ka-JP+Vj66SUkMw|A>G4X2u;8 zYl@!j;UN&uisBunUS@C1dBNxe*nkmace!@<{MXbQ&S*x9~)_@~xu_GG| z7hzz_wO5ehvgduFPMtk#6^N(yMZNiX0mPw{?VfTo@vbw;=o}CcN0{0(2j9R-<(Q9A{@7G!PSSIq2mNwnSClg zEROV+YUH=PvgU`kkrP7}K+=#rWFBNGGBW1d-!y>(!0J=ZJHcE~up5YF! zYHz(K5Ag`0utT!y=h@R#%{Ci%9R%;@SjRl1RqdFbhLzy321IsGF-=>JF9=`17_Bma zpQnM|nie|x_TrkEEdlQ@^tSP?&n*j=tknswI|@J`WNeM$c}W zHR6`N%T~7VW9j~|bdp^P_5aa$3wZQ^9f3<#XK>5wKWdx41O^llc4wdQ{biEIj3yr`e#e9l&fM+Ag`kkH&Ro6T=6a^#3f zgXmT(&h(RNee5t4c=@kA{xi4R@Hbz_+@;jM{`1v)w%bW|su$DxzCmC1ec34%?KhuV({4YK-kHxheL2o#i^0Tw)+udX3E~u$xqD{AwuI4(h<5YSEGPw_b&p0$%i^Fq5 z1+d4zux}LP&~KQ1BWW-MLA8Vo0Yc&#f`cSYRJBNYh5+$2YvB6K5(|VKCWgMcd;=xB zWTzMql4+nwNTz`RA(;ls5Rz#iKs?Q+fs$G>2Mh?w98e@Ab3lNQ%mHPHr^_6uFC^BW z`0?}mZ--pSoNvI=scbCC{>3LGLy9`=or9Qw_%ZzK(d zf-E6JfRK2G;2@Wzi2xz#8G?hPfe8+hZK60xR+|7Jxe$~gBo~4JA-NC)hyPa>;%jd6 X#}ga=5v1IRa0p$s_SKRVia-Aw*xrVx literal 0 HcmV?d00001 From c78d849e8ff4ab34a1a3b0d03900198bdef3a762 Mon Sep 17 00:00:00 2001 From: con-docs Date: Mon, 31 Mar 2025 16:22:01 -0500 Subject: [PATCH 03/82] devrel-2066 --- docs/api/authorization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/authorization.md b/docs/api/authorization.md index d58e543aa..e65a4ac07 100644 --- a/docs/api/authorization.md +++ b/docs/api/authorization.md @@ -90,7 +90,7 @@ SailPoint is working to define scopes for every endpoint, but you may encounter ## Assigning Scopes with the UI -When you create a PAT in the UI, you can apply scopes to the token. More information on how to do this will be added in the near future. +When you generate a PAT with the UI, a list of scopes available to you will display in the window. To apply the desired scopes to your PAT, toggle them on before you select 'Create'. To learn more about generating a PAT and assigning scopes, refer to [Managing API Keys and Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html). ## Assigning Scopes with the API From 3cf8d9759a33bf6829fffb81810558459626a2bc Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Tue, 1 Apr 2025 19:07:14 +0000 Subject: [PATCH 04/82] Automated commit by github action: 14203954833 --- static/api-specs/nerm/paths/isc_account.yaml | 2 ++ .../nerm/requestBodies/PATCH/ProfileAccount.yaml | 8 -------- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/static/api-specs/nerm/paths/isc_account.yaml b/static/api-specs/nerm/paths/isc_account.yaml index 6628942af..155ee0e2f 100644 --- a/static/api-specs/nerm/paths/isc_account.yaml +++ b/static/api-specs/nerm/paths/isc_account.yaml @@ -19,6 +19,8 @@ patch: description: Updates a profile only through ISC schema-mapped attributes, performs a reverse mapping to match the NERM attributes to update. tags: - isc accounts + parameters: + - $ref: "../parameters/path/id.yaml" requestBody: $ref: "../requestBodies/PATCH/ProfileAccount.yaml" responses: diff --git a/static/api-specs/nerm/requestBodies/PATCH/ProfileAccount.yaml b/static/api-specs/nerm/requestBodies/PATCH/ProfileAccount.yaml index 29395f953..edf693384 100644 --- a/static/api-specs/nerm/requestBodies/PATCH/ProfileAccount.yaml +++ b/static/api-specs/nerm/requestBodies/PATCH/ProfileAccount.yaml @@ -3,14 +3,6 @@ content: schema: type: object properties: - id: - name: id - in: query - required: true - type: string - format: uuid - description: The profile account id. - example: 79ed1cb6-9977-4965-9bfe-f2bcc2424444 profile: name: profile in: body From d1aa6b47b00b543f3ec5265a8c44b280cec02d35 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Tue, 1 Apr 2025 21:12:21 +0000 Subject: [PATCH 05/82] Automated commit by github action: 14206119690 --- .../idn/beta/paths/access-profiles.yaml | 10 +++--- static/api-specs/idn/beta/paths/roles.yaml | 7 ++-- .../idn/beta/paths/workflow-execution.yaml | 4 ++- .../idn/beta/schemas/WorkflowExecution.yaml | 1 + .../idn/v2024/paths/access-profiles.yaml | 10 +++--- static/api-specs/idn/v2024/paths/roles.yaml | 7 ++-- .../idn/v2024/paths/workflow-execution.yaml | 4 ++- .../idn/v2024/schemas/WorkflowExecution.yaml | 1 + .../v2024/schemas/access/AccessProfile.yaml | 34 +++++++++---------- .../access/AccessProfileApprovalScheme.yaml | 4 +-- .../access/AccessProfileSourceRef.yaml | 6 ++-- .../v2024/schemas/access/OwnerReference.yaml | 6 ++-- .../access/ProvisioningCriteriaLevel1.yaml | 14 ++++---- .../access/ProvisioningCriteriaLevel2.yaml | 14 ++++---- .../access/ProvisioningCriteriaLevel3.yaml | 18 +++++----- .../access/ProvisioningCriteriaOperation.yaml | 2 +- .../v2024/schemas/access/Requestability.yaml | 12 +++++-- .../schemas/access/RequestabilityForRole.yaml | 6 ++++ .../v2024/schemas/access/Revocability.yaml | 2 +- .../idn/v2025/paths/access-profiles.yaml | 10 +++--- static/api-specs/idn/v2025/paths/roles.yaml | 7 ++-- .../idn/v2025/paths/workflow-execution.yaml | 4 ++- .../idn/v2025/schemas/WorkflowExecution.yaml | 1 + .../v2025/schemas/access/AccessProfile.yaml | 34 +++++++++---------- .../access/AccessProfileApprovalScheme.yaml | 4 +-- .../access/AccessProfileSourceRef.yaml | 6 ++-- .../v2025/schemas/access/OwnerReference.yaml | 6 ++-- .../access/ProvisioningCriteriaLevel1.yaml | 14 ++++---- .../access/ProvisioningCriteriaLevel2.yaml | 14 ++++---- .../access/ProvisioningCriteriaLevel3.yaml | 18 +++++----- .../access/ProvisioningCriteriaOperation.yaml | 2 +- .../v2025/schemas/access/Requestability.yaml | 12 +++++-- .../schemas/access/RequestabilityForRole.yaml | 6 ++++ .../v2025/schemas/access/Revocability.yaml | 2 +- 34 files changed, 172 insertions(+), 130 deletions(-) diff --git a/static/api-specs/idn/beta/paths/access-profiles.yaml b/static/api-specs/idn/beta/paths/access-profiles.yaml index 202217988..67f6656c4 100644 --- a/static/api-specs/idn/beta/paths/access-profiles.yaml +++ b/static/api-specs/idn/beta/paths/access-profiles.yaml @@ -41,7 +41,7 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* @@ -128,8 +128,8 @@ post: description: >- Create an access profile. - A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the - access profile's Source. + A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the + access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. @@ -157,8 +157,8 @@ post: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:access-profile:manage] - - applicationAuth: [idn:access-profile:manage] + - userAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] + - applicationAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] x-sailpoint-userLevels: - ORG_ADMIN - ROLE_ADMIN diff --git a/static/api-specs/idn/beta/paths/roles.yaml b/static/api-specs/idn/beta/paths/roles.yaml index 34a9b54cd..8cd019665 100644 --- a/static/api-specs/idn/beta/paths/roles.yaml +++ b/static/api-specs/idn/beta/paths/roles.yaml @@ -42,16 +42,19 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* - **modified**: *gt, lt, ge, le* + **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + + + **dimensional**: *eq* example: requestable eq false required: false - in: query diff --git a/static/api-specs/idn/beta/paths/workflow-execution.yaml b/static/api-specs/idn/beta/paths/workflow-execution.yaml index 08ca2c0af..8a06b81ea 100644 --- a/static/api-specs/idn/beta/paths/workflow-execution.yaml +++ b/static/api-specs/idn/beta/paths/workflow-execution.yaml @@ -4,7 +4,9 @@ get: - Workflows summary: Get Workflow Execution description: >- - Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + x-sailpoint-userLevels: + - ORG_ADMIN security: - userAuth: [sp:workflow:read] parameters: diff --git a/static/api-specs/idn/beta/schemas/WorkflowExecution.yaml b/static/api-specs/idn/beta/schemas/WorkflowExecution.yaml index ae3f6a3a3..e0a41afce 100644 --- a/static/api-specs/idn/beta/schemas/WorkflowExecution.yaml +++ b/static/api-specs/idn/beta/schemas/WorkflowExecution.yaml @@ -29,6 +29,7 @@ properties: - "Completed" - "Failed" - "Canceled" + - "Queued" - "Running" example: "Completed" diff --git a/static/api-specs/idn/v2024/paths/access-profiles.yaml b/static/api-specs/idn/v2024/paths/access-profiles.yaml index a9a148c70..e4bdd4fad 100644 --- a/static/api-specs/idn/v2024/paths/access-profiles.yaml +++ b/static/api-specs/idn/v2024/paths/access-profiles.yaml @@ -41,7 +41,7 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* @@ -131,8 +131,8 @@ post: description: >- Create an access profile. - A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the - access profile's Source. + A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the + access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. @@ -160,8 +160,8 @@ post: '500': $ref: '../responses/500.yaml' security: - - userAuth: [idn:access-profile:manage] - - applicationAuth: [idn:access-profile:manage] + - userAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] + - applicationAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] x-sailpoint-userLevels: - ORG_ADMIN - ROLE_ADMIN diff --git a/static/api-specs/idn/v2024/paths/roles.yaml b/static/api-specs/idn/v2024/paths/roles.yaml index 4aa02ed36..d085c5ce9 100644 --- a/static/api-specs/idn/v2024/paths/roles.yaml +++ b/static/api-specs/idn/v2024/paths/roles.yaml @@ -42,16 +42,19 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* - **modified**: *gt, lt, ge, le* + **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + + + **dimensional**: *eq* example: requestable eq false required: false - in: query diff --git a/static/api-specs/idn/v2024/paths/workflow-execution.yaml b/static/api-specs/idn/v2024/paths/workflow-execution.yaml index ea73228d7..256c60796 100644 --- a/static/api-specs/idn/v2024/paths/workflow-execution.yaml +++ b/static/api-specs/idn/v2024/paths/workflow-execution.yaml @@ -4,7 +4,9 @@ get: - Workflows summary: Get Workflow Execution description: >- - Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + x-sailpoint-userLevels: + - ORG_ADMIN security: - userAuth: [sp:workflow:read] parameters: diff --git a/static/api-specs/idn/v2024/schemas/WorkflowExecution.yaml b/static/api-specs/idn/v2024/schemas/WorkflowExecution.yaml index ae3f6a3a3..e0a41afce 100644 --- a/static/api-specs/idn/v2024/schemas/WorkflowExecution.yaml +++ b/static/api-specs/idn/v2024/schemas/WorkflowExecution.yaml @@ -29,6 +29,7 @@ properties: - "Completed" - "Failed" - "Canceled" + - "Queued" - "Running" example: "Completed" diff --git a/static/api-specs/idn/v2024/schemas/access/AccessProfile.yaml b/static/api-specs/idn/v2024/schemas/access/AccessProfile.yaml index d18f0a6a0..46c444239 100644 --- a/static/api-specs/idn/v2024/schemas/access/AccessProfile.yaml +++ b/static/api-specs/idn/v2024/schemas/access/AccessProfile.yaml @@ -1,71 +1,71 @@ type: object -description: Access Profile +description: Access profile. properties: id: type: string - description: The ID of the Access Profile + description: Access profile ID. example: 2c91808a7190d06e01719938fcd20792 readOnly: true name: type: string - description: Name of the Access Profile + description: Access profile name. example: Employee-database-read-write description: type: string nullable: true - description: Information about the Access Profile + description: Access profile description. example: Collection of entitlements to read/write the employee database created: type: string - description: Date the Access Profile was created + description: Date and time when the access profile was created. format: 'date-time' example: '2021-03-01T22:32:58.104Z' readOnly: true modified: type: string - description: Date the Access Profile was last modified. + description: Date and time when the access profile was last modified. format: 'date-time' example: '2021-03-02T20:22:28.104Z' readOnly: true enabled: type: boolean - default: true - description: Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. + default: false + description: Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. example: true owner: $ref: './OwnerReference.yaml' - description: Owner of the Access Profile + description: Access profile owner. source: $ref: './AccessProfileSourceRef.yaml' entitlements: type: array nullable: true - description: A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + description: List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. items: $ref: './EntitlementRef.yaml' requestable: type: boolean default: true description: >- - Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported - for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value + Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported + for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. example: true accessRequestConfig: $ref: './Requestability.yaml' nullable: true - description: Access request configuration for this object + description: Access request configuration for the object. revocationRequestConfig: $ref: './Revocability.yaml' nullable: true description: >- - Revocation request configuration for this object. + Revocation request configuration for the object. segments: type: array nullable: true items: type: string - description: List of IDs of segments, if any, to which this Access Profile is assigned. + description: List of segment IDs, if any, that the access profile is assigned to. example: [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" @@ -73,8 +73,8 @@ properties: provisioningCriteria: $ref: './ProvisioningCriteriaLevel1.yaml' description: >- - When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression - is evaluated against those Accounts to choose one to provision with the Access Profile. + When an identity has multiple accounts on the source the access profile is associated with, the API evaluates this expression + against those accounts to choose one to provision with the access profile. nullable: true example: { "operation": "OR", diff --git a/static/api-specs/idn/v2024/schemas/access/AccessProfileApprovalScheme.yaml b/static/api-specs/idn/v2024/schemas/access/AccessProfileApprovalScheme.yaml index 9691e9a96..64849c3e9 100644 --- a/static/api-specs/idn/v2024/schemas/access/AccessProfileApprovalScheme.yaml +++ b/static/api-specs/idn/v2024/schemas/access/AccessProfileApprovalScheme.yaml @@ -9,7 +9,7 @@ properties: - MANAGER - GOVERNANCE_GROUP description: >- - Describes the individual or group that is responsible for an approval step. Values are as follows. + Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application @@ -29,7 +29,7 @@ properties: approverId: type: string nullable: true - description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP + description: Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. example: 46c79819-a69f-49a2-becb-12c971ae66c6 diff --git a/static/api-specs/idn/v2024/schemas/access/AccessProfileSourceRef.yaml b/static/api-specs/idn/v2024/schemas/access/AccessProfileSourceRef.yaml index 7de02a342..dd0866bb7 100644 --- a/static/api-specs/idn/v2024/schemas/access/AccessProfileSourceRef.yaml +++ b/static/api-specs/idn/v2024/schemas/access/AccessProfileSourceRef.yaml @@ -2,15 +2,15 @@ type: object properties: id: type: string - description: The ID of the Source with with which the Access Profile is associated + description: ID of the source the access profile is associated with. example: 2c91809773dee3610173fdb0b6061ef4 type: type: string enum: - SOURCE - description: The type of the Source, will always be SOURCE + description: Source's DTO type. example: SOURCE name: type: string - description: The display name of the associated Source + description: Source name. example: "ODS-AD-SOURCE" diff --git a/static/api-specs/idn/v2024/schemas/access/OwnerReference.yaml b/static/api-specs/idn/v2024/schemas/access/OwnerReference.yaml index eed01a878..32b171536 100644 --- a/static/api-specs/idn/v2024/schemas/access/OwnerReference.yaml +++ b/static/api-specs/idn/v2024/schemas/access/OwnerReference.yaml @@ -1,6 +1,6 @@ type: object nullable: false -description: The owner of this object. +description: Owner of the object. properties: type: type: string @@ -10,9 +10,9 @@ properties: example: 'IDENTITY' id: type: string - description: Identity id + description: Owner's identity ID. example: '2c9180a46faadee4016fb4e018c20639' name: type: string - description: Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. + description: Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. example: 'support' diff --git a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel1.yaml b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel1.yaml index 7a5c05e2b..27b78a08c 100644 --- a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel1.yaml +++ b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel1.yaml @@ -1,23 +1,23 @@ type: object nullable: true -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: array @@ -25,7 +25,7 @@ properties: $ref: './ProvisioningCriteriaLevel2.yaml' nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null diff --git a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel2.yaml b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel2.yaml index 02f0a3730..063b605ff 100644 --- a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel2.yaml +++ b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel2.yaml @@ -1,22 +1,22 @@ type: object -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: array @@ -24,7 +24,7 @@ properties: $ref: './ProvisioningCriteriaLevel3.yaml' nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null diff --git a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel3.yaml b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel3.yaml index 97dd2b61d..8ab352c4d 100644 --- a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel3.yaml +++ b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel3.yaml @@ -1,28 +1,28 @@ type: object -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string + nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: string + nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null - nullable: true - diff --git a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaOperation.yaml b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaOperation.yaml index 45cd8346e..5ebc9c606 100644 --- a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaOperation.yaml +++ b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaOperation.yaml @@ -6,6 +6,6 @@ enum: - HAS - AND - OR -description: Supported operations on ProvisioningCriteria +description: Supported operations on `ProvisioningCriteria`. example: EQUALS diff --git a/static/api-specs/idn/v2024/schemas/access/Requestability.yaml b/static/api-specs/idn/v2024/schemas/access/Requestability.yaml index 48091512e..81796c57c 100644 --- a/static/api-specs/idn/v2024/schemas/access/Requestability.yaml +++ b/static/api-specs/idn/v2024/schemas/access/Requestability.yaml @@ -3,20 +3,26 @@ nullable : true properties: commentsRequired: type: boolean - description: Whether the requester of the containing object must provide comments justifying the request + description: Indicates whether the requester of the containing object must provide comments justifying the request. example: true nullable: true default: false denialCommentsRequired: type: boolean - description: Whether an approver must provide comments when denying the request + description: Indicates whether an approver must provide comments when denying the request. + example: true + nullable: true + default: false + reauthorizationRequired: + type: boolean + description: Indicates whether reauthorization is required for the request. example: true nullable: true default: false approvalSchemes: type: array nullable : true - description: List describing the steps in approving the request + description: List describing the steps involved in approving the request. items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v2024/schemas/access/RequestabilityForRole.yaml b/static/api-specs/idn/v2024/schemas/access/RequestabilityForRole.yaml index 5e26e325b..4b0e9d5cf 100644 --- a/static/api-specs/idn/v2024/schemas/access/RequestabilityForRole.yaml +++ b/static/api-specs/idn/v2024/schemas/access/RequestabilityForRole.yaml @@ -12,6 +12,12 @@ properties: example: true nullable: true default: false + reauthorizationRequired: + type: boolean + description: Indicates whether reauthorization is required for the request. + example: true + nullable: true + default: false approvalSchemes: type: array description: List describing the steps in approving the request diff --git a/static/api-specs/idn/v2024/schemas/access/Revocability.yaml b/static/api-specs/idn/v2024/schemas/access/Revocability.yaml index 505d191b1..657e27745 100644 --- a/static/api-specs/idn/v2024/schemas/access/Revocability.yaml +++ b/static/api-specs/idn/v2024/schemas/access/Revocability.yaml @@ -4,7 +4,7 @@ properties: approvalSchemes: type: array nullable: true - description: List describing the steps in approving the revocation request + description: List describing the steps involved in approving the revocation request. items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v2025/paths/access-profiles.yaml b/static/api-specs/idn/v2025/paths/access-profiles.yaml index a9a148c70..e4bdd4fad 100644 --- a/static/api-specs/idn/v2025/paths/access-profiles.yaml +++ b/static/api-specs/idn/v2025/paths/access-profiles.yaml @@ -41,7 +41,7 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* @@ -131,8 +131,8 @@ post: description: >- Create an access profile. - A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the - access profile's Source. + A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the + access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. @@ -160,8 +160,8 @@ post: '500': $ref: '../responses/500.yaml' security: - - userAuth: [idn:access-profile:manage] - - applicationAuth: [idn:access-profile:manage] + - userAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] + - applicationAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] x-sailpoint-userLevels: - ORG_ADMIN - ROLE_ADMIN diff --git a/static/api-specs/idn/v2025/paths/roles.yaml b/static/api-specs/idn/v2025/paths/roles.yaml index 4aa02ed36..d085c5ce9 100644 --- a/static/api-specs/idn/v2025/paths/roles.yaml +++ b/static/api-specs/idn/v2025/paths/roles.yaml @@ -42,16 +42,19 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* - **modified**: *gt, lt, ge, le* + **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + + + **dimensional**: *eq* example: requestable eq false required: false - in: query diff --git a/static/api-specs/idn/v2025/paths/workflow-execution.yaml b/static/api-specs/idn/v2025/paths/workflow-execution.yaml index ea73228d7..256c60796 100644 --- a/static/api-specs/idn/v2025/paths/workflow-execution.yaml +++ b/static/api-specs/idn/v2025/paths/workflow-execution.yaml @@ -4,7 +4,9 @@ get: - Workflows summary: Get Workflow Execution description: >- - Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + x-sailpoint-userLevels: + - ORG_ADMIN security: - userAuth: [sp:workflow:read] parameters: diff --git a/static/api-specs/idn/v2025/schemas/WorkflowExecution.yaml b/static/api-specs/idn/v2025/schemas/WorkflowExecution.yaml index ae3f6a3a3..e0a41afce 100644 --- a/static/api-specs/idn/v2025/schemas/WorkflowExecution.yaml +++ b/static/api-specs/idn/v2025/schemas/WorkflowExecution.yaml @@ -29,6 +29,7 @@ properties: - "Completed" - "Failed" - "Canceled" + - "Queued" - "Running" example: "Completed" diff --git a/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml b/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml index d18f0a6a0..46c444239 100644 --- a/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml +++ b/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml @@ -1,71 +1,71 @@ type: object -description: Access Profile +description: Access profile. properties: id: type: string - description: The ID of the Access Profile + description: Access profile ID. example: 2c91808a7190d06e01719938fcd20792 readOnly: true name: type: string - description: Name of the Access Profile + description: Access profile name. example: Employee-database-read-write description: type: string nullable: true - description: Information about the Access Profile + description: Access profile description. example: Collection of entitlements to read/write the employee database created: type: string - description: Date the Access Profile was created + description: Date and time when the access profile was created. format: 'date-time' example: '2021-03-01T22:32:58.104Z' readOnly: true modified: type: string - description: Date the Access Profile was last modified. + description: Date and time when the access profile was last modified. format: 'date-time' example: '2021-03-02T20:22:28.104Z' readOnly: true enabled: type: boolean - default: true - description: Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. + default: false + description: Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. example: true owner: $ref: './OwnerReference.yaml' - description: Owner of the Access Profile + description: Access profile owner. source: $ref: './AccessProfileSourceRef.yaml' entitlements: type: array nullable: true - description: A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + description: List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. items: $ref: './EntitlementRef.yaml' requestable: type: boolean default: true description: >- - Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported - for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value + Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported + for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. example: true accessRequestConfig: $ref: './Requestability.yaml' nullable: true - description: Access request configuration for this object + description: Access request configuration for the object. revocationRequestConfig: $ref: './Revocability.yaml' nullable: true description: >- - Revocation request configuration for this object. + Revocation request configuration for the object. segments: type: array nullable: true items: type: string - description: List of IDs of segments, if any, to which this Access Profile is assigned. + description: List of segment IDs, if any, that the access profile is assigned to. example: [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" @@ -73,8 +73,8 @@ properties: provisioningCriteria: $ref: './ProvisioningCriteriaLevel1.yaml' description: >- - When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression - is evaluated against those Accounts to choose one to provision with the Access Profile. + When an identity has multiple accounts on the source the access profile is associated with, the API evaluates this expression + against those accounts to choose one to provision with the access profile. nullable: true example: { "operation": "OR", diff --git a/static/api-specs/idn/v2025/schemas/access/AccessProfileApprovalScheme.yaml b/static/api-specs/idn/v2025/schemas/access/AccessProfileApprovalScheme.yaml index 9691e9a96..64849c3e9 100644 --- a/static/api-specs/idn/v2025/schemas/access/AccessProfileApprovalScheme.yaml +++ b/static/api-specs/idn/v2025/schemas/access/AccessProfileApprovalScheme.yaml @@ -9,7 +9,7 @@ properties: - MANAGER - GOVERNANCE_GROUP description: >- - Describes the individual or group that is responsible for an approval step. Values are as follows. + Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application @@ -29,7 +29,7 @@ properties: approverId: type: string nullable: true - description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP + description: Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. example: 46c79819-a69f-49a2-becb-12c971ae66c6 diff --git a/static/api-specs/idn/v2025/schemas/access/AccessProfileSourceRef.yaml b/static/api-specs/idn/v2025/schemas/access/AccessProfileSourceRef.yaml index 7de02a342..dd0866bb7 100644 --- a/static/api-specs/idn/v2025/schemas/access/AccessProfileSourceRef.yaml +++ b/static/api-specs/idn/v2025/schemas/access/AccessProfileSourceRef.yaml @@ -2,15 +2,15 @@ type: object properties: id: type: string - description: The ID of the Source with with which the Access Profile is associated + description: ID of the source the access profile is associated with. example: 2c91809773dee3610173fdb0b6061ef4 type: type: string enum: - SOURCE - description: The type of the Source, will always be SOURCE + description: Source's DTO type. example: SOURCE name: type: string - description: The display name of the associated Source + description: Source name. example: "ODS-AD-SOURCE" diff --git a/static/api-specs/idn/v2025/schemas/access/OwnerReference.yaml b/static/api-specs/idn/v2025/schemas/access/OwnerReference.yaml index eed01a878..32b171536 100644 --- a/static/api-specs/idn/v2025/schemas/access/OwnerReference.yaml +++ b/static/api-specs/idn/v2025/schemas/access/OwnerReference.yaml @@ -1,6 +1,6 @@ type: object nullable: false -description: The owner of this object. +description: Owner of the object. properties: type: type: string @@ -10,9 +10,9 @@ properties: example: 'IDENTITY' id: type: string - description: Identity id + description: Owner's identity ID. example: '2c9180a46faadee4016fb4e018c20639' name: type: string - description: Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. + description: Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. example: 'support' diff --git a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel1.yaml b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel1.yaml index 7a5c05e2b..27b78a08c 100644 --- a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel1.yaml +++ b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel1.yaml @@ -1,23 +1,23 @@ type: object nullable: true -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: array @@ -25,7 +25,7 @@ properties: $ref: './ProvisioningCriteriaLevel2.yaml' nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null diff --git a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel2.yaml b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel2.yaml index 02f0a3730..063b605ff 100644 --- a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel2.yaml +++ b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel2.yaml @@ -1,22 +1,22 @@ type: object -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: array @@ -24,7 +24,7 @@ properties: $ref: './ProvisioningCriteriaLevel3.yaml' nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null diff --git a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel3.yaml b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel3.yaml index 97dd2b61d..8ab352c4d 100644 --- a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel3.yaml +++ b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel3.yaml @@ -1,28 +1,28 @@ type: object -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string + nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: string + nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null - nullable: true - diff --git a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaOperation.yaml b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaOperation.yaml index 45cd8346e..5ebc9c606 100644 --- a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaOperation.yaml +++ b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaOperation.yaml @@ -6,6 +6,6 @@ enum: - HAS - AND - OR -description: Supported operations on ProvisioningCriteria +description: Supported operations on `ProvisioningCriteria`. example: EQUALS diff --git a/static/api-specs/idn/v2025/schemas/access/Requestability.yaml b/static/api-specs/idn/v2025/schemas/access/Requestability.yaml index 48091512e..81796c57c 100644 --- a/static/api-specs/idn/v2025/schemas/access/Requestability.yaml +++ b/static/api-specs/idn/v2025/schemas/access/Requestability.yaml @@ -3,20 +3,26 @@ nullable : true properties: commentsRequired: type: boolean - description: Whether the requester of the containing object must provide comments justifying the request + description: Indicates whether the requester of the containing object must provide comments justifying the request. example: true nullable: true default: false denialCommentsRequired: type: boolean - description: Whether an approver must provide comments when denying the request + description: Indicates whether an approver must provide comments when denying the request. + example: true + nullable: true + default: false + reauthorizationRequired: + type: boolean + description: Indicates whether reauthorization is required for the request. example: true nullable: true default: false approvalSchemes: type: array nullable : true - description: List describing the steps in approving the request + description: List describing the steps involved in approving the request. items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v2025/schemas/access/RequestabilityForRole.yaml b/static/api-specs/idn/v2025/schemas/access/RequestabilityForRole.yaml index 5e26e325b..4b0e9d5cf 100644 --- a/static/api-specs/idn/v2025/schemas/access/RequestabilityForRole.yaml +++ b/static/api-specs/idn/v2025/schemas/access/RequestabilityForRole.yaml @@ -12,6 +12,12 @@ properties: example: true nullable: true default: false + reauthorizationRequired: + type: boolean + description: Indicates whether reauthorization is required for the request. + example: true + nullable: true + default: false approvalSchemes: type: array description: List describing the steps in approving the request diff --git a/static/api-specs/idn/v2025/schemas/access/Revocability.yaml b/static/api-specs/idn/v2025/schemas/access/Revocability.yaml index 505d191b1..657e27745 100644 --- a/static/api-specs/idn/v2025/schemas/access/Revocability.yaml +++ b/static/api-specs/idn/v2025/schemas/access/Revocability.yaml @@ -4,7 +4,7 @@ properties: approvalSchemes: type: array nullable: true - description: List describing the steps in approving the revocation request + description: List describing the steps involved in approving the revocation request. items: $ref: './AccessProfileApprovalScheme.yaml' From e0cd17773ead75d2c492bd7957a51dca6a018076 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Tue, 1 Apr 2025 21:13:44 +0000 Subject: [PATCH 06/82] Update to powershell SDK docs: 14206146282 --- .../Beta/Methods/BetaAccessProfilesApi.md | 6 +++--- .../Reference/Beta/Methods/BetaRolesApi.md | 4 ++-- .../Reference/Beta/Methods/BetaWorkflowsApi.md | 2 +- .../Reference/Beta/Models/WorkflowExecution.md | 2 +- .../V2024/Methods/V2024AccessProfilesApi.md | 7 ++++--- .../Reference/V2024/Methods/V2024RolesApi.md | 5 +++-- .../Reference/V2024/Models/AccessProfile.md | 18 +++++++++--------- .../Models/AccessProfileApprovalScheme.md | 4 ++-- .../V2024/Models/AccessProfileSourceRef.md | 6 +++--- .../Reference/V2024/Models/OwnerReference.md | 4 ++-- .../V2024/Models/ProvisioningCriteriaLevel1.md | 6 +++--- .../V2024/Models/ProvisioningCriteriaLevel2.md | 6 +++--- .../V2024/Models/ProvisioningCriteriaLevel3.md | 6 +++--- .../Reference/V2024/Models/Requestability.md | 8 +++++--- .../V2024/Models/RequestabilityForRole.md | 2 ++ .../Reference/V2024/Models/Revocability.md | 2 +- .../beta/powershell_code_examples_overlay.yaml | 4 ++-- .../powershell_code_examples_overlay.yaml | 6 ++++-- 18 files changed, 53 insertions(+), 45 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md index 6dcb94423..f4aad6090 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md @@ -63,7 +63,7 @@ Method | HTTP request | Description ## create-access-profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-profile) @@ -409,7 +409,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -437,7 +437,7 @@ $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returne $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md index 647f2a44c..69eb7f771 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md @@ -541,7 +541,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -569,7 +569,7 @@ $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filter $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) +$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md index 4a4794c44..3e1b7d0c7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md @@ -221,7 +221,7 @@ try { [[Back to top]](#) ## get-workflow-execution -Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. +Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md index 8e629a09c..4bcd9f6c3 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Queued", "Running" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md index 2bb57db17..ced98a283 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md @@ -63,7 +63,7 @@ Method | HTTP request | Description ## create-access-profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-profile) @@ -127,6 +127,7 @@ $AccessProfile = @"{ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -411,7 +412,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -439,7 +440,7 @@ $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returne $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md index f8c5ecfba..9bd35f8b7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md @@ -226,6 +226,7 @@ $Role = @"{ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -693,7 +694,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -721,7 +722,7 @@ $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filter $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) +$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfile.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfile.md index f321fe3cc..b5fd787d8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfile.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfile.md @@ -16,19 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2024AccessProfile'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Access Profile | [optional] [readonly] -**Name** | **String** | Name of the Access Profile | [required] -**Description** | **String** | Information about the Access Profile | [optional] -**Created** | **System.DateTime** | Date the Access Profile was created | [optional] [readonly] -**Modified** | **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly] -**Enabled** | **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $true] +**Id** | **String** | Access profile ID. | [optional] [readonly] +**Name** | **String** | Access profile name. | [required] +**Description** | **String** | Access profile description. | [optional] +**Created** | **System.DateTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | **System.DateTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | **Boolean** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to $false] **Owner** | [**OwnerReference**](owner-reference) | | [required] **Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**Requestable** | **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] +**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | **Boolean** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] **AccessRequestConfig** | [**Requestability**](requestability) | | [optional] **RevocationRequestConfig** | [**Revocability**](revocability) | | [optional] -**Segments** | **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**Segments** | **[]String** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **ProvisioningCriteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileApprovalScheme.md index 20de748ee..26a341d4e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2024A Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**ApproverId** | **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | **String** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileSourceRef.md index 7c26ea9e2..128ef305f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2024Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Source with with which the Access Profile is associated | [optional] -**Type** | **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional] -**Name** | **String** | The display name of the associated Source | [optional] +**Id** | **String** | ID of the source the access profile is associated with. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Source's DTO type. | [optional] +**Name** | **String** | Source name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/OwnerReference.md b/docs/tools/sdk/powershell/Reference/V2024/Models/OwnerReference.md index 7162164fa..37bb8bd89 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/OwnerReference.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/OwnerReference.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2024OwnerReference Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Type** | **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | **String** | Identity id | [optional] -**Name** | **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**Id** | **String** | Owner's identity ID. | [optional] +**Name** | **String** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel1.md index 918414740..887d25481 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel1.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2024Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel2.md index 65cf9301a..c8a8bea1b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel2.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2024Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel3.md index d9a003155..3620e8740 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel3.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2024Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | **String** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Requestability.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Requestability.md index 2a743b213..d2bfdbcd3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Requestability.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2024Requestability Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**CommentsRequired** | **Boolean** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to $false] +**DenialCommentsRequired** | **Boolean** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $Requestability = Initialize-PSSailpoint.V2024Requestability -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestabilityForRole.md index 82c2e3a01..640e338ab 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] **DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] **ApprovalSchemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $RequestabilityForRole = Initialize-PSSailpoint.V2024RequestabilityForRole -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Revocability.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Revocability.md index 927a62073..19313372f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Revocability.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2024Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] ## Examples diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index 407d57ebf..ad831aa53 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -278,7 +278,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) @@ -9754,7 +9754,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index 833f00fcd..f2656ac8f 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -121,6 +121,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -282,7 +283,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) @@ -11967,6 +11968,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -12199,7 +12201,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) From b3d4b9a599661a16e3ac64e53af1f8d07ce2eff9 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Tue, 1 Apr 2025 21:14:08 +0000 Subject: [PATCH 07/82] Update to python SDK docs: 14206153422 --- .../Beta/Methods/AccessProfilesApi.md | 6 +++--- .../python/Reference/Beta/Methods/RolesApi.md | 4 ++-- .../Reference/Beta/Methods/WorkflowsApi.md | 2 +- .../Beta/Models/WorkflowExecution.md | 2 +- .../V2024/Methods/AccessProfilesApi.md | 7 ++++--- .../Reference/V2024/Methods/RolesApi.md | 5 +++-- .../Reference/V2024/Models/AccessProfile.md | 21 ++++++++++--------- .../Models/AccessProfileApprovalScheme.md | 4 ++-- .../V2024/Models/AccessProfileSourceRef.md | 6 +++--- .../Reference/V2024/Models/OwnerReference.md | 6 +++--- .../Models/ProvisioningCriteriaLevel1.md | 8 +++---- .../Models/ProvisioningCriteriaLevel2.md | 8 +++---- .../Models/ProvisioningCriteriaLevel3.md | 8 +++---- .../Models/ProvisioningCriteriaOperation.md | 2 +- .../Reference/V2024/Models/Requestability.md | 8 ++++--- .../V2024/Models/RequestabilityForRole.md | 2 ++ .../Reference/V2024/Models/Revocability.md | 2 +- .../sdk/python/Reference/V2024/Models/Role.md | 1 + .../beta/python_code_examples_overlay.yaml | 4 ++-- .../v2024/python_code_examples_overlay.yaml | 6 ++++-- 20 files changed, 61 insertions(+), 51 deletions(-) diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md index c97cf5e92..0728d9b02 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md @@ -62,7 +62,7 @@ Method | HTTP request | Description ## create-access-profile Create Access Profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-profile) @@ -470,7 +470,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -507,7 +507,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md index ebda72af7..80ad574fd 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md @@ -615,7 +615,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -652,7 +652,7 @@ with ApiClient(configuration) as api_client: limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md index 1b34e4f96..690fef012 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md @@ -266,7 +266,7 @@ with ApiClient(configuration) as api_client: ## get-workflow-execution Get Workflow Execution -Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. +Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecution.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecution.md index a59a9e098..dd008877f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecution.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **start_time** | **datetime** | Date/time when the workflow started. | [optional] **close_time** | **datetime** | Date/time when the workflow ended. | [optional] -**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional] +**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Queued', 'Running' ] | Workflow execution status. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md index bd427274b..805ac4b49 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md @@ -62,7 +62,7 @@ Method | HTTP request | Description ## create-access-profile Create Access Profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-profile) @@ -136,6 +136,7 @@ with ApiClient(configuration) as api_client: "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -472,7 +473,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -509,7 +510,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md index c4deae00c..bcb03c3dd 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md @@ -235,6 +235,7 @@ with ApiClient(configuration) as api_client: }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -810,7 +811,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -847,7 +848,7 @@ with ApiClient(configuration) as api_client: limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfile.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfile.md index 2d26d2a11..84c9945ae 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfile.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfile.md @@ -11,25 +11,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2024AccessProfile'] # AccessProfile -Access Profile +Access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Access Profile | [optional] [readonly] -**name** | **str** | Name of the Access Profile | [required] -**description** | **str** | Information about the Access Profile | [optional] -**created** | **datetime** | Date the Access Profile was created | [optional] [readonly] -**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly] -**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to True] +**id** | **str** | Access profile ID. | [optional] [readonly] +**name** | **str** | Access profile name. | [required] +**description** | **str** | Access profile description. | [optional] +**created** | **datetime** | Date and time when the access profile was created. | [optional] [readonly] +**modified** | **datetime** | Date and time when the access profile was last modified. | [optional] [readonly] +**enabled** | **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to False] **owner** | [**OwnerReference**](owner-reference) | | [required] **source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**requestable** | **bool** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to True] **access_request_config** | [**Requestability**](requestability) | | [optional] **revocation_request_config** | [**Revocability**](revocability) | | [optional] -**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**segments** | **[]str** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] } @@ -63,6 +63,7 @@ requestable=True, access_request_config=sailpoint.v2024.models.requestability.Requestability( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.v2024.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileApprovalScheme.md index 19b953e63..f87667264 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2024A Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**approver_id** | **str** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSourceRef.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSourceRef.md index 07b625ee3..20a3ad0e9 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2024Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional] -**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional] -**name** | **str** | The display name of the associated Source | [optional] +**id** | **str** | ID of the source the access profile is associated with. | [optional] +**type** | **Enum** [ 'SOURCE' ] | Source's DTO type. | [optional] +**name** | **str** | Source name. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OwnerReference.md b/docs/tools/sdk/python/Reference/V2024/Models/OwnerReference.md index c756a45f4..3827fa56e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/OwnerReference.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/OwnerReference.md @@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2024OwnerReference # OwnerReference -The owner of this object. +Owner of the object. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**id** | **str** | Identity id | [optional] -**name** | **str** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel1.md index 68e315e61..d12e20170 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel1.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2024Pr # ProvisioningCriteriaLevel1 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel2.md index dddd29dcb..6bd20d14f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel2.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2024Pr # ProvisioningCriteriaLevel2 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel3.md index ca7e512ea..359006b23 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel3.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2024Pr # ProvisioningCriteriaLevel3 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | **str** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | **str** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaOperation.md index 108d3432e..356568859 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaOperation.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaOperation.md @@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'V202 # ProvisioningCriteriaOperation -Supported operations on ProvisioningCriteria +Supported operations on `ProvisioningCriteria`. ## Enum diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Requestability.md b/docs/tools/sdk/python/Reference/V2024/Models/Requestability.md index 13c2ed16a..073fd23a3 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/Requestability.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2024Requestability Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] -**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**comments_required** | **bool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to False] +**denial_comments_required** | **bool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] } ## Example @@ -29,6 +30,7 @@ from sailpoint.v2024.models.requestability import Requestability requestability = Requestability( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.v2024.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestabilityForRole.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestabilityForRole.md index 1ab2dd8b8..0f1ebcfc8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] **denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] **approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] } @@ -29,6 +30,7 @@ from sailpoint.v2024.models.requestability_for_role import RequestabilityForRole requestability_for_role = RequestabilityForRole( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.v2024.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Revocability.md b/docs/tools/sdk/python/Reference/V2024/Models/Revocability.md index 3a5f1fa7b..c9a0cc931 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/Revocability.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2024Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Role.md b/docs/tools/sdk/python/Reference/V2024/Models/Role.md index 550fe2335..19b1763cd 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/Role.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/Role.md @@ -89,6 +89,7 @@ requestable=True, access_request_config=sailpoint.v2024.models.requestability_for_role.RequestabilityForRole( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.v2024.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index bab9690f6..57728a5a4 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -332,7 +332,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) @@ -11435,7 +11435,7 @@ limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index 359e84ddb..a6ee30ec4 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -156,6 +156,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -340,7 +341,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) @@ -14236,6 +14237,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -14513,7 +14515,7 @@ limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) From 051f38fa6ddb054929cd86523001554c5aeff7bf Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 2 Apr 2025 00:29:55 +0000 Subject: [PATCH 08/82] Update to python SDK docs: 14208793952 --- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../V2025/Methods/AccessProfilesApi.md | 7 +- .../Reference/V2025/Methods/RolesApi.md | 5 +- .../Reference/V2025/Models/AccessProfile.md | 21 +- .../Models/AccessProfileApprovalScheme.md | 4 +- .../V2025/Models/AccessProfileSourceRef.md | 6 +- .../Reference/V2025/Models/OwnerReference.md | 6 +- .../Models/ProvisioningCriteriaLevel1.md | 8 +- .../Models/ProvisioningCriteriaLevel2.md | 8 +- .../Models/ProvisioningCriteriaLevel3.md | 8 +- .../Models/ProvisioningCriteriaOperation.md | 2 +- .../Reference/V2025/Models/Requestability.md | 8 +- .../V2025/Models/RequestabilityForRole.md | 2 + .../Reference/V2025/Models/Revocability.md | 2 +- .../sdk/python/Reference/V2025/Models/Role.md | 1 + .../Reference/V3/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../python/Reference/V3/Models/SourceUsage.md | 2 +- .../beta/python_code_examples_overlay.yaml | 3094 ++++++------ .../v2024/python_code_examples_overlay.yaml | 4224 ++++++++-------- .../v2025/python_code_examples_overlay.yaml | 4230 +++++++++-------- .../v3/python_code_examples_overlay.yaml | 2984 ++++++------ 27 files changed, 7327 insertions(+), 7317 deletions(-) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md index dced03305..6d30198f2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index bffe6c49e..e0b91fdea 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md index fbcbd7a29..72badf0ff 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md index 5353898b1..442faa748 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index db5a37930..a37f38fea 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md index c57393c0d..ea8523f54 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md index 100849515..0fe2ff0aa 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md @@ -62,7 +62,7 @@ Method | HTTP request | Description ## create-access-profile Create Access Profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-profile) @@ -136,6 +136,7 @@ with ApiClient(configuration) as api_client: "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -472,7 +473,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -509,7 +510,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md index 2b8c28b1b..243fc3e73 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md @@ -235,6 +235,7 @@ with ApiClient(configuration) as api_client: }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -810,7 +811,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -847,7 +848,7 @@ with ApiClient(configuration) as api_client: limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccessProfile.md b/docs/tools/sdk/python/Reference/V2025/Models/AccessProfile.md index acc3cd0a5..ac501ab9a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccessProfile.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccessProfile.md @@ -11,25 +11,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2025AccessProfile'] # AccessProfile -Access Profile +Access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Access Profile | [optional] [readonly] -**name** | **str** | Name of the Access Profile | [required] -**description** | **str** | Information about the Access Profile | [optional] -**created** | **datetime** | Date the Access Profile was created | [optional] [readonly] -**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly] -**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to True] +**id** | **str** | Access profile ID. | [optional] [readonly] +**name** | **str** | Access profile name. | [required] +**description** | **str** | Access profile description. | [optional] +**created** | **datetime** | Date and time when the access profile was created. | [optional] [readonly] +**modified** | **datetime** | Date and time when the access profile was last modified. | [optional] [readonly] +**enabled** | **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to False] **owner** | [**OwnerReference**](owner-reference) | | [required] **source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**requestable** | **bool** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to True] **access_request_config** | [**Requestability**](requestability) | | [optional] **revocation_request_config** | [**Revocability**](revocability) | | [optional] -**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**segments** | **[]str** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] } @@ -63,6 +63,7 @@ requestable=True, access_request_config=sailpoint.v2025.models.requestability.Requestability( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.v2025.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileApprovalScheme.md index a62216561..491a75c64 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2025A Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**approver_id** | **str** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileSourceRef.md b/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileSourceRef.md index b0ee294ad..09c0bbf0f 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2025Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional] -**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional] -**name** | **str** | The display name of the associated Source | [optional] +**id** | **str** | ID of the source the access profile is associated with. | [optional] +**type** | **Enum** [ 'SOURCE' ] | Source's DTO type. | [optional] +**name** | **str** | Source name. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/OwnerReference.md b/docs/tools/sdk/python/Reference/V2025/Models/OwnerReference.md index 66f7de901..b7cdcec41 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/OwnerReference.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/OwnerReference.md @@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2025OwnerReference # OwnerReference -The owner of this object. +Owner of the object. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**id** | **str** | Identity id | [optional] -**name** | **str** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel1.md index 61591b87b..4546973b1 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel1.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2025Pr # ProvisioningCriteriaLevel1 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel2.md index 519b0322b..3b8462175 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel2.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2025Pr # ProvisioningCriteriaLevel2 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel3.md index 876fe19d2..5a04ce80d 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel3.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2025Pr # ProvisioningCriteriaLevel3 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | **str** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | **str** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaOperation.md index c1afdb6f4..cc02274b7 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaOperation.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaOperation.md @@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'V202 # ProvisioningCriteriaOperation -Supported operations on ProvisioningCriteria +Supported operations on `ProvisioningCriteria`. ## Enum diff --git a/docs/tools/sdk/python/Reference/V2025/Models/Requestability.md b/docs/tools/sdk/python/Reference/V2025/Models/Requestability.md index d0a862fcb..2c58af48a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/Requestability.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2025Requestability Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] -**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**comments_required** | **bool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to False] +**denial_comments_required** | **bool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] } ## Example @@ -29,6 +30,7 @@ from sailpoint.v2025.models.requestability import Requestability requestability = Requestability( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.v2025.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2025/Models/RequestabilityForRole.md b/docs/tools/sdk/python/Reference/V2025/Models/RequestabilityForRole.md index 221464202..28a676d2c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] **denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] **approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] } @@ -29,6 +30,7 @@ from sailpoint.v2025.models.requestability_for_role import RequestabilityForRole requestability_for_role = RequestabilityForRole( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.v2025.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2025/Models/Revocability.md b/docs/tools/sdk/python/Reference/V2025/Models/Revocability.md index 5929db226..df8e0babf 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/Revocability.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2025Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/Role.md b/docs/tools/sdk/python/Reference/V2025/Models/Role.md index ba988c6f2..e006eabd8 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/Role.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/Role.md @@ -89,6 +89,7 @@ requestable=True, access_request_config=sailpoint.v2025.models.requestability_for_role.RequestabilityForRole( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.v2025.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md index 211d1a3d1..a1615a57b 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index 049a9aafe..a80904ad9 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md index 4d3443864..159a7ebe0 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index 57728a5a4..f411cfd5d 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -936,35 +936,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.beta.api.account_usages_api import AccountUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1413,6 +1384,35 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.beta.api.account_usages_api import AccountUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications/{id} method: GET xCodeSample: @@ -7644,6 +7644,195 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.beta.api.managed_clients_api import ManagedClientsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_client_status import ManagedClientStatus + from sailpoint.beta.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get + type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get + try: + # Specified Managed Client Status. + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status + source: | + from sailpoint.beta.api.managed_clients_api import ManagedClientsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_client_status import ManagedClientStatus + from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update + managed_client_status = '''{ + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + }''' # ManagedClientStatus | + try: + # Handle status request from client + new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) + results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) + print("The response of ManagedClientsApi->update_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for + try: + # Get managed cluster's log configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get + try: + # Get a specified ManagedCluster. + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq operation' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + try: + # Retrieve all Managed Clusters. + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for + client_log_configuration = '''{ + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + try: + # Update managed cluster's log configuration + + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -8030,195 +8219,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.beta.api.managed_clients_api import ManagedClientsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_client_status import ManagedClientStatus - from sailpoint.beta.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get - type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get - try: - # Specified Managed Client Status. - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status - source: | - from sailpoint.beta.api.managed_clients_api import ManagedClientsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_client_status import ManagedClientStatus - from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update - managed_client_status = '''{ - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - }''' # ManagedClientStatus | - try: - # Handle status request from client - new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) - results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) - print("The response of ManagedClientsApi->update_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for - try: - # Get managed cluster's log configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get - try: - # Get a specified ManagedCluster. - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq operation' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Retrieve all Managed Clusters. - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for - client_log_configuration = '''{ - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" - }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster - try: - # Update managed cluster's log configuration - - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -11476,6 +11476,601 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + search_attribute_config = '''{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }''' # SearchAttributeConfig | + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. + try: + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. + try: + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) +- path: /segments + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#create-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + segment = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }''' # Segment | + try: + # Create Segment + new_segment = Segment.from_json(segment) + results = SegmentsApi(api_client).create_segment(segment=new_segment) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).create_segment(new_segment) + print("The response of SegmentsApi->create_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#delete-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + SegmentsApi(api_client).delete_segment(id=id) + # Below is a request that includes all optional parameters + # SegmentsApi(api_client).delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) +- path: /segments/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#get-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + results = SegmentsApi(api_client).get_segment(id=id) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) +- path: /segments + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#list-segments + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # List Segments + + results = SegmentsApi(api_client).list_segments() + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#patch-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + try: + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).patch_segment(id, new_request_body) + print("The response of SegmentsApi->patch_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # List existing Service Desk integrations + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Service Desk integration types + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get the time check configuration + + results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + try: + # Patch a Service Desk Integration + new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }''' # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + queued_check_config_details = '''{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }''' # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) + results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) - path: /sim-integrations method: POST xCodeSample: @@ -12323,835 +12918,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.export_payload import ExportPayload - from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.import_options import ImportOptions - from sailpoint.beta.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - search_attribute_config = '''{ - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - }''' # SearchAttributeConfig | - try: - # Create Extended Search Attributes - new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) - results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) - print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. - try: - # Delete Extended Search Attribute - - SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) - # Below is a request that includes all optional parameters - # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Extended Search Attributes - - results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) - print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. - try: - # Get Extended Search Attribute - - results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) - print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.json_patch_operation import JsonPatchOperation - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. - json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | - try: - # Update Extended Search Attribute - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) - print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) -- path: /segments - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#create-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - segment = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - }''' # Segment | - try: - # Create Segment - new_segment = Segment.from_json(segment) - results = SegmentsApi(api_client).create_segment(segment=new_segment) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).create_segment(new_segment) - print("The response of SegmentsApi->create_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->create_segment: %s\n" % e) -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#delete-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. - try: - # Delete Segment by ID - - SegmentsApi(api_client).delete_segment(id=id) - # Below is a request that includes all optional parameters - # SegmentsApi(api_client).delete_segment(id) - except Exception as e: - print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) -- path: /segments/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#get-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. - try: - # Get Segment by ID - - results = SegmentsApi(api_client).get_segment(id=id) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).get_segment(id) - print("The response of SegmentsApi->get_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->get_segment: %s\n" % e) -- path: /segments - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#list-segments - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Segments - - results = SegmentsApi(api_client).list_segments() - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).list_segments(limit, offset, count) - print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->list_segments: %s\n" % e) -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#patch-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. - request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - try: - # Update Segment - new_request_body = RequestBody.from_json(request_body) - results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).patch_segment(id, new_request_body) - print("The response of SegmentsApi->patch_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create - try: - # Create new Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete - try: - # Delete a Service Desk integration - - ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get - try: - # Get a Service Desk integration - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List existing Service Desk integrations - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get - try: - # Service Desk integration template by scriptName - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Service Desk integration types - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get the time check configuration - - results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - try: - # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) - print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of the integration to update - try: - # Update a Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - queued_check_config_details = '''{ - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - }''' # QueuedCheckConfigDetails | The modified time check configuration - try: - # Update the time check configuration - new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) - results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) - print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.beta.api.source_usages_api import SourceUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.beta.api.source_usages_api import SourceUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -14562,6 +14328,240 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.beta.api.source_usages_api import SourceUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.beta.api.source_usages_api import SourceUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.export_payload import ExportPayload + from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.import_options import ImportOptions + from sailpoint.beta.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -15911,6 +15911,506 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response + from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) + print("The response of WorkflowsApi->post_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) + print("The response of WorkflowsApi->post_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#update-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.beta.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).update_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).update_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->update_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -16495,503 +16995,3 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.json_patch_operation import JsonPatchOperation - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response - from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) - print("The response of WorkflowsApi->post_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) - print("The response of WorkflowsApi->post_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#update-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.beta.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).update_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).update_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->update_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index a6ee30ec4..181d9c1fa 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -1068,35 +1068,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2024.api.account_usages_api import AccountUsagesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1555,6 +1526,35 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2024.api.account_usages_api import AccountUsagesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -3368,119 +3368,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3809,6 +3696,119 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: @@ -10084,196 +10084,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -10666,150 +10476,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # Get Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: @@ -11024,6 +10690,340 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#create-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_type = '''{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }''' # ManagedClusterType | + try: + # Create new Managed Cluster Type + new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) + results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) + print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#delete-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Delete a Managed Cluster Type + + ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Get a Managed Cluster Type + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) + print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-types + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) + pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) + org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + try: + # Get Managed Cluster Types + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) + print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#update-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JSONPatch payload used to update the schema. + try: + # Update a Managed Cluster Type + new_json_patch = JsonPatch.from_json(json_patch) + results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) + print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -14739,1119 +14739,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a SIM integration details. - - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - try: - # List SOD policies - - results = SODPoliciesApi(api_client).list_sod_policies() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2024.api.sod_violations_api import SODViolationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2024.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2024.api.sod_violations_api import SODViolationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2024.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.export_payload import ExportPayload - from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.import_options import ImportOptions - from sailpoint.v2024.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -17365,60 +16252,939 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration source: | - from sailpoint.v2024.api.source_usages_api import SourceUsagesApi + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.source_usage_status import SourceUsageStatus + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() + configuration.experimental = true with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration source: | - from sailpoint.v2024.api.source_usages_api import SourceUsagesApi + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.source_usage import SourceUsage + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) try: - # Returns source usage insights + # List SOD policies - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + results = SODPoliciesApi(api_client).list_sod_policies() # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2024.api.sod_violations_api import SODViolationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2024.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2024.api.sod_violations_api import SODViolationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2024.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -19027,6 +18793,240 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.v2024.api.source_usages_api import SourceUsagesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.v2024.api.source_usages_api import SourceUsagesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.export_payload import ExportPayload + from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.import_options import ImportOptions + from sailpoint.v2024.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -20351,6 +20351,506 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = '''sailpoint.v2024.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.v2024.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.v2024.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -20955,503 +21455,3 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v2024.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.v2024.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v2024.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index 50913467c..ef50dc4db 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -156,6 +156,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -340,7 +341,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) @@ -1067,35 +1068,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2025.api.account_usages_api import AccountUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1554,6 +1526,35 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2025.api.account_usages_api import AccountUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -3367,119 +3368,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3808,6 +3696,119 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: @@ -10083,196 +10084,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -10665,150 +10476,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: @@ -11023,6 +10690,340 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_type = '''{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }''' # ManagedClusterType | + try: + # Create new Managed Cluster Type + new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) + results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) + print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Delete a Managed Cluster Type + + ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Get a Managed Cluster Type + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) + print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) + pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) + org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + try: + # List Managed Cluster Types + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) + print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JSONPatch payload used to update the schema. + try: + # Update a Managed Cluster Type + new_json_patch = JsonPatch.from_json(json_patch) + results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) + print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -14236,6 +14237,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -14513,7 +14515,7 @@ limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) @@ -14737,1119 +14739,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a SIM integration details. - - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - try: - # List SOD policies - - results = SODPoliciesApi(api_client).list_sod_policies() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2025.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2025.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.export_payload import ExportPayload - from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.import_options import ImportOptions - from sailpoint.v2025.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get config object details - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -17363,60 +16252,939 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage_status import SourceUsageStatus + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() + configuration.experimental = true with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage import SourceUsage + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) try: - # Returns source usage insights + # List SOD policies - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + results = SODPoliciesApi(api_client).list_sod_policies() # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2025.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2025.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -19025,6 +18793,240 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.export_payload import ExportPayload + from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.import_options import ImportOptions + from sailpoint.v2025.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -20349,6 +20351,506 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.v2025.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -20953,503 +21455,3 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.v2025.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) \ No newline at end of file diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index 5e569934f..f5d5cfe68 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -727,35 +727,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v3.api.account_usages_api import AccountUsagesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1075,6 +1046,35 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v3.api.account_usages_api import AccountUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -2322,119 +2322,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2763,6 +2650,119 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -4085,6 +4085,355 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /managed-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.v3.models.managed_client_request import ManagedClientRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_client_request = '''{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }''' # ManagedClientRequest | + try: + # Create Managed Client + new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) + results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) + print("The response of ManagedClientsApi->create_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + ManagedClientsApi(api_client).delete_managed_client(id=id) + # Below is a request that includes all optional parameters + # ManagedClientsApi(api_client).delete_managed_client(id) + except Exception as e: + print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + results = ManagedClientsApi(api_client).get_managed_client(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client_status import ManagedClientStatus + from sailpoint.v3.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. + type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + try: + # Get Managed Client Status + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + try: + # Get Managed Clients + + results = ManagedClientsApi(api_client).get_managed_clients() + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) + print("The response of ManagedClientsApi->update_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-clusters + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_request = '''{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }''' # ManagedClusterRequest | + try: + # Create Create Managed Cluster + new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) + results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) + try: + # Delete Managed Cluster + + ManagedClustersApi(api_client).delete_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) + except Exception as e: + print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. + try: + # Get Managed Cluster Log Configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + try: + # Get Managed Clusters + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. + put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Cluster + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -4471,355 +4820,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) -- path: /managed-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.v3.models.managed_client_request import ManagedClientRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_client_request = '''{ - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - }''' # ManagedClientRequest | - try: - # Create Managed Client - new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) - results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) - print("The response of ManagedClientsApi->create_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Delete Managed Client - - ManagedClientsApi(api_client).delete_managed_client(id=id) - # Below is a request that includes all optional parameters - # ManagedClientsApi(api_client).delete_managed_client(id) - except Exception as e: - print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Get Managed Client - - results = ManagedClientsApi(api_client).get_managed_client(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client(id) - print("The response of ManagedClientsApi->get_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client_status import ManagedClientStatus - from sailpoint.v3.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. - type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. - try: - # Get Managed Client Status - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-clients - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - try: - # Get Managed Clients - - results = ManagedClientsApi(api_client).get_managed_clients() - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) - print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Client - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) - print("The response of ManagedClientsApi->update_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-clusters - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_request = '''{ - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - }''' # ManagedClusterRequest | - try: - # Create Create Managed Cluster - new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) - results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) - print("The response of ManagedClustersApi->create_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) - try: - # Delete Managed Cluster - - ManagedClustersApi(api_client).delete_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) - except Exception as e: - print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. - try: - # Get Managed Cluster Log Configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - try: - # Get Managed Cluster - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Get Managed Clusters - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration - from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. - put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. - try: - # Update Managed Cluster Log Configuration - new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Cluster - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) - print("The response of ManagedClustersApi->update_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -7083,645 +7083,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - try: - # List SOD policies - - results = SODPoliciesApi(api_client).list_sod_policies() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v3.api.sod_violations_api import SODViolationsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v3.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check - source: | - from sailpoint.v3.api.sod_violations_api import SODViolationsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v3.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -9177,60 +8538,645 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET +- path: /sod-policies + method: POST xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy source: | - from sailpoint.v3.api.source_usages_api import SourceUsagesApi + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.source_usage_status import SourceUsageStatus + from sailpoint.v3.models.sod_policy import SodPolicy from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy source: | - from sailpoint.v3.api.source_usages_api import SourceUsagesApi + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) try: - # Returns source usage insights + # List SOD policies - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + results = SODPoliciesApi(api_client).list_sod_policies() # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v3.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v3.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -10149,6 +10095,60 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.v3.api.source_usages_api import SourceUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.v3.api.source_usages_api import SourceUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -10647,344 +10647,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Approve an Approval Item - - results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->approve_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk approve Approval Items - - results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) - print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) - try: - # Complete a Work Item - - results = WorkItemsApi(api_client).complete_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).complete_work_item(id, new_body) - print("The response of WorkItemsApi->complete_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) -- path: /work-items/completed - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Completed Work Items - - results = WorkItemsApi(api_client).get_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) - print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Completed Work Items - - results = WorkItemsApi(api_client).get_count_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) - print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) -- path: /work-items/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Work Items - - results = WorkItemsApi(api_client).get_count_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_work_items(owner_id) - print("The response of WorkItemsApi->get_count_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. - try: - # Get a Work Item - - results = WorkItemsApi(api_client).get_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_item(id) - print("The response of WorkItemsApi->get_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) -- path: /work-items/summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_summary import WorkItemsSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Work Items Summary - - results = WorkItemsApi(api_client).get_work_items_summary() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) - print("The response of WorkItemsApi->get_work_items_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) -- path: /work-items - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # List Work Items - - results = WorkItemsApi(api_client).list_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) - print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Reject an Approval Item - - results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->reject_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk reject Approval Items - - results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) - print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_item_forward import WorkItemForward - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - work_item_forward = '''{ - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - }''' # WorkItemForward | - try: - # Forward a Work Item - new_work_item_forward = WorkItemForward.from_json(work_item_forward) - WorkItemsApi(api_client).send_work_item_forward(id=id, work_item_forward=new_work_item_forward) - # Below is a request that includes all optional parameters - # WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward) - except Exception as e: - print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName - try: - # Submit Account Selections - new_request_body = RequestBody.from_json(request_body) - results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) - print("The response of WorkItemsApi->submit_account_selection:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -11485,3 +11147,341 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Approve an Approval Item + + results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) + try: + # Complete a Work Item + + results = WorkItemsApi(api_client).complete_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id, new_body) + print("The response of WorkItemsApi->complete_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # Completed Work Items + + results = WorkItemsApi(api_client).get_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Completed Work Items + + results = WorkItemsApi(api_client).get_count_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + results = WorkItemsApi(api_client).get_count_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + results = WorkItemsApi(api_client).get_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_summary import WorkItemsSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + results = WorkItemsApi(api_client).get_work_items_summary() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + results = WorkItemsApi(api_client).list_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Reject an Approval Item + + results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_item_forward import WorkItemForward + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + work_item_forward = '''{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }''' # WorkItemForward | + try: + # Forward a Work Item + new_work_item_forward = WorkItemForward.from_json(work_item_forward) + WorkItemsApi(api_client).send_work_item_forward(id=id, work_item_forward=new_work_item_forward) + # Below is a request that includes all optional parameters + # WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward) + except Exception as e: + print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName + try: + # Submit Account Selections + new_request_body = RequestBody.from_json(request_body) + results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) + print("The response of WorkItemsApi->submit_account_selection:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) From e3154507bce2b8aa2746f6ea721f4ad8d8a8502c Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 2 Apr 2025 01:20:21 +0000 Subject: [PATCH 09/82] Update to powershell SDK docs: 14209385488 --- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../V2025/Methods/V2025AccessProfilesApi.md | 7 +- .../Reference/V2025/Methods/V2025RolesApi.md | 5 +- .../Reference/V2025/Models/AccessProfile.md | 18 +- .../Models/AccessProfileApprovalScheme.md | 4 +- .../V2025/Models/AccessProfileSourceRef.md | 6 +- .../Reference/V2025/Models/OwnerReference.md | 4 +- .../Models/ProvisioningCriteriaLevel1.md | 6 +- .../Models/ProvisioningCriteriaLevel2.md | 6 +- .../Models/ProvisioningCriteriaLevel3.md | 6 +- .../Reference/V2025/Models/Requestability.md | 8 +- .../V2025/Models/RequestabilityForRole.md | 2 + .../Reference/V2025/Models/Revocability.md | 2 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V3/Models/SourceUsage.md | 2 +- .../powershell_code_examples_overlay.yaml | 2564 ++++++------ .../powershell_code_examples_overlay.yaml | 3536 ++++++++-------- .../powershell_code_examples_overlay.yaml | 3542 +++++++++-------- .../v3/powershell_code_examples_overlay.yaml | 2476 ++++++------ 25 files changed, 6112 insertions(+), 6104 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md index 9d6d48011..f6a1eaaa2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index 414c1c740..4eef80103 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md index 05cceab03..bb3b65383 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md index b901e027d..9cb9ee94f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index 6393f6ed6..54727248f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md index 3d6b4c94a..235e4ab2c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md index b5ab471ee..d6790d1d0 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md @@ -63,7 +63,7 @@ Method | HTTP request | Description ## create-access-profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-profile) @@ -127,6 +127,7 @@ $AccessProfile = @"{ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -411,7 +412,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -439,7 +440,7 @@ $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returne $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md index 7cb8f10e1..3d7fdf0de 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md @@ -226,6 +226,7 @@ $Role = @"{ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -693,7 +694,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -721,7 +722,7 @@ $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filter $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) +$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfile.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfile.md index 5c19903d4..5f3d93d6d 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfile.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfile.md @@ -16,19 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2025AccessProfile'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Access Profile | [optional] [readonly] -**Name** | **String** | Name of the Access Profile | [required] -**Description** | **String** | Information about the Access Profile | [optional] -**Created** | **System.DateTime** | Date the Access Profile was created | [optional] [readonly] -**Modified** | **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly] -**Enabled** | **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $true] +**Id** | **String** | Access profile ID. | [optional] [readonly] +**Name** | **String** | Access profile name. | [required] +**Description** | **String** | Access profile description. | [optional] +**Created** | **System.DateTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | **System.DateTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | **Boolean** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to $false] **Owner** | [**OwnerReference**](owner-reference) | | [required] **Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**Requestable** | **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] +**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | **Boolean** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] **AccessRequestConfig** | [**Requestability**](requestability) | | [optional] **RevocationRequestConfig** | [**Revocability**](revocability) | | [optional] -**Segments** | **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**Segments** | **[]String** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **ProvisioningCriteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileApprovalScheme.md index 1f9d69ce3..22cc8b7a5 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2025A Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**ApproverId** | **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | **String** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileSourceRef.md index 17f87fa1c..20739b738 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2025Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Source with with which the Access Profile is associated | [optional] -**Type** | **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional] -**Name** | **String** | The display name of the associated Source | [optional] +**Id** | **String** | ID of the source the access profile is associated with. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Source's DTO type. | [optional] +**Name** | **String** | Source name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/OwnerReference.md b/docs/tools/sdk/powershell/Reference/V2025/Models/OwnerReference.md index e0aee5fc5..207757788 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/OwnerReference.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/OwnerReference.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2025OwnerReference Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Type** | **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | **String** | Identity id | [optional] -**Name** | **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**Id** | **String** | Owner's identity ID. | [optional] +**Name** | **String** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel1.md index 148abe98b..b1a98a01a 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel1.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2025Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel2.md index abb38f860..857dad112 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel2.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2025Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel3.md index a7bb5ea15..79a9b347e 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel3.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2025Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | **String** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/Requestability.md b/docs/tools/sdk/powershell/Reference/V2025/Models/Requestability.md index 2ba89ac9d..da3aa25a6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/Requestability.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2025Requestability Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**CommentsRequired** | **Boolean** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to $false] +**DenialCommentsRequired** | **Boolean** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $Requestability = Initialize-PSSailpoint.V2025Requestability -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestabilityForRole.md index 83a294f1b..45bd29deb 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] **DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] **ApprovalSchemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $RequestabilityForRole = Initialize-PSSailpoint.V2025RequestabilityForRole -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/Revocability.md b/docs/tools/sdk/powershell/Reference/V2025/Models/Revocability.md index 3cc905e0c..9821efa31 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/Revocability.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2025Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md index 35c8a92f6..3b9cae031 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index 17d96a073..071f0e39a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V3NonEmployeeReq -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md index 0328c565b..92919ac01 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index ad831aa53..5f6b70bf2 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -803,29 +803,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-BetaUsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /accounts method: POST xCodeSample: @@ -1198,6 +1175,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-BetaUsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /discovered-applications/{id} method: GET xCodeSample: @@ -6536,6 +6536,162 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" Write-Host $_.ErrorDetails } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to get + $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get + + # Specified Managed Client Status. + + try { + Get-BetaManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-BetaManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to update + $ManagedClientStatus = @" + { + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } + "@ + + # Handle status request from client + + try { + $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus + Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for + + # Get managed cluster's log configuration + + try { + Get-BetaClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster + source: | + $Id = "aClusterId" # String | ID of the ManagedCluster to get + + # Get a specified ManagedCluster. + + try { + Get-BetaManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq operation" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Retrieve all Managed Clusters. + + try { + Get-BetaManagedClusters + + # Below is a request that includes all optional parameters + # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for + $ClientLogConfiguration = @" + { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } + "@ + + # Update managed cluster's log configuration + + try { + Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result + + # Below is a request that includes all optional parameters + # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -6862,162 +7018,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to get - $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get - - # Specified Managed Client Status. - - try { - Get-BetaManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-BetaManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to update - $ManagedClientStatus = @" - { - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - } - "@ - - # Handle status request from client - - try { - $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus - Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result - - # Below is a request that includes all optional parameters - # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for - - # Get managed cluster's log configuration - - try { - Get-BetaClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster - source: | - $Id = "aClusterId" # String | ID of the ManagedCluster to get - - # Get a specified ManagedCluster. - - try { - Get-BetaManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq operation" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Retrieve all Managed Clusters. - - try { - Get-BetaManagedClusters - - # Below is a request that includes all optional parameters - # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for - $ClientLogConfiguration = @" - { - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" - } - "@ - - # Update managed cluster's log configuration - - try { - Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result - - # Below is a request that includes all optional parameters - # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } - path: /multihosts method: POST xCodeSample: @@ -9796,6 +9796,515 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" Write-Host $_.ErrorDetails } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-BetaSearchAttributeConfig -SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-BetaSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Remove-BetaSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Extended Search Attributes + + try { + Get-BetaSearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-BetaSearchAttributeConfig -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. + + # Get Extended Search Attribute + + try { + Get-BetaSingleSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Get-BetaSingleSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-BetaSegment -Segment $Result + + # Below is a request that includes all optional parameters + # New-BetaSegment -Segment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-BetaSegment -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSegment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-BetaSegment -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSegment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-BetaSegments + + # Below is a request that includes all optional parameters + # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSegment -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSegment -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-BetaServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-BetaServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-BetaServiceDeskIntegrationList + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-BetaServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details + source: | + + # Get the time check configuration + + try { + Get-BetaStatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-BetaStatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } - path: /sim-integrations method: POST xCodeSample: @@ -10533,697 +11042,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" Write-Host $_.ErrorDetails } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-BetaSpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-BetaSpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-BetaSpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-BetaSpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-BetaSpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-BetaSpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-BetaSpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-BetaSpConfigObjects - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config - source: | - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ - - # Create Extended Search Attributes - - try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-BetaSearchAttributeConfig -SearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - - # Delete Extended Search Attribute - - try { - Remove-BetaSearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Remove-BetaSearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Extended Search Attributes - - try { - Get-BetaSearchAttributeConfig - - # Below is a request that includes all optional parameters - # Get-BetaSearchAttributeConfig -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - - # Get Extended Search Attribute - - try { - Get-BetaSingleSearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Get-BetaSingleSearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config - source: | - $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Extended Search Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment - source: | - $Segment = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-BetaSegment -Segment $Result - - # Below is a request that includes all optional parameters - # New-BetaSegment -Segment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-BetaSegment -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSegment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-BetaSegment -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSegment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Segments - - try { - Get-BetaSegments - - # Below is a request that includes all optional parameters - # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSegment -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaSegment -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration - source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - } - "@ - - # Create new Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration - source: | - $Id = "anId" # String | ID of Service Desk integration to delete - - # Delete a Service Desk integration - - try { - Remove-BetaServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to get - - # Get a Service Desk integration - - try { - Get-BetaServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List existing Service Desk integrations - - try { - Get-BetaServiceDeskIntegrationList - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - - # Service Desk integration template by scriptName - - try { - Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types - source: | - - # List Service Desk integration types - - try { - Get-BetaServiceDeskIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details - source: | - - # Get the time check configuration - - try { - Get-BetaStatusCheckDetails - - # Below is a request that includes all optional parameters - # Get-BetaStatusCheckDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - - "@ - - # Patch a Service Desk Integration - - try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - - # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - } - "@ - - # Update a Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details - source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ - - # Update the time check configuration - - try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result - - # Below is a request that includes all optional parameters - # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-BetaStatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaStatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-BetaUsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" - Write-Host $_.ErrorDetails - } - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -12541,6 +12359,188 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" Write-Host $_.ErrorDetails } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-BetaStatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaStatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-BetaUsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-BetaSpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-BetaSpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-BetaSpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-BetaSpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-BetaSpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-BetaSpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-BetaSpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-BetaSpConfigObjects + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" + Write-Host $_.ErrorDetails + } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -13726,6 +13726,418 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-BetaWorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-BetaWorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-BetaWorkflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-BetaWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-BetaWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-BetaWorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-BetaWorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-BetaWorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-BetaCompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-BetaWorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-BetaWorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-BetaWorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-BetaWorkflows + + # Below is a request that includes all optional parameters + # Get-BetaWorkflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $PostExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + Submit-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + Submit-BetaWorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaWorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Update-BetaWorkflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -14194,415 +14606,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-BetaWorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-BetaWorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-BetaWorkflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaWorkflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-BetaWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaWorkflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-BetaWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-BetaWorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-BetaWorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-BetaWorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-BetaCompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-BetaWorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-BetaWorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-BetaWorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-BetaWorkflows - - # Below is a request that includes all optional parameters - # Get-BetaWorkflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $PostExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - Submit-BetaExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - Submit-BetaWorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # Submit-BetaWorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-BetaExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Update-BetaWorkflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails - } diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index f2656ac8f..dc3795d02 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -909,29 +909,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2024UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /accounts method: POST xCodeSample: @@ -1309,6 +1286,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2024UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /discovered-applications method: GET xCodeSample: @@ -2851,95 +2851,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2024IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2024IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2024IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3218,6 +3129,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2024IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2024IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2024IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /configuration-hub/deploys method: POST xCodeSample: @@ -8479,164 +8479,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-V2024MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-V2024MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-V2024MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2024MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2024MFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-V2024MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-V2024MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" - Write-Host $_.ErrorDetails - } - path: /machine-accounts/{id} method: GET xCodeSample: @@ -8958,128 +8800,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" Write-Host $_.ErrorDetails } -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#create-managed-cluster-type - source: | - $ManagedClusterType = @" - { - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - } - "@ - - # Create new Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType - New-V2024ManagedClusterType -ManagedClusterType $Result - - # Below is a request that includes all optional parameters - # New-V2024ManagedClusterType -ManagedClusterType $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#delete-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Delete a Managed Cluster Type - - try { - Remove-V2024ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Get a Managed Cluster Type - - try { - Get-V2024ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-types - source: | - $Type = "IDN" # String | Type descriptor (optional) - $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) - $Org = "denali-xyz" # String | Pinned org (or default) (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # Get Managed Cluster Types - - try { - Get-V2024ManagedClusterTypes - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterTypes" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#update-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update a Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } - path: /managed-clusters method: POST xCodeSample: @@ -9258,6 +8978,286 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" Write-Host $_.ErrorDetails } +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#create-managed-cluster-type + source: | + $ManagedClusterType = @" + { + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + } + "@ + + # Create new Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType + New-V2024ManagedClusterType -ManagedClusterType $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedClusterType -ManagedClusterType $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#delete-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Delete a Managed Cluster Type + + try { + Remove-V2024ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Get a Managed Cluster Type + + try { + Get-V2024ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-types + source: | + $Type = "IDN" # String | Type descriptor (optional) + $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) + $Org = "denali-xyz" # String | Pinned org (or default) (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # Get Managed Cluster Types + + try { + Get-V2024ManagedClusterTypes + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterTypes" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#update-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Update a Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-V2024MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-V2024MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-V2024MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2024MFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2024MFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-V2024MFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-V2024MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" + Write-Host $_.ErrorDetails + } - path: /multihosts method: POST xCodeSample: @@ -12403,954 +12403,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" Write-Host $_.ErrorDetails } -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration - source: | - $Id = "12345" # String | The id of the integration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a SIM integration - - try { - Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a SIM integration details. - - try { - Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2024SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2024SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2024SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2024DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2024SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2024SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2024SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2024SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-V2024SodPolicies - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2024SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2024SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2024EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2024SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2024PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2024SpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2024SpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-V2024SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-V2024SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-V2024SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-V2024SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2024SpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-V2024SpConfigObjects - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" - Write-Host $_.ErrorDetails - } - path: /saved-searches method: POST xCodeSample: @@ -14714,46 +13766,812 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ - # Finds status of source usage + # Create new SIM integration try { - Get-V2024StatusBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Get-V2024StatusBySourceId -SourceId $SourceId + # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration + source: | + $Id = "12345" # String | The id of the integration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a SIM integration + + try { + Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a SIM integration details. + + try { + Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2024SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2024SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2024SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-V2024SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2024SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2024SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2024SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - # Returns source usage insights + # List SOD policies try { - Get-V2024UsagesBySourceId -SourceId $SourceId + Get-V2024SodPolicies # Below is a request that includes all optional parameters - # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2024SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2024SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2024EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2024SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -16231,6 +16049,188 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" Write-Host $_.ErrorDetails } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-V2024StatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-V2024UsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2024SpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2024SpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-V2024SpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-V2024SpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-V2024SpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-V2024SpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2024SpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-V2024SpConfigObjects + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.ErrorDetails + } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -17382,6 +17382,418 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2024WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2024ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2024Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2024WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-V2024WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2024Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2024Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2024WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2024WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2024WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-V2024CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-V2024WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-V2024WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-V2024WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-V2024Workflows + + # Below is a request that includes all optional parameters + # Get-V2024Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2024Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2024Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2024ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.ErrorDetails + } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -17858,415 +18270,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2024WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2024WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2024ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2024Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2024WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-V2024WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2024Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2024Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2024WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2024WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2024WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-V2024CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-V2024WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2024WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-V2024WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2024Workflows - - # Below is a request that includes all optional parameters - # Get-V2024Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2024Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2024Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2024ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" - Write-Host $_.ErrorDetails - } diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index a10a0e7a6..5a73e13b7 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -121,6 +121,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -282,7 +283,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) @@ -908,29 +909,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountAggregationStatus" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2025UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /accounts method: POST xCodeSample: @@ -1308,6 +1286,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Account" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2025UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /discovered-applications method: GET xCodeSample: @@ -2850,95 +2851,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Campaign" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2025IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2025IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2025IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3217,6 +3129,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025ReassignCertsAsync" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2025IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2025IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2025IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2025IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /configuration-hub/deploys method: POST xCodeSample: @@ -8478,164 +8479,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025LifecycleStates" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-V2025MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-V2025MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAKbaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-V2025MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2025MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAKBAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2025MFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-V2025MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-V2025MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025MFAConfig" - Write-Host $_.ErrorDetails - } - path: /machine-accounts/{id} method: GET xCodeSample: @@ -8957,128 +8800,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClient" Write-Host $_.ErrorDetails } -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - $ManagedClusterType = @" - { - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - } - "@ - - # Create new Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType - New-V2025ManagedClusterType -ManagedClusterType $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedClusterType -ManagedClusterType $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Delete a Managed Cluster Type - - try { - Remove-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Get a Managed Cluster Type - - try { - Get-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - $Type = "IDN" # String | Type descriptor (optional) - $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) - $Org = "denali-xyz" # String | Pinned org (or default) (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Managed Cluster Types - - try { - Get-V2025ManagedClusterTypes - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterTypes" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update a Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } - path: /managed-clusters method: POST xCodeSample: @@ -9257,6 +8978,286 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedCluster" Write-Host $_.ErrorDetails } +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#create-managed-cluster-type + source: | + $ManagedClusterType = @" + { + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + } + "@ + + # Create new Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType + New-V2025ManagedClusterType -ManagedClusterType $Result + + # Below is a request that includes all optional parameters + # New-V2025ManagedClusterType -ManagedClusterType $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#delete-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Delete a Managed Cluster Type + + try { + Remove-V2025ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Get a Managed Cluster Type + + try { + Get-V2025ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-types + source: | + $Type = "IDN" # String | Type descriptor (optional) + $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) + $Org = "denali-xyz" # String | Pinned org (or default) (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # List Managed Cluster Types + + try { + Get-V2025ManagedClusterTypes + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterTypes" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#update-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Update a Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-V2025MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-kba-config + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-V2025MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-V2025MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-duo-config + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2025MFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfakba-config + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-okta-config + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2025MFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#test-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-V2025MFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-V2025MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025MFAConfig" + Write-Host $_.ErrorDetails + } - path: /multihosts method: POST xCodeSample: @@ -11967,6 +11968,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -12199,7 +12201,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) @@ -12401,954 +12403,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByQuery" Write-Host $_.ErrorDetails } -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration - source: | - $Id = "12345" # String | The id of the integration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a SIM integration - - try { - Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a SIM integration details. - - try { - Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2025SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2025SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2025SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2025SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2025SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-V2025SodPolicies - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2025SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2025SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2025EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2025SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2025SpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2025SpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-V2025SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-V2025SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-V2025SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-V2025SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2025SpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects - source: | - - # Get config object details - - try { - Get-V2025SpConfigObjects - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" - Write-Host $_.ErrorDetails - } - path: /saved-searches method: POST xCodeSample: @@ -14712,46 +13766,812 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ - # Finds status of source usage + # Create new SIM integration try { - Get-V2025StatusBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Get-V2025StatusBySourceId -SourceId $SourceId + # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration + source: | + $Id = "12345" # String | The id of the integration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a SIM integration + + try { + Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a SIM integration details. + + try { + Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2025SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2025SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2025SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2025DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-V2025SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2025SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2025SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2025SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - # Returns source usage insights + # List SOD policies try { - Get-V2025UsagesBySourceId -SourceId $SourceId + Get-V2025SodPolicies # Below is a request that includes all optional parameters - # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2025SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2025SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2025EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2025SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2025PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -16229,6 +16049,188 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchema" Write-Host $_.ErrorDetails } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-V2025StatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-V2025UsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2025SpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2025SpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-V2025SpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-V2025SpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-V2025SpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-V2025SpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2025SpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-V2025SpConfigObjects + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" + Write-Host $_.ErrorDetails + } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -17380,6 +17382,418 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025VendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2025WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2025WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2025ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2025Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2025WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-V2025WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2025Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2025Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2025WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2025WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2025WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-V2025CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-V2025WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-V2025WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-V2025WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-V2025Workflows + + # Below is a request that includes all optional parameters + # Get-V2025Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2025Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2025Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2025ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" + Write-Host $_.ErrorDetails + } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -17856,415 +18270,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TenantConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2025Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2025WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2025WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2025WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-V2025CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-V2025WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2025WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-V2025WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2025Workflows - - # Below is a request that includes all optional parameters - # Get-V2025Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2025Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2025Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" - Write-Host $_.ErrorDetails - } \ No newline at end of file diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index f60bafeec..f4d1a2791 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -636,29 +636,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /accounts method: POST xCodeSample: @@ -926,6 +903,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /discovered-applications method: GET xCodeSample: @@ -2013,95 +2013,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2380,6 +2291,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -3560,6 +3560,298 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" Write-Host $_.ErrorDetails } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-ManagedClient -ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedClient -ManagedClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-ManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-ManagedClients + + # Below is a request that includes all optional parameters + # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-ManagedCluster -ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedCluster -ManagedClusterRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-ClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-ManagedClusters + + # Below is a request that includes all optional parameters + # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" + Write-Host $_.ErrorDetails + } - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -3886,298 +4178,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client - source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ - - # Create Managed Client - - try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-ManagedClient -ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedClient -ManagedClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Delete Managed Client - - try { - Remove-ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Get Managed Client - - try { - Get-ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. - - # Get Managed Client Status - - try { - Get-ManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-ManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - - # Get Managed Clients - - try { - Get-ManagedClients - - # Below is a request that includes all optional parameters - # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-ManagedCluster -ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedCluster -ManagedClusterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-ManagedClusters - - # Below is a request that includes all optional parameters - # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedCluster -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" - Write-Host $_.ErrorDetails - } - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -6128,558 +6128,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" Write-Host $_.ErrorDetails } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-SodPolicies - - # Below is a request that includes all optional parameters - # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" - Write-Host $_.ErrorDetails - } - path: /saved-searches method: POST xCodeSample: @@ -7990,46 +7438,556 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sod-policies + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ - # Finds status of source usage + # Create SOD policy try { - Get-StatusBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy -SodPolicy $Result # Below is a request that includes all optional parameters - # Get-StatusBySourceId -SourceId $SourceId + # New-SodPolicy -SodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - # Returns source usage insights + # List SOD policies try { - Get-UsagesBySourceId -SourceId $SourceId + Get-SodPolicies # Below is a request that includes all optional parameters - # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -8942,6 +8900,48 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" Write-Host $_.ErrorDetails } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-StatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-UsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + Write-Host $_.ErrorDetails + } - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -9405,272 +9405,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Approve an Approval Item - - try { - Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk approve Approval Items - - try { - Approve-ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Approve-ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) - - # Complete a Work Item - - try { - Complete-WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Complete-WorkItem -Id $Id -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Completed Work Items - - try { - Get-CompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Count Completed Work Items - - try { - Get-CountCompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-CountCompletedWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items - source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - - # Count Work Items - - try { - Get-CountWorkItems - - # Below is a request that includes all optional parameters - # Get-CountWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - - # Get a Work Item - - try { - Get-WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Get-WorkItem -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Work Items Summary - - try { - Get-WorkItemsSummary - - # Below is a request that includes all optional parameters - # Get-WorkItemsSummary -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" - Write-Host $_.ErrorDetails - } -- path: /work-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # List Work Items - - try { - Get-WorkItems - - # Below is a request that includes all optional parameters - # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Reject an Approval Item - - try { - Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk reject Approval Items - - try { - Deny-ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Deny-ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ - - # Forward a Work Item - - try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Send-WorkItemForward -Id $Id -WorkItemForward $Result - - # Below is a request that includes all optional parameters - # Send-WorkItemForward -Id $Id -WorkItemForward $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - - # Submit Account Selections - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-AccountSelection -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Submit-AccountSelection -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" - Write-Host $_.ErrorDetails - } - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -10083,3 +9817,269 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" Write-Host $_.ErrorDetails } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Approve-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) + + # Complete a Work Item + + try { + Complete-WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Complete-WorkItem -Id $Id -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-CountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CountCompletedWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-CountWorkItems + + # Below is a request that includes all optional parameters + # Get-CountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-WorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-WorkItems + + # Below is a request that includes all optional parameters + # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Deny-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-WorkItemForward -Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Send-WorkItemForward -Id $Id -WorkItemForward $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-AccountSelection -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-AccountSelection -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" + Write-Host $_.ErrorDetails + } From 72b9bb1f90406e9d72773aa4e9075d9a2d5f96dd Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Wed, 2 Apr 2025 06:11:54 +0000 Subject: [PATCH 10/82] Automated commit by github action: 14212758357 --- .../idn/v2024/paths/managed-clients.yaml | 1 + .../idn/v2024/paths/managed-clusters.yaml | 10 ++++ .../idn/v2024/schemas/ManagedClient.yaml | 20 +++++++ .../idn/v2024/schemas/ManagedCluster.yaml | 56 ++++++++++++++++++- 4 files changed, 86 insertions(+), 1 deletion(-) diff --git a/static/api-specs/idn/v2024/paths/managed-clients.yaml b/static/api-specs/idn/v2024/paths/managed-clients.yaml index c9845725f..19ce85484 100644 --- a/static/api-specs/idn/v2024/paths/managed-clients.yaml +++ b/static/api-specs/idn/v2024/paths/managed-clients.yaml @@ -53,6 +53,7 @@ get: $ref: '../responses/500.yaml' security: - userAuth: [idn:remote-client:read, idn:remote-client:manage] + - applicationAuth: [idn:remote-client:read, idn:remote-client:manage] x-sailpoint-userLevels: - ORG_ADMIN post: diff --git a/static/api-specs/idn/v2024/paths/managed-clusters.yaml b/static/api-specs/idn/v2024/paths/managed-clusters.yaml index ed60909d0..ea47bbd64 100644 --- a/static/api-specs/idn/v2024/paths/managed-clusters.yaml +++ b/static/api-specs/idn/v2024/paths/managed-clusters.yaml @@ -20,6 +20,15 @@ get: **operational**: *eq* + + + **name**: *eq* + + + **type**: *eq* + + + **status**: *eq* required: false example: operational eq "operation" responses: @@ -43,6 +52,7 @@ get: $ref: '../responses/500.yaml' security: - userAuth: [idn:remote-client:read, idn:remote-client:manage] + - applicationAuth: [idn:remote-client:read, idn:remote-client:manage] x-sailpoint-userLevels: - ORG_ADMIN post: diff --git a/static/api-specs/idn/v2024/schemas/ManagedClient.yaml b/static/api-specs/idn/v2024/schemas/ManagedClient.yaml index 86ea556bd..71a8a6dfc 100644 --- a/static/api-specs/idn/v2024/schemas/ManagedClient.yaml +++ b/static/api-specs/idn/v2024/schemas/ManagedClient.yaml @@ -19,9 +19,11 @@ properties: type: string example: "CLIENT_STATUS_NOT_CONFIGURED" apiGatewayBaseUrl: + description: apiGatewayBaseUrl for the Managed client nullable: true type: string cookbook: + description: cookbook id for the Managed client nullable: true type: string ccId: @@ -144,3 +146,21 @@ properties: - DRAFT example: PROVISIONED + healthIndicators: + description: The health indicators of the ManagedClient + type: object + nullable: true + example : '{ + "network": { + "errors": [], + "warnings": [] + }, + "memory": { + "errors": [], + "warnings": [] + }, + "cpu": { + "errors": [], + "warnings": [] + } + }' \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/ManagedCluster.yaml b/static/api-specs/idn/v2024/schemas/ManagedCluster.yaml index c12671cf3..57a65ff1a 100644 --- a/static/api-specs/idn/v2024/schemas/ManagedCluster.yaml +++ b/static/api-specs/idn/v2024/schemas/ManagedCluster.yaml @@ -132,4 +132,58 @@ properties: example: '2023-08-04T20:48:01.865Z' nullable: true type: string - format: date-time \ No newline at end of file + format: date-time + lastReleaseNotifiedAt: + description: The date/time this cluster was notified for the last release + type: string + format: date-time + nullable: true + example: "2025-03-11T07:00:13.729721Z" + updatePreferences: + description: The preference for applying updates for the cluster + type: object + properties: + processGroups: + description: The processGroups for updatePreferences + type: string + nullable: true + updateState: + description: The current updateState for the cluster + type: string + nullable: true + enum: + - null + - AUTO + - DISABLED + example: "DISABLED" + notificationEmail: + description: The mail id to which new releases will be notified + type: string + format: email + nullable: true + example: "test@mail.com" + currentInstalledReleaseVersion: + description: The current installed release on the Managed cluster + type: string + nullable: true + example: "123.1" + updatePackage: + description: New available updates for the Managed cluster + type: string + nullable: true + isOutOfDateNotifiedAt: + description: The time at which out of date notification was sent for the Managed cluster + type: string + format: date-time + nullable: true + example: "2025-03-11T07:00:13.734393Z" + consolidatedHealthIndicatorsStatus: + description: The consolidated Health Status for the Managed cluster + type: string + nullable: true + enum: + - null + - NORMAL + - WARNING + - ERROR + example: "ERROR" \ No newline at end of file From cab77035bdb544f69ed071e9b208dbe067664636 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 2 Apr 2025 06:13:18 +0000 Subject: [PATCH 11/82] Update to powershell SDK docs: 14212780503 --- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../V2024/Methods/V2024ManagedClustersApi.md | 4 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../Reference/V2024/Models/ManagedClient.md | 8 +- .../Reference/V2024/Models/ManagedCluster.md | 14 +- .../Models/ManagedClusterUpdatePreferences.md | 39 + .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../Reference/V2025/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2025/Models/SourceUsage.md | 2 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V3/Models/SourceUsage.md | 2 +- .../powershell_code_examples_overlay.yaml | 2564 ++++++------ .../powershell_code_examples_overlay.yaml | 3592 ++++++++--------- .../powershell_code_examples_overlay.yaml | 3534 ++++++++-------- .../v3/powershell_code_examples_overlay.yaml | 2474 ++++++------ 20 files changed, 6157 insertions(+), 6104 deletions(-) create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClusterUpdatePreferences.md diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md index f6a1eaaa2..9d6d48011 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index 4eef80103..414c1c740 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md index bb3b65383..05cceab03 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md index eb822fc5a..e7633a8d6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md @@ -235,7 +235,7 @@ Param Type | Name | Data Type | Required | Description Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* ### Return type [**ManagedCluster[]**](../models/managed-cluster) @@ -259,7 +259,7 @@ Code | Description | Data Type $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) +$Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) # Get Managed Clusters diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md index 9cb9ee94f..b901e027d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClient.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClient.md index 966f9f02e..a654f6157 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClient.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClient.md @@ -18,8 +18,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **String** | ManagedClient ID | [optional] [readonly] **AlertKey** | **String** | ManagedClient alert key | [optional] [readonly] -**ApiGatewayBaseUrl** | **String** | | [optional] -**Cookbook** | **String** | | [optional] +**ApiGatewayBaseUrl** | **String** | apiGatewayBaseUrl for the Managed client | [optional] +**Cookbook** | **String** | cookbook id for the Managed client | [optional] **CcId** | **Int64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] **ClientId** | **String** | The client ID used in API management | [required] **ClusterId** | **String** | Cluster ID that the ManagedClient is linked to | [required] @@ -37,6 +37,7 @@ Name | Type | Description | Notes **CreatedAt** | **System.DateTime** | The date/time this ManagedClient was created | [optional] **UpdatedAt** | **System.DateTime** | The date/time this ManagedClient was last updated | [optional] **ProvisionStatus** | **Enum** [ "PROVISIONED", "DRAFT" ] | The provisioning status of the ManagedClient | [optional] [readonly] +**HealthIndicators** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The health indicators of the ManagedClient | [optional] ## Examples @@ -62,7 +63,8 @@ $ManagedClient = Initialize-PSSailpoint.V2024ManagedClient -Id 2c9180878eaf4204 -Secret ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381 ` -CreatedAt 2023-08-04T20:48:01.865Z ` -UpdatedAt 2023-08-04T20:48:01.865Z ` - -ProvisionStatus PROVISIONED + -ProvisionStatus PROVISIONED ` + -HealthIndicators { "network": { "errors": [], "warnings": [] }, "memory": { "errors": [], "warnings": [] }, "cpu": { "errors": [], "warnings": [] } } ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md index 494c11f39..5b4c5757c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md @@ -41,6 +41,12 @@ Name | Type | Description | Notes **CcId** | **String** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"] **CreatedAt** | **System.DateTime** | The date/time this cluster was created | [optional] **UpdatedAt** | **System.DateTime** | The date/time this cluster was last updated | [optional] +**LastReleaseNotifiedAt** | **System.DateTime** | The date/time this cluster was notified for the last release | [optional] +**UpdatePreferences** | [**ManagedClusterUpdatePreferences**](managed-cluster-update-preferences) | | [optional] +**CurrentInstalledReleaseVersion** | **String** | The current installed release on the Managed cluster | [optional] +**UpdatePackage** | **String** | New available updates for the Managed cluster | [optional] +**IsOutOfDateNotifiedAt** | **System.DateTime** | The time at which out of date notification was sent for the Managed cluster | [optional] +**ConsolidatedHealthIndicatorsStatus** | **Enum** [ "NORMAL", "WARNING", "ERROR" ] | The consolidated Health Status for the Managed cluster | [optional] ## Examples @@ -70,7 +76,13 @@ $ManagedCluster = Initialize-PSSailpoint.V2024ManagedCluster -Id e1ff7bb24c9342 -ServiceCount 6 ` -CcId 1533 ` -CreatedAt 2023-08-04T20:48:01.865Z ` - -UpdatedAt 2023-08-04T20:48:01.865Z + -UpdatedAt 2023-08-04T20:48:01.865Z ` + -LastReleaseNotifiedAt 2025-03-11T07:00:13.729721Z ` + -UpdatePreferences null ` + -CurrentInstalledReleaseVersion 123.1 ` + -UpdatePackage null ` + -IsOutOfDateNotifiedAt 2025-03-11T07:00:13.734393Z ` + -ConsolidatedHealthIndicatorsStatus ERROR ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClusterUpdatePreferences.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClusterUpdatePreferences.md new file mode 100644 index 000000000..697d12eb5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClusterUpdatePreferences.md @@ -0,0 +1,39 @@ +--- +id: v2024-managed-cluster-update-preferences +title: ManagedClusterUpdatePreferences +pagination_label: ManagedClusterUpdatePreferences +sidebar_label: ManagedClusterUpdatePreferences +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences'] +slug: /tools/sdk/powershell/v2024/models/managed-cluster-update-preferences +tags: ['SDK', 'Software Development Kit', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences'] +--- + + +# ManagedClusterUpdatePreferences + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProcessGroups** | **String** | The processGroups for updatePreferences | [optional] +**UpdateState** | **Enum** [ "AUTO", "DISABLED" ] | The current updateState for the cluster | [optional] +**NotificationEmail** | **String** | The mail id to which new releases will be notified | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterUpdatePreferences = Initialize-PSSailpoint.V2024ManagedClusterUpdatePreferences -ProcessGroups null ` + -UpdateState DISABLED ` + -NotificationEmail test@mail.com +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterUpdatePreferences | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index 54727248f..6393f6ed6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md index 235e4ab2c..3d6b4c94a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md index f0699a5d6..10c9e238e 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V2025AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2025AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 34280ad09..d31582750 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2025NonEmployee -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md index 7c6c72949..e5a21ea4d 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V2025SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2025SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md index 3b9cae031..35c8a92f6 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index 071f0e39a..17d96a073 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V3NonEmployeeReq -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md index 92919ac01..0328c565b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index 5f6b70bf2..ad831aa53 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -803,6 +803,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-BetaUsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /accounts method: POST xCodeSample: @@ -1175,29 +1198,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-BetaUsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /discovered-applications/{id} method: GET xCodeSample: @@ -6536,162 +6536,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to get - $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get - - # Specified Managed Client Status. - - try { - Get-BetaManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-BetaManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to update - $ManagedClientStatus = @" - { - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - } - "@ - - # Handle status request from client - - try { - $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus - Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result - - # Below is a request that includes all optional parameters - # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for - - # Get managed cluster's log configuration - - try { - Get-BetaClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster - source: | - $Id = "aClusterId" # String | ID of the ManagedCluster to get - - # Get a specified ManagedCluster. - - try { - Get-BetaManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq operation" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Retrieve all Managed Clusters. - - try { - Get-BetaManagedClusters - - # Below is a request that includes all optional parameters - # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for - $ClientLogConfiguration = @" - { - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" - } - "@ - - # Update managed cluster's log configuration - - try { - Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result - - # Below is a request that includes all optional parameters - # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -7018,6 +6862,162 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" Write-Host $_.ErrorDetails } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to get + $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get + + # Specified Managed Client Status. + + try { + Get-BetaManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-BetaManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to update + $ManagedClientStatus = @" + { + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } + "@ + + # Handle status request from client + + try { + $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus + Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for + + # Get managed cluster's log configuration + + try { + Get-BetaClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster + source: | + $Id = "aClusterId" # String | ID of the ManagedCluster to get + + # Get a specified ManagedCluster. + + try { + Get-BetaManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq operation" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Retrieve all Managed Clusters. + + try { + Get-BetaManagedClusters + + # Below is a request that includes all optional parameters + # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for + $ClientLogConfiguration = @" + { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } + "@ + + # Update managed cluster's log configuration + + try { + Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result + + # Below is a request that includes all optional parameters + # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } - path: /multihosts method: POST xCodeSample: @@ -9796,515 +9796,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config - source: | - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ - - # Create Extended Search Attributes - - try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-BetaSearchAttributeConfig -SearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - - # Delete Extended Search Attribute - - try { - Remove-BetaSearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Remove-BetaSearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Extended Search Attributes - - try { - Get-BetaSearchAttributeConfig - - # Below is a request that includes all optional parameters - # Get-BetaSearchAttributeConfig -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - - # Get Extended Search Attribute - - try { - Get-BetaSingleSearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Get-BetaSingleSearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config - source: | - $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Extended Search Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment - source: | - $Segment = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-BetaSegment -Segment $Result - - # Below is a request that includes all optional parameters - # New-BetaSegment -Segment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-BetaSegment -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSegment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-BetaSegment -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSegment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Segments - - try { - Get-BetaSegments - - # Below is a request that includes all optional parameters - # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSegment -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaSegment -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration - source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - } - "@ - - # Create new Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration - source: | - $Id = "anId" # String | ID of Service Desk integration to delete - - # Delete a Service Desk integration - - try { - Remove-BetaServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to get - - # Get a Service Desk integration - - try { - Get-BetaServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List existing Service Desk integrations - - try { - Get-BetaServiceDeskIntegrationList - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - - # Service Desk integration template by scriptName - - try { - Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types - source: | - - # List Service Desk integration types - - try { - Get-BetaServiceDeskIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details - source: | - - # Get the time check configuration - - try { - Get-BetaStatusCheckDetails - - # Below is a request that includes all optional parameters - # Get-BetaStatusCheckDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - - "@ - - # Patch a Service Desk Integration - - try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - - # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - } - "@ - - # Update a Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details - source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ - - # Update the time check configuration - - try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result - - # Below is a request that includes all optional parameters - # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails - } - path: /sim-integrations method: POST xCodeSample: @@ -11042,6 +10533,697 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" Write-Host $_.ErrorDetails } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-BetaSpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-BetaSpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-BetaSpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-BetaSpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-BetaSpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-BetaSpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-BetaSpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-BetaSpConfigObjects + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-BetaSearchAttributeConfig -SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-BetaSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Remove-BetaSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Extended Search Attributes + + try { + Get-BetaSearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-BetaSearchAttributeConfig -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. + + # Get Extended Search Attribute + + try { + Get-BetaSingleSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Get-BetaSingleSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-BetaSegment -Segment $Result + + # Below is a request that includes all optional parameters + # New-BetaSegment -Segment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-BetaSegment -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSegment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-BetaSegment -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSegment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-BetaSegments + + # Below is a request that includes all optional parameters + # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSegment -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSegment -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-BetaServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-BetaServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-BetaServiceDeskIntegrationList + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-BetaServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details + source: | + + # Get the time check configuration + + try { + Get-BetaStatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-BetaStatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-BetaStatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaStatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-BetaUsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" + Write-Host $_.ErrorDetails + } - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -12359,188 +12541,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-BetaStatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaStatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-BetaUsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-BetaSpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-BetaSpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-BetaSpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-BetaSpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-BetaSpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-BetaSpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-BetaSpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-BetaSpConfigObjects - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" - Write-Host $_.ErrorDetails - } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -13726,418 +13726,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-BetaWorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-BetaWorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-BetaWorkflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaWorkflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-BetaWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaWorkflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-BetaWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-BetaWorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-BetaWorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-BetaWorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-BetaCompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-BetaWorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-BetaWorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-BetaWorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-BetaWorkflows - - # Below is a request that includes all optional parameters - # Get-BetaWorkflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $PostExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - Submit-BetaExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - Submit-BetaWorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # Submit-BetaWorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-BetaExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Update-BetaWorkflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails - } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -14606,3 +14194,415 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-BetaWorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-BetaWorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-BetaWorkflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-BetaWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-BetaWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-BetaWorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-BetaWorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-BetaWorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-BetaCompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-BetaWorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-BetaWorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-BetaWorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-BetaWorkflows + + # Below is a request that includes all optional parameters + # Get-BetaWorkflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $PostExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + Submit-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + Submit-BetaWorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaWorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Update-BetaWorkflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index dc3795d02..1efdac59c 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -909,6 +909,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2024UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /accounts method: POST xCodeSample: @@ -1286,29 +1309,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2024UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /discovered-applications method: GET xCodeSample: @@ -2851,6 +2851,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2024IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2024IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2024IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3129,95 +3218,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2024IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2024IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2024IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /configuration-hub/deploys method: POST xCodeSample: @@ -8479,6 +8479,164 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" Write-Host $_.ErrorDetails } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-V2024MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-V2024MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-V2024MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2024MFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2024MFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-V2024MFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-V2024MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" + Write-Host $_.ErrorDetails + } - path: /machine-accounts/{id} method: GET xCodeSample: @@ -8800,184 +8958,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" Write-Host $_.ErrorDetails } -- path: /managed-clusters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-V2024ManagedCluster -ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ManagedCluster -ManagedClusterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-V2024ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-V2024ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-V2024ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-V2024ManagedClusters - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/manualUpgrade - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. - - # Trigger Manual Upgrade for Managed Cluster - - try { - Update-V2024 -Id $Id - - # Below is a request that includes all optional parameters - # Update-V2024 -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } - path: /managed-cluster-types method: POST xCodeSample: @@ -9100,162 +9080,182 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClusterType" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-V2024MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-V2024MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-V2024MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2024MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config/answers +- path: /managed-clusters method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#create-managed-cluster source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" + $ManagedClusterRequest = @" { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" } "@ - # Set Okta MFA configuration + # Create Create Managed Cluster try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2024MFAOktaConfig -MfaOktaConfig $Result + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-V2024ManagedCluster -ManagedClusterRequest $Result # Below is a request that includes all optional parameters - # Set-V2024MFAOktaConfig -MfaOktaConfig $Result + # New-V2024ManagedCluster -ManagedClusterRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" Write-Host $_.ErrorDetails } -- path: /mfa/{method}/test +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#delete-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-V2024ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-client-log-configuration source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - # MFA method's test configuration + # Get Managed Cluster Log Configuration try { - Test-V2024MFAConfig -Method $Method + Get-V2024ClientLogConfiguration -Id $Id # Below is a request that includes all optional parameters - # Test-V2024MFAConfig -Method $Method + # Get-V2024ClientLogConfiguration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-V2024ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-V2024ManagedClusters + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/manualUpgrade + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. + + # Trigger Manual Upgrade for Managed Cluster + + try { + Update-V2024 -Id $Id + + # Below is a request that includes all optional parameters + # Update-V2024 -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" Write-Host $_.ErrorDetails } - path: /multihosts @@ -12403,6 +12403,954 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" Write-Host $_.ErrorDetails } +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration + source: | + $Id = "12345" # String | The id of the integration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a SIM integration + + try { + Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a SIM integration details. + + try { + Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2024SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2024SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2024SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-V2024SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2024SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2024SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2024SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-V2024SodPolicies + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2024SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2024SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2024EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2024SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2024SpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2024SpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-V2024SpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-V2024SpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-V2024SpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-V2024SpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2024SpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-V2024SpConfigObjects + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.ErrorDetails + } - path: /saved-searches method: POST xCodeSample: @@ -13766,812 +14714,46 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration - source: | - $Id = "12345" # String | The id of the integration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a SIM integration - - try { - Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - # Get a SIM integration details. + # Finds status of source usage try { - Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2024StatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2024StatusBySourceId -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" Write-Host $_.ErrorDetails } -- path: /sim-integrations +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2024SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2024SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2024SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2024DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2024SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2024SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2024SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2024SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - # List SOD policies + # Returns source usage insights try { - Get-V2024SodPolicies + Get-V2024UsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2024SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2024SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2024EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2024SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2024PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -16049,188 +16231,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-V2024StatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024StatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-V2024UsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2024SpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2024SpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-V2024SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-V2024SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-V2024SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-V2024SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2024SpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-V2024SpConfigObjects - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" - Write-Host $_.ErrorDetails - } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -17382,418 +17382,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2024WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2024WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2024ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2024Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2024WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-V2024WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2024Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2024Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2024WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2024WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2024WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-V2024CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-V2024WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2024WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-V2024WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2024Workflows - - # Below is a request that includes all optional parameters - # Get-V2024Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2024Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2024Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2024ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" - Write-Host $_.ErrorDetails - } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -18270,3 +17858,415 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2024WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2024ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2024Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2024WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-V2024WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2024Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2024Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2024WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2024WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2024WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-V2024CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-V2024WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-V2024WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-V2024WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-V2024Workflows + + # Below is a request that includes all optional parameters + # Get-V2024Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2024Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2024Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2024ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.ErrorDetails + } diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index 5a73e13b7..47a10dee2 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -909,6 +909,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountAggregationStatus" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2025UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /accounts method: POST xCodeSample: @@ -1286,29 +1309,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Account" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2025UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /discovered-applications method: GET xCodeSample: @@ -2851,6 +2851,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Campaign" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2025IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2025IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2025IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2025IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3129,95 +3218,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025ReassignCertsAsync" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2025IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2025IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2025IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /configuration-hub/deploys method: POST xCodeSample: @@ -8479,6 +8479,164 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025LifecycleStates" Write-Host $_.ErrorDetails } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-V2025MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-kba-config + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-V2025MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-V2025MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-duo-config + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2025MFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfakba-config + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-okta-config + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2025MFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#test-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-V2025MFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-V2025MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025MFAConfig" + Write-Host $_.ErrorDetails + } - path: /machine-accounts/{id} method: GET xCodeSample: @@ -8800,6 +8958,128 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClient" Write-Host $_.ErrorDetails } +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#create-managed-cluster-type + source: | + $ManagedClusterType = @" + { + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + } + "@ + + # Create new Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType + New-V2025ManagedClusterType -ManagedClusterType $Result + + # Below is a request that includes all optional parameters + # New-V2025ManagedClusterType -ManagedClusterType $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#delete-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Delete a Managed Cluster Type + + try { + Remove-V2025ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Get a Managed Cluster Type + + try { + Get-V2025ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-types + source: | + $Type = "IDN" # String | Type descriptor (optional) + $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) + $Org = "denali-xyz" # String | Pinned org (or default) (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # List Managed Cluster Types + + try { + Get-V2025ManagedClusterTypes + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterTypes" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#update-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Update a Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } - path: /managed-clusters method: POST xCodeSample: @@ -8978,286 +9258,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedCluster" Write-Host $_.ErrorDetails } -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - $ManagedClusterType = @" - { - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - } - "@ - - # Create new Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType - New-V2025ManagedClusterType -ManagedClusterType $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedClusterType -ManagedClusterType $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Delete a Managed Cluster Type - - try { - Remove-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Get a Managed Cluster Type - - try { - Get-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - $Type = "IDN" # String | Type descriptor (optional) - $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) - $Org = "denali-xyz" # String | Pinned org (or default) (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Managed Cluster Types - - try { - Get-V2025ManagedClusterTypes - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterTypes" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update a Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-V2025MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-V2025MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAKbaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-V2025MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2025MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAKBAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2025MFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-V2025MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-V2025MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025MFAConfig" - Write-Host $_.ErrorDetails - } - path: /multihosts method: POST xCodeSample: @@ -12403,6 +12403,954 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByQuery" Write-Host $_.ErrorDetails } +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration + source: | + $Id = "12345" # String | The id of the integration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a SIM integration + + try { + Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a SIM integration details. + + try { + Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2025SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2025SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2025SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2025DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-V2025SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2025SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2025SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2025SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-V2025SodPolicies + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2025SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2025SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2025EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2025SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2025PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2025SpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2025SpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-V2025SpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-V2025SpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-V2025SpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-V2025SpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2025SpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-V2025SpConfigObjects + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" + Write-Host $_.ErrorDetails + } - path: /saved-searches method: POST xCodeSample: @@ -13766,812 +14714,46 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration - source: | - $Id = "12345" # String | The id of the integration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a SIM integration - - try { - Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - # Get a SIM integration details. + # Finds status of source usage try { - Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025StatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025StatusBySourceId -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" Write-Host $_.ErrorDetails } -- path: /sim-integrations +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2025SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2025SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2025SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2025SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2025SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies + label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - # List SOD policies + # Returns source usage insights try { - Get-V2025SodPolicies + Get-V2025UsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2025SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2025SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2025EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2025SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -16049,188 +16231,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchema" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-V2025StatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025StatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-V2025UsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2025SpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2025SpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-V2025SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-V2025SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-V2025SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-V2025SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2025SpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-V2025SpConfigObjects - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" - Write-Host $_.ErrorDetails - } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -17382,418 +17382,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025VendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2025Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2025WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2025WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2025WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-V2025CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-V2025WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2025WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-V2025WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2025Workflows - - # Below is a request that includes all optional parameters - # Get-V2025Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2025Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2025Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" - Write-Host $_.ErrorDetails - } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -18270,3 +17858,415 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TenantConfiguration" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2025WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2025WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2025ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2025Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2025WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-V2025WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2025Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2025Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2025WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2025WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2025WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-V2025CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-V2025WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-V2025WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-V2025WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-V2025Workflows + + # Below is a request that includes all optional parameters + # Get-V2025Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2025Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2025Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2025ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" + Write-Host $_.ErrorDetails + } diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index f4d1a2791..f60bafeec 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -636,6 +636,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /accounts method: POST xCodeSample: @@ -903,29 +926,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /discovered-applications method: GET xCodeSample: @@ -2013,6 +2013,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2291,95 +2380,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -3560,298 +3560,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client - source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ - - # Create Managed Client - - try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-ManagedClient -ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedClient -ManagedClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Delete Managed Client - - try { - Remove-ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Get Managed Client - - try { - Get-ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. - - # Get Managed Client Status - - try { - Get-ManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-ManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - - # Get Managed Clients - - try { - Get-ManagedClients - - # Below is a request that includes all optional parameters - # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-ManagedCluster -ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedCluster -ManagedClusterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-ManagedClusters - - # Below is a request that includes all optional parameters - # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedCluster -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" - Write-Host $_.ErrorDetails - } - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -4178,6 +3886,298 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" Write-Host $_.ErrorDetails } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-ManagedClient -ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedClient -ManagedClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-ManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-ManagedClients + + # Below is a request that includes all optional parameters + # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-ManagedCluster -ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedCluster -ManagedClusterRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-ClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-ManagedClusters + + # Below is a request that includes all optional parameters + # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" + Write-Host $_.ErrorDetails + } - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -6128,6 +6128,558 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" Write-Host $_.ErrorDetails } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-SodPolicies + + # Below is a request that includes all optional parameters + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" + Write-Host $_.ErrorDetails + } - path: /saved-searches method: POST xCodeSample: @@ -7438,556 +7990,46 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - # Download custom violation report + # Finds status of source usage try { - Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + Get-StatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + # Get-StatusBySourceId -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - # List SOD policies + # Returns source usage insights try { - Get-SodPolicies + Get-UsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -8900,48 +8942,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-StatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-StatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-UsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" - Write-Host $_.ErrorDetails - } - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -9405,6 +9405,272 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Approve-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) + + # Complete a Work Item + + try { + Complete-WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Complete-WorkItem -Id $Id -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-CountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CountCompletedWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-CountWorkItems + + # Below is a request that includes all optional parameters + # Get-CountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-WorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-WorkItems + + # Below is a request that includes all optional parameters + # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Deny-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-WorkItemForward -Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Send-WorkItemForward -Id $Id -WorkItemForward $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-AccountSelection -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-AccountSelection -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" + Write-Host $_.ErrorDetails + } - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -9817,269 +10083,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Approve an Approval Item - - try { - Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk approve Approval Items - - try { - Approve-ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Approve-ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) - - # Complete a Work Item - - try { - Complete-WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Complete-WorkItem -Id $Id -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Completed Work Items - - try { - Get-CompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Count Completed Work Items - - try { - Get-CountCompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-CountCompletedWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items - source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - - # Count Work Items - - try { - Get-CountWorkItems - - # Below is a request that includes all optional parameters - # Get-CountWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - - # Get a Work Item - - try { - Get-WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Get-WorkItem -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Work Items Summary - - try { - Get-WorkItemsSummary - - # Below is a request that includes all optional parameters - # Get-WorkItemsSummary -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" - Write-Host $_.ErrorDetails - } -- path: /work-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # List Work Items - - try { - Get-WorkItems - - # Below is a request that includes all optional parameters - # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Reject an Approval Item - - try { - Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk reject Approval Items - - try { - Deny-ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Deny-ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ - - # Forward a Work Item - - try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Send-WorkItemForward -Id $Id -WorkItemForward $Result - - # Below is a request that includes all optional parameters - # Send-WorkItemForward -Id $Id -WorkItemForward $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - - # Submit Account Selections - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-AccountSelection -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Submit-AccountSelection -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" - Write-Host $_.ErrorDetails - } From 635580862626c02e91d687c1c29e9872d26cc4de Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 2 Apr 2025 06:13:45 +0000 Subject: [PATCH 12/82] Update to python SDK docs: 14212788787 --- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../V2024/Methods/ManagedClustersApi.md | 4 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../Reference/V2024/Models/ManagedClient.md | 8 +- .../Reference/V2024/Models/ManagedCluster.md | 17 +- .../Models/ManagedClusterUpdatePreferences.md | 38 + .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../Reference/V2025/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2025/Models/SourceUsage.md | 2 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../python/Reference/V3/Models/SourceUsage.md | 2 +- .../beta/python_code_examples_overlay.yaml | 3094 ++++++------ .../v2024/python_code_examples_overlay.yaml | 4302 ++++++++--------- .../v2025/python_code_examples_overlay.yaml | 4220 ++++++++-------- .../v3/python_code_examples_overlay.yaml | 2978 ++++++------ 20 files changed, 7374 insertions(+), 7319 deletions(-) create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterUpdatePreferences.md diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md index 6d30198f2..dced03305 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index e0b91fdea..bffe6c49e 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md index 72badf0ff..fbcbd7a29 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md index 3f089f369..d73824e5e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md @@ -284,7 +284,7 @@ Param Type | Name | Data Type | Required | Description Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* ### Return type [**List[ManagedCluster]**](../models/managed-cluster) @@ -317,7 +317,7 @@ with ApiClient(configuration) as api_client: offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) try: # Get Managed Clusters diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md index 442faa748..5353898b1 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClient.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClient.md index 3874acc1f..bab03340e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClient.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClient.md @@ -19,8 +19,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | ManagedClient ID | [optional] [readonly] **alert_key** | **str** | ManagedClient alert key | [optional] [readonly] -**api_gateway_base_url** | **str** | | [optional] -**cookbook** | **str** | | [optional] +**api_gateway_base_url** | **str** | apiGatewayBaseUrl for the Managed client | [optional] +**cookbook** | **str** | cookbook id for the Managed client | [optional] **cc_id** | **int** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] **client_id** | **str** | The client ID used in API management | [required] **cluster_id** | **str** | Cluster ID that the ManagedClient is linked to | [required] @@ -38,6 +38,7 @@ Name | Type | Description | Notes **created_at** | **datetime** | The date/time this ManagedClient was created | [optional] **updated_at** | **datetime** | The date/time this ManagedClient was last updated | [optional] **provision_status** | **Enum** [ 'PROVISIONED', 'DRAFT' ] | The provisioning status of the ManagedClient | [optional] [readonly] +**health_indicators** | **object** | The health indicators of the ManagedClient | [optional] } ## Example @@ -66,7 +67,8 @@ va_version='va-megapod-useast1-610-1621372012', secret='ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381', created_at='2023-08-04T20:48:01.865Z', updated_at='2023-08-04T20:48:01.865Z', -provision_status='PROVISIONED' +provision_status='PROVISIONED', +health_indicators={ "network": { "errors": [], "warnings": [] }, "memory": { "errors": [], "warnings": [] }, "cpu": { "errors": [], "warnings": [] } } ) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md index c6108d6c5..e1d6034e6 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md @@ -42,6 +42,12 @@ Name | Type | Description | Notes **cc_id** | **str** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to '0'] **created_at** | **datetime** | The date/time this cluster was created | [optional] **updated_at** | **datetime** | The date/time this cluster was last updated | [optional] +**last_release_notified_at** | **datetime** | The date/time this cluster was notified for the last release | [optional] +**update_preferences** | [**ManagedClusterUpdatePreferences**](managed-cluster-update-preferences) | | [optional] +**current_installed_release_version** | **str** | The current installed release on the Managed cluster | [optional] +**update_package** | **str** | New available updates for the Managed cluster | [optional] +**is_out_of_date_notified_at** | **datetime** | The time at which out of date notification was sent for the Managed cluster | [optional] +**consolidated_health_indicators_status** | **Enum** [ 'NORMAL', 'WARNING', 'ERROR' ] | The consolidated Health Status for the Managed cluster | [optional] } ## Example @@ -88,7 +94,16 @@ client_ids=[1244, 1245], service_count=6, cc_id='0', created_at='2023-08-04T20:48:01.865Z', -updated_at='2023-08-04T20:48:01.865Z' +updated_at='2023-08-04T20:48:01.865Z', +last_release_notified_at='2025-03-11T07:00:13.729721Z', +update_preferences=sailpoint.v2024.models.managed_cluster_update_preferences.ManagedCluster_updatePreferences( + process_groups = '', + update_state = 'DISABLED', + notification_email = 'test@mail.com', ), +current_installed_release_version='123.1', +update_package='', +is_out_of_date_notified_at='2025-03-11T07:00:13.734393Z', +consolidated_health_indicators_status='ERROR' ) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterUpdatePreferences.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterUpdatePreferences.md new file mode 100644 index 000000000..164f815f4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterUpdatePreferences.md @@ -0,0 +1,38 @@ +--- +id: v2024-managed-cluster-update-preferences +title: ManagedClusterUpdatePreferences +pagination_label: ManagedClusterUpdatePreferences +sidebar_label: ManagedClusterUpdatePreferences +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences'] +slug: /tools/sdk/python/v2024/models/managed-cluster-update-preferences +tags: ['SDK', 'Software Development Kit', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences'] +--- + +# ManagedClusterUpdatePreferences + +The preference for applying updates for the cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**process_groups** | **str** | The processGroups for updatePreferences | [optional] +**update_state** | **Enum** [ 'AUTO', 'DISABLED' ] | The current updateState for the cluster | [optional] +**notification_email** | **str** | The mail id to which new releases will be notified | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.managed_cluster_update_preferences import ManagedClusterUpdatePreferences + +managed_cluster_update_preferences = ManagedClusterUpdatePreferences( +process_groups='', +update_state='DISABLED', +notification_email='test@mail.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index a37f38fea..db5a37930 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md index ea8523f54..c57393c0d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md index 8403e7986..626e62e2b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 960d4b101..33437e264 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md index 3f731dad1..3091b3a26 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md index a1615a57b..211d1a3d1 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index a80904ad9..049a9aafe 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md index 159a7ebe0..4d3443864 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index f411cfd5d..57728a5a4 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -936,6 +936,35 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.beta.api.account_usages_api import AccountUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1384,35 +1413,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.beta.api.account_usages_api import AccountUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications/{id} method: GET xCodeSample: @@ -7644,195 +7644,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.beta.api.managed_clients_api import ManagedClientsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_client_status import ManagedClientStatus - from sailpoint.beta.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get - type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get - try: - # Specified Managed Client Status. - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status - source: | - from sailpoint.beta.api.managed_clients_api import ManagedClientsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_client_status import ManagedClientStatus - from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update - managed_client_status = '''{ - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - }''' # ManagedClientStatus | - try: - # Handle status request from client - new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) - results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) - print("The response of ManagedClientsApi->update_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for - try: - # Get managed cluster's log configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get - try: - # Get a specified ManagedCluster. - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq operation' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Retrieve all Managed Clusters. - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for - client_log_configuration = '''{ - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" - }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster - try: - # Update managed cluster's log configuration - - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -8219,6 +8030,195 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.beta.api.managed_clients_api import ManagedClientsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_client_status import ManagedClientStatus + from sailpoint.beta.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get + type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get + try: + # Specified Managed Client Status. + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status + source: | + from sailpoint.beta.api.managed_clients_api import ManagedClientsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_client_status import ManagedClientStatus + from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update + managed_client_status = '''{ + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + }''' # ManagedClientStatus | + try: + # Handle status request from client + new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) + results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) + print("The response of ManagedClientsApi->update_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for + try: + # Get managed cluster's log configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get + try: + # Get a specified ManagedCluster. + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq operation' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + try: + # Retrieve all Managed Clusters. + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for + client_log_configuration = '''{ + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + try: + # Update managed cluster's log configuration + + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -11476,601 +11476,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - search_attribute_config = '''{ - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - }''' # SearchAttributeConfig | - try: - # Create Extended Search Attributes - new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) - results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) - print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. - try: - # Delete Extended Search Attribute - - SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) - # Below is a request that includes all optional parameters - # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Extended Search Attributes - - results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) - print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. - try: - # Get Extended Search Attribute - - results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) - print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.json_patch_operation import JsonPatchOperation - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. - json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | - try: - # Update Extended Search Attribute - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) - print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) -- path: /segments - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#create-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - segment = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - }''' # Segment | - try: - # Create Segment - new_segment = Segment.from_json(segment) - results = SegmentsApi(api_client).create_segment(segment=new_segment) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).create_segment(new_segment) - print("The response of SegmentsApi->create_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->create_segment: %s\n" % e) -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#delete-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. - try: - # Delete Segment by ID - - SegmentsApi(api_client).delete_segment(id=id) - # Below is a request that includes all optional parameters - # SegmentsApi(api_client).delete_segment(id) - except Exception as e: - print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) -- path: /segments/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#get-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. - try: - # Get Segment by ID - - results = SegmentsApi(api_client).get_segment(id=id) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).get_segment(id) - print("The response of SegmentsApi->get_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->get_segment: %s\n" % e) -- path: /segments - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#list-segments - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Segments - - results = SegmentsApi(api_client).list_segments() - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).list_segments(limit, offset, count) - print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->list_segments: %s\n" % e) -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#patch-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. - request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - try: - # Update Segment - new_request_body = RequestBody.from_json(request_body) - results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).patch_segment(id, new_request_body) - print("The response of SegmentsApi->patch_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create - try: - # Create new Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete - try: - # Delete a Service Desk integration - - ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get - try: - # Get a Service Desk integration - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List existing Service Desk integrations - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get - try: - # Service Desk integration template by scriptName - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Service Desk integration types - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get the time check configuration - - results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - try: - # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) - print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of the integration to update - try: - # Update a Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - queued_check_config_details = '''{ - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - }''' # QueuedCheckConfigDetails | The modified time check configuration - try: - # Update the time check configuration - new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) - results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) - print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) - path: /sim-integrations method: POST xCodeSample: @@ -12918,6 +12323,835 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.export_payload import ExportPayload + from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.import_options import ImportOptions + from sailpoint.beta.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + search_attribute_config = '''{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }''' # SearchAttributeConfig | + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. + try: + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. + try: + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) +- path: /segments + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#create-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + segment = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }''' # Segment | + try: + # Create Segment + new_segment = Segment.from_json(segment) + results = SegmentsApi(api_client).create_segment(segment=new_segment) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).create_segment(new_segment) + print("The response of SegmentsApi->create_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#delete-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + SegmentsApi(api_client).delete_segment(id=id) + # Below is a request that includes all optional parameters + # SegmentsApi(api_client).delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) +- path: /segments/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#get-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + results = SegmentsApi(api_client).get_segment(id=id) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) +- path: /segments + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#list-segments + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # List Segments + + results = SegmentsApi(api_client).list_segments() + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#patch-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + try: + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).patch_segment(id, new_request_body) + print("The response of SegmentsApi->patch_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # List existing Service Desk integrations + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Service Desk integration types + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get the time check configuration + + results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + try: + # Patch a Service Desk Integration + new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }''' # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + queued_check_config_details = '''{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }''' # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) + results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.beta.api.source_usages_api import SourceUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.beta.api.source_usages_api import SourceUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -14328,240 +14562,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.beta.api.source_usages_api import SourceUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.beta.api.source_usages_api import SourceUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.export_payload import ExportPayload - from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.import_options import ImportOptions - from sailpoint.beta.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -15911,506 +15911,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.json_patch_operation import JsonPatchOperation - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response - from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) - print("The response of WorkflowsApi->post_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) - print("The response of WorkflowsApi->post_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#update-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.beta.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).update_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).update_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->update_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -16995,3 +16495,503 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response + from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) + print("The response of WorkflowsApi->post_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) + print("The response of WorkflowsApi->post_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#update-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.beta.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).update_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).update_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->update_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index 181d9c1fa..fe609ed05 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -1068,6 +1068,35 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2024.api.account_usages_api import AccountUsagesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1526,35 +1555,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2024.api.account_usages_api import AccountUsagesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -3368,6 +3368,119 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3696,119 +3809,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: @@ -10084,6 +10084,196 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -10476,220 +10666,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-clusters - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-clusters#create-managed-cluster - source: | - from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster import ManagedCluster - from sailpoint.v2024.models.managed_cluster_request import ManagedClusterRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_request = '''{ - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - }''' # ManagedClusterRequest | - try: - # Create Create Managed Cluster - new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) - results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) - print("The response of ManagedClustersApi->create_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-clusters#delete-managed-cluster - source: | - from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) - try: - # Delete Managed Cluster - - ManagedClustersApi(api_client).delete_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) - except Exception as e: - print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. - try: - # Get Managed Cluster Log Configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - try: - # Get Managed Cluster - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Get Managed Clusters - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.client_log_configuration import ClientLogConfiguration - from sailpoint.v2024.models.put_client_log_configuration_request import PutClientLogConfigurationRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. - put_client_log_configuration_request = '''sailpoint.v2024.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. - try: - # Update Managed Cluster Log Configuration - new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id}/manualUpgrade - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-clusters#update - source: | - from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.cluster_manual_upgrade import ClusterManualUpgrade - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to trigger manual upgrade. # str | ID of managed cluster to trigger manual upgrade. - try: - # Trigger Manual Upgrade for Managed Cluster - - results = ManagedClustersApi(api_client).update(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).update(id) - print("The response of ManagedClustersApi->update:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->update: %s\n" % e) -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-clusters#update-managed-cluster - source: | - from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2024.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Cluster - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) - print("The response of ManagedClustersApi->update_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /managed-cluster-types method: POST xCodeSample: @@ -10834,196 +10810,220 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers +- path: /managed-clusters method: POST xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#create-managed-cluster source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.v2024.models.managed_cluster import ManagedCluster + from sailpoint.v2024.models.managed_cluster_request import ManagedClusterRequest from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + managed_cluster_request = '''{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }''' # ManagedClusterRequest | try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Create Create Managed Cluster + new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) + results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") + # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) + print("The response of ManagedClustersApi->create_managed_cluster:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#delete-managed-cluster + source: | + from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) + try: + # Delete Managed Cluster + + ManagedClustersApi(api_client).delete_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) + except Exception as e: + print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id}/log-config method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-client-log-configuration source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.v2024.models.client_log_configuration import ClientLogConfiguration from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. try: - # MFA method's test configuration + # Get Managed Cluster Log Configuration - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) + try: + # Get Managed Clusters + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.client_log_configuration import ClientLogConfiguration + from sailpoint.v2024.models.put_client_log_configuration_request import PutClientLogConfigurationRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. + put_client_log_configuration_request = '''sailpoint.v2024.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id}/manualUpgrade + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#update + source: | + from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.cluster_manual_upgrade import ClusterManualUpgrade + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to trigger manual upgrade. # str | ID of managed cluster to trigger manual upgrade. + try: + # Trigger Manual Upgrade for Managed Cluster + + results = ManagedClustersApi(api_client).update(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).update(id) + print("The response of ManagedClustersApi->update:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->update: %s\n" % e) +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#update-managed-cluster + source: | + from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Cluster + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -14739,6 +14739,1119 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) +- path: /sim-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration + try: + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2024.api.sod_violations_api import SODViolationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2024.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2024.api.sod_violations_api import SODViolationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2024.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.export_payload import ExportPayload + from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.import_options import ImportOptions + from sailpoint.v2024.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -16252,939 +17365,60 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api.source_usages_api import SourceUsagesApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.source_usage_status import SourceUsageStatus from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source try: - # Get a SIM integration details. + # Finds status of source usage - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api.source_usages_api import SourceUsagesApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.v2024.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) try: - # List SOD policies + # Returns source usage insights - results = SODPoliciesApi(api_client).list_sod_policies() + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2024.api.sod_violations_api import SODViolationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2024.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2024.api.sod_violations_api import SODViolationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2024.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -18793,240 +19027,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.v2024.api.source_usages_api import SourceUsagesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.v2024.api.source_usages_api import SourceUsagesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.export_payload import ExportPayload - from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.import_options import ImportOptions - from sailpoint.v2024.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -20351,506 +20351,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v2024.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.v2024.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v2024.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -21455,3 +20955,503 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = '''sailpoint.v2024.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.v2024.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.v2024.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index ef50dc4db..06ce63fa3 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -1068,6 +1068,35 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2025.api.account_usages_api import AccountUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1526,35 +1555,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2025.api.account_usages_api import AccountUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -3368,6 +3368,119 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3696,119 +3809,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: @@ -10084,6 +10084,196 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -10476,6 +10666,150 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_type = '''{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }''' # ManagedClusterType | + try: + # Create new Managed Cluster Type + new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) + results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) + print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Delete a Managed Cluster Type + + ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Get a Managed Cluster Type + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) + print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) + pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) + org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + try: + # List Managed Cluster Types + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) + print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JSONPatch payload used to update the schema. + try: + # Update a Managed Cluster Type + new_json_patch = JsonPatch.from_json(json_patch) + results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) + print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: @@ -10690,340 +11024,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -14739,6 +14739,1119 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) +- path: /sim-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration + try: + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2025.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2025.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.export_payload import ExportPayload + from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.import_options import ImportOptions + from sailpoint.v2025.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -16252,939 +17365,60 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.source_usage_status import SourceUsageStatus from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source try: - # Get a SIM integration details. + # Finds status of source usage - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.v2025.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) try: - # List SOD policies + # Returns source usage insights - results = SODPoliciesApi(api_client).list_sod_policies() + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2025.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2025.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -18793,240 +19027,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.export_payload import ExportPayload - from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.import_options import ImportOptions - from sailpoint.v2025.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -20351,506 +20351,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.v2025.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -21455,3 +20955,503 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.v2025.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index f5d5cfe68..5e569934f 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -727,6 +727,35 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v3.api.account_usages_api import AccountUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1046,35 +1075,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v3.api.account_usages_api import AccountUsagesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -2322,6 +2322,119 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2650,119 +2763,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -4085,355 +4085,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /managed-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.v3.models.managed_client_request import ManagedClientRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_client_request = '''{ - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - }''' # ManagedClientRequest | - try: - # Create Managed Client - new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) - results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) - print("The response of ManagedClientsApi->create_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Delete Managed Client - - ManagedClientsApi(api_client).delete_managed_client(id=id) - # Below is a request that includes all optional parameters - # ManagedClientsApi(api_client).delete_managed_client(id) - except Exception as e: - print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Get Managed Client - - results = ManagedClientsApi(api_client).get_managed_client(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client(id) - print("The response of ManagedClientsApi->get_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client_status import ManagedClientStatus - from sailpoint.v3.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. - type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. - try: - # Get Managed Client Status - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-clients - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - try: - # Get Managed Clients - - results = ManagedClientsApi(api_client).get_managed_clients() - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) - print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Client - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) - print("The response of ManagedClientsApi->update_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-clusters - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_request = '''{ - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - }''' # ManagedClusterRequest | - try: - # Create Create Managed Cluster - new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) - results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) - print("The response of ManagedClustersApi->create_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) - try: - # Delete Managed Cluster - - ManagedClustersApi(api_client).delete_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) - except Exception as e: - print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. - try: - # Get Managed Cluster Log Configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - try: - # Get Managed Cluster - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Get Managed Clusters - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration - from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. - put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. - try: - # Update Managed Cluster Log Configuration - new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Cluster - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) - print("The response of ManagedClustersApi->update_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -4820,6 +4471,355 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) +- path: /managed-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.v3.models.managed_client_request import ManagedClientRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_client_request = '''{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }''' # ManagedClientRequest | + try: + # Create Managed Client + new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) + results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) + print("The response of ManagedClientsApi->create_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + ManagedClientsApi(api_client).delete_managed_client(id=id) + # Below is a request that includes all optional parameters + # ManagedClientsApi(api_client).delete_managed_client(id) + except Exception as e: + print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + results = ManagedClientsApi(api_client).get_managed_client(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client_status import ManagedClientStatus + from sailpoint.v3.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. + type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + try: + # Get Managed Client Status + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + try: + # Get Managed Clients + + results = ManagedClientsApi(api_client).get_managed_clients() + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) + print("The response of ManagedClientsApi->update_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-clusters + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_request = '''{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }''' # ManagedClusterRequest | + try: + # Create Create Managed Cluster + new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) + results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) + try: + # Delete Managed Cluster + + ManagedClustersApi(api_client).delete_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) + except Exception as e: + print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. + try: + # Get Managed Cluster Log Configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + try: + # Get Managed Clusters + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. + put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Cluster + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -7083,6 +7083,645 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v3.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v3.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -8538,645 +9177,60 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report + label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api.source_usages_api import SourceUsagesApi from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source_usage_status import SourceUsageStatus from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source try: - # Download custom violation report + # Finds status of source usage - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report + label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api.source_usages_api import SourceUsagesApi from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) try: - # List SOD policies + # Returns source usage insights - results = SODPoliciesApi(api_client).list_sod_policies() + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v3.api.sod_violations_api import SODViolationsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v3.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check - source: | - from sailpoint.v3.api.sod_violations_api import SODViolationsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v3.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -10095,60 +10149,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.v3.api.source_usages_api import SourceUsagesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.v3.api.source_usages_api import SourceUsagesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -10647,6 +10647,344 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Approve an Approval Item + + results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) + try: + # Complete a Work Item + + results = WorkItemsApi(api_client).complete_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id, new_body) + print("The response of WorkItemsApi->complete_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # Completed Work Items + + results = WorkItemsApi(api_client).get_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Completed Work Items + + results = WorkItemsApi(api_client).get_count_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + results = WorkItemsApi(api_client).get_count_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + results = WorkItemsApi(api_client).get_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_summary import WorkItemsSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + results = WorkItemsApi(api_client).get_work_items_summary() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + results = WorkItemsApi(api_client).list_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Reject an Approval Item + + results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_item_forward import WorkItemForward + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + work_item_forward = '''{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }''' # WorkItemForward | + try: + # Forward a Work Item + new_work_item_forward = WorkItemForward.from_json(work_item_forward) + WorkItemsApi(api_client).send_work_item_forward(id=id, work_item_forward=new_work_item_forward) + # Below is a request that includes all optional parameters + # WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward) + except Exception as e: + print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName + try: + # Submit Account Selections + new_request_body = RequestBody.from_json(request_body) + results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) + print("The response of WorkItemsApi->submit_account_selection:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -11147,341 +11485,3 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Approve an Approval Item - - results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->approve_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk approve Approval Items - - results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) - print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) - try: - # Complete a Work Item - - results = WorkItemsApi(api_client).complete_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).complete_work_item(id, new_body) - print("The response of WorkItemsApi->complete_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) -- path: /work-items/completed - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Completed Work Items - - results = WorkItemsApi(api_client).get_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) - print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Completed Work Items - - results = WorkItemsApi(api_client).get_count_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) - print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) -- path: /work-items/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Work Items - - results = WorkItemsApi(api_client).get_count_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_work_items(owner_id) - print("The response of WorkItemsApi->get_count_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. - try: - # Get a Work Item - - results = WorkItemsApi(api_client).get_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_item(id) - print("The response of WorkItemsApi->get_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) -- path: /work-items/summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_summary import WorkItemsSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Work Items Summary - - results = WorkItemsApi(api_client).get_work_items_summary() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) - print("The response of WorkItemsApi->get_work_items_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) -- path: /work-items - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # List Work Items - - results = WorkItemsApi(api_client).list_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) - print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Reject an Approval Item - - results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->reject_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk reject Approval Items - - results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) - print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_item_forward import WorkItemForward - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - work_item_forward = '''{ - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - }''' # WorkItemForward | - try: - # Forward a Work Item - new_work_item_forward = WorkItemForward.from_json(work_item_forward) - WorkItemsApi(api_client).send_work_item_forward(id=id, work_item_forward=new_work_item_forward) - # Below is a request that includes all optional parameters - # WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward) - except Exception as e: - print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName - try: - # Submit Account Selections - new_request_body = RequestBody.from_json(request_body) - results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) - print("The response of WorkItemsApi->submit_account_selection:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) From c38ce8969266fc2e02710df96e47544dcbb4e7a5 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Wed, 2 Apr 2025 17:55:36 +0000 Subject: [PATCH 13/82] Automated commit by github action: 14226269692 --- static/api-specs/idn/v2024/paths/machine-account.yaml | 2 +- static/api-specs/idn/v2024/paths/machine-identity.yaml | 2 +- static/api-specs/idn/v2025/paths/machine-account.yaml | 2 +- static/api-specs/idn/v2025/paths/machine-identity.yaml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/static/api-specs/idn/v2024/paths/machine-account.yaml b/static/api-specs/idn/v2024/paths/machine-account.yaml index 980b2d044..726216f4d 100644 --- a/static/api-specs/idn/v2024/paths/machine-account.yaml +++ b/static/api-specs/idn/v2024/paths/machine-account.yaml @@ -108,7 +108,7 @@ patch: type: array items: type: object - example: + examples: Add machine identity attribute: value: - op: add diff --git a/static/api-specs/idn/v2024/paths/machine-identity.yaml b/static/api-specs/idn/v2024/paths/machine-identity.yaml index 4949322c0..1ba2717bd 100644 --- a/static/api-specs/idn/v2024/paths/machine-identity.yaml +++ b/static/api-specs/idn/v2024/paths/machine-identity.yaml @@ -89,7 +89,7 @@ patch: type: array items: type: object - example: + examples: Add machine identity attribute: value: - op: add diff --git a/static/api-specs/idn/v2025/paths/machine-account.yaml b/static/api-specs/idn/v2025/paths/machine-account.yaml index 980b2d044..726216f4d 100644 --- a/static/api-specs/idn/v2025/paths/machine-account.yaml +++ b/static/api-specs/idn/v2025/paths/machine-account.yaml @@ -108,7 +108,7 @@ patch: type: array items: type: object - example: + examples: Add machine identity attribute: value: - op: add diff --git a/static/api-specs/idn/v2025/paths/machine-identity.yaml b/static/api-specs/idn/v2025/paths/machine-identity.yaml index 4949322c0..1ba2717bd 100644 --- a/static/api-specs/idn/v2025/paths/machine-identity.yaml +++ b/static/api-specs/idn/v2025/paths/machine-identity.yaml @@ -89,7 +89,7 @@ patch: type: array items: type: object - example: + examples: Add machine identity attribute: value: - op: add From 9a5c92f08a4a038227b13cdf9b95e4833f27e65c Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 2 Apr 2025 17:56:57 +0000 Subject: [PATCH 14/82] Update to powershell SDK docs: 14226292371 --- .../Reference/V2024/Methods/V2024MachineAccountsApi.md | 2 +- .../Reference/V2024/Methods/V2024MachineIdentitiesApi.md | 2 +- .../Reference/V2025/Methods/V2025MachineAccountsApi.md | 2 +- .../Reference/V2025/Methods/V2025MachineIdentitiesApi.md | 2 +- .../code-examples/v2024/powershell_code_examples_overlay.yaml | 4 ++-- .../code-examples/v2025/powershell_code_examples_overlay.yaml | 4 ++-- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md index 3f6b77b17..4da96562f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md @@ -171,7 +171,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + $RequestBody = @"[{op=add, path=/environment, value=test}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes # Update a Machine Account diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md index 2d9096168..a2b56ae55 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md @@ -286,7 +286,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. # Update a Machine Identity diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md index 900a27858..bf56d1044 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md @@ -171,7 +171,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + $RequestBody = @"[{op=add, path=/environment, value=test}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes # Update a Machine Account diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md index 56a0fa136..1153482df 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md @@ -286,7 +286,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. # Update a Machine Identity diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index 1efdac59c..75d10b669 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -8690,7 +8690,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ + $RequestBody = @"[{op=add, path=/environment, value=test}]"@ # Update a Machine Account @@ -8810,7 +8810,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ + $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ # Update a Machine Identity diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index 47a10dee2..1cefc7ca9 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -8690,7 +8690,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ + $RequestBody = @"[{op=add, path=/environment, value=test}]"@ # Update a Machine Account @@ -8810,7 +8810,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ + $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ # Update a Machine Identity From ea6e5bf6e85f3ed981cb17a7be69c2659ff4748a Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 2 Apr 2025 17:57:25 +0000 Subject: [PATCH 15/82] Update to python SDK docs: 14226300004 --- .../sdk/python/Reference/V2024/Methods/MachineAccountsApi.md | 2 +- .../python/Reference/V2024/Methods/MachineIdentitiesApi.md | 2 +- .../sdk/python/Reference/V2025/Methods/MachineAccountsApi.md | 2 +- .../python/Reference/V2025/Methods/MachineIdentitiesApi.md | 2 +- static/code-examples/v2024/python_code_examples_overlay.yaml | 4 ++-- static/code-examples/v2025/python_code_examples_overlay.yaml | 4 ++-- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md index 513258da1..93fe5a0fd 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md @@ -232,7 +232,7 @@ configuration.experimental = true with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + request_body = '''[{op=add, path=/environment, value=test}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes try: # Update a Machine Account diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md index 822dd6fa7..f38744ea4 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md @@ -387,7 +387,7 @@ configuration.experimental = true with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + request_body = '''[{op=add, path=/attributes/securityRisk, value=medium}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: # Update a Machine Identity diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md index b8465807b..4edebe8a3 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md @@ -232,7 +232,7 @@ configuration.experimental = true with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + request_body = '''[{op=add, path=/environment, value=test}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes try: # Update a Machine Account diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md index ca49fc05d..83cd2b9aa 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md @@ -387,7 +387,7 @@ configuration.experimental = true with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + request_body = '''[{op=add, path=/attributes/securityRisk, value=medium}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: # Update a Machine Identity diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index fe609ed05..c6dd58b25 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -10349,7 +10349,7 @@ with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + request_body = '''[{op=add, path=/environment, value=test}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes try: # Update a Machine Account new_request_body = RequestBody.from_json(request_body) @@ -10495,7 +10495,7 @@ with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + request_body = '''[{op=add, path=/attributes/securityRisk, value=medium}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: # Update a Machine Identity new_request_body = RequestBody.from_json(request_body) diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index 06ce63fa3..d0822cfba 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -10349,7 +10349,7 @@ with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + request_body = '''[{op=add, path=/environment, value=test}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes try: # Update a Machine Account new_request_body = RequestBody.from_json(request_body) @@ -10495,7 +10495,7 @@ with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + request_body = '''[{op=add, path=/attributes/securityRisk, value=medium}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: # Update a Machine Identity new_request_body = RequestBody.from_json(request_body) From 386dbed391a5faae54138f3dba630ae63b3d2a08 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Wed, 2 Apr 2025 15:43:16 -0400 Subject: [PATCH 16/82] fixing video library loading --- src/services/DiscourseService.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/services/DiscourseService.ts b/src/services/DiscourseService.ts index dd596afd5..63443aadb 100644 --- a/src/services/DiscourseService.ts +++ b/src/services/DiscourseService.ts @@ -168,7 +168,9 @@ export async function getVideoPosts(tags?: string[]): Promise Date: Thu, 3 Apr 2025 16:31:58 +0000 Subject: [PATCH 17/82] Update to python SDK docs: 14248105327 --- .../Beta/Methods/AccessModelMetadataApi.md | 6 +- .../Beta/Methods/AccessProfilesApi.md | 9 +- .../Beta/Methods/AccessRequestApprovalsApi.md | 6 +- .../Beta/Methods/AccessRequestsApi.md | 3 +- .../Beta/Methods/AccountActivitiesApi.md | 3 +- .../Beta/Methods/AccountUsagesApi.md | 3 +- .../Reference/Beta/Methods/AccountsApi.md | 12 +- .../Beta/Methods/ApplicationDiscoveryApi.md | 3 +- .../Reference/Beta/Methods/ApprovalsApi.md | 3 +- .../python/Reference/Beta/Methods/AppsApi.md | 24 +- .../Reference/Beta/Methods/AuthProfileApi.md | 3 +- .../Beta/Methods/CertificationCampaignsApi.md | 9 +- .../Beta/Methods/CertificationsApi.md | 12 +- .../Methods/ConnectorRuleManagementApi.md | 3 +- .../Reference/Beta/Methods/ConnectorsApi.md | 3 +- .../Reference/Beta/Methods/CustomFormsApi.md | 6 +- .../Reference/Beta/Methods/EntitlementsApi.md | 9 +- .../Beta/Methods/GovernanceGroupsApi.md | 18 +- .../IAIAccessRequestRecommendationsApi.md | 15 +- .../Beta/Methods/IAICommonAccessApi.md | 3 +- .../Beta/Methods/IAIMessageCatalogsApi.md | 3 +- .../Reference/Beta/Methods/IAIOutliersApi.md | 15 +- .../Beta/Methods/IAIPeerGroupStrategiesApi.md | 3 +- .../Beta/Methods/IAIRoleMiningApi.md | 30 +- .../Reference/Beta/Methods/IdentitiesApi.md | 6 +- .../Beta/Methods/IdentityAttributesApi.md | 3 +- .../Beta/Methods/IdentityHistoryApi.md | 24 +- .../Beta/Methods/IdentityProfilesApi.md | 6 +- .../Beta/Methods/MFAConfigurationApi.md | 6 +- .../Beta/Methods/ManagedClustersApi.md | 3 +- .../Beta/Methods/MultiHostIntegrationApi.md | 12 +- .../NonEmployeeLifecycleManagementApi.md | 15 +- .../Beta/Methods/NotificationsApi.md | 18 +- .../Reference/Beta/Methods/OAuthClientsApi.md | 3 +- .../Reference/Beta/Methods/OrgConfigApi.md | 3 +- .../Beta/Methods/PasswordPoliciesApi.md | 3 +- .../Beta/Methods/PasswordSyncGroupsApi.md | 3 +- .../Beta/Methods/PersonalAccessTokensApi.md | 3 +- .../Beta/Methods/RequestableObjectsApi.md | 3 +- .../Reference/Beta/Methods/RoleInsightsApi.md | 12 +- .../python/Reference/Beta/Methods/RolesApi.md | 9 +- .../Reference/Beta/Methods/SODPoliciesApi.md | 3 +- .../Reference/Beta/Methods/SPConfigApi.md | 3 +- .../SearchAttributeConfigurationApi.md | 6 +- .../Reference/Beta/Methods/SegmentsApi.md | 3 +- .../Beta/Methods/ServiceDeskIntegrationApi.md | 6 +- .../Reference/Beta/Methods/SourceUsagesApi.md | 3 +- .../Reference/Beta/Methods/SourcesApi.md | 12 +- .../SuggestedEntitlementDescriptionApi.md | 6 +- .../Beta/Methods/TaggedObjectsApi.md | 6 +- .../python/Reference/Beta/Methods/TagsApi.md | 3 +- .../Beta/Methods/TaskManagementApi.md | 6 +- .../Reference/Beta/Methods/TransformsApi.md | 3 +- .../Reference/Beta/Methods/TriggersApi.md | 12 +- .../Methods/VendorConnectorMappingsApi.md | 3 +- .../Reference/Beta/Methods/WorkItemsApi.md | 9 +- .../Beta/Methods/WorkReassignmentApi.md | 9 +- .../Reference/Beta/Methods/WorkflowsApi.md | 21 +- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../V2024/Methods/AccessModelMetadataApi.md | 6 +- .../V2024/Methods/AccessProfilesApi.md | 9 +- .../Methods/AccessRequestApprovalsApi.md | 9 +- .../V2024/Methods/AccessRequestsApi.md | 6 +- .../V2024/Methods/AccountActivitiesApi.md | 3 +- .../V2024/Methods/AccountUsagesApi.md | 3 +- .../Reference/V2024/Methods/AccountsApi.md | 12 +- .../V2024/Methods/ApplicationDiscoveryApi.md | 3 +- .../Reference/V2024/Methods/ApprovalsApi.md | 3 +- .../python/Reference/V2024/Methods/AppsApi.md | 24 +- .../Reference/V2024/Methods/AuthProfileApi.md | 3 +- .../Reference/V2024/Methods/BrandingApi.md | 3 +- .../Methods/CertificationCampaignsApi.md | 9 +- .../Methods/CertificationSummariesApi.md | 6 +- .../V2024/Methods/CertificationsApi.md | 15 +- .../V2024/Methods/ConfigurationHubApi.md | 15 +- .../V2024/Methods/ConnectorCustomizersApi.md | 3 +- .../Methods/ConnectorRuleManagementApi.md | 3 +- .../Reference/V2024/Methods/ConnectorsApi.md | 3 +- .../Reference/V2024/Methods/CustomFormsApi.md | 6 +- .../V2024/Methods/DataSegmentationApi.md | 3 +- .../Reference/V2024/Methods/DimensionsApi.md | 9 +- .../V2024/Methods/EntitlementsApi.md | 9 +- .../V2024/Methods/GovernanceGroupsApi.md | 18 +- .../IAIAccessRequestRecommendationsApi.md | 15 +- .../V2024/Methods/IAICommonAccessApi.md | 3 +- .../Reference/V2024/Methods/IAIOutliersApi.md | 15 +- .../Methods/IAIPeerGroupStrategiesApi.md | 3 +- .../V2024/Methods/IAIRoleMiningApi.md | 30 +- .../Reference/V2024/Methods/IdentitiesApi.md | 6 +- .../V2024/Methods/IdentityAttributesApi.md | 3 +- .../V2024/Methods/IdentityHistoryApi.md | 24 +- .../V2024/Methods/IdentityProfilesApi.md | 6 +- .../V2024/Methods/LifecycleStatesApi.md | 3 +- .../V2024/Methods/MFAConfigurationApi.md | 6 +- .../V2024/Methods/MachineAccountsApi.md | 3 +- .../V2024/Methods/MachineIdentitiesApi.md | 3 +- .../V2024/Methods/ManagedClientsApi.md | 3 +- .../V2024/Methods/ManagedClusterTypesApi.md | 3 +- .../V2024/Methods/ManagedClustersApi.md | 3 +- .../V2024/Methods/MultiHostIntegrationApi.md | 18 +- .../NonEmployeeLifecycleManagementApi.md | 15 +- .../V2024/Methods/NotificationsApi.md | 12 +- .../V2024/Methods/OAuthClientsApi.md | 3 +- .../Reference/V2024/Methods/OrgConfigApi.md | 3 +- .../V2024/Methods/PasswordPoliciesApi.md | 3 +- .../V2024/Methods/PasswordSyncGroupsApi.md | 3 +- .../V2024/Methods/PersonalAccessTokensApi.md | 3 +- .../V2024/Methods/PublicIdentitiesApi.md | 3 +- .../V2024/Methods/RequestableObjectsApi.md | 3 +- .../V2024/Methods/RoleInsightsApi.md | 12 +- .../Reference/V2024/Methods/RolesApi.md | 12 +- .../V2024/Methods/SIMIntegrationsApi.md | 3 +- .../Reference/V2024/Methods/SODPoliciesApi.md | 3 +- .../Reference/V2024/Methods/SPConfigApi.md | 3 +- .../Reference/V2024/Methods/SavedSearchApi.md | 3 +- .../V2024/Methods/ScheduledSearchApi.md | 3 +- .../Reference/V2024/Methods/SearchApi.md | 3 +- .../SearchAttributeConfigurationApi.md | 3 +- .../Reference/V2024/Methods/SegmentsApi.md | 3 +- .../Methods/ServiceDeskIntegrationApi.md | 6 +- .../V2024/Methods/SourceUsagesApi.md | 3 +- .../Reference/V2024/Methods/SourcesApi.md | 18 +- .../SuggestedEntitlementDescriptionApi.md | 6 +- .../V2024/Methods/TaggedObjectsApi.md | 9 +- .../V2024/Methods/TaskManagementApi.md | 6 +- .../V2024/Methods/TenantContextApi.md | 3 +- .../Reference/V2024/Methods/TransformsApi.md | 3 +- .../Reference/V2024/Methods/TriggersApi.md | 12 +- .../Methods/VendorConnectorMappingsApi.md | 3 +- .../Reference/V2024/Methods/WorkItemsApi.md | 6 +- .../V2024/Methods/WorkReassignmentApi.md | 9 +- .../Reference/V2024/Methods/WorkflowsApi.md | 21 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../V2025/Methods/AccessModelMetadataApi.md | 6 +- .../V2025/Methods/AccessProfilesApi.md | 9 +- .../Methods/AccessRequestApprovalsApi.md | 9 +- .../V2025/Methods/AccessRequestsApi.md | 6 +- .../V2025/Methods/AccountActivitiesApi.md | 3 +- .../V2025/Methods/AccountUsagesApi.md | 3 +- .../Reference/V2025/Methods/AccountsApi.md | 12 +- .../V2025/Methods/ApplicationDiscoveryApi.md | 3 +- .../Reference/V2025/Methods/ApprovalsApi.md | 3 +- .../python/Reference/V2025/Methods/AppsApi.md | 24 +- .../Reference/V2025/Methods/AuthProfileApi.md | 3 +- .../Reference/V2025/Methods/BrandingApi.md | 3 +- .../Methods/CertificationCampaignsApi.md | 9 +- .../Methods/CertificationSummariesApi.md | 6 +- .../V2025/Methods/CertificationsApi.md | 15 +- .../V2025/Methods/ConfigurationHubApi.md | 15 +- .../V2025/Methods/ConnectorCustomizersApi.md | 3 +- .../Methods/ConnectorRuleManagementApi.md | 3 +- .../Reference/V2025/Methods/ConnectorsApi.md | 3 +- .../Reference/V2025/Methods/CustomFormsApi.md | 6 +- .../V2025/Methods/DataSegmentationApi.md | 3 +- .../Reference/V2025/Methods/DimensionsApi.md | 9 +- .../V2025/Methods/EntitlementsApi.md | 9 +- .../V2025/Methods/GovernanceGroupsApi.md | 18 +- .../IAIAccessRequestRecommendationsApi.md | 15 +- .../V2025/Methods/IAICommonAccessApi.md | 3 +- .../Reference/V2025/Methods/IAIOutliersApi.md | 15 +- .../Methods/IAIPeerGroupStrategiesApi.md | 3 +- .../V2025/Methods/IAIRoleMiningApi.md | 30 +- .../Reference/V2025/Methods/IdentitiesApi.md | 6 +- .../V2025/Methods/IdentityAttributesApi.md | 3 +- .../V2025/Methods/IdentityHistoryApi.md | 24 +- .../V2025/Methods/IdentityProfilesApi.md | 6 +- .../V2025/Methods/LifecycleStatesApi.md | 3 +- .../V2025/Methods/MFAConfigurationApi.md | 6 +- .../V2025/Methods/MachineAccountsApi.md | 3 +- .../V2025/Methods/MachineIdentitiesApi.md | 3 +- .../V2025/Methods/ManagedClientsApi.md | 3 +- .../V2025/Methods/ManagedClusterTypesApi.md | 3 +- .../V2025/Methods/ManagedClustersApi.md | 3 +- .../V2025/Methods/MultiHostIntegrationApi.md | 18 +- .../NonEmployeeLifecycleManagementApi.md | 15 +- .../V2025/Methods/NotificationsApi.md | 12 +- .../V2025/Methods/OAuthClientsApi.md | 3 +- .../Reference/V2025/Methods/OrgConfigApi.md | 3 +- .../V2025/Methods/PasswordPoliciesApi.md | 3 +- .../V2025/Methods/PasswordSyncGroupsApi.md | 3 +- .../V2025/Methods/PersonalAccessTokensApi.md | 3 +- .../V2025/Methods/PublicIdentitiesApi.md | 3 +- .../V2025/Methods/RequestableObjectsApi.md | 3 +- .../V2025/Methods/RoleInsightsApi.md | 12 +- .../Reference/V2025/Methods/RolesApi.md | 12 +- .../V2025/Methods/SIMIntegrationsApi.md | 3 +- .../Reference/V2025/Methods/SODPoliciesApi.md | 3 +- .../Reference/V2025/Methods/SPConfigApi.md | 3 +- .../Reference/V2025/Methods/SavedSearchApi.md | 3 +- .../V2025/Methods/ScheduledSearchApi.md | 3 +- .../Reference/V2025/Methods/SearchApi.md | 3 +- .../SearchAttributeConfigurationApi.md | 3 +- .../Reference/V2025/Methods/SegmentsApi.md | 3 +- .../Methods/ServiceDeskIntegrationApi.md | 6 +- .../V2025/Methods/SourceUsagesApi.md | 3 +- .../Reference/V2025/Methods/SourcesApi.md | 18 +- .../SuggestedEntitlementDescriptionApi.md | 6 +- .../V2025/Methods/TaggedObjectsApi.md | 9 +- .../V2025/Methods/TaskManagementApi.md | 6 +- .../V2025/Methods/TenantContextApi.md | 3 +- .../Reference/V2025/Methods/TransformsApi.md | 3 +- .../Reference/V2025/Methods/TriggersApi.md | 12 +- .../Methods/VendorConnectorMappingsApi.md | 3 +- .../Reference/V2025/Methods/WorkItemsApi.md | 6 +- .../V2025/Methods/WorkReassignmentApi.md | 9 +- .../Reference/V2025/Methods/WorkflowsApi.md | 21 +- .../Reference/V2025/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2025/Models/SourceUsage.md | 2 +- .../Reference/V3/Methods/AccessProfilesApi.md | 6 +- .../V3/Methods/AccessRequestApprovalsApi.md | 6 +- .../Reference/V3/Methods/AccessRequestsApi.md | 3 +- .../V3/Methods/AccountActivitiesApi.md | 3 +- .../Reference/V3/Methods/AccountUsagesApi.md | 3 +- .../Reference/V3/Methods/AccountsApi.md | 6 +- .../V3/Methods/ApplicationDiscoveryApi.md | 3 +- .../Reference/V3/Methods/BrandingApi.md | 3 +- .../V3/Methods/CertificationCampaignsApi.md | 9 +- .../V3/Methods/CertificationSummariesApi.md | 6 +- .../Reference/V3/Methods/CertificationsApi.md | 15 +- .../V3/Methods/ConfigurationHubApi.md | 6 +- .../Reference/V3/Methods/ConnectorsApi.md | 3 +- .../V3/Methods/IdentityProfilesApi.md | 6 +- .../V3/Methods/LifecycleStatesApi.md | 3 +- .../V3/Methods/MFAConfigurationApi.md | 6 +- .../Reference/V3/Methods/ManagedClientsApi.md | 3 +- .../V3/Methods/ManagedClustersApi.md | 3 +- .../NonEmployeeLifecycleManagementApi.md | 15 +- .../Reference/V3/Methods/OAuthClientsApi.md | 3 +- .../V3/Methods/PasswordPoliciesApi.md | 3 +- .../V3/Methods/PasswordSyncGroupsApi.md | 3 +- .../V3/Methods/PersonalAccessTokensApi.md | 3 +- .../V3/Methods/PublicIdentitiesApi.md | 3 +- .../V3/Methods/RequestableObjectsApi.md | 3 +- .../python/Reference/V3/Methods/RolesApi.md | 6 +- .../Reference/V3/Methods/SODPoliciesApi.md | 3 +- .../Reference/V3/Methods/SavedSearchApi.md | 3 +- .../V3/Methods/ScheduledSearchApi.md | 3 +- .../python/Reference/V3/Methods/SearchApi.md | 3 +- .../SearchAttributeConfigurationApi.md | 6 +- .../Reference/V3/Methods/SegmentsApi.md | 3 +- .../V3/Methods/ServiceDeskIntegrationApi.md | 6 +- .../Reference/V3/Methods/SourceUsagesApi.md | 3 +- .../python/Reference/V3/Methods/SourcesApi.md | 12 +- .../Reference/V3/Methods/TaggedObjectsApi.md | 9 +- .../Reference/V3/Methods/TransformsApi.md | 3 +- .../V3/Methods/VendorConnectorMappingsApi.md | 3 +- .../Reference/V3/Methods/WorkItemsApi.md | 6 +- .../Reference/V3/Methods/WorkflowsApi.md | 21 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../python/Reference/V3/Models/SourceUsage.md | 2 +- .../beta/python_code_examples_overlay.yaml | 450 ++++++++++----- .../v2024/python_code_examples_overlay.yaml | 531 ++++++++++++------ .../v2025/python_code_examples_overlay.yaml | 531 ++++++++++++------ .../v3/python_code_examples_overlay.yaml | 216 ++++--- 260 files changed, 2320 insertions(+), 1168 deletions(-) diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md index ba61b7858..9cfb4a65d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md @@ -198,7 +198,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) ``` @@ -256,7 +257,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md index 0728d9b02..832d4965e 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md @@ -446,7 +446,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) ``` @@ -519,7 +520,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) ``` @@ -651,7 +653,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(new_access_profile_bulk_update_request_inner) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md index 891c02898..46098b866 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md @@ -291,7 +291,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) ``` @@ -358,7 +359,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md index f8f06cc53..024b5f3e4 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md @@ -440,7 +440,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md index 824006147..c400e0cf0 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md @@ -176,7 +176,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, type, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md index be1aa6ffa..b96554844 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md @@ -78,7 +78,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md index d15b505fa..52f5d81f5 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md @@ -442,7 +442,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).disable_accounts_for_identities(new_identities_accounts_bulk_request) print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) ``` @@ -627,7 +628,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).enable_accounts_for_identities(new_identities_accounts_bulk_request) print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) ``` @@ -753,7 +755,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, offset, limit, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) ``` @@ -821,7 +824,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(detail_level, limit, offset, count, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md index 1cbad3cd1..5df8021ba 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md @@ -138,7 +138,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md index 0f04b4074..33c6e1967 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md @@ -134,7 +134,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApprovalsApi(api_client).get_approvals(mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md index 34d4650f6..8dfb79e15 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md @@ -154,7 +154,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, new_request_body, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) ``` @@ -335,7 +336,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_access_profiles_for_source_app(id, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) ``` @@ -403,7 +405,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_source_app(limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) ``` @@ -468,7 +471,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_user_apps(filters, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) ``` @@ -534,7 +538,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_assigned_source_app(limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) ``` @@ -598,7 +603,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_accounts_for_user_app(id, limit, count, offset) print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) ``` @@ -664,7 +670,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_source_apps(limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) ``` @@ -728,7 +735,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_owned_user_apps(limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md index c238e0009..f682ae40a 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md @@ -130,7 +130,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AuthProfileApi(api_client).get_profile_config_list() print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md index e1209b300..a42f6a9c3 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md @@ -797,7 +797,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) ``` @@ -927,7 +928,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) ``` @@ -1191,7 +1193,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md index f9a3059ce..4e8a205b7 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md @@ -101,7 +101,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) ``` @@ -160,7 +161,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_pending_tasks(id) print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_pending_tasks: %s\n" % e) ``` @@ -293,7 +295,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) ``` @@ -361,7 +364,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certifications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md index 3c8af1fd9..8df6c2457 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md @@ -277,7 +277,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list() print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md index d2ab7768d..748e40ece 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md @@ -90,7 +90,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md index 083a42eba..82854d4cd 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md @@ -706,7 +706,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) ``` @@ -1314,7 +1315,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md index 5d005bfe4..031c96bf2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md @@ -444,7 +444,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_children(id, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) ``` @@ -513,7 +514,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_parents(id, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) ``` @@ -591,7 +593,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md index 407249e44..e58aaf991 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md @@ -216,7 +216,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) ``` @@ -288,7 +289,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(new_workgroup_bulk_delete_request) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) ``` @@ -412,7 +414,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) ``` @@ -478,7 +481,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) ``` @@ -544,7 +548,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroups(offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) ``` @@ -676,7 +681,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md index a23c09dfa..5651b4959 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md @@ -270,7 +270,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(new_access_request_recommendation_action_item_dto) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) ``` @@ -340,7 +341,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) ``` @@ -406,7 +408,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) ``` @@ -472,7 +475,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) ``` @@ -538,7 +542,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md index e67b026fd..93750b259 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md @@ -145,7 +145,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAICommonAccessApi(api_client).get_common_access(offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md index 893b55cc2..79708094f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md @@ -67,7 +67,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id) print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIMessageCatalogsApi->get_message_catalogs: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md index 76743e1e3..439f87923 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md @@ -144,7 +144,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) ``` @@ -212,7 +213,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outliers(limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) ``` @@ -271,7 +273,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) ``` @@ -405,7 +408,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) ``` @@ -534,7 +538,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md index e17088ce4..bf969965c 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md @@ -76,7 +76,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md index 8e799b82f..5ca5a5f27 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md @@ -506,7 +506,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) ``` @@ -638,7 +639,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) ``` @@ -707,7 +709,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) ``` @@ -776,7 +779,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) ``` @@ -904,7 +908,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) ``` @@ -972,7 +977,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) ``` @@ -1040,7 +1046,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) ``` @@ -1108,7 +1115,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) ``` @@ -1348,7 +1356,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) ``` @@ -1412,7 +1421,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md index e4af8710d..b61d4ffb7 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md @@ -334,7 +334,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).get_role_assignments(identity_id, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) ``` @@ -402,7 +403,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).list_identities(filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md index 6459154ce..28145aa47 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md @@ -332,7 +332,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityAttributesApi(api_client).list_identity_attributes(include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md index 998cf032c..84e5881dd 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md @@ -89,7 +89,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) ``` @@ -161,7 +162,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) ``` @@ -290,7 +292,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) ``` @@ -420,7 +423,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) ``` @@ -543,7 +547,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_historical_identities(starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) ``` @@ -616,7 +621,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_access_items(id, type, filters, sorters, query, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) ``` @@ -679,7 +685,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) ``` @@ -747,7 +754,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md index 536ebd373..6781e9666 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md @@ -329,7 +329,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) ``` @@ -575,7 +576,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md index 0eccd7136..481f41e62 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md @@ -186,7 +186,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) ``` @@ -431,7 +432,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md index 551ff71cd..d8076a1b1 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md @@ -205,7 +205,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md index e62574ed6..9776e94f1 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md @@ -484,7 +484,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) ``` @@ -545,7 +546,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) ``` @@ -602,7 +604,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) ``` @@ -673,7 +676,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md index 09e6f868a..789791a40 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md @@ -1412,7 +1412,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -1543,7 +1544,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approval(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approval: %s\n" % e) ``` @@ -1609,7 +1611,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) ``` @@ -1677,7 +1680,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) ``` @@ -1747,7 +1751,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md index b525acb51..fcedaeb00 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md @@ -391,7 +391,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_dkim_attributes() print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) ``` @@ -507,7 +508,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_notification_template(id) print("The response of NotificationsApi->get_notification_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) ``` @@ -627,7 +629,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_from_addresses(limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) ``` @@ -686,7 +689,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_preferences(key) print("The response of NotificationsApi->list_notification_preferences:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) ``` @@ -748,7 +752,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_template_defaults(limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) ``` @@ -810,7 +815,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_templates(limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md index 470d5838b..9e1d76495 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md index 059189f7a..ea8c272a7 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md @@ -121,7 +121,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OrgConfigApi(api_client).get_valid_time_zones() print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md index d0dad2691..4e8cad31e 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md @@ -291,7 +291,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md index a56dc4870..df624204d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md @@ -286,7 +286,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md index 6ec880dee..b819500a8 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md @@ -202,7 +202,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md index 60c4cd199..ff8b753a6 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md @@ -89,7 +89,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md index 1c1994820..847d93e9d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md @@ -205,7 +205,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) ``` @@ -327,7 +328,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights(offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) ``` @@ -386,7 +388,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) ``` @@ -447,7 +450,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md index 80ad574fd..2daaf8666 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md @@ -522,7 +522,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) ``` @@ -590,7 +591,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_entitlements(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) ``` @@ -664,7 +666,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md index 4d3852000..fd6207c12 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md @@ -794,7 +794,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md index 43af2995d..7dce19145 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md @@ -450,7 +450,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SPConfigApi(api_client).list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md index a85dc4212..7b2282bd4 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md @@ -214,7 +214,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) ``` @@ -273,7 +274,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md index 0e99294a2..bdc4fce0d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md @@ -294,7 +294,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md index 375b90219..ec15150f3 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md @@ -313,7 +313,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) ``` @@ -427,7 +428,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md index 0cb4b879b..deb151231 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md @@ -137,7 +137,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md index afb06edfd..dff8ae276 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md @@ -1377,7 +1377,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) ``` @@ -1807,7 +1808,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) ``` @@ -1880,7 +1882,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) ``` @@ -2808,7 +2811,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md index 775bdd9fa..0be14dbf6 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md @@ -222,7 +222,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) ``` @@ -345,7 +346,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md index 1f08a8578..3d0b78954 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md @@ -322,7 +322,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) ``` @@ -390,7 +391,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md index dff3007fb..545ece158 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md @@ -273,7 +273,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TagsApi(api_client).list_tags(limit, offset, count, filters, sorters) print("The response of TagsApi->list_tags:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TagsApi->list_tags: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md index 4c12262c6..78802e4f3 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md @@ -136,7 +136,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_pending_tasks(offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) ``` @@ -263,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_task_status_list(limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md index 25d9f75d8..734380085 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md @@ -267,7 +267,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md index 1e5790878..0089a9943 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md @@ -330,7 +330,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_subscriptions(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) ``` @@ -398,7 +399,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_trigger_invocation_status(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) ``` @@ -464,7 +466,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_triggers(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) ``` @@ -597,7 +600,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).start_test_trigger_invocation(new_test_invocation) print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md index 6ae8a1681..121832759 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md @@ -236,7 +236,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md index dcbdbd2cc..fb7b0b025 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md @@ -334,7 +334,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) ``` @@ -390,7 +391,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) ``` @@ -624,7 +626,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md index 8feba74df..8266ac171 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md @@ -213,7 +213,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) ``` @@ -267,7 +268,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_reassignment_config_types() print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) ``` @@ -442,7 +444,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).list_reassignment_configurations(limit, offset) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md index 690fef012..cb1c03da1 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md @@ -372,7 +372,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) ``` @@ -449,7 +450,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) ``` @@ -509,7 +511,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) ``` @@ -571,7 +574,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) ``` @@ -625,7 +629,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) ``` @@ -687,7 +692,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) ``` @@ -741,7 +747,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflows() print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md index dced03305..6d30198f2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index bffe6c49e..e0b91fdea 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md index fbcbd7a29..72badf0ff 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md index 093839191..72e332675 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md @@ -240,7 +240,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) ``` @@ -312,7 +313,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md index 805ac4b49..4acc8015a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md @@ -449,7 +449,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) ``` @@ -522,7 +523,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) ``` @@ -692,7 +694,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md index 9d965f64d..920ab3270 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md @@ -291,7 +291,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count) print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) ``` @@ -359,7 +360,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) ``` @@ -427,7 +429,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md index a60efea45..c64017b2e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md @@ -582,7 +582,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) ``` @@ -659,7 +660,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md index da47f4440..b2990f975 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md @@ -174,7 +174,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md index 9db339dec..8f051c0f4 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md @@ -78,7 +78,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md index 5468428d5..e7422eaa4 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md @@ -482,7 +482,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) ``` @@ -694,7 +695,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) ``` @@ -818,7 +820,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) ``` @@ -886,7 +889,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md index 1cb9534cc..1b49a141e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md @@ -80,7 +80,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md index 790a34a5d..160f35465 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md @@ -162,7 +162,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md index f43926807..f83e92254 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md @@ -182,7 +182,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) ``` @@ -405,7 +406,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) ``` @@ -485,7 +487,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) ``` @@ -564,7 +567,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) ``` @@ -644,7 +648,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) ``` @@ -720,7 +725,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count) print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) ``` @@ -800,7 +806,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) ``` @@ -878,7 +885,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md index f0db8d81d..3dbd53124 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md @@ -160,7 +160,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental) print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md index c00082fa7..b3927692a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md @@ -259,7 +259,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = BrandingApi(api_client).get_branding_list() print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md index d87f8eb8e..9600d4add 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md @@ -764,7 +764,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) ``` @@ -886,7 +887,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) ``` @@ -1130,7 +1132,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md index b142498c4..8d05105e1 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md @@ -97,7 +97,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) ``` @@ -227,7 +228,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md index 37c6904dd..b05953e36 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md @@ -229,7 +229,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) ``` @@ -296,7 +297,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) ``` @@ -365,7 +367,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) ``` @@ -440,7 +443,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) ``` @@ -508,7 +512,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md index 66e96b96b..508268f87 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md @@ -813,7 +813,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) ``` @@ -930,7 +931,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_backups(filters) print("The response of ConfigurationHubApi->list_backups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) ``` @@ -1042,7 +1044,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_drafts(filters) print("The response of ConfigurationHubApi->list_drafts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) ``` @@ -1096,7 +1099,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_scheduled_actions() print("The response of ConfigurationHubApi->list_scheduled_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_scheduled_actions: %s\n" % e) ``` @@ -1155,7 +1159,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorCustomizersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorCustomizersApi.md index 55bbdf7a5..ed58a9d87 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorCustomizersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorCustomizersApi.md @@ -312,7 +312,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorCustomizersApi(api_client).list_connector_customizers(offset, limit) print("The response of ConnectorCustomizersApi->list_connector_customizers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorCustomizersApi->list_connector_customizers: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md index 1bc607976..1d85fa398 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md @@ -282,7 +282,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(limit, offset, count) print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md index bff47622c..b9e229d3a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md @@ -343,7 +343,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md index 133dde49a..bd41eca3f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md @@ -536,7 +536,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) ``` @@ -1144,7 +1145,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md index f595939dc..969c7beb8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md @@ -451,7 +451,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) print("The response of DataSegmentationApi->list_data_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md index 757735ed7..3ba5f4663 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md @@ -424,7 +424,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->get_dimension_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) ``` @@ -497,7 +498,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimension_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) ``` @@ -569,7 +571,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimensions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md index a23c4788d..949e8abd8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md @@ -528,7 +528,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) ``` @@ -611,7 +612,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) ``` @@ -703,7 +705,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md index 5d09ac145..84507523c 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md @@ -257,7 +257,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) ``` @@ -343,7 +344,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) ``` @@ -495,7 +497,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) ``` @@ -575,7 +578,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) ``` @@ -655,7 +659,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) ``` @@ -812,7 +817,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md index d0e476570..366500211 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md @@ -328,7 +328,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) ``` @@ -412,7 +413,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) ``` @@ -562,7 +564,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) ``` @@ -642,7 +645,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) ``` @@ -722,7 +726,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md index 6446462f9..2efd10569 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md @@ -173,7 +173,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md index 70ab436e1..816aa5023 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md @@ -172,7 +172,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) ``` @@ -254,7 +255,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) ``` @@ -327,7 +329,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) ``` @@ -489,7 +492,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) ``` @@ -646,7 +650,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md index b70390fe7..39b51af0c 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md @@ -90,7 +90,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md index 4d5cf46d7..c85fff2f5 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md @@ -604,7 +604,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) ``` @@ -764,7 +765,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) ``` @@ -847,7 +849,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) ``` @@ -930,7 +933,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) ``` @@ -1086,7 +1090,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) ``` @@ -1168,7 +1173,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) ``` @@ -1250,7 +1256,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) ``` @@ -1332,7 +1339,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) ``` @@ -1628,7 +1636,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) ``` @@ -1706,7 +1715,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md index 65abafe23..8dd8e7501 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md @@ -404,7 +404,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) ``` @@ -486,7 +487,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md index 044ef26c6..76d010e2e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md @@ -402,7 +402,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md index 9758a6bd4..6909110f7 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md @@ -103,7 +103,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) ``` @@ -189,7 +190,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) ``` @@ -346,7 +348,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) ``` @@ -504,7 +507,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) ``` @@ -655,7 +659,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) ``` @@ -737,7 +742,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) ``` @@ -813,7 +819,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) ``` @@ -895,7 +902,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md index 9f2fa5677..8594ec3f3 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md @@ -323,7 +323,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) ``` @@ -665,7 +666,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md index 53cf0cfa6..74afd26c0 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md @@ -324,7 +324,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md index 8ba529834..ba909250f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md @@ -127,7 +127,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) ``` @@ -372,7 +373,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md index 93fe5a0fd..1d6aca07f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md @@ -165,7 +165,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of MachineAccountsApi->list_machine_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md index f38744ea4..a16b6ef7c 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md @@ -320,7 +320,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, filters, sorters, count, limit, offset) print("The response of MachineIdentitiesApi->list_machine_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md index f0ce5678a..486082918 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md @@ -321,7 +321,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClusterTypesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClusterTypesApi.md index f0f903227..3cb61d414 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClusterTypesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClusterTypesApi.md @@ -266,7 +266,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md index d73824e5e..306bbbac0 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md @@ -326,7 +326,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MultiHostIntegrationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MultiHostIntegrationApi.md index 9f929b33a..e7299c0b9 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MultiHostIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MultiHostIntegrationApi.md @@ -294,7 +294,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id, offset, limit) print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) ``` @@ -359,7 +360,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id, offset, limit) print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) ``` @@ -491,7 +493,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) ``` @@ -552,7 +555,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) ``` @@ -609,7 +613,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) ``` @@ -680,7 +685,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md index e17ce04f9..07172e0cc 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md @@ -1433,7 +1433,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -1566,7 +1567,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) ``` @@ -1634,7 +1636,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) ``` @@ -1706,7 +1709,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) ``` @@ -1776,7 +1780,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md index bc1ec9856..7caf4b3f1 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md @@ -477,7 +477,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) ``` @@ -771,7 +772,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) ``` @@ -918,7 +920,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) ``` @@ -994,7 +997,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md index 29ebd6f1a..0e52fa1a6 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md index db647bdc7..7d1485f9d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md @@ -159,7 +159,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count) print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md index 0caba087d..eeb7d2352 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md @@ -290,7 +290,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md index 72223bfcd..dc8936a3c 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md @@ -286,7 +286,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md index 9dac7471f..ea9e15068 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md @@ -202,7 +202,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md index a40feb254..1dbee4683 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md @@ -80,7 +80,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md index 0b673ac27..1bb7f3b47 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md @@ -89,7 +89,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md index abe356c9a..a7242c555 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md @@ -249,7 +249,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) ``` @@ -399,7 +400,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) ``` @@ -472,7 +474,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) ``` @@ -547,7 +550,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md index bcb03c3dd..8eb895a24 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md @@ -517,7 +517,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_bulk_update_status() print("The response of RolesApi->get_bulk_update_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) ``` @@ -704,7 +705,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) ``` @@ -786,7 +788,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) ``` @@ -860,7 +863,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md index 9030ea288..779da7c9f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md @@ -327,7 +327,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md index 526cd72d5..bf5c50ffb 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md @@ -755,7 +755,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md index 14b9af250..0e4ed3c78 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md @@ -453,7 +453,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SPConfigApi(api_client).list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md index f1901d396..8303ef082 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md @@ -336,7 +336,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md index 78a5f785a..808fe15db 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md @@ -283,7 +283,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md index af9ea61ee..22fa69bd7 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md @@ -628,7 +628,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchApi(api_client).search_post(new_search, offset, limit, count) print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchApi->search_post: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md index 7aad9521b..eaf25c05a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md @@ -255,7 +255,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental, limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md index 7a491b87f..7e73b2524 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md @@ -290,7 +290,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md index 5f46f7d43..593283055 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md @@ -363,7 +363,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) ``` @@ -430,7 +431,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md index da84d544f..afef6680a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md @@ -137,7 +137,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md index 4b72b9046..8cadc35f3 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md @@ -1689,7 +1689,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schedules(source_id) print("The response of SourcesApi->get_source_schedules:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) ``` @@ -1814,7 +1815,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) ``` @@ -2219,7 +2221,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) ``` @@ -2290,7 +2293,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) ``` @@ -3257,7 +3261,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) print("The response of SourcesApi->update_password_policy_holders:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) ``` @@ -3318,7 +3323,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md index 10fa45907..a3af2dad8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md @@ -224,7 +224,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) ``` @@ -347,7 +348,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md index 38d22d44c..ab1ef6824 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md @@ -319,7 +319,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) ``` @@ -387,7 +388,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) ``` @@ -592,7 +594,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md index a1450f43f..e98ababce 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md @@ -164,7 +164,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) ``` @@ -319,7 +320,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TenantContextApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TenantContextApi.md index b68429196..b2fcc91fb 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TenantContextApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TenantContextApi.md @@ -83,7 +83,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental) print("The response of TenantContextApi->get_tenant_context:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TenantContextApi->get_tenant_context: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md index 432d792a7..e88e2927d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md index 18de16ea7..980404a38 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md @@ -386,7 +386,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) ``` @@ -468,7 +469,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) ``` @@ -548,7 +550,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) ``` @@ -709,7 +712,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation) print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md index 6f5c855d9..246c9f7a6 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md @@ -236,7 +236,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md index ee9f86d8f..bdc447643 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md @@ -356,7 +356,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) ``` @@ -664,7 +665,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md index d3d1c4a23..157dfc40d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md @@ -255,7 +255,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) ``` @@ -325,7 +326,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) ``` @@ -540,7 +542,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md index 91afe5a2e..cb42304e6 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md @@ -491,7 +491,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) ``` @@ -568,7 +569,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) ``` @@ -628,7 +630,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) ``` @@ -690,7 +693,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) ``` @@ -744,7 +748,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) ``` @@ -806,7 +811,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) ``` @@ -860,7 +866,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflows() print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md index 5353898b1..442faa748 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index db5a37930..a37f38fea 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md index c57393c0d..ea8523f54 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md index 67c80a771..2782bcd64 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md @@ -240,7 +240,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) ``` @@ -312,7 +313,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md index 0fe2ff0aa..94a99b1bc 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md @@ -449,7 +449,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) ``` @@ -522,7 +523,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) ``` @@ -692,7 +694,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestApprovalsApi.md index 815f886ba..347962833 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestApprovalsApi.md @@ -291,7 +291,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count) print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) ``` @@ -359,7 +360,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) ``` @@ -427,7 +429,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md index 6aaa35aad..f5f5c714e 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md @@ -582,7 +582,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) ``` @@ -659,7 +660,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccountActivitiesApi.md index ec9364d9a..49f83c473 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccountActivitiesApi.md @@ -174,7 +174,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccountUsagesApi.md index ca398fbee..fbcb7806c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccountUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccountUsagesApi.md @@ -78,7 +78,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccountsApi.md index 92d98291c..496e7ebf3 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccountsApi.md @@ -482,7 +482,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) ``` @@ -694,7 +695,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) ``` @@ -818,7 +820,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) ``` @@ -886,7 +889,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ApplicationDiscoveryApi.md index 90f041f13..02eb144be 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ApplicationDiscoveryApi.md @@ -80,7 +80,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md index e197b5b83..d7a816774 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md @@ -162,7 +162,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AppsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AppsApi.md index 5e4c6051d..0ef47ac97 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AppsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AppsApi.md @@ -182,7 +182,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) ``` @@ -405,7 +406,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) ``` @@ -485,7 +487,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) ``` @@ -564,7 +567,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) ``` @@ -644,7 +648,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) ``` @@ -720,7 +725,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count) print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) ``` @@ -800,7 +806,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) ``` @@ -878,7 +885,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AuthProfileApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AuthProfileApi.md index 5fe02e9c4..132f725c3 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AuthProfileApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AuthProfileApi.md @@ -160,7 +160,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental) print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/BrandingApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/BrandingApi.md index e3c4d4feb..b9b1f4612 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/BrandingApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/BrandingApi.md @@ -259,7 +259,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = BrandingApi(api_client).get_branding_list() print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md index fb6a31448..5e014a906 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md @@ -764,7 +764,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) ``` @@ -886,7 +887,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) ``` @@ -1130,7 +1132,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationSummariesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationSummariesApi.md index e5b01ec57..4a52822b3 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationSummariesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationSummariesApi.md @@ -97,7 +97,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) ``` @@ -227,7 +228,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationsApi.md index 12c58be11..eb736abc4 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationsApi.md @@ -229,7 +229,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) ``` @@ -296,7 +297,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) ``` @@ -365,7 +367,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) ``` @@ -440,7 +443,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) ``` @@ -508,7 +512,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ConfigurationHubApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ConfigurationHubApi.md index d6371992a..cd5f12e61 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ConfigurationHubApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ConfigurationHubApi.md @@ -813,7 +813,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) ``` @@ -930,7 +931,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_backups(filters) print("The response of ConfigurationHubApi->list_backups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) ``` @@ -1042,7 +1044,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_drafts(filters) print("The response of ConfigurationHubApi->list_drafts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) ``` @@ -1096,7 +1099,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_scheduled_actions() print("The response of ConfigurationHubApi->list_scheduled_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_scheduled_actions: %s\n" % e) ``` @@ -1155,7 +1159,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorCustomizersApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorCustomizersApi.md index d65e7f09b..955fca8e8 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorCustomizersApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorCustomizersApi.md @@ -312,7 +312,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorCustomizersApi(api_client).list_connector_customizers(offset, limit) print("The response of ConnectorCustomizersApi->list_connector_customizers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorCustomizersApi->list_connector_customizers: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorRuleManagementApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorRuleManagementApi.md index 1f51b2895..29973ee3e 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorRuleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorRuleManagementApi.md @@ -282,7 +282,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(limit, offset, count) print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorsApi.md index 943921855..5d738bcb9 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorsApi.md @@ -343,7 +343,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/CustomFormsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/CustomFormsApi.md index 5785a824f..142ece625 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/CustomFormsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/CustomFormsApi.md @@ -536,7 +536,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) ``` @@ -1144,7 +1145,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/DataSegmentationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/DataSegmentationApi.md index 36e17126b..2e31bc3d2 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/DataSegmentationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/DataSegmentationApi.md @@ -451,7 +451,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) print("The response of DataSegmentationApi->list_data_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/DimensionsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/DimensionsApi.md index 9ac872e6b..652d9a206 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/DimensionsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/DimensionsApi.md @@ -424,7 +424,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->get_dimension_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) ``` @@ -497,7 +498,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimension_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) ``` @@ -569,7 +571,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimensions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/EntitlementsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/EntitlementsApi.md index 0c2e326eb..bfefc3a1f 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/EntitlementsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/EntitlementsApi.md @@ -528,7 +528,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) ``` @@ -611,7 +612,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) ``` @@ -703,7 +705,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/GovernanceGroupsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/GovernanceGroupsApi.md index 85915f850..92116b4e0 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/GovernanceGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/GovernanceGroupsApi.md @@ -257,7 +257,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) ``` @@ -343,7 +344,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) ``` @@ -495,7 +497,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) ``` @@ -575,7 +578,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) ``` @@ -655,7 +659,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) ``` @@ -812,7 +817,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIAccessRequestRecommendationsApi.md index f534762c6..06fc82052 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIAccessRequestRecommendationsApi.md @@ -328,7 +328,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) ``` @@ -412,7 +413,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) ``` @@ -562,7 +564,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) ``` @@ -642,7 +645,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) ``` @@ -722,7 +726,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAICommonAccessApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAICommonAccessApi.md index a03820f6e..febaf3831 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAICommonAccessApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAICommonAccessApi.md @@ -173,7 +173,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIOutliersApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIOutliersApi.md index 0fd2a5476..d87fda828 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIOutliersApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIOutliersApi.md @@ -172,7 +172,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) ``` @@ -254,7 +255,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) ``` @@ -327,7 +329,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) ``` @@ -489,7 +492,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) ``` @@ -646,7 +650,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIPeerGroupStrategiesApi.md index bb246ef3d..15093b5d7 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIPeerGroupStrategiesApi.md @@ -90,7 +90,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIRoleMiningApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIRoleMiningApi.md index f41b0c25b..16696cd70 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIRoleMiningApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIRoleMiningApi.md @@ -604,7 +604,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) ``` @@ -764,7 +765,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) ``` @@ -847,7 +849,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) ``` @@ -930,7 +933,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) ``` @@ -1086,7 +1090,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) ``` @@ -1168,7 +1173,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) ``` @@ -1250,7 +1256,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) ``` @@ -1332,7 +1339,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) ``` @@ -1628,7 +1636,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) ``` @@ -1706,7 +1715,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md index c8ba51bc1..748eeec82 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md @@ -404,7 +404,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) ``` @@ -486,7 +487,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityAttributesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityAttributesApi.md index 30f628b40..9c850deaa 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityAttributesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityAttributesApi.md @@ -402,7 +402,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityHistoryApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityHistoryApi.md index 5a40ff3eb..389f83945 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityHistoryApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityHistoryApi.md @@ -103,7 +103,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) ``` @@ -189,7 +190,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) ``` @@ -346,7 +348,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) ``` @@ -504,7 +507,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) ``` @@ -655,7 +659,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) ``` @@ -737,7 +742,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) ``` @@ -813,7 +819,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) ``` @@ -895,7 +902,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md index 194f9aeaf..7c20e9f5d 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md @@ -323,7 +323,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) ``` @@ -665,7 +666,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md index 0c58fe2ca..a99ffafdd 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md @@ -324,7 +324,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/MFAConfigurationApi.md index 301f9ba38..b930c5fbe 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/MFAConfigurationApi.md @@ -127,7 +127,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) ``` @@ -372,7 +373,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md index 4edebe8a3..2232330ef 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md @@ -165,7 +165,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of MachineAccountsApi->list_machine_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md index 83cd2b9aa..0a2db8c3e 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md @@ -320,7 +320,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, filters, sorters, count, limit, offset) print("The response of MachineIdentitiesApi->list_machine_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClientsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClientsApi.md index ce275250d..ca0d692ba 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClientsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClientsApi.md @@ -321,7 +321,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClusterTypesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClusterTypesApi.md index 6d4903097..52ec3c5f0 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClusterTypesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClusterTypesApi.md @@ -263,7 +263,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClustersApi.md index 9c6b88f4d..0ba3f256a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClustersApi.md @@ -326,7 +326,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/MultiHostIntegrationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/MultiHostIntegrationApi.md index 965e30aa3..ef2459981 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/MultiHostIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/MultiHostIntegrationApi.md @@ -294,7 +294,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id, offset, limit) print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) ``` @@ -359,7 +360,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id, offset, limit) print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) ``` @@ -491,7 +493,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) ``` @@ -552,7 +555,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) ``` @@ -609,7 +613,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) ``` @@ -680,7 +685,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/NonEmployeeLifecycleManagementApi.md index 0ca0e2bbe..7f81398f9 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/NonEmployeeLifecycleManagementApi.md @@ -1433,7 +1433,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -1566,7 +1567,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) ``` @@ -1634,7 +1636,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) ``` @@ -1706,7 +1709,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) ``` @@ -1776,7 +1780,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/NotificationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/NotificationsApi.md index 209ce4bb5..cf94205a0 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/NotificationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/NotificationsApi.md @@ -477,7 +477,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) ``` @@ -771,7 +772,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) ``` @@ -918,7 +920,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) ``` @@ -994,7 +997,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/OAuthClientsApi.md index be95c9ed6..a1bcc8e09 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/OAuthClientsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/OrgConfigApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/OrgConfigApi.md index 0d259610a..2fc2a20af 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/OrgConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/OrgConfigApi.md @@ -159,7 +159,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count) print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/PasswordPoliciesApi.md index ad04eaf02..bf8976df7 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/PasswordPoliciesApi.md @@ -290,7 +290,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/PasswordSyncGroupsApi.md index a6facba4f..cb918281a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/PasswordSyncGroupsApi.md @@ -286,7 +286,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/PersonalAccessTokensApi.md index 1bb4d65e1..45786fcea 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/PersonalAccessTokensApi.md @@ -202,7 +202,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/PublicIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/PublicIdentitiesApi.md index 39bfb713b..5a5212e31 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/PublicIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/PublicIdentitiesApi.md @@ -80,7 +80,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/RequestableObjectsApi.md index cfe79b3fe..27456b81f 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/RequestableObjectsApi.md @@ -89,7 +89,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/RoleInsightsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/RoleInsightsApi.md index 2cfb9597f..73536c434 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/RoleInsightsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/RoleInsightsApi.md @@ -249,7 +249,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) ``` @@ -399,7 +400,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) ``` @@ -472,7 +474,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) ``` @@ -547,7 +550,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md index 243fc3e73..40c24cab7 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md @@ -517,7 +517,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_bulk_update_status() print("The response of RolesApi->get_bulk_update_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) ``` @@ -704,7 +705,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) ``` @@ -786,7 +788,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) ``` @@ -860,7 +863,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SIMIntegrationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SIMIntegrationsApi.md index ecafd30dd..8e6a3345e 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SIMIntegrationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SIMIntegrationsApi.md @@ -327,7 +327,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SODPoliciesApi.md index 8934d71bd..da69c828e 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SODPoliciesApi.md @@ -755,7 +755,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SPConfigApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SPConfigApi.md index 6049caa58..8a75661f1 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SPConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SPConfigApi.md @@ -453,7 +453,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SPConfigApi(api_client).list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SavedSearchApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SavedSearchApi.md index 43a824f5c..e988e115c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SavedSearchApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SavedSearchApi.md @@ -336,7 +336,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ScheduledSearchApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ScheduledSearchApi.md index 787f5dfc0..e62f51217 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ScheduledSearchApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ScheduledSearchApi.md @@ -283,7 +283,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SearchApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SearchApi.md index 110006c58..e3da2fdba 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SearchApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SearchApi.md @@ -628,7 +628,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchApi(api_client).search_post(new_search, offset, limit, count) print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchApi->search_post: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SearchAttributeConfigurationApi.md index e1a5427ff..88b772262 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SearchAttributeConfigurationApi.md @@ -255,7 +255,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental, limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SegmentsApi.md index a0a88a866..cca422dce 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SegmentsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SegmentsApi.md @@ -290,7 +290,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md index 340976f25..fa2571539 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md @@ -363,7 +363,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) ``` @@ -430,7 +431,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SourceUsagesApi.md index 193d8f2c6..f02cd61dd 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SourceUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SourceUsagesApi.md @@ -137,7 +137,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md index e5291f04b..6522af83d 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md @@ -1689,7 +1689,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schedules(source_id) print("The response of SourcesApi->get_source_schedules:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) ``` @@ -1814,7 +1815,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) ``` @@ -2219,7 +2221,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) ``` @@ -2290,7 +2293,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) ``` @@ -3257,7 +3261,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) print("The response of SourcesApi->update_password_policy_holders:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) ``` @@ -3318,7 +3323,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SuggestedEntitlementDescriptionApi.md index faaf5a16c..463defab7 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SuggestedEntitlementDescriptionApi.md @@ -224,7 +224,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) ``` @@ -347,7 +348,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TaggedObjectsApi.md index abc2de066..dfc580196 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TaggedObjectsApi.md @@ -319,7 +319,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) ``` @@ -387,7 +388,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) ``` @@ -592,7 +594,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TaskManagementApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TaskManagementApi.md index 34bc388ae..f241a3c72 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TaskManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TaskManagementApi.md @@ -164,7 +164,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) ``` @@ -319,7 +320,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TenantContextApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TenantContextApi.md index 23f486fbc..b9e35c288 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TenantContextApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TenantContextApi.md @@ -83,7 +83,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental) print("The response of TenantContextApi->get_tenant_context:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TenantContextApi->get_tenant_context: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TransformsApi.md index 112d4063a..69882cc76 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TransformsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TransformsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TriggersApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TriggersApi.md index cc5f15152..a05008a26 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TriggersApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TriggersApi.md @@ -386,7 +386,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) ``` @@ -468,7 +469,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) ``` @@ -548,7 +550,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) ``` @@ -709,7 +712,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation) print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/VendorConnectorMappingsApi.md index cf66060aa..7800aa9be 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/VendorConnectorMappingsApi.md @@ -236,7 +236,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/WorkItemsApi.md index a402b800d..0cc3a6ee2 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/WorkItemsApi.md @@ -356,7 +356,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) ``` @@ -664,7 +665,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/WorkReassignmentApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/WorkReassignmentApi.md index 28a0f5281..fa837f5b3 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/WorkReassignmentApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/WorkReassignmentApi.md @@ -255,7 +255,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) ``` @@ -325,7 +326,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) ``` @@ -540,7 +542,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/WorkflowsApi.md index 557f9ac38..24e18cdc8 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/WorkflowsApi.md @@ -491,7 +491,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) ``` @@ -568,7 +569,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) ``` @@ -628,7 +630,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) ``` @@ -690,7 +693,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) ``` @@ -744,7 +748,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) ``` @@ -806,7 +811,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) ``` @@ -860,7 +866,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflows() print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md index 626e62e2b..8403e7986 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 33437e264..960d4b101 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md index 3091b3a26..3f731dad1 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md index 21d3d47fd..19199e33c 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md @@ -447,7 +447,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) ``` @@ -520,7 +521,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md index df90b9881..4161d1145 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md @@ -292,7 +292,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) ``` @@ -360,7 +361,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md index cc03280e3..f9f2bf0b9 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md @@ -365,7 +365,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md index 267f49434..14f840584 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md @@ -174,7 +174,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md index 2c2188c67..f140ac832 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md @@ -78,7 +78,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md index 02d13f8cc..ca424c6cc 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md @@ -441,7 +441,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) ``` @@ -509,7 +510,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md index 642333eb3..43319315f 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md @@ -80,7 +80,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md b/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md index bb18c9ed4..3181e494d 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md @@ -259,7 +259,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = BrandingApi(api_client).get_branding_list() print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md index e8c917490..88c8dea4d 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md @@ -762,7 +762,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) ``` @@ -884,7 +885,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) ``` @@ -1128,7 +1130,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md index 7eb8a7040..834d6149c 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md @@ -97,7 +97,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) ``` @@ -227,7 +228,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md index 9b2c0644a..e4c5753d8 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md @@ -229,7 +229,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) ``` @@ -296,7 +297,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) ``` @@ -365,7 +367,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) ``` @@ -440,7 +443,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) ``` @@ -508,7 +512,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md index 3d5f5fe13..baee35a27 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md @@ -423,7 +423,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) ``` @@ -541,7 +542,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md index d846517d0..61629c252 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md @@ -283,7 +283,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md index fe9afda3f..3144af415 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md @@ -323,7 +323,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) ``` @@ -566,7 +567,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md index 36ca111cd..1c2e6286f 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md @@ -324,7 +324,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md index b8e5bfd0e..f03c4fed7 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md @@ -186,7 +186,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) ``` @@ -431,7 +432,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md index 3e6b7bb1d..ecfde8c48 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md @@ -321,7 +321,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md index 51101d3df..3b95cc5da 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md @@ -325,7 +325,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md index 2753a668e..60f64462b 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md @@ -1433,7 +1433,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -1566,7 +1567,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) ``` @@ -1634,7 +1636,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) ``` @@ -1706,7 +1709,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) ``` @@ -1776,7 +1780,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md index 3db63429f..2bfb0bd9d 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md index 98034eddd..5bee15b51 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md @@ -290,7 +290,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md index 504465b9f..bf94cd6bb 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md @@ -286,7 +286,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md index cd23f309a..c6f6222fc 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md @@ -202,7 +202,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md index 4cd8c8d05..c96b85aab 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md @@ -80,7 +80,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md index 397762d93..30c9cb4ab 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md @@ -89,7 +89,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md index b99f995af..f54a23bc0 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md @@ -518,7 +518,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) ``` @@ -590,7 +591,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md index e464d48c2..65f6ff8f6 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md @@ -755,7 +755,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md index 23fb26d5b..4328e7af6 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md @@ -336,7 +336,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md index 7ed54200a..306bbae62 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md @@ -283,7 +283,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md index 6cd2d1f71..6adfbe269 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md @@ -628,7 +628,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchApi(api_client).search_post(new_search, offset, limit, count) print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchApi->search_post: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md index 56324446a..d10e2357e 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md @@ -214,7 +214,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) ``` @@ -274,7 +275,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md index aa135f39d..5c3077943 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md @@ -290,7 +290,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md index 73106dd2c..9321726f7 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md @@ -363,7 +363,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) ``` @@ -430,7 +431,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md index 3b92c4a4e..27ba65310 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md @@ -137,7 +137,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md index 8867020db..b0b73bf65 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md @@ -1054,7 +1054,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) ``` @@ -1307,7 +1308,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) ``` @@ -1378,7 +1380,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) ``` @@ -1772,7 +1775,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md index 062cb500c..881257381 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md @@ -319,7 +319,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) ``` @@ -387,7 +388,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) ``` @@ -592,7 +594,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md index 0902537b9..906783957 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md index 63e186b3f..1322a7c49 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md @@ -232,7 +232,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md index ce582fe02..9134f46f5 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md @@ -280,7 +280,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) ``` @@ -577,7 +578,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md index 044c3110c..581f58442 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md @@ -491,7 +491,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) ``` @@ -568,7 +569,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) ``` @@ -628,7 +630,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) ``` @@ -690,7 +693,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) ``` @@ -744,7 +748,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) ``` @@ -806,7 +811,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) ``` @@ -860,7 +866,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflows() print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md index 211d1a3d1..a1615a57b 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index 049a9aafe..a80904ad9 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md index 4d3443864..159a7ebe0 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index 57728a5a4..66ec92f90 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -71,7 +71,8 @@ # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) - path: /access-model-metadata/attributes/{key}/values @@ -96,7 +97,8 @@ # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) - path: /access-profiles @@ -311,7 +313,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - path: /access-profiles @@ -343,7 +346,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - path: /access-profiles/{id} @@ -396,7 +400,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(new_access_profile_bulk_update_request_inner) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) - path: /access-request-approvals/{approvalId}/approve @@ -515,7 +520,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending @@ -545,7 +551,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - path: /access-request-approvals/{approvalId}/reject @@ -800,7 +807,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - path: /access-request-config @@ -908,7 +916,8 @@ # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, type, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /account-aggregations/{id}/status @@ -962,7 +971,8 @@ # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts @@ -1129,7 +1139,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).disable_accounts_for_identities(new_identities_accounts_bulk_request) print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) - path: /accounts/{id}/enable @@ -1211,7 +1222,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).enable_accounts_for_identities(new_identities_accounts_bulk_request) print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) - path: /accounts/{id} @@ -1264,7 +1276,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, offset, limit, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts @@ -1294,7 +1307,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(detail_level, limit, offset, count, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} @@ -1461,7 +1475,8 @@ # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template @@ -1583,7 +1598,8 @@ # Below is a request that includes all optional parameters # results = ApprovalsApi(api_client).get_approvals(mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) - path: /source-apps @@ -1645,7 +1661,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, new_request_body, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) - path: /source-apps/{id} @@ -1723,7 +1740,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_access_profiles_for_source_app(id, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) - path: /source-apps/all @@ -1752,7 +1770,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_source_app(limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) - path: /user-apps/all @@ -1780,7 +1799,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_user_apps(filters, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) - path: /source-apps/assigned @@ -1809,7 +1829,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_assigned_source_app(limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) - path: /user-apps/{id}/available-accounts @@ -1837,7 +1858,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_accounts_for_user_app(id, limit, count, offset) print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) - path: /source-apps @@ -1866,7 +1888,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_source_apps(limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) - path: /user-apps @@ -1894,7 +1917,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_owned_user_apps(limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) - path: /source-apps/{id} @@ -2031,7 +2055,8 @@ # Below is a request that includes all optional parameters # results = AuthProfileApi(api_client).get_profile_config_list() print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) - path: /auth-profiles/{id} @@ -2468,7 +2493,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - path: /campaigns/{id} @@ -2518,7 +2544,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - path: /campaigns/reports-configuration @@ -2621,7 +2648,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - path: /campaigns/{id}/reassign @@ -2911,7 +2939,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - path: /certifications/{id}/tasks-pending @@ -2936,7 +2965,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_pending_tasks(id) print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_pending_tasks: %s\n" % e) - path: /certifications/{id}/tasks/{taskId} @@ -2992,7 +3022,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - path: /certifications @@ -3022,7 +3053,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certifications: %s\n" % e) - path: /certifications/{id}/reassign-async @@ -3181,7 +3213,8 @@ # Below is a request that includes all optional parameters # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list() print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) - path: /connector-rules/{id} @@ -3292,7 +3325,8 @@ # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - path: /form-definitions @@ -3722,7 +3756,8 @@ # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) - path: /form-definitions/{formDefinitionID}/file/{fileID} @@ -3981,7 +4016,8 @@ # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) - path: /form-definitions/predefined-select-options @@ -4280,7 +4316,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_children(id, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) - path: /entitlements/{id}/parents @@ -4310,7 +4347,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_parents(id, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) - path: /entitlements @@ -4343,7 +4381,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) - path: /entitlements/{id} @@ -4556,7 +4595,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) - path: /workgroups/bulk-delete @@ -4584,7 +4624,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(new_workgroup_bulk_delete_request) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) - path: /workgroups/{id} @@ -4638,7 +4679,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) - path: /workgroups/{workgroupId}/members @@ -4667,7 +4709,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) - path: /workgroups @@ -4696,7 +4739,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroups(offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) - path: /workgroups/{id} @@ -4750,7 +4794,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items @@ -4872,7 +4917,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(new_access_request_recommendation_action_item_dto) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations @@ -4903,7 +4949,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items @@ -4932,7 +4979,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) - path: /ai-access-request-recommendations/requested-items @@ -4961,7 +5009,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items @@ -4990,7 +5039,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) - path: /common-access @@ -5055,7 +5105,8 @@ # Below is a request that includes all optional parameters # results = IAICommonAccessApi(api_client).get_common_access(offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) - path: /common-access/update-status @@ -5105,7 +5156,8 @@ # Below is a request that includes all optional parameters # results = IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id) print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIMessageCatalogsApi->get_message_catalogs: %s\n" % e) - path: /outliers/export @@ -5158,7 +5210,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) - path: /outliers @@ -5188,7 +5241,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outliers(limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) - path: /outlier-summaries/latest @@ -5213,7 +5267,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) - path: /outlier-feature-summaries/{outlierFeatureId} @@ -5268,7 +5323,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) - path: /outliers/ignore @@ -5321,7 +5377,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) - path: /outliers/unignore @@ -5371,7 +5428,8 @@ # Below is a request that includes all optional parameters # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) - path: /recommendations/request @@ -5700,7 +5758,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution @@ -5758,7 +5817,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements @@ -5789,7 +5849,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities @@ -5820,7 +5881,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} @@ -5876,7 +5938,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements @@ -5906,7 +5969,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage @@ -5936,7 +6000,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries @@ -5966,7 +6031,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} @@ -6070,7 +6136,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) - path: /role-mining-potential-roles/saved @@ -6098,7 +6165,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} @@ -6383,7 +6451,8 @@ # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).get_role_assignments(identity_id, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) - path: /identities @@ -6413,7 +6482,8 @@ # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).list_identities(filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) - path: /identities/{identityId}/reset @@ -6690,7 +6760,8 @@ # Below is a request that includes all optional parameters # results = IdentityAttributesApi(api_client).list_identity_attributes(include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) - path: /identity-attributes/{name} @@ -6768,7 +6839,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) - path: /historical-identities/{id}/compare/{accessType} @@ -6800,7 +6872,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) - path: /historical-identities/{id} @@ -6856,7 +6929,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date} @@ -6913,7 +6987,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) - path: /historical-identities/{id}/start-date @@ -6966,7 +7041,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_historical_identities(starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) - path: /historical-identities/{id}/access-items @@ -6998,7 +7074,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_access_items(id, type, filters, sorters, query, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date}/access-items @@ -7025,7 +7102,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots @@ -7055,7 +7133,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) - path: /identity-profiles @@ -7207,7 +7286,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config @@ -7312,7 +7392,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview @@ -7715,7 +7796,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - path: /mfa/okta-verify/config @@ -7831,7 +7913,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - path: /mfa/{method}/test @@ -8184,7 +8267,8 @@ # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /managed-clusters/{id}/log-config @@ -8418,7 +8502,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) - path: /multihosts/{multiHostId}/sources/errors @@ -8443,7 +8528,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) - path: /multihosts/types @@ -8467,7 +8553,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) - path: /multihosts/{multihostId}/sources @@ -8497,7 +8584,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) - path: /multihosts/{multihostId}/sources/testConnection @@ -9166,7 +9254,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload @@ -9222,7 +9311,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approval(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approval: %s\n" % e) - path: /non-employee-records @@ -9251,7 +9341,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - path: /non-employee-requests @@ -9281,7 +9372,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources @@ -9311,7 +9403,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - path: /non-employee-records/{id} @@ -9631,7 +9724,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_dkim_attributes() print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) - path: /mail-from-attributes/{identityId} @@ -9681,7 +9775,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_notification_template(id) print("The response of NotificationsApi->get_notification_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) - path: /notification-template-context @@ -9734,7 +9829,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_from_addresses(limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) - path: /notification-preferences/{key} @@ -9759,7 +9855,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_preferences(key) print("The response of NotificationsApi->list_notification_preferences:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) - path: /notification-template-defaults @@ -9786,7 +9883,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_template_defaults(limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) - path: /notification-templates @@ -9813,7 +9911,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_templates(limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) - path: /mail-from-attributes @@ -9983,7 +10082,8 @@ # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - path: /oauth-clients/{id} @@ -10057,7 +10157,8 @@ # Below is a request that includes all optional parameters # results = OrgConfigApi(api_client).get_valid_time_zones() print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) - path: /org-config @@ -10459,7 +10560,8 @@ # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - path: /password-policies/{id} @@ -10623,7 +10725,8 @@ # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - path: /password-sync-groups/{id} @@ -10734,7 +10837,8 @@ # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - path: /personal-access-tokens/{id} @@ -10859,7 +10963,8 @@ # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - path: /role-insights/requests @@ -10941,7 +11046,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) - path: /role-insights/{insightId} @@ -10995,7 +11101,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights(offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) - path: /role-insights/{insightId}/current-entitlements @@ -11021,7 +11128,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes @@ -11048,7 +11156,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) - path: /role-insights/requests/{id} @@ -11384,7 +11493,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - path: /roles/{id}/entitlements @@ -11414,7 +11524,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_entitlements(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) - path: /roles @@ -11446,7 +11557,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) - path: /roles/{id} @@ -12012,7 +12124,8 @@ # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - path: /sod-policies/{id} @@ -12500,7 +12613,8 @@ # Below is a request that includes all optional parameters # results = SPConfigApi(api_client).list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /accounts/search-attribute-config @@ -12580,7 +12694,8 @@ # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} @@ -12605,7 +12720,8 @@ # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} @@ -12754,7 +12870,8 @@ # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - path: /segments/{id} @@ -12911,7 +13028,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) - path: /service-desk-integrations/templates/{scriptName} @@ -12960,7 +13078,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations/status-check-configuration @@ -13149,7 +13268,8 @@ # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies @@ -13743,7 +13863,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - path: /sources/{sourceId}/load-accounts @@ -13926,7 +14047,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - path: /sources @@ -13957,7 +14079,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) - path: /sources/{sourceId}/connector/peek-resource-objects @@ -14437,7 +14560,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} @@ -14639,7 +14763,8 @@ # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) - path: /suggested-entitlement-descriptions @@ -14692,7 +14817,8 @@ # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) - path: /suggested-entitlement-description-assignments @@ -14865,7 +14991,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - path: /tagged-objects/{type} @@ -14894,7 +15021,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - path: /tagged-objects/{type}/{id} @@ -15110,7 +15238,8 @@ # Below is a request that includes all optional parameters # results = TagsApi(api_client).list_tags(limit, offset, count, filters, sorters) print("The response of TagsApi->list_tags:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TagsApi->list_tags: %s\n" % e) - path: /task-status/pending-tasks @@ -15161,7 +15290,8 @@ # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_pending_tasks(offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) - path: /task-status/{id} @@ -15215,7 +15345,8 @@ # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_task_status_list(limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) - path: /task-status/{id} @@ -15372,7 +15503,8 @@ # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - path: /transforms/{id} @@ -15534,7 +15666,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_subscriptions(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) - path: /trigger-invocations/status @@ -15563,7 +15696,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_trigger_invocation_status(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) - path: /triggers @@ -15592,7 +15726,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_triggers(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) - path: /trigger-subscriptions/{id} @@ -15654,7 +15789,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).start_test_trigger_invocation(new_test_invocation) print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) - path: /trigger-subscriptions/validate-filter @@ -15908,7 +16044,8 @@ # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} @@ -16041,7 +16178,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - path: /work-items/completed/count @@ -16066,7 +16204,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) - path: /work-items/count @@ -16169,7 +16308,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - path: /work-items/{id}/reject/{approvalItemId} @@ -16330,7 +16470,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/types @@ -16354,7 +16495,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_reassignment_config_types() print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) - path: /reassignment-configurations/{identityId} @@ -16429,7 +16571,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).list_reassignment_configurations(limit, offset) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) - path: /reassignment-configurations/{identityId} @@ -16636,7 +16779,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - path: /workflows/{id}/executions @@ -16665,7 +16809,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library @@ -16691,7 +16836,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - path: /workflow-library/actions @@ -16718,7 +16864,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - path: /workflow-library/operators @@ -16742,7 +16889,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers @@ -16769,7 +16917,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - path: /workflows @@ -16793,7 +16942,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflows() print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index c6dd58b25..193c27f3d 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -77,7 +77,8 @@ # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) - path: /access-model-metadata/attributes/{key}/values @@ -104,7 +105,8 @@ # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) - path: /access-profiles @@ -320,7 +322,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - path: /access-profiles @@ -352,7 +355,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - path: /access-profiles/{id} @@ -407,7 +411,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) - path: /access-request-approvals/{approvalId}/approve @@ -524,7 +529,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count) print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) - path: /access-request-approvals/completed @@ -554,7 +560,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending @@ -584,7 +591,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - path: /access-request-approvals/{approvalId}/reject @@ -897,7 +905,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - path: /access-request-administration @@ -931,7 +940,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) - path: /access-request-config @@ -1038,7 +1048,8 @@ # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /account-aggregations/{id}/status @@ -1094,7 +1105,8 @@ # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts @@ -1267,7 +1279,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) - path: /accounts/{id}/enable @@ -1353,7 +1366,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) - path: /accounts/{id} @@ -1406,7 +1420,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts @@ -1436,7 +1451,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} @@ -1581,7 +1597,8 @@ # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template @@ -1683,7 +1700,8 @@ # Below is a request that includes all optional parameters # results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) - path: /source-apps @@ -1749,7 +1767,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) - path: /source-apps/{id} @@ -1833,7 +1852,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) - path: /source-apps/all @@ -1864,7 +1884,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) - path: /user-apps/all @@ -1894,7 +1915,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) - path: /source-apps/assigned @@ -1925,7 +1947,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) - path: /user-apps/{id}/available-accounts @@ -1954,7 +1977,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count) print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) - path: /source-apps @@ -1985,7 +2009,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) - path: /user-apps @@ -2015,7 +2040,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) - path: /source-apps/{id} @@ -2162,7 +2188,8 @@ # Below is a request that includes all optional parameters # results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental) print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) - path: /auth-profiles/{id} @@ -2346,7 +2373,8 @@ # Below is a request that includes all optional parameters # results = BrandingApi(api_client).get_branding_list() print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) - path: /brandings/{name} @@ -2950,7 +2978,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - path: /campaigns/{id} @@ -3001,7 +3030,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - path: /campaigns/reports-configuration @@ -3104,7 +3134,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - path: /campaigns/{id}/reassign @@ -3396,7 +3427,8 @@ # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) - path: /certifications/{id}/decision-summary @@ -3452,7 +3484,8 @@ # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) - path: /certifications/{id}/identity-summaries/{identitySummaryId} @@ -3558,7 +3591,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - path: /certification-tasks @@ -3587,7 +3621,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) - path: /certifications/{id}/reviewers @@ -3617,7 +3652,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - path: /certifications/{id}/access-review-items @@ -3650,7 +3686,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) - path: /certifications @@ -3680,7 +3717,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) - path: /certifications/{id}/decide @@ -4143,7 +4181,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) - path: /configuration-hub/backups/uploads/{id} @@ -4193,7 +4232,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_backups(filters) print("The response of ConfigurationHubApi->list_backups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) - path: /configuration-hub/deploys @@ -4242,7 +4282,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_drafts(filters) print("The response of ConfigurationHubApi->list_drafts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) - path: /configuration-hub/scheduled-actions @@ -4266,7 +4307,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_scheduled_actions() print("The response of ConfigurationHubApi->list_scheduled_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_scheduled_actions: %s\n" % e) - path: /configuration-hub/backups/uploads @@ -4291,7 +4333,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch @@ -4494,7 +4537,8 @@ # Below is a request that includes all optional parameters # results = ConnectorCustomizersApi(api_client).list_connector_customizers(offset, limit) print("The response of ConnectorCustomizersApi->list_connector_customizers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorCustomizersApi->list_connector_customizers: %s\n" % e) - path: /connector-customizers/{id} @@ -4648,7 +4692,8 @@ # Below is a request that includes all optional parameters # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(limit, offset, count) print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) - path: /connector-rules/{id} @@ -4863,7 +4908,8 @@ # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - path: /connectors/{scriptName}/source-config @@ -5361,7 +5407,8 @@ # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) - path: /form-definitions/{formDefinitionID}/file/{fileID} @@ -5620,7 +5667,8 @@ # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) - path: /form-definitions/predefined-select-options @@ -5930,7 +5978,8 @@ # Below is a request that includes all optional parameters # results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) print("The response of DataSegmentationApi->list_data_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) - path: /data-segments/{segmentId} @@ -6204,7 +6253,8 @@ # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->get_dimension_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles @@ -6235,7 +6285,8 @@ # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimension_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) - path: /roles/{roleId}/dimensions @@ -6266,7 +6317,8 @@ # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimensions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId} @@ -6463,7 +6515,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) - path: /entitlements/{id}/parents @@ -6495,7 +6548,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) - path: /entitlements @@ -6530,7 +6584,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) - path: /entitlements/{id} @@ -6829,7 +6884,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) - path: /workgroups/bulk-delete @@ -6859,7 +6915,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) - path: /workgroups/{id} @@ -6917,7 +6974,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) - path: /workgroups/{workgroupId}/members @@ -6948,7 +7006,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) - path: /workgroups @@ -6979,7 +7038,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) - path: /workgroups/{id} @@ -7037,7 +7097,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items @@ -7167,7 +7228,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations @@ -7200,7 +7262,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) - path: /ai-access-request-recommendations/config @@ -7257,7 +7320,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) - path: /ai-access-request-recommendations/requested-items @@ -7288,7 +7352,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items @@ -7319,7 +7384,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations/config @@ -7422,7 +7488,8 @@ # Below is a request that includes all optional parameters # results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) - path: /common-access/update-status @@ -7506,7 +7573,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) - path: /outliers @@ -7538,7 +7606,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) - path: /outlier-summaries/latest @@ -7565,7 +7634,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) - path: /outlier-feature-summaries/{outlierFeatureId} @@ -7624,7 +7694,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) - path: /outliers/ignore @@ -7681,7 +7752,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) - path: /outliers/unignore @@ -7735,7 +7807,8 @@ # Below is a request that includes all optional parameters # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) - path: /recommendations/request @@ -8084,7 +8157,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution @@ -8146,7 +8220,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements @@ -8179,7 +8254,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities @@ -8212,7 +8288,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} @@ -8272,7 +8349,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements @@ -8304,7 +8382,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage @@ -8336,7 +8415,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries @@ -8368,7 +8448,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} @@ -8480,7 +8561,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) - path: /role-mining-potential-roles/saved @@ -8510,7 +8592,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} @@ -8818,7 +8901,8 @@ # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) - path: /identities @@ -8850,7 +8934,8 @@ # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) - path: /identities/{id}/reset @@ -9147,7 +9232,8 @@ # Below is a request that includes all optional parameters # results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) - path: /identity-attributes/{name} @@ -9229,7 +9315,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) - path: /historical-identities/{id}/compare/{access-type} @@ -9263,7 +9350,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) - path: /historical-identities/{id} @@ -9323,7 +9411,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date} @@ -9384,7 +9473,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) - path: /historical-identities/{id}/start-date @@ -9441,7 +9531,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) - path: /historical-identities/{id}/access-items @@ -9472,7 +9563,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date}/access-items @@ -9501,7 +9593,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots @@ -9533,7 +9626,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) - path: /identity-profiles @@ -9685,7 +9779,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview @@ -9844,7 +9939,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/process-identities @@ -10026,7 +10122,8 @@ # Below is a request that includes all optional parameters # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) - path: /identities/{identity-id}/set-lifecycle-state @@ -10130,7 +10227,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - path: /mfa/okta-verify/config @@ -10246,7 +10344,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - path: /mfa/{method}/test @@ -10329,7 +10428,8 @@ # Below is a request that includes all optional parameters # results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of MachineAccountsApi->list_machine_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) - path: /machine-accounts/{id} @@ -10475,7 +10575,8 @@ # Below is a request that includes all optional parameters # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, filters, sorters, count, limit, offset) print("The response of MachineIdentitiesApi->list_machine_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) - path: /machine-identities/{id} @@ -10636,7 +10737,8 @@ # Below is a request that includes all optional parameters # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) - path: /managed-clients/{id} @@ -10770,7 +10872,8 @@ # Below is a request that includes all optional parameters # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) - path: /managed-cluster-types/{id} @@ -10942,7 +11045,8 @@ # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /managed-clusters/{id}/log-config @@ -11145,7 +11249,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id, offset, limit) print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) - path: /multihosts/{multiHostId}/entitlementAggregationGroups @@ -11172,7 +11277,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id, offset, limit) print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) - path: /multihosts/{multihostId} @@ -11227,7 +11333,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) - path: /multihosts/{multiHostId}/sources/errors @@ -11252,7 +11359,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) - path: /multihosts/types @@ -11276,7 +11384,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) - path: /multihosts/{multihostId}/sources @@ -11306,7 +11415,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) - path: /multihosts/{multihostId}/sources/testConnection @@ -11975,7 +12085,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload @@ -12031,7 +12142,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) - path: /non-employee-records @@ -12060,7 +12172,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - path: /non-employee-requests @@ -12090,7 +12203,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources @@ -12120,7 +12234,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - path: /non-employee-records/{id} @@ -12452,7 +12567,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) - path: /mail-from-attributes/{identity} @@ -12563,7 +12679,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) - path: /notification-preferences/{key} @@ -12618,7 +12735,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) - path: /notification-templates @@ -12647,7 +12765,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) - path: /mail-from-attributes @@ -12821,7 +12940,8 @@ # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - path: /oauth-clients/{id} @@ -12902,7 +13022,8 @@ # Below is a request that includes all optional parameters # results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count) print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) - path: /org-config @@ -13308,7 +13429,8 @@ # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - path: /password-policies/{id} @@ -13472,7 +13594,8 @@ # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - path: /password-sync-groups/{id} @@ -13583,7 +13706,8 @@ # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - path: /personal-access-tokens/{id} @@ -13640,7 +13764,8 @@ # Below is a request that includes all optional parameters # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) - path: /public-identities-config @@ -13845,7 +13970,8 @@ # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - path: /role-insights/requests @@ -13933,7 +14059,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) - path: /role-insights/{insightId} @@ -13991,7 +14118,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) - path: /role-insights/{insightId}/current-entitlements @@ -14019,7 +14147,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes @@ -14048,7 +14177,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) - path: /role-insights/requests/{id} @@ -14382,7 +14512,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_bulk_update_status() print("The response of RolesApi->get_bulk_update_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) - path: /roles/access-model-metadata/bulk-update/id @@ -14462,7 +14593,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - path: /roles/{id}/entitlements @@ -14494,7 +14626,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) - path: /roles @@ -14526,7 +14659,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) - path: /roles/{id} @@ -14858,7 +14992,8 @@ # Below is a request that includes all optional parameters # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) - path: /sim-integrations/{id}/beforeProvisioningRule @@ -15309,7 +15444,8 @@ # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - path: /sod-policies/{id} @@ -15849,7 +15985,8 @@ # Below is a request that includes all optional parameters # results = SPConfigApi(api_client).list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches @@ -15984,7 +16121,8 @@ # Below is a request that includes all optional parameters # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) - path: /saved-searches/{id} @@ -16155,7 +16293,8 @@ # Below is a request that includes all optional parameters # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id}/unsubscribe @@ -16751,7 +16890,8 @@ # Below is a request that includes all optional parameters # results = SearchApi(api_client).search_post(new_search, offset, limit, count) print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchApi->search_post: %s\n" % e) - path: /accounts/search-attribute-config @@ -16837,7 +16977,8 @@ # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental, limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} @@ -17015,7 +17156,8 @@ # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - path: /segments/{id} @@ -17195,7 +17337,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations @@ -17224,7 +17367,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) - path: /service-desk-integrations/status-check-configuration @@ -17416,7 +17560,8 @@ # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies @@ -18116,7 +18261,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schedules(source_id) print("The response of SourcesApi->get_source_schedules:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} @@ -18169,7 +18315,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - path: /sources/{id}/load-accounts @@ -18330,7 +18477,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - path: /sources @@ -18361,7 +18509,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) - path: /sources/{sourceId}/connector/ping-cluster @@ -18847,7 +18996,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) print("The response of SourcesApi->update_password_policy_holders:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/bulk-update @@ -18873,7 +19023,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} @@ -19105,7 +19256,8 @@ # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) - path: /suggested-entitlement-descriptions @@ -19158,7 +19310,8 @@ # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) - path: /suggested-entitlement-description-assignments @@ -19330,7 +19483,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - path: /tagged-objects/{type} @@ -19359,7 +19513,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - path: /tagged-objects/{type}/{id} @@ -19461,7 +19616,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) - path: /task-status/pending-tasks @@ -19516,7 +19672,8 @@ # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) - path: /task-status/{id} @@ -19574,7 +19731,8 @@ # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) - path: /task-status/{id} @@ -19653,7 +19811,8 @@ # Below is a request that includes all optional parameters # results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental) print("The response of TenantContextApi->get_tenant_context:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TenantContextApi->get_tenant_context: %s\n" % e) - path: /tenant-context @@ -19788,7 +19947,8 @@ # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - path: /transforms/{id} @@ -19958,7 +20118,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) - path: /trigger-invocations/status @@ -19989,7 +20150,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) - path: /triggers @@ -20020,7 +20182,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) - path: /trigger-subscriptions/{id} @@ -20086,7 +20249,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation) print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) - path: /trigger-subscriptions/validate-filter @@ -20348,7 +20512,8 @@ # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} @@ -20483,7 +20648,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - path: /work-items/completed/count @@ -20613,7 +20779,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - path: /work-items/{id}/reject/{approvalItemId} @@ -20780,7 +20947,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/types @@ -20806,7 +20974,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) - path: /reassignment-configurations/{identityId} @@ -20885,7 +21054,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) - path: /reassignment-configurations/{identityId} @@ -21148,7 +21318,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - path: /workflows/{id}/executions @@ -21177,7 +21348,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library @@ -21203,7 +21375,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - path: /workflow-library/actions @@ -21230,7 +21403,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - path: /workflow-library/operators @@ -21254,7 +21428,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers @@ -21281,7 +21456,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - path: /workflows @@ -21305,7 +21481,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflows() print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index d0822cfba..632587f6a 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -77,7 +77,8 @@ # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) - path: /access-model-metadata/attributes/{key}/values @@ -104,7 +105,8 @@ # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) - path: /access-profiles @@ -320,7 +322,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - path: /access-profiles @@ -352,7 +355,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - path: /access-profiles/{id} @@ -407,7 +411,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) - path: /access-request-approvals/{approvalId}/approve @@ -524,7 +529,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count) print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) - path: /access-request-approvals/completed @@ -554,7 +560,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending @@ -584,7 +591,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - path: /access-request-approvals/{approvalId}/reject @@ -897,7 +905,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - path: /access-request-administration @@ -931,7 +940,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) - path: /access-request-config @@ -1038,7 +1048,8 @@ # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /account-aggregations/{id}/status @@ -1094,7 +1105,8 @@ # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts @@ -1267,7 +1279,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) - path: /accounts/{id}/enable @@ -1353,7 +1366,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) - path: /accounts/{id} @@ -1406,7 +1420,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts @@ -1436,7 +1451,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} @@ -1581,7 +1597,8 @@ # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template @@ -1683,7 +1700,8 @@ # Below is a request that includes all optional parameters # results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) - path: /source-apps @@ -1749,7 +1767,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) - path: /source-apps/{id} @@ -1833,7 +1852,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) - path: /source-apps/all @@ -1864,7 +1884,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) - path: /user-apps/all @@ -1894,7 +1915,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) - path: /source-apps/assigned @@ -1925,7 +1947,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) - path: /user-apps/{id}/available-accounts @@ -1954,7 +1977,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count) print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) - path: /source-apps @@ -1985,7 +2009,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) - path: /user-apps @@ -2015,7 +2040,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) - path: /source-apps/{id} @@ -2162,7 +2188,8 @@ # Below is a request that includes all optional parameters # results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental) print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) - path: /auth-profiles/{id} @@ -2346,7 +2373,8 @@ # Below is a request that includes all optional parameters # results = BrandingApi(api_client).get_branding_list() print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) - path: /brandings/{name} @@ -2950,7 +2978,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - path: /campaigns/{id} @@ -3001,7 +3030,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - path: /campaigns/reports-configuration @@ -3104,7 +3134,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - path: /campaigns/{id}/reassign @@ -3396,7 +3427,8 @@ # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) - path: /certifications/{id}/decision-summary @@ -3452,7 +3484,8 @@ # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) - path: /certifications/{id}/identity-summaries/{identitySummaryId} @@ -3558,7 +3591,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - path: /certification-tasks @@ -3587,7 +3621,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) - path: /certifications/{id}/reviewers @@ -3617,7 +3652,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - path: /certifications/{id}/access-review-items @@ -3650,7 +3686,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) - path: /certifications @@ -3680,7 +3717,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) - path: /certifications/{id}/decide @@ -4143,7 +4181,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) - path: /configuration-hub/backups/uploads/{id} @@ -4193,7 +4232,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_backups(filters) print("The response of ConfigurationHubApi->list_backups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) - path: /configuration-hub/deploys @@ -4242,7 +4282,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_drafts(filters) print("The response of ConfigurationHubApi->list_drafts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) - path: /configuration-hub/scheduled-actions @@ -4266,7 +4307,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_scheduled_actions() print("The response of ConfigurationHubApi->list_scheduled_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_scheduled_actions: %s\n" % e) - path: /configuration-hub/backups/uploads @@ -4291,7 +4333,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch @@ -4494,7 +4537,8 @@ # Below is a request that includes all optional parameters # results = ConnectorCustomizersApi(api_client).list_connector_customizers(offset, limit) print("The response of ConnectorCustomizersApi->list_connector_customizers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorCustomizersApi->list_connector_customizers: %s\n" % e) - path: /connector-customizers/{id} @@ -4648,7 +4692,8 @@ # Below is a request that includes all optional parameters # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(limit, offset, count) print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) - path: /connector-rules/{id} @@ -4863,7 +4908,8 @@ # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - path: /connectors/{scriptName}/source-config @@ -5361,7 +5407,8 @@ # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) - path: /form-definitions/{formDefinitionID}/file/{fileID} @@ -5620,7 +5667,8 @@ # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) - path: /form-definitions/predefined-select-options @@ -5930,7 +5978,8 @@ # Below is a request that includes all optional parameters # results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) print("The response of DataSegmentationApi->list_data_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) - path: /data-segments/{segmentId} @@ -6204,7 +6253,8 @@ # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->get_dimension_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles @@ -6235,7 +6285,8 @@ # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimension_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) - path: /roles/{roleId}/dimensions @@ -6266,7 +6317,8 @@ # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimensions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId} @@ -6463,7 +6515,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) - path: /entitlements/{id}/parents @@ -6495,7 +6548,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) - path: /entitlements @@ -6530,7 +6584,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) - path: /entitlements/{id} @@ -6829,7 +6884,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) - path: /workgroups/bulk-delete @@ -6859,7 +6915,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) - path: /workgroups/{id} @@ -6917,7 +6974,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) - path: /workgroups/{workgroupId}/members @@ -6948,7 +7006,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) - path: /workgroups @@ -6979,7 +7038,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) - path: /workgroups/{id} @@ -7037,7 +7097,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items @@ -7167,7 +7228,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations @@ -7200,7 +7262,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) - path: /ai-access-request-recommendations/config @@ -7257,7 +7320,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) - path: /ai-access-request-recommendations/requested-items @@ -7288,7 +7352,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items @@ -7319,7 +7384,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations/config @@ -7422,7 +7488,8 @@ # Below is a request that includes all optional parameters # results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) - path: /common-access/update-status @@ -7506,7 +7573,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) - path: /outliers @@ -7538,7 +7606,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) - path: /outlier-summaries/latest @@ -7565,7 +7634,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) - path: /outlier-feature-summaries/{outlierFeatureId} @@ -7624,7 +7694,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) - path: /outliers/ignore @@ -7681,7 +7752,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) - path: /outliers/unignore @@ -7735,7 +7807,8 @@ # Below is a request that includes all optional parameters # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) - path: /recommendations/request @@ -8084,7 +8157,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution @@ -8146,7 +8220,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements @@ -8179,7 +8254,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities @@ -8212,7 +8288,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} @@ -8272,7 +8349,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements @@ -8304,7 +8382,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage @@ -8336,7 +8415,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries @@ -8368,7 +8448,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} @@ -8480,7 +8561,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) - path: /role-mining-potential-roles/saved @@ -8510,7 +8592,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} @@ -8818,7 +8901,8 @@ # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) - path: /identities @@ -8850,7 +8934,8 @@ # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) - path: /identities/{id}/reset @@ -9147,7 +9232,8 @@ # Below is a request that includes all optional parameters # results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) - path: /identity-attributes/{name} @@ -9229,7 +9315,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) - path: /historical-identities/{id}/compare/{access-type} @@ -9263,7 +9350,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) - path: /historical-identities/{id} @@ -9323,7 +9411,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date} @@ -9384,7 +9473,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) - path: /historical-identities/{id}/start-date @@ -9441,7 +9531,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) - path: /historical-identities/{id}/access-items @@ -9472,7 +9563,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date}/access-items @@ -9501,7 +9593,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots @@ -9533,7 +9626,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) - path: /identity-profiles @@ -9685,7 +9779,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview @@ -9844,7 +9939,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/process-identities @@ -10026,7 +10122,8 @@ # Below is a request that includes all optional parameters # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) - path: /identities/{identity-id}/set-lifecycle-state @@ -10130,7 +10227,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - path: /mfa/okta-verify/config @@ -10246,7 +10344,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - path: /mfa/{method}/test @@ -10329,7 +10428,8 @@ # Below is a request that includes all optional parameters # results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of MachineAccountsApi->list_machine_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) - path: /machine-accounts/{id} @@ -10475,7 +10575,8 @@ # Below is a request that includes all optional parameters # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, filters, sorters, count, limit, offset) print("The response of MachineIdentitiesApi->list_machine_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) - path: /machine-identities/{id} @@ -10636,7 +10737,8 @@ # Below is a request that includes all optional parameters # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) - path: /managed-clients/{id} @@ -10770,7 +10872,8 @@ # Below is a request that includes all optional parameters # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) - path: /managed-cluster-types/{id} @@ -10942,7 +11045,8 @@ # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /managed-clusters/{id}/log-config @@ -11145,7 +11249,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id, offset, limit) print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) - path: /multihosts/{multiHostId}/entitlementAggregationGroups @@ -11172,7 +11277,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id, offset, limit) print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) - path: /multihosts/{multihostId} @@ -11227,7 +11333,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) - path: /multihosts/{multiHostId}/sources/errors @@ -11252,7 +11359,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) - path: /multihosts/types @@ -11276,7 +11384,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) - path: /multihosts/{multihostId}/sources @@ -11306,7 +11415,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) - path: /multihosts/{multihostId}/sources/testConnection @@ -11975,7 +12085,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload @@ -12031,7 +12142,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) - path: /non-employee-records @@ -12060,7 +12172,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - path: /non-employee-requests @@ -12090,7 +12203,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources @@ -12120,7 +12234,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - path: /non-employee-records/{id} @@ -12452,7 +12567,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) - path: /mail-from-attributes/{identity} @@ -12563,7 +12679,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) - path: /notification-preferences/{key} @@ -12618,7 +12735,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) - path: /notification-templates @@ -12647,7 +12765,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) - path: /mail-from-attributes @@ -12821,7 +12940,8 @@ # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - path: /oauth-clients/{id} @@ -12902,7 +13022,8 @@ # Below is a request that includes all optional parameters # results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count) print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) - path: /org-config @@ -13308,7 +13429,8 @@ # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - path: /password-policies/{id} @@ -13472,7 +13594,8 @@ # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - path: /password-sync-groups/{id} @@ -13583,7 +13706,8 @@ # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - path: /personal-access-tokens/{id} @@ -13640,7 +13764,8 @@ # Below is a request that includes all optional parameters # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) - path: /public-identities-config @@ -13845,7 +13970,8 @@ # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - path: /role-insights/requests @@ -13933,7 +14059,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) - path: /role-insights/{insightId} @@ -13991,7 +14118,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) - path: /role-insights/{insightId}/current-entitlements @@ -14019,7 +14147,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes @@ -14048,7 +14177,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) - path: /role-insights/requests/{id} @@ -14382,7 +14512,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_bulk_update_status() print("The response of RolesApi->get_bulk_update_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) - path: /roles/access-model-metadata/bulk-update/id @@ -14462,7 +14593,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - path: /roles/{id}/entitlements @@ -14494,7 +14626,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) - path: /roles @@ -14526,7 +14659,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) - path: /roles/{id} @@ -14858,7 +14992,8 @@ # Below is a request that includes all optional parameters # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) - path: /sim-integrations/{id}/beforeProvisioningRule @@ -15309,7 +15444,8 @@ # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - path: /sod-policies/{id} @@ -15849,7 +15985,8 @@ # Below is a request that includes all optional parameters # results = SPConfigApi(api_client).list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches @@ -15984,7 +16121,8 @@ # Below is a request that includes all optional parameters # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) - path: /saved-searches/{id} @@ -16155,7 +16293,8 @@ # Below is a request that includes all optional parameters # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id}/unsubscribe @@ -16751,7 +16890,8 @@ # Below is a request that includes all optional parameters # results = SearchApi(api_client).search_post(new_search, offset, limit, count) print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchApi->search_post: %s\n" % e) - path: /accounts/search-attribute-config @@ -16837,7 +16977,8 @@ # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental, limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} @@ -17015,7 +17156,8 @@ # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - path: /segments/{id} @@ -17195,7 +17337,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations @@ -17224,7 +17367,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) - path: /service-desk-integrations/status-check-configuration @@ -17416,7 +17560,8 @@ # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies @@ -18116,7 +18261,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schedules(source_id) print("The response of SourcesApi->get_source_schedules:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} @@ -18169,7 +18315,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - path: /sources/{id}/load-accounts @@ -18330,7 +18477,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - path: /sources @@ -18361,7 +18509,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) - path: /sources/{sourceId}/connector/ping-cluster @@ -18847,7 +18996,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) print("The response of SourcesApi->update_password_policy_holders:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/bulk-update @@ -18873,7 +19023,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} @@ -19105,7 +19256,8 @@ # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) - path: /suggested-entitlement-descriptions @@ -19158,7 +19310,8 @@ # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) - path: /suggested-entitlement-description-assignments @@ -19330,7 +19483,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - path: /tagged-objects/{type} @@ -19359,7 +19513,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - path: /tagged-objects/{type}/{id} @@ -19461,7 +19616,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) - path: /task-status/pending-tasks @@ -19516,7 +19672,8 @@ # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) - path: /task-status/{id} @@ -19574,7 +19731,8 @@ # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) - path: /task-status/{id} @@ -19653,7 +19811,8 @@ # Below is a request that includes all optional parameters # results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental) print("The response of TenantContextApi->get_tenant_context:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TenantContextApi->get_tenant_context: %s\n" % e) - path: /tenant-context @@ -19788,7 +19947,8 @@ # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - path: /transforms/{id} @@ -19958,7 +20118,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) - path: /trigger-invocations/status @@ -19989,7 +20150,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) - path: /triggers @@ -20020,7 +20182,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) - path: /trigger-subscriptions/{id} @@ -20086,7 +20249,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation) print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) - path: /trigger-subscriptions/validate-filter @@ -20348,7 +20512,8 @@ # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} @@ -20483,7 +20648,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - path: /work-items/completed/count @@ -20613,7 +20779,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - path: /work-items/{id}/reject/{approvalItemId} @@ -20780,7 +20947,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/types @@ -20806,7 +20974,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) - path: /reassignment-configurations/{identityId} @@ -20885,7 +21054,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) - path: /reassignment-configurations/{identityId} @@ -21148,7 +21318,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - path: /workflows/{id}/executions @@ -21177,7 +21348,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library @@ -21203,7 +21375,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - path: /workflow-library/actions @@ -21230,7 +21403,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - path: /workflow-library/operators @@ -21254,7 +21428,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers @@ -21281,7 +21456,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - path: /workflows @@ -21305,7 +21481,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflows() print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index 5e569934f..85ade15b6 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -210,7 +210,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - path: /access-profiles @@ -242,7 +243,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - path: /access-profiles/{id} @@ -388,7 +390,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending @@ -418,7 +421,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - path: /access-request-approvals/{approvalId}/reject @@ -617,7 +621,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - path: /access-request-config @@ -724,7 +729,8 @@ # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /account-usages/{accountId}/summaries @@ -753,7 +759,8 @@ # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts @@ -926,7 +933,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts @@ -956,7 +964,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} @@ -1101,7 +1110,8 @@ # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template @@ -1302,7 +1312,8 @@ # Below is a request that includes all optional parameters # results = BrandingApi(api_client).get_branding_list() print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) - path: /brandings/{name} @@ -1904,7 +1915,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - path: /campaigns/{id} @@ -1955,7 +1967,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - path: /campaigns/reports-configuration @@ -2058,7 +2071,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - path: /campaigns/{id}/reassign @@ -2350,7 +2364,8 @@ # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) - path: /certifications/{id}/decision-summary @@ -2406,7 +2421,8 @@ # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) - path: /certifications/{id}/identity-summaries/{identitySummaryId} @@ -2512,7 +2528,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - path: /certification-tasks @@ -2541,7 +2558,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) - path: /certifications/{id}/reviewers @@ -2571,7 +2589,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - path: /certifications/{id}/access-review-items @@ -2604,7 +2623,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) - path: /certifications @@ -2634,7 +2654,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) - path: /certifications/{id}/decide @@ -2930,7 +2951,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) - path: /configuration-hub/backups/uploads/{id} @@ -2980,7 +3002,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch @@ -3129,7 +3152,8 @@ # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - path: /connectors/{scriptName}/source-config @@ -3688,7 +3712,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config @@ -3793,7 +3818,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview @@ -4027,7 +4053,8 @@ # Below is a request that includes all optional parameters # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) - path: /identities/{identity-id}/set-lifecycle-state @@ -4156,7 +4183,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - path: /mfa/okta-verify/config @@ -4272,7 +4300,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - path: /mfa/{method}/test @@ -4601,7 +4630,8 @@ # Below is a request that includes all optional parameters # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) - path: /managed-clients/{id} @@ -4763,7 +4793,8 @@ # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /managed-clusters/{id}/log-config @@ -5414,7 +5445,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload @@ -5470,7 +5502,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) - path: /non-employee-records @@ -5499,7 +5532,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - path: /non-employee-requests @@ -5529,7 +5563,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources @@ -5559,7 +5594,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - path: /non-employee-records/{id} @@ -5824,7 +5860,8 @@ # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - path: /oauth-clients/{id} @@ -6197,7 +6234,8 @@ # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - path: /password-policies/{id} @@ -6361,7 +6399,8 @@ # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - path: /password-sync-groups/{id} @@ -6472,7 +6511,8 @@ # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - path: /personal-access-tokens/{id} @@ -6529,7 +6569,8 @@ # Below is a request that includes all optional parameters # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) - path: /public-identities-config @@ -6734,7 +6775,8 @@ # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - path: /roles @@ -7021,7 +7063,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - path: /roles @@ -7053,7 +7096,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) - path: /roles/{id} @@ -7407,7 +7451,8 @@ # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - path: /sod-policies/{id} @@ -7854,7 +7899,8 @@ # Below is a request that includes all optional parameters # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) - path: /saved-searches/{id} @@ -8025,7 +8071,8 @@ # Below is a request that includes all optional parameters # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id}/unsubscribe @@ -8573,7 +8620,8 @@ # Below is a request that includes all optional parameters # results = SearchApi(api_client).search_post(new_search, offset, limit, count) print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchApi->search_post: %s\n" % e) - path: /accounts/search-attribute-config @@ -8653,7 +8701,8 @@ # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} @@ -8678,7 +8727,8 @@ # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} @@ -8827,7 +8877,8 @@ # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - path: /segments/{id} @@ -9007,7 +9058,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations @@ -9036,7 +9088,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) - path: /service-desk-integrations/status-check-configuration @@ -9228,7 +9281,8 @@ # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies @@ -9699,7 +9753,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - path: /sources/{id}/schemas/accounts @@ -9803,7 +9858,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - path: /sources @@ -9834,7 +9890,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} @@ -10062,7 +10119,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} @@ -10257,7 +10315,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - path: /tagged-objects/{type} @@ -10286,7 +10345,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - path: /tagged-objects/{type}/{id} @@ -10388,7 +10448,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) - path: /transforms @@ -10494,7 +10555,8 @@ # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - path: /transforms/{id} @@ -10644,7 +10706,8 @@ # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} @@ -10749,7 +10812,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - path: /work-items/completed/count @@ -10877,7 +10941,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - path: /work-items/{id}/reject/{approvalItemId} @@ -11178,7 +11243,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - path: /workflows/{id}/executions @@ -11207,7 +11273,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library @@ -11233,7 +11300,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - path: /workflow-library/actions @@ -11260,7 +11328,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - path: /workflow-library/operators @@ -11284,7 +11353,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers @@ -11311,7 +11381,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - path: /workflows @@ -11335,7 +11406,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflows() print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} From 8503a31a7662226412fd2a6bb1f736a5c4938a65 Mon Sep 17 00:00:00 2001 From: arnav-chhabra-sp Date: Thu, 3 Apr 2025 12:40:01 -0500 Subject: [PATCH 18/82] CAM-27835 Update the docs --- .../ciem-er-diagram.md | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/reporting/access-intelligence-center/ciem-er-diagram.md b/docs/reporting/access-intelligence-center/ciem-er-diagram.md index cd3a2f57e..456b79828 100644 --- a/docs/reporting/access-intelligence-center/ciem-er-diagram.md +++ b/docs/reporting/access-intelligence-center/ciem-er-diagram.md @@ -20,7 +20,7 @@ import MermaidViewer from '@site/src/components/MermaidViewer'; Date: Thu, 3 Apr 2025 18:42:55 +0000 Subject: [PATCH 19/82] Automated commit by github action: 14250408148 --- static/api-specs/idn/beta/paths/campaigns.yaml | 11 +++++++++-- static/api-specs/idn/v2024/paths/campaigns.yaml | 2 +- static/api-specs/idn/v2025/paths/campaigns.yaml | 2 +- static/api-specs/idn/v3/paths/campaigns.yaml | 2 +- 4 files changed, 12 insertions(+), 5 deletions(-) diff --git a/static/api-specs/idn/beta/paths/campaigns.yaml b/static/api-specs/idn/beta/paths/campaigns.yaml index fddf70e17..e23a29aa1 100644 --- a/static/api-specs/idn/beta/paths/campaigns.yaml +++ b/static/api-specs/idn/beta/paths/campaigns.yaml @@ -9,6 +9,10 @@ get: A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. security: - userAuth: [idn:campaign:read, idn:campaign:manage, idn:campaign-report:read, idn:campaign-report:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - CERT_ADMIN + - REPORT_ADMIN deprecated: true parameters: - in: query @@ -64,9 +68,9 @@ get: schema: type: array items: - oneOf: - - $ref: '../schemas/SlimCampaign.yaml' + anyOf: - $ref: '../schemas/Campaign.yaml' + - $ref: '../schemas/SlimCampaign.yaml' examples: Slim Campaign: @@ -94,6 +98,9 @@ post: A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. security: - userAuth: [idn:campaign:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - CERT_ADMIN deprecated: true requestBody: required: true diff --git a/static/api-specs/idn/v2024/paths/campaigns.yaml b/static/api-specs/idn/v2024/paths/campaigns.yaml index 6d0db6f04..63049a54b 100644 --- a/static/api-specs/idn/v2024/paths/campaigns.yaml +++ b/static/api-specs/idn/v2024/paths/campaigns.yaml @@ -66,8 +66,8 @@ get: type: array items: anyOf: - - $ref: '../schemas/SlimCampaign.yaml' - $ref: '../schemas/Campaign.yaml' + - $ref: '../schemas/SlimCampaign.yaml' examples: Slim Campaign: $ref: '../schemas/campaign/examples/SlimCampaigns.yaml' diff --git a/static/api-specs/idn/v2025/paths/campaigns.yaml b/static/api-specs/idn/v2025/paths/campaigns.yaml index 6d0db6f04..63049a54b 100644 --- a/static/api-specs/idn/v2025/paths/campaigns.yaml +++ b/static/api-specs/idn/v2025/paths/campaigns.yaml @@ -66,8 +66,8 @@ get: type: array items: anyOf: - - $ref: '../schemas/SlimCampaign.yaml' - $ref: '../schemas/Campaign.yaml' + - $ref: '../schemas/SlimCampaign.yaml' examples: Slim Campaign: $ref: '../schemas/campaign/examples/SlimCampaigns.yaml' diff --git a/static/api-specs/idn/v3/paths/campaigns.yaml b/static/api-specs/idn/v3/paths/campaigns.yaml index 6d0db6f04..63049a54b 100644 --- a/static/api-specs/idn/v3/paths/campaigns.yaml +++ b/static/api-specs/idn/v3/paths/campaigns.yaml @@ -66,8 +66,8 @@ get: type: array items: anyOf: - - $ref: '../schemas/SlimCampaign.yaml' - $ref: '../schemas/Campaign.yaml' + - $ref: '../schemas/SlimCampaign.yaml' examples: Slim Campaign: $ref: '../schemas/campaign/examples/SlimCampaigns.yaml' From fdec0b3605cb9786a96ffe8aea434fc5a4383774 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Thu, 3 Apr 2025 18:44:25 +0000 Subject: [PATCH 20/82] Update to powershell SDK docs: 14250434703 --- .../GetActiveCampaigns200ResponseInner.md | 2 +- .../Methods/V2024CertificationCampaignsApi.md | 4 +- .../V2024/Models/GetCampaign200Response.md | 79 +++++++++++++++++++ .../Methods/V2025CertificationCampaignsApi.md | 4 +- .../V2025/Models/GetCampaign200Response.md | 79 +++++++++++++++++++ .../V3/Methods/CertificationCampaignsApi.md | 4 +- .../V3/Models/GetCampaign200Response.md | 79 +++++++++++++++++++ 7 files changed, 244 insertions(+), 7 deletions(-) create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/GetCampaign200Response.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/GetCampaign200Response.md create mode 100644 docs/tools/sdk/powershell/Reference/V3/Models/GetCampaign200Response.md diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md index 35136549a..64196ebfa 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes **AutoRevokeAllowed** | **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] **RecommendationsEnabled** | **Boolean** | 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. | [optional] [default to $false] **Status** | **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] -**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | 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). | [optional] +**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | 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). | [optional] **Created** | **System.DateTime** | Created time of the campaign | [optional] [readonly] **TotalCertifications** | **Int32** | The total number of certifications in this campaign. | [optional] [readonly] **CompletedCertifications** | **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md index 3b544a881..cbf0ba2e8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md @@ -706,12 +706,12 @@ Path | Id | **String** | True | ID of the campaign to be retrieved. Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. ### Return type -[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) +[**GetCampaign200Response**](../models/get-campaign200-response) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Requested campaign object. | GetActiveCampaigns200ResponseInner +200 | Requested campaign object. | GetCampaign200Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/GetCampaign200Response.md b/docs/tools/sdk/powershell/Reference/V2024/Models/GetCampaign200Response.md new file mode 100644 index 000000000..0302ecdf0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/GetCampaign200Response.md @@ -0,0 +1,79 @@ +--- +id: v2024-get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetCampaign200Response', 'V2024GetCampaign200Response'] +slug: /tools/sdk/powershell/v2024/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'V2024GetCampaign200Response'] +--- + + +# GetCampaign200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | **System.DateTime** | 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. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | **Boolean** | 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. | [optional] [default to $false] +**Status** | **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | 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). | [optional] +**Created** | **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | 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). | [optional] [readonly] +**MandatoryCommentRequirement** | **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | 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. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetCampaign200Response = Initialize-PSSailpoint.V2024GetCampaign200Response -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$GetCampaign200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignsApi.md index 7f0d92576..ca3a8eedb 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignsApi.md @@ -706,12 +706,12 @@ Path | Id | **String** | True | ID of the campaign to be retrieved. Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. ### Return type -[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) +[**GetCampaign200Response**](../models/get-campaign200-response) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Requested campaign object. | GetActiveCampaigns200ResponseInner +200 | Requested campaign object. | GetCampaign200Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/GetCampaign200Response.md b/docs/tools/sdk/powershell/Reference/V2025/Models/GetCampaign200Response.md new file mode 100644 index 000000000..674c95ae0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/GetCampaign200Response.md @@ -0,0 +1,79 @@ +--- +id: v2025-get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetCampaign200Response', 'V2025GetCampaign200Response'] +slug: /tools/sdk/powershell/v2025/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'V2025GetCampaign200Response'] +--- + + +# GetCampaign200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | **System.DateTime** | 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. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | **Boolean** | 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. | [optional] [default to $false] +**Status** | **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | 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). | [optional] +**Created** | **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | 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). | [optional] [readonly] +**MandatoryCommentRequirement** | **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | 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. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetCampaign200Response = Initialize-PSSailpoint.V2025GetCampaign200Response -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$GetCampaign200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md index 75be21ef7..6c6818b6d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md @@ -704,12 +704,12 @@ Path | Id | **String** | True | ID of the campaign to be retrieved. Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. ### Return type -[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) +[**GetCampaign200Response**](../models/get-campaign200-response) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Requested campaign object. | GetActiveCampaigns200ResponseInner +200 | Requested campaign object. | GetCampaign200Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/GetCampaign200Response.md b/docs/tools/sdk/powershell/Reference/V3/Models/GetCampaign200Response.md new file mode 100644 index 000000000..42d35b426 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/Models/GetCampaign200Response.md @@ -0,0 +1,79 @@ +--- +id: get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetCampaign200Response', 'GetCampaign200Response'] +slug: /tools/sdk/powershell/v3/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'GetCampaign200Response'] +--- + + +# GetCampaign200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | **System.DateTime** | 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. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | **Boolean** | 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. | [optional] [default to $false] +**Status** | **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | 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). | [optional] +**Created** | **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | 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). | [optional] [readonly] +**MandatoryCommentRequirement** | **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | 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. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetCampaign200Response = Initialize-PSSailpoint.V3GetCampaign200Response -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$GetCampaign200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + From 3ad342a88c767adaee17459b2949e11f461eeb7d Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Thu, 3 Apr 2025 19:29:44 +0000 Subject: [PATCH 21/82] Update to python SDK docs: 14250439109 --- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../GetActiveCampaigns200ResponseInner.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../Methods/CertificationCampaignsApi.md | 6 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../V2024/Models/GetCampaign200Response.md | 123 ++++++++++++++++++ .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../Methods/CertificationCampaignsApi.md | 6 +- .../Reference/V2025/Models/AccountUsage.md | 2 +- .../V2025/Models/GetCampaign200Response.md | 123 ++++++++++++++++++ .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2025/Models/SourceUsage.md | 2 +- .../V3/Methods/CertificationCampaignsApi.md | 6 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../V3/Models/GetCampaign200Response.md | 122 +++++++++++++++++ .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../python/Reference/V3/Models/SourceUsage.md | 2 +- .../v2024/python_code_examples_overlay.yaml | 2 +- .../v2025/python_code_examples_overlay.yaml | 2 +- .../v3/python_code_examples_overlay.yaml | 2 +- 22 files changed, 397 insertions(+), 29 deletions(-) create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/GetCampaign200Response.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/GetCampaign200Response.md create mode 100644 docs/tools/sdk/python/Reference/V3/Models/GetCampaign200Response.md diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md index 6d30198f2..dced03305 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/python/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md index a3e81c81a..75c1b3173 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes **auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False] **recommendations_enabled** | **bool** | 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. | [optional] [default to False] **status** | **Enum** [ 'PENDING', 'STAGED', 'CANCELING', 'ACTIVATING', 'ACTIVE', 'COMPLETING', 'COMPLETED', 'ERROR', 'ARCHIVED' ] | The campaign's current status. | [optional] [readonly] -**correlated_status** | **Enum** [ 'CORRELATED', 'UNCORRELATED' ] | 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). | [optional] +**correlated_status** | **Enum** [ 'CORRELATED', 'UNCORRELATED' ] | 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). | [optional] **created** | **datetime** | Created time of the campaign | [optional] [readonly] **total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly] **completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly] diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index e0b91fdea..bffe6c49e 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md index 72badf0ff..fbcbd7a29 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md index 9600d4add..859289116 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md @@ -789,12 +789,12 @@ Path | id | **str** | True | ID of the campaign to be retrieved. Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. ### Return type -[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) +[**GetCampaign200Response**](../models/get-campaign200-response) ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | Requested campaign object. | GetActiveCampaigns200ResponseInner | - | +200 | Requested campaign object. | GetCampaign200Response | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | @@ -811,7 +811,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v2024.api_client import ApiClient -from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner +from sailpoint.v2024.models.get_campaign200_response import GetCampaign200Response from sailpoint.configuration import Configuration configuration = Configuration() diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md index 442faa748..5353898b1 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/GetCampaign200Response.md b/docs/tools/sdk/python/Reference/V2024/Models/GetCampaign200Response.md new file mode 100644 index 000000000..0e6e391fc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/GetCampaign200Response.md @@ -0,0 +1,123 @@ +--- +id: v2024-get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetCampaign200Response', 'V2024GetCampaign200Response'] +slug: /tools/sdk/python/v2024/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'V2024GetCampaign200Response'] +--- + +# GetCampaign200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the campaign | [optional] [readonly] +**name** | **str** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**description** | **str** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**deadline** | **datetime** | 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. | [optional] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION', 'MACHINE_ACCOUNT' ] | The type of campaign. Could be extended in the future. | [required] +**email_notification_enabled** | **bool** | Enables email notification for this campaign | [optional] [default to False] +**auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False] +**recommendations_enabled** | **bool** | 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. | [optional] [default to False] +**status** | **Enum** [ 'PENDING', 'STAGED', 'CANCELING', 'ACTIVATING', 'ACTIVE', 'COMPLETING', 'COMPLETED', 'ERROR', 'ARCHIVED' ] | The campaign's current status. | [optional] [readonly] +**correlated_status** | **Enum** [ 'CORRELATED', 'UNCORRELATED' ] | 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). | [optional] +**created** | **datetime** | Created time of the campaign | [optional] [readonly] +**total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly] +**completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly] +**alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**modified** | **datetime** | Modified time of the campaign | [optional] [readonly] +**filter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**sunset_comments_required** | **bool** | Determines if comments on sunset date changes are required. | [optional] [default to True] +**source_owner_campaign_info** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**search_campaign_info** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**role_composition_campaign_info** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**machine_account_campaign_info** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**sources_with_orphan_entitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | 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). | [optional] [readonly] +**mandatory_comment_requirement** | **Enum** [ 'ALL_DECISIONS', 'REVOKE_ONLY_DECISIONS', 'NO_DECISIONS' ] | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.get_campaign200_response import GetCampaign200Response + +get_campaign200_response = GetCampaign200Response( +id='2c9079b270a266a60170a2779fcb0007', +name='Manager Campaign', +description='Everyone needs to be reviewed by their manager', +deadline='2020-03-15T10:00:01.456Z', +type='MANAGER', +email_notification_enabled=False, +auto_revoke_allowed=False, +recommendations_enabled=True, +status='ACTIVE', +correlated_status='CORRELATED', +created='2020-03-03T22:15:13.611Z', +total_certifications=100, +completed_certifications=10, +alerts=[ + sailpoint.v2024.models.campaign_alert.CampaignAlert( + level = 'ERROR', + localizations = [ + sailpoint.v2024.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], ) + ], +modified='2020-03-03T22:20:12.674Z', +filter=sailpoint.v2024.models.campaign_all_of_filter.Campaign_allOf_filter( + id = '0fbe863c063c4c88a35fd7f17e8a3df5', + type = 'CAMPAIGN_FILTER', + name = 'Test Filter', ), +sunset_comments_required=True, +source_owner_campaign_info=sailpoint.v2024.models.campaign_all_of_source_owner_campaign_info.Campaign_allOf_sourceOwnerCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ), +search_campaign_info=sailpoint.v2024.models.campaign_all_of_search_campaign_info.Campaign_allOf_searchCampaignInfo( + type = 'ACCESS', + description = 'Search Campaign description', + reviewer = sailpoint.v2024.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + query = 'Search Campaign query description', + identity_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + access_constraints = [ + sailpoint.v2024.models.access_constraint.AccessConstraint( + type = 'ENTITLEMENT', + ids = [2c90ad2a70ace7d50170acf22ca90010], + operator = 'SELECTED', ) + ], ), +role_composition_campaign_info=sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo( + reviewer_id = '2c91808568c529c60168cca6f90c1313', + reviewer = sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_reviewer.Campaign_allOf_roleCompositionCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + role_ids = [2c90ad2a70ace7d50170acf22ca90010], + remediator_ref = sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_remediator_ref.Campaign_allOf_roleCompositionCampaignInfo_remediatorRef( + type = 'IDENTITY', + id = '2c90ad2a70ace7d50170acf22ca90010', + name = 'Role Admin', ), + query = 'Search Query', + description = 'Role Composition Description', ), +machine_account_campaign_info=sailpoint.v2024.models.campaign_all_of_machine_account_campaign_info.Campaign_allOf_machineAccountCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + reviewer_type = 'ACCOUNT_OWNER', ), +sources_with_orphan_entitlements=[ + sailpoint.v2024.models.campaign_all_of_sources_with_orphan_entitlements.Campaign_allOf_sourcesWithOrphanEntitlements( + id = '2c90ad2a70ace7d50170acf22ca90010', + type = 'SOURCE', + name = 'Source with orphan entitlements', ) + ], +mandatory_comment_requirement='NO_DECISIONS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index a37f38fea..db5a37930 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md index ea8523f54..c57393c0d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md index 5e014a906..5be0d4771 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md @@ -789,12 +789,12 @@ Path | id | **str** | True | ID of the campaign to be retrieved. Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. ### Return type -[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) +[**GetCampaign200Response**](../models/get-campaign200-response) ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | Requested campaign object. | GetActiveCampaigns200ResponseInner | - | +200 | Requested campaign object. | GetCampaign200Response | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | @@ -811,7 +811,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v2025.api_client import ApiClient -from sailpoint.v2025.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner +from sailpoint.v2025.models.get_campaign200_response import GetCampaign200Response from sailpoint.configuration import Configuration configuration = Configuration() diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md index 8403e7986..626e62e2b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/GetCampaign200Response.md b/docs/tools/sdk/python/Reference/V2025/Models/GetCampaign200Response.md new file mode 100644 index 000000000..9ac04bf7c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/GetCampaign200Response.md @@ -0,0 +1,123 @@ +--- +id: v2025-get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetCampaign200Response', 'V2025GetCampaign200Response'] +slug: /tools/sdk/python/v2025/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'V2025GetCampaign200Response'] +--- + +# GetCampaign200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the campaign | [optional] [readonly] +**name** | **str** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**description** | **str** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**deadline** | **datetime** | 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. | [optional] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION', 'MACHINE_ACCOUNT' ] | The type of campaign. Could be extended in the future. | [required] +**email_notification_enabled** | **bool** | Enables email notification for this campaign | [optional] [default to False] +**auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False] +**recommendations_enabled** | **bool** | 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. | [optional] [default to False] +**status** | **Enum** [ 'PENDING', 'STAGED', 'CANCELING', 'ACTIVATING', 'ACTIVE', 'COMPLETING', 'COMPLETED', 'ERROR', 'ARCHIVED' ] | The campaign's current status. | [optional] [readonly] +**correlated_status** | **Enum** [ 'CORRELATED', 'UNCORRELATED' ] | 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). | [optional] +**created** | **datetime** | Created time of the campaign | [optional] [readonly] +**total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly] +**completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly] +**alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**modified** | **datetime** | Modified time of the campaign | [optional] [readonly] +**filter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**sunset_comments_required** | **bool** | Determines if comments on sunset date changes are required. | [optional] [default to True] +**source_owner_campaign_info** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**search_campaign_info** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**role_composition_campaign_info** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**machine_account_campaign_info** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**sources_with_orphan_entitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | 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). | [optional] [readonly] +**mandatory_comment_requirement** | **Enum** [ 'ALL_DECISIONS', 'REVOKE_ONLY_DECISIONS', 'NO_DECISIONS' ] | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.get_campaign200_response import GetCampaign200Response + +get_campaign200_response = GetCampaign200Response( +id='2c9079b270a266a60170a2779fcb0007', +name='Manager Campaign', +description='Everyone needs to be reviewed by their manager', +deadline='2020-03-15T10:00:01.456Z', +type='MANAGER', +email_notification_enabled=False, +auto_revoke_allowed=False, +recommendations_enabled=True, +status='ACTIVE', +correlated_status='CORRELATED', +created='2020-03-03T22:15:13.611Z', +total_certifications=100, +completed_certifications=10, +alerts=[ + sailpoint.v2025.models.campaign_alert.CampaignAlert( + level = 'ERROR', + localizations = [ + sailpoint.v2025.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], ) + ], +modified='2020-03-03T22:20:12.674Z', +filter=sailpoint.v2025.models.campaign_all_of_filter.Campaign_allOf_filter( + id = '0fbe863c063c4c88a35fd7f17e8a3df5', + type = 'CAMPAIGN_FILTER', + name = 'Test Filter', ), +sunset_comments_required=True, +source_owner_campaign_info=sailpoint.v2025.models.campaign_all_of_source_owner_campaign_info.Campaign_allOf_sourceOwnerCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ), +search_campaign_info=sailpoint.v2025.models.campaign_all_of_search_campaign_info.Campaign_allOf_searchCampaignInfo( + type = 'ACCESS', + description = 'Search Campaign description', + reviewer = sailpoint.v2025.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + query = 'Search Campaign query description', + identity_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + access_constraints = [ + sailpoint.v2025.models.access_constraint.AccessConstraint( + type = 'ENTITLEMENT', + ids = [2c90ad2a70ace7d50170acf22ca90010], + operator = 'SELECTED', ) + ], ), +role_composition_campaign_info=sailpoint.v2025.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo( + reviewer_id = '2c91808568c529c60168cca6f90c1313', + reviewer = sailpoint.v2025.models.campaign_all_of_role_composition_campaign_info_reviewer.Campaign_allOf_roleCompositionCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + role_ids = [2c90ad2a70ace7d50170acf22ca90010], + remediator_ref = sailpoint.v2025.models.campaign_all_of_role_composition_campaign_info_remediator_ref.Campaign_allOf_roleCompositionCampaignInfo_remediatorRef( + type = 'IDENTITY', + id = '2c90ad2a70ace7d50170acf22ca90010', + name = 'Role Admin', ), + query = 'Search Query', + description = 'Role Composition Description', ), +machine_account_campaign_info=sailpoint.v2025.models.campaign_all_of_machine_account_campaign_info.Campaign_allOf_machineAccountCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + reviewer_type = 'ACCOUNT_OWNER', ), +sources_with_orphan_entitlements=[ + sailpoint.v2025.models.campaign_all_of_sources_with_orphan_entitlements.Campaign_allOf_sourcesWithOrphanEntitlements( + id = '2c90ad2a70ace7d50170acf22ca90010', + type = 'SOURCE', + name = 'Source with orphan entitlements', ) + ], +mandatory_comment_requirement='NO_DECISIONS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 960d4b101..33437e264 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md index 3f731dad1..3091b3a26 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md index 88c8dea4d..2783e3e79 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md @@ -787,12 +787,12 @@ Path | id | **str** | True | ID of the campaign to be retrieved. Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. ### Return type -[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) +[**GetCampaign200Response**](../models/get-campaign200-response) ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | Requested campaign object. | GetActiveCampaigns200ResponseInner | - | +200 | Requested campaign object. | GetCampaign200Response | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | @@ -809,7 +809,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v3.api_client import ApiClient -from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner +from sailpoint.v3.models.get_campaign200_response import GetCampaign200Response from sailpoint.configuration import Configuration configuration = Configuration() diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md index a1615a57b..211d1a3d1 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/GetCampaign200Response.md b/docs/tools/sdk/python/Reference/V3/Models/GetCampaign200Response.md new file mode 100644 index 000000000..1c72f4b4f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/GetCampaign200Response.md @@ -0,0 +1,122 @@ +--- +id: get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetCampaign200Response', 'GetCampaign200Response'] +slug: /tools/sdk/python/v3/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'GetCampaign200Response'] +--- + +# GetCampaign200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the campaign | [optional] [readonly] +**name** | **str** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**description** | **str** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**deadline** | **datetime** | 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. | [optional] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION', 'MACHINE_ACCOUNT' ] | The type of campaign. Could be extended in the future. | [required] +**email_notification_enabled** | **bool** | Enables email notification for this campaign | [optional] [default to False] +**auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False] +**recommendations_enabled** | **bool** | 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. | [optional] [default to False] +**status** | **Enum** [ 'PENDING', 'STAGED', 'CANCELING', 'ACTIVATING', 'ACTIVE', 'COMPLETING', 'COMPLETED', 'ERROR', 'ARCHIVED' ] | The campaign's current status. | [optional] [readonly] +**correlated_status** | **Enum** [ 'CORRELATED', 'UNCORRELATED' ] | 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). | [optional] +**created** | **datetime** | Created time of the campaign | [optional] [readonly] +**total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly] +**completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly] +**alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**modified** | **datetime** | Modified time of the campaign | [optional] [readonly] +**filter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**sunset_comments_required** | **bool** | Determines if comments on sunset date changes are required. | [optional] [default to True] +**source_owner_campaign_info** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**search_campaign_info** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**role_composition_campaign_info** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**machine_account_campaign_info** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**sources_with_orphan_entitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | 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). | [optional] [readonly] +**mandatory_comment_requirement** | **Enum** [ 'ALL_DECISIONS', 'REVOKE_ONLY_DECISIONS', 'NO_DECISIONS' ] | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.get_campaign200_response import GetCampaign200Response + +get_campaign200_response = GetCampaign200Response( +id='2c9079b270a266a60170a2779fcb0007', +name='Manager Campaign', +description='Everyone needs to be reviewed by their manager', +deadline='2020-03-15T10:00:01.456Z', +type='MANAGER', +email_notification_enabled=False, +auto_revoke_allowed=False, +recommendations_enabled=True, +status='ACTIVE', +correlated_status='CORRELATED', +created='2020-03-03T22:15:13.611Z', +total_certifications=100, +completed_certifications=10, +alerts=[ + sailpoint.v3.models.campaign_alert.CampaignAlert( + level = 'ERROR', + localizations = [ + sailpoint.v3.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], ) + ], +modified='2020-03-03T22:20:12.674Z', +filter=sailpoint.v3.models.campaign_all_of_filter.Campaign_allOf_filter( + id = '0fbe863c063c4c88a35fd7f17e8a3df5', + type = 'CAMPAIGN_FILTER', + name = 'Test Filter', ), +sunset_comments_required=True, +source_owner_campaign_info=sailpoint.v3.models.campaign_all_of_source_owner_campaign_info.Campaign_allOf_sourceOwnerCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ), +search_campaign_info=sailpoint.v3.models.campaign_all_of_search_campaign_info.Campaign_allOf_searchCampaignInfo( + type = 'ACCESS', + description = 'Search Campaign description', + reviewer = sailpoint.v3.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + query = 'Search Campaign query description', + identity_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + access_constraints = [ + sailpoint.v3.models.access_constraint.AccessConstraint( + type = 'ENTITLEMENT', + ids = [2c90ad2a70ace7d50170acf22ca90010], + operator = 'SELECTED', ) + ], ), +role_composition_campaign_info=sailpoint.v3.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo( + reviewer = sailpoint.v3.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + role_ids = [2c90ad2a70ace7d50170acf22ca90010], + remediator_ref = sailpoint.v3.models.campaign_all_of_role_composition_campaign_info_remediator_ref.Campaign_allOf_roleCompositionCampaignInfo_remediatorRef( + type = 'IDENTITY', + id = '2c90ad2a70ace7d50170acf22ca90010', + name = 'Role Admin', ), + query = 'Search Query', + description = 'Role Composition Description', ), +machine_account_campaign_info=sailpoint.v3.models.campaign_all_of_machine_account_campaign_info.Campaign_allOf_machineAccountCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + reviewer_type = 'ACCOUNT_OWNER', ), +sources_with_orphan_entitlements=[ + sailpoint.v3.models.campaign_all_of_sources_with_orphan_entitlements.Campaign_allOf_sourcesWithOrphanEntitlements( + id = '2c90ad2a70ace7d50170acf22ca90010', + type = 'SOURCE', + name = 'Source with orphan entitlements', ) + ], +mandatory_comment_requirement='NO_DECISIONS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index a80904ad9..049a9aafe 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md index 159a7ebe0..4d3443864 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index 193c27f3d..242af980e 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -2990,7 +2990,7 @@ source: | from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner + from sailpoint.v2024.models.get_campaign200_response import GetCampaign200Response from sailpoint.configuration import Configuration configuration = Configuration() diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index 632587f6a..55e2fe7aa 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -2990,7 +2990,7 @@ source: | from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner + from sailpoint.v2025.models.get_campaign200_response import GetCampaign200Response from sailpoint.configuration import Configuration configuration = Configuration() diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index 85ade15b6..7798f6e3d 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -1927,7 +1927,7 @@ source: | from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner + from sailpoint.v3.models.get_campaign200_response import GetCampaign200Response from sailpoint.configuration import Configuration configuration = Configuration() From de6bf24706afdb73e9456a9388fc6cd92212e5f6 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Thu, 3 Apr 2025 21:36:14 -0400 Subject: [PATCH 22/82] update styles to fit sailpoint theme --- i18n/en/docusaurus-theme-classic/footer.json | 2 +- .../homepage/HomepageBasics/styles.module.css | 16 ++++++++------- .../homepage/HomepageCard/styles.module.css | 12 +++++------ .../HomepageDeveloperDays/styles.module.css | 20 +++++++++---------- .../styles.module.css | 8 ++++---- .../HomepageGettingStarted/styles.module.css | 8 ++++---- .../homepage/TeamCard/styles.module.css | 4 ++-- .../MarketplaceCardDetail/styles.module.css | 2 +- .../VideoCardDetails/styles.module.css | 2 +- src/css/custom.css | 18 ++++++++++++++--- src/pages/ambassador.module.css | 2 +- src/pages/blog.module.css | 8 ++++---- src/pages/exchange.module.css | 10 +++++----- src/pages/videos.module.css | 8 ++++---- 14 files changed, 66 insertions(+), 54 deletions(-) diff --git a/i18n/en/docusaurus-theme-classic/footer.json b/i18n/en/docusaurus-theme-classic/footer.json index d0ff7cb46..a7302dfe8 100644 --- a/i18n/en/docusaurus-theme-classic/footer.json +++ b/i18n/en/docusaurus-theme-classic/footer.json @@ -88,7 +88,7 @@ "description": "The label of footer link with label=Terms & Conditions linking to https://developet.sailpoint.com" }, "copyright": { - "message": "Copyright © 2023 SailPoint Technologies, Inc. All Rights Reserved.", + "message": "Copyright © 2025 SailPoint Technologies, Inc. All Rights Reserved.", "description": "The footer copyright" } } diff --git a/src/components/homepage/HomepageBasics/styles.module.css b/src/components/homepage/HomepageBasics/styles.module.css index f087afa93..aa3b2aee9 100644 --- a/src/components/homepage/HomepageBasics/styles.module.css +++ b/src/components/homepage/HomepageBasics/styles.module.css @@ -9,14 +9,14 @@ .gettingStartedOne { color: var(--ifm-color-primary); font-size: 30px; - font-weight: bold; + font-weight: 600; line-height: 100%; } .gettingStartedThree { margin-top: 20px; font-size: 16px; - font-weight: 500; + font-weight: 400; } .bold { @@ -33,8 +33,8 @@ cursor: pointer; top: -2px; box-shadow: 0 4px 5px rgba(0, 0, 0, 0.2); - background-color: var(--dev-button-hover); - color: #cc27b0; + background-color: var(--ifm-color-secondary-dark); + color: #ffffff; text-decoration: none; } @@ -55,16 +55,18 @@ opacity: 1; box-shadow: 0px 20px 60px #00000015; - border: 2px solid #df61ca; + border: 1px solid transparent; + background-color: var(--ifm-color-secondary); + color: #ffffff; border-radius: 5px; transition: all 0.3s; } .link { - color: #df61ca; + color: #ffffff; } .link:hover { - color: #df61ca; + color: #ffffff; text-decoration: none; } diff --git a/src/components/homepage/HomepageCard/styles.module.css b/src/components/homepage/HomepageCard/styles.module.css index c8854b895..a066e36d9 100644 --- a/src/components/homepage/HomepageCard/styles.module.css +++ b/src/components/homepage/HomepageCard/styles.module.css @@ -32,10 +32,11 @@ position: absolute; margin: 20px; font-size: 16px; - font-weight: 500; + font-weight: 600; width: 135px; bottom: 0; left: 0; + color: var(--ifm-primary-text-color); } .cardIcon { @@ -64,12 +65,9 @@ left: 0; } -.idn { - color: #177dd2; -} - -.iiq { - color: #60b359; +.idn, .iiq { + color: var(--ifm-primary-text-color); + font-weight: 400; } @media only screen and (max-width: 570px) { diff --git a/src/components/homepage/HomepageDeveloperDays/styles.module.css b/src/components/homepage/HomepageDeveloperDays/styles.module.css index a85757de8..9eff37e41 100644 --- a/src/components/homepage/HomepageDeveloperDays/styles.module.css +++ b/src/components/homepage/HomepageDeveloperDays/styles.module.css @@ -59,9 +59,9 @@ .registerButton { align-items: center; background: var(--ifm-color-primary); - border-radius: 0.5rem; + border-radius: 0.25rem; border: none; - color: #eee; + color: #ffffff; display: inline-flex; padding: 10px 15px; margin-right: 45px; @@ -79,24 +79,24 @@ width: 259px; height: 61px; line-height: 61px; - background: transparent 0% 0% no-repeat padding-box; + background: var(--ifm-color-secondary); opacity: 1; box-shadow: 0px 20px 60px #00000015; - border: 2px solid #df61ca; - border-radius: 0.5rem; - color: #df61ca; + border: 1px solid transparent; + border-radius: 0.25rem; + color: #ffffff; padding: 10px 15px; margin-right: 45px; font-size: 16px; - font-weight: bold; + font-weight: 600; } .registerButtonPink:hover { cursor: pointer; top: -2px; box-shadow: 0 4px 5px rgba(0, 0, 0, 0.2); - background-color: var(--dev-button-hover); - color: #cc27b0; + background-color: var(--ifm-color-secondary-dark); + color: #ffffff; text-decoration: none; } @@ -128,7 +128,7 @@ background: var(--main-hero-card-background); box-shadow: var(--dev-main-card-shadow); border: 1px solid var(--dev-card-background); - border-radius: 40px; + border-radius: 0.25rem; opacity: 1; margin: 50px auto; width: calc(100% - 100px); diff --git a/src/components/homepage/HomepageDeveloperDaysCallToPapers/styles.module.css b/src/components/homepage/HomepageDeveloperDaysCallToPapers/styles.module.css index ef9bd42be..df4070232 100644 --- a/src/components/homepage/HomepageDeveloperDaysCallToPapers/styles.module.css +++ b/src/components/homepage/HomepageDeveloperDaysCallToPapers/styles.module.css @@ -16,7 +16,7 @@ .gettingStartedOne { color: var(--ifm-color-primary); font-size: 30px; - font-weight: bold; + font-weight: 600; line-height: 100%; text-align: center; } @@ -24,14 +24,14 @@ .gettingStartedTwo { margin-top: 20px; font-size: 20px; - font-weight: bold; + font-weight: 400; text-align: center; } .gettingStartedThree { margin-top: 20px; font-size: 16px; - font-weight: 500; + font-weight: 400; margin-bottom: 20px; text-align: center; } @@ -82,7 +82,7 @@ background: var(--main-hero-card-background); box-shadow: var(--dev-main-card-shadow); border: 1px solid var(--dev-card-background); - border-radius: 40px; + border-radius: 0.25em; opacity: 1; margin: 50px auto; width: calc(100% - 100px); diff --git a/src/components/homepage/HomepageGettingStarted/styles.module.css b/src/components/homepage/HomepageGettingStarted/styles.module.css index 1d89a5045..9e3a0d43e 100644 --- a/src/components/homepage/HomepageGettingStarted/styles.module.css +++ b/src/components/homepage/HomepageGettingStarted/styles.module.css @@ -14,20 +14,20 @@ color: var(--ifm-color-primary); font-size: 30px; max-width: 396px; - font-weight: bold; + font-weight: 600; line-height: 100%; } .gettingStartedTwo { margin-top: 20px; font-size: 20px; - font-weight: bold; + font-weight: 400; } .gettingStartedThree { margin-top: 20px; font-size: 16px; - font-weight: 500; + font-weight: 400; } .bold { @@ -75,7 +75,7 @@ background: var(--main-hero-card-background); box-shadow: var(--dev-main-card-shadow); border: 1px solid var(--dev-card-background); - border-radius: 40px; + border-radius: 0.25em; opacity: 1; margin: 50px auto; width: calc(100% - 100px); diff --git a/src/components/homepage/TeamCard/styles.module.css b/src/components/homepage/TeamCard/styles.module.css index 7bf786316..c8745a0cb 100644 --- a/src/components/homepage/TeamCard/styles.module.css +++ b/src/components/homepage/TeamCard/styles.module.css @@ -34,7 +34,7 @@ margin: 22px auto; text-align: center; font-size: 16px; - font-weight: 500; + font-weight: 600; width: 100%; top: 116px; left: 0; @@ -59,7 +59,7 @@ margin: 22px auto; text-align: center; font-size: 10px; - font-weight: 500; + font-weight: 600; width: 100%; letter-spacing: 2px; top: 160px; diff --git a/src/components/marketplace/MarketplaceCardDetail/styles.module.css b/src/components/marketplace/MarketplaceCardDetail/styles.module.css index 68ed71eca..959197609 100644 --- a/src/components/marketplace/MarketplaceCardDetail/styles.module.css +++ b/src/components/marketplace/MarketplaceCardDetail/styles.module.css @@ -14,7 +14,7 @@ flex-direction: column; } .detailImage { - border-radius: 40px; + border-radius: 0.25em; max-width: 400px; min-width: 180px; } diff --git a/src/components/video-library/VideoCardDetails/styles.module.css b/src/components/video-library/VideoCardDetails/styles.module.css index d4b901cba..2a55a7d70 100644 --- a/src/components/video-library/VideoCardDetails/styles.module.css +++ b/src/components/video-library/VideoCardDetails/styles.module.css @@ -6,6 +6,6 @@ } .discourseContainer { - border-radius: 0.5em; + border-radius: 0.25em; height: 400px; } diff --git a/src/css/custom.css b/src/css/custom.css index 8a08071d7..e9efc5cd7 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -229,6 +229,7 @@ :root { color: #415364; + --ifm-primary-text-color: #415364; --ifm-color-primary: #0033a1; --ifm-color-primary-dark: #002e91; --ifm-color-primary-darker: #002b89; @@ -238,7 +239,8 @@ --ifm-color-primary-lightest: #0042d1; --ifm-color-secondary: #cc27b0; - --ifm-link-color: #0188f7; + --ifm-color-secondary-dark: rgb(181, 13, 152); + --ifm-link-color: #0071cE; --terminal-key: rgb(47, 162, 160); --terminal-value: rgb(226, 52, 120); @@ -287,7 +289,8 @@ /* For readability concerns, you should choose a lighter palette in dark mode. */ [data-theme='dark'] { color: #ffffff; - --ifm-color-primary: #7ecfee; + --ifm-primary-text-color: #ffffff; + --ifm-color-primary: #54C0e8; --ifm-color-primary-dark: #5ec3ea; --ifm-color-primary-darker: #4ebde8; --ifm-color-primary-darkest: #1eabe1; @@ -297,6 +300,7 @@ --ifm-link-color: #7ecfee; --ifm-color-secondary: #cc27b0; + --ifm-color-secondary-dark: rgb(181, 13, 152); --terminal-key: rgb(247, 247, 240); --terminal-value: rgb(255, 110, 191); @@ -335,6 +339,14 @@ --main-hero-card-background: #202122; } +.navbar__link:hover { + color: var(--ifm-link-color) !important; +} + +.footer__link-item:hover { + color: var(--ifm-link-color) !important; +} + .navbar__logo { margin-right: 0.5rem; } @@ -559,7 +571,7 @@ iframe[id^='discourse-embed-frame'] { } div[id^='discourseContainer'] { - border-radius: 0.5em; + border-radius: 0.25em; } div[id^='discourse-comments'] { diff --git a/src/pages/ambassador.module.css b/src/pages/ambassador.module.css index 47534cca4..b98851ae0 100644 --- a/src/pages/ambassador.module.css +++ b/src/pages/ambassador.module.css @@ -74,7 +74,7 @@ .ambassadorPurposeImage { width: 40%; box-shadow: var(--dev-card-selected); - border-radius: 40px; + border-radius: 0.25em; margin: 50px 50px 50px 0px; } diff --git a/src/pages/blog.module.css b/src/pages/blog.module.css index 53208d4ff..e2997e24c 100644 --- a/src/pages/blog.module.css +++ b/src/pages/blog.module.css @@ -24,20 +24,20 @@ color: var(--ifm-color-primary); font-size: 30px; max-width: 396px; - font-weight: bold; + font-weight: 600; line-height: 100%; } .gettingStartedTwo { margin-top: 20px; font-size: 20px; - font-weight: bold; + font-weight: 400; } .gettingStartedThree { margin-top: 20px; font-size: 16px; - font-weight: 500; + font-weight: 400; } .bold { @@ -101,7 +101,7 @@ background: var(--main-hero-card-background); box-shadow: var(--dev-main-card-shadow); border: 1px solid var(--dev-card-background); - border-radius: 40px; + border-radius: 0.25em; opacity: 1; margin: 50px auto; width: calc(100% - 100px); diff --git a/src/pages/exchange.module.css b/src/pages/exchange.module.css index fed89f92d..65c5cbb38 100644 --- a/src/pages/exchange.module.css +++ b/src/pages/exchange.module.css @@ -14,7 +14,7 @@ } .discourseContainer { - border-radius: 0.5em; + border-radius: 0.25em; height: 100%; } @@ -45,20 +45,20 @@ color: var(--ifm-color-primary); font-size: 30px; max-width: 396px; - font-weight: bold; + font-weight: 600; line-height: 100%; } .gettingStartedTwo { margin-top: 20px; font-size: 20px; - font-weight: bold; + font-weight: 400; } .gettingStartedThree { margin-top: 20px; font-size: 16px; - font-weight: 500; + font-weight: 400; } .bold { @@ -148,7 +148,7 @@ background: var(--main-hero-card-background); box-shadow: var(--dev-main-card-shadow); border: 1px solid var(--dev-card-background); - border-radius: 40px; + border-radius: 0.25em; opacity: 1; margin: 50px auto; width: calc(100% - 100px); diff --git a/src/pages/videos.module.css b/src/pages/videos.module.css index 67aec8916..d221c97ae 100644 --- a/src/pages/videos.module.css +++ b/src/pages/videos.module.css @@ -50,20 +50,20 @@ color: var(--ifm-color-primary); font-size: 30px; max-width: 396px; - font-weight: bold; + font-weight: 600; line-height: 100%; } .gettingStartedTwo { margin-top: 20px; font-size: 20px; - font-weight: bold; + font-weight: 400; } .gettingStartedThree { margin-top: 20px; font-size: 16px; - font-weight: 500; + font-weight: 400; } .bold { @@ -112,7 +112,7 @@ background: var(--main-hero-card-background); box-shadow: var(--dev-main-card-shadow); border: 1px solid var(--dev-card-background); - border-radius: 40px; + border-radius: 0.25em; opacity: 1; margin: 50px auto; width: calc(100% - 100px); From 0f851b16ee1e97bf872c587abd8e8249442c8275 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Fri, 4 Apr 2025 10:08:20 +0000 Subject: [PATCH 23/82] Automated commit by github action: 14263008271 --- .../idn/v2024/schemas/AccessRequestItem.yaml | 14 ++++++++++++++ .../idn/v3/schemas/AccessRequestItem.yaml | 14 ++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/static/api-specs/idn/v2024/schemas/AccessRequestItem.yaml b/static/api-specs/idn/v2024/schemas/AccessRequestItem.yaml index 7b24f89f2..f943fac74 100644 --- a/static/api-specs/idn/v2024/schemas/AccessRequestItem.yaml +++ b/static/api-specs/idn/v2024/schemas/AccessRequestItem.yaml @@ -38,5 +38,19 @@ properties: * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. format: 'date-time' example: '2020-07-11T21:23:15.000Z' + assignmentId: + type: string + nullable: true + description: | + The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. + * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. + example: 'ee48a191c00d49bf9264eb0a4fc3a9fc' + nativeIdentity: + type: string + nullable: true + description: | + The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. + * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. + example: 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' required : ["id", "type"] diff --git a/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml b/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml index 7b24f89f2..f943fac74 100644 --- a/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml +++ b/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml @@ -38,5 +38,19 @@ properties: * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. format: 'date-time' example: '2020-07-11T21:23:15.000Z' + assignmentId: + type: string + nullable: true + description: | + The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. + * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. + example: 'ee48a191c00d49bf9264eb0a4fc3a9fc' + nativeIdentity: + type: string + nullable: true + description: | + The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. + * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. + example: 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' required : ["id", "type"] From 9ad71c889bceb239d13f8833de657e7cacd33c76 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Fri, 4 Apr 2025 10:09:41 +0000 Subject: [PATCH 24/82] Update to powershell SDK docs: 14263035264 --- .../Beta/Methods/BetaAccessRequestsApi.md | 20 ++++++++++++++----- .../Beta/Models/AccessRequestItem.md | 6 +++++- .../V2024/Methods/V2024AccessRequestsApi.md | 20 ++++++++++++++----- .../V2024/Models/AccessRequestItem.md | 6 +++++- .../Reference/V3/Methods/AccessRequestsApi.md | 20 ++++++++++++++----- .../Reference/V3/Models/AccessRequestItem.md | 6 +++++- .../powershell_code_examples_overlay.yaml | 20 ++++++++++++++----- .../powershell_code_examples_overlay.yaml | 20 ++++++++++++++----- .../v3/powershell_code_examples_overlay.yaml | 20 ++++++++++++++----- 9 files changed, 105 insertions(+), 33 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md index 76015f4bf..160616eb4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md @@ -227,7 +227,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -236,7 +238,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -245,7 +249,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -254,7 +260,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -263,7 +271,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md index 16415ee28..36810a643 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] ## Examples @@ -30,7 +32,9 @@ $AccessRequestItem = Initialize-PSSailpoint.BetaAccessRequestItem -Type ACCESS_ -Id 2c9180835d2e5168015d32f890ca1581 ` -Comment Requesting access profile for John Doe ` -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` - -RemoveDate 2020-07-11T21:23:15Z + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md index 40b8a6227..2b6a2bea7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md @@ -336,7 +336,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -345,7 +347,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -354,7 +358,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -363,7 +369,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -372,7 +380,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md index e92c37783..f9b1dc2b6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] ## Examples @@ -30,7 +32,9 @@ $AccessRequestItem = Initialize-PSSailpoint.V2024AccessRequestItem -Type ACCESS -Id 2c9180835d2e5168015d32f890ca1581 ` -Comment Requesting access profile for John Doe ` -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` - -RemoveDate 2020-07-11T21:23:15Z + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md index 938669ce4..d21462142 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md @@ -164,7 +164,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -173,7 +175,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -182,7 +186,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -191,7 +197,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -200,7 +208,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md index 0f7506e82..bff001652 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] ## Examples @@ -30,7 +32,9 @@ $AccessRequestItem = Initialize-PSSailpoint.V3AccessRequestItem -Type ACCESS_PR -Id 2c9180835d2e5168015d32f890ca1581 ` -Comment Requesting access profile for John Doe ` -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` - -RemoveDate 2020-07-11T21:23:15Z + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ``` - Convert the resource to JSON diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index ad831aa53..aa9428e5c 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -592,7 +592,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -601,7 +603,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -610,7 +614,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -619,7 +625,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -628,7 +636,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ] } "@ diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index 75d10b669..1aac5da75 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -670,7 +670,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -679,7 +681,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -688,7 +692,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -697,7 +703,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -706,7 +714,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ] } "@ diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index f60bafeec..b34657cb1 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -445,7 +445,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -454,7 +456,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -463,7 +467,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -472,7 +478,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -481,7 +489,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ] } "@ From 4ec60bd87d64c4caa4d8d7e1eefae681ebd61638 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Fri, 4 Apr 2025 10:10:18 +0000 Subject: [PATCH 25/82] Update to python SDK docs: 14263046685 --- .../Beta/Methods/AccessRequestsApi.md | 20 ++++++++++++++----- .../Reference/Beta/Models/AccessRequest.md | 4 +++- .../Beta/Models/AccessRequestItem.md | 6 +++++- .../V2024/Methods/AccessRequestsApi.md | 20 ++++++++++++++----- .../Reference/V2024/Models/AccessRequest.md | 4 +++- .../V2024/Models/AccessRequestItem.md | 6 +++++- .../Reference/V3/Methods/AccessRequestsApi.md | 20 ++++++++++++++----- .../Reference/V3/Models/AccessRequest.md | 4 +++- .../Reference/V3/Models/AccessRequestItem.md | 6 +++++- .../beta/python_code_examples_overlay.yaml | 20 ++++++++++++++----- .../v2024/python_code_examples_overlay.yaml | 20 ++++++++++++++----- .../v3/python_code_examples_overlay.yaml | 20 ++++++++++++++----- 12 files changed, 114 insertions(+), 36 deletions(-) diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md index 024b5f3e4..5103a5c36 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md @@ -261,7 +261,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -270,7 +272,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -279,7 +283,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -288,7 +294,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -297,7 +305,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ] }''' # AccessRequest | diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md index 864932ac7..e4160f406 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md @@ -38,7 +38,9 @@ requested_items=[ id = '2c9180835d2e5168015d32f890ca1581', comment = 'Requesting access profile for John Doe', client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, - remove_date = '2020-07-11T21:23:15Z', ) + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) ], client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItem.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItem.md index 70bc09731..8cbd57b6d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItem.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] } ## Example @@ -33,7 +35,9 @@ type='ACCESS_PROFILE', id='2c9180835d2e5168015d32f890ca1581', comment='Requesting access profile for John Doe', client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, -remove_date='2020-07-11T21:23:15Z' +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' ) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md index c64017b2e..ba395e4a2 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md @@ -403,7 +403,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -412,7 +414,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -421,7 +425,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -430,7 +436,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -439,7 +447,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ] }''' # AccessRequest | diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md index 15f69bbb5..cc33bfb60 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md @@ -38,7 +38,9 @@ requested_items=[ id = '2c9180835d2e5168015d32f890ca1581', comment = 'Requesting access profile for John Doe', client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, - remove_date = '2020-07-11T21:23:15Z', ) + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) ], client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItem.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItem.md index b5ed66db1..823664cef 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItem.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] } ## Example @@ -33,7 +35,9 @@ type='ACCESS_PROFILE', id='2c9180835d2e5168015d32f890ca1581', comment='Requesting access profile for John Doe', client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, -remove_date='2020-07-11T21:23:15Z' +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' ) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md index f9f2bf0b9..7a5946ccf 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md @@ -186,7 +186,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -195,7 +197,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -204,7 +208,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -213,7 +219,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -222,7 +230,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ] }''' # AccessRequest | diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md index af8e51fd0..363037b89 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md @@ -38,7 +38,9 @@ requested_items=[ id = '2c9180835d2e5168015d32f890ca1581', comment = 'Requesting access profile for John Doe', client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, - remove_date = '2020-07-11T21:23:15Z', ) + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) ], client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessRequestItem.md b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestItem.md index 715a5bfbf..b3bc1fca1 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccessRequestItem.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] } ## Example @@ -33,7 +35,9 @@ type='ACCESS_PROFILE', id='2c9180835d2e5168015d32f890ca1581', comment='Requesting access profile for John Doe', client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, -remove_date='2020-07-11T21:23:15Z' +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' ) ``` diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index 66ec92f90..b27e602ff 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -703,7 +703,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -712,7 +714,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -721,7 +725,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -730,7 +736,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -739,7 +747,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ] }''' # AccessRequest | try: diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index 242af980e..17ab6baf8 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -801,7 +801,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -810,7 +812,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -819,7 +823,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -828,7 +834,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -837,7 +845,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ] }''' # AccessRequest | try: diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index 7798f6e3d..3f1a09070 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -517,7 +517,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -526,7 +528,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -535,7 +539,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -544,7 +550,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -553,7 +561,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ] }''' # AccessRequest | try: From 5397951a37a53563ba29a9e57e08a4b91ad1c8b5 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Fri, 4 Apr 2025 09:31:54 -0400 Subject: [PATCH 26/82] update styles to fit sailpoint theme --- src/components/blog/BlogSidebar/styles.module.css | 4 ++-- .../homepage/HomepageBasics/styles.module.css | 2 +- .../video-library/VideoSidebar/styles.module.css | 4 ++-- src/css/custom.css | 1 + src/pages/ambassador.module.css | 15 ++++++++------- 5 files changed, 14 insertions(+), 12 deletions(-) diff --git a/src/components/blog/BlogSidebar/styles.module.css b/src/components/blog/BlogSidebar/styles.module.css index ded22ad26..167fb6dcf 100644 --- a/src/components/blog/BlogSidebar/styles.module.css +++ b/src/components/blog/BlogSidebar/styles.module.css @@ -79,7 +79,7 @@ ); /* Dropdown background color */ /* Text color */ padding: 14px 45px; /* Padding inside the dropdown button */ border: 2px solid #cccccc; /* Border around the dropdown */ - border-radius: 5px; /* Rounded corners */ + border-radius: .25rem;; /* Rounded corners */ cursor: pointer; /* Change mouse cursor to indicate it's clickable */ position: relative; /* To position the arrow icon correctly */ display: inline-block; /* To keep the button's block behavior */ @@ -117,7 +117,7 @@ box-shadow: 0px 8px 16px 0px rgba(0, 0, 0, 0.2); z-index: 1; padding: 10px; - border-radius: 5px; + border-radius: .25rem;; overflow-y: scroll; max-height: 400px; } diff --git a/src/components/homepage/HomepageBasics/styles.module.css b/src/components/homepage/HomepageBasics/styles.module.css index aa3b2aee9..166239ec8 100644 --- a/src/components/homepage/HomepageBasics/styles.module.css +++ b/src/components/homepage/HomepageBasics/styles.module.css @@ -58,7 +58,7 @@ border: 1px solid transparent; background-color: var(--ifm-color-secondary); color: #ffffff; - border-radius: 5px; + border-radius: .25rem; transition: all 0.3s; } diff --git a/src/components/video-library/VideoSidebar/styles.module.css b/src/components/video-library/VideoSidebar/styles.module.css index 133f78ef5..983c035d2 100644 --- a/src/components/video-library/VideoSidebar/styles.module.css +++ b/src/components/video-library/VideoSidebar/styles.module.css @@ -56,7 +56,7 @@ ); /* Dropdown background color */ /* Text color */ padding: 5px 15px; /* Padding inside the dropdown button */ border: 0.5px solid #cccccc; /* Border around the dropdown */ - border-radius: 5px; /* Rounded corners */ + border-radius: .25rem;; /* Rounded corners */ cursor: pointer; /* Change mouse cursor to indicate it's clickable */ position: relative; /* To position the arrow icon correctly */ display: inline-block; /* To keep the button's block behavior */ @@ -93,7 +93,7 @@ box-shadow: 0px 8px 16px 0px rgba(0, 0, 0, 0.2); z-index: 25; padding: 10px; - border-radius: 5px; + border-radius: .25rem;; } .dropdownContainer .dropdownContent label { diff --git a/src/css/custom.css b/src/css/custom.css index e9efc5cd7..521290be4 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -345,6 +345,7 @@ .footer__link-item:hover { color: var(--ifm-link-color) !important; + text-decoration: underline !important; } .navbar__logo { diff --git a/src/pages/ambassador.module.css b/src/pages/ambassador.module.css index b98851ae0..19d0524a7 100644 --- a/src/pages/ambassador.module.css +++ b/src/pages/ambassador.module.css @@ -95,9 +95,9 @@ cursor: pointer; top: -2px; box-shadow: 0 4px 5px rgba(0, 0, 0, 0.2); - background-color: #c552ae10; - color: #cc27b0; - background-color: var(--dev-button-hover); + background-color: var(--ifm-color-secondary-dark); + color: #ffffff; + text-decoration: none; } .button { @@ -117,15 +117,16 @@ opacity: 1; box-shadow: 0px 20px 60px #00000015; - border: 2px solid #df61ca; - border-radius: 5px; + border: 1px solid transparent; + border-radius: .25rem; transition: all 0.3s; + background-color: var(--ifm-color-secondary); } .link { - color: #df61ca; + color: #ffffff;; } .link:hover { - color: #df61ca; + color: #ffffff; text-decoration: none; } From f9746f50f0b78025cf2bc338615ba81ab1d00e89 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Fri, 4 Apr 2025 20:46:12 -0400 Subject: [PATCH 27/82] more style updates --- .../AmbassadorCard/styles.module.css | 30 +++++++------------ .../blog/BlogCard/styles.module.css | 17 ++++++----- .../MarketplaceCard/styles.module.css | 11 +++---- src/css/custom.css | 4 +-- src/pages/tools/json-path.module.css | 8 ++--- 5 files changed, 32 insertions(+), 38 deletions(-) diff --git a/src/components/ambassador/AmbassadorCard/styles.module.css b/src/components/ambassador/AmbassadorCard/styles.module.css index f5dd6eac3..45db94bc2 100644 --- a/src/components/ambassador/AmbassadorCard/styles.module.css +++ b/src/components/ambassador/AmbassadorCard/styles.module.css @@ -60,11 +60,11 @@ .name { font-size: 22px; - font-weight: 500; + font-weight: 600; width: 100%; top: 124px; left: 0; - color: var(--dev-text-color-normal); + color: var(--ifm-primary-text-color); } .titleText { @@ -74,17 +74,17 @@ letter-spacing: 2px; top: 150px; left: 0; - color: var(--dev-text-color-normal); + color: var(--ifm-primary-text-color); } .location { font-size: 10px; - font-weight: 500; + font-weight: 600; width: 100%; letter-spacing: 2px; top: 141px; left: 0; - color: var(--ifm-color-primary); + color: var(--ifm-primary-text-color); } .cardArrow { @@ -98,9 +98,9 @@ .bio { margin: 30px auto; font-size: 16px; - font-weight: 500; + font-weight: 400; width: 100%; - color: var(--ifm-color-primary); + color: var(--ifm-primary-text-color); padding: 0px 30px; margin-bottom: 50px; } @@ -113,18 +113,9 @@ align-items: center; } -.cardEye { - fill: #96a9bb; - /* computed from codepen https://codepen.io/sosuke/pen/Pjoqqp */ - filter: invert(79%) sepia(12%) saturate(484%) hue-rotate(168deg) - brightness(84%) contrast(84%); - margin-left: 5px; - height: 18px; - width: 18px; -} - .cardCommentText { - color: #96a9ba; + font-weight: 400; + color: var(--ifm-primary-text-color); /* computed from codepen https://codepen.io/sosuke/pen/Pjoqqp */ margin-left: 5px; margin-bottom: 5px; @@ -133,7 +124,8 @@ } .cardCommentTextUpper { - color: #96a9ba; + font-weight: 400; + color: var(--ifm-primary-text-color); /* computed from codepen https://codepen.io/sosuke/pen/Pjoqqp */ margin-left: 10px; margin-bottom: 5px; diff --git a/src/components/blog/BlogCard/styles.module.css b/src/components/blog/BlogCard/styles.module.css index 75bc50b86..2c4fb3a6f 100644 --- a/src/components/blog/BlogCard/styles.module.css +++ b/src/components/blog/BlogCard/styles.module.css @@ -94,7 +94,7 @@ a:active { .featuredCardTitle { font-size: 20px; - font-weight: 500; + font-weight: 400; display: flex; gap: 1rem; margin-top: 1rem; @@ -106,7 +106,7 @@ a:active { .cardTitle { font-size: 16px; - font-weight: 500; + font-weight: 400; display: flex; gap: 1rem; margin-top: 1rem; @@ -137,34 +137,35 @@ a:active { .cardName { min-width: 170px; - font-weight: 800; + font-weight: 600; margin-top: 7px; margin-left: 10px; display: flex; - color: var(--text-color); + color: var(--ifm-primary-text-color); } .cardCreatorTitle { min-width: 170px; margin-left: 10px; display: flex; - color: var(--text-color); + color: var(--ifm-primary-text-color); } .featuredCardName { min-width: 170px; - font-weight: 800; + font-weight: 600; margin-top: 7px; margin-left: 10px; display: flex; - color: var(--text-color); + color: var(--ifm-primary-text-color); } .featuredCardCreatorTitle { min-width: 170px; margin-left: 10px; + font-weight: 400; display: flex; - color: var(--text-color); + color: var(--ifm-primary-text-color); } .split { diff --git a/src/components/marketplace/MarketplaceCard/styles.module.css b/src/components/marketplace/MarketplaceCard/styles.module.css index 894f392b7..7fbd75f67 100644 --- a/src/components/marketplace/MarketplaceCard/styles.module.css +++ b/src/components/marketplace/MarketplaceCard/styles.module.css @@ -86,7 +86,7 @@ .featuredCardTitle { font-size: 20px; - font-weight: 500; + font-weight: 400; display: flex; gap: 1rem; margin-top: 1rem; @@ -98,7 +98,7 @@ .cardTitle { font-size: 16px; - font-weight: 500; + font-weight: 400; display: flex; gap: 1rem; margin-top: 1rem; @@ -140,18 +140,19 @@ .cardName { min-width: 170px; - font-weight: 800; + font-weight: 600; margin-top: 7px; margin-left: 10px; display: flex; - color: var(--text-color); + color: var(--ifm-primary-text-color); } .cardCreatorTitle { + font-weight: 400; min-width: 170px; margin-left: 10px; display: flex; - color: var(--text-color); + color: var(--ifm-primary-text-color); } .cardBadge { diff --git a/src/css/custom.css b/src/css/custom.css index 521290be4..14a13765e 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -260,7 +260,7 @@ --dev-tag-highlight: #eaeef1; --text-on-primary: #ffffff; - --text-color: black; + --ifm-primary-text-color: black; --dropdown-background: #ffffff; @@ -318,7 +318,7 @@ --text-on-primary: #ffffff; - --text-color: #ffffff; + --ifm-primary-text-color: #ffffff; --dropdown-background: #2a2b2d; diff --git a/src/pages/tools/json-path.module.css b/src/pages/tools/json-path.module.css index 3367be7aa..8545ccc36 100644 --- a/src/pages/tools/json-path.module.css +++ b/src/pages/tools/json-path.module.css @@ -26,14 +26,14 @@ a[id^='jsonpathDocumentationLink'] { } li[class^='MuiButtonBase-root'] { - color: var(--text-color); + color: var(--ifm-primary-text-color); } div[class^='MuiFormControl-root'] { - color: var(--text-color); + color: var(--ifm-primary-text-color); } div[id^='terminal-font-size-select'], div[id^='implementation-dropdown-select'] { - color: var(--text-color); + color: var(--ifm-primary-text-color); } input[id^='outlined-basic-jsonpath-input'], @@ -42,7 +42,7 @@ select[id^='terminal-font-size-select'], label[id^='terminal-font-size-label'], select[id^='implementation-dropdown-select'], label[id^='implementation-dropdown-label'] { - color: var(--text-color); + color: var(--ifm-primary-text-color); } input[id^='outlined-basic-jsonpath-input'], div[id^='terminal-font-size-select'], From 1fb1149046d48a7dabbdab89a3e564a0330dcce7 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Fri, 4 Apr 2025 21:55:42 -0400 Subject: [PATCH 28/82] fix text color --- src/css/custom.css | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/css/custom.css b/src/css/custom.css index 14a13765e..a2649e0f2 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -260,7 +260,6 @@ --dev-tag-highlight: #eaeef1; --text-on-primary: #ffffff; - --ifm-primary-text-color: black; --dropdown-background: #ffffff; @@ -318,8 +317,6 @@ --text-on-primary: #ffffff; - --ifm-primary-text-color: #ffffff; - --dropdown-background: #2a2b2d; /*card css*/ From f3b40b2201adeae997d324adf052319d103b4516 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Mon, 7 Apr 2025 15:42:49 +0000 Subject: [PATCH 29/82] Automated commit by github action: 14313523966 --- static/api-specs/idn/v2024/schemas/LifecyclestateDeleted.yaml | 1 + static/api-specs/idn/v2025/schemas/LifecyclestateDeleted.yaml | 1 + 2 files changed, 2 insertions(+) diff --git a/static/api-specs/idn/v2024/schemas/LifecyclestateDeleted.yaml b/static/api-specs/idn/v2024/schemas/LifecyclestateDeleted.yaml index 15ea4f91b..749160f6f 100644 --- a/static/api-specs/idn/v2024/schemas/LifecyclestateDeleted.yaml +++ b/static/api-specs/idn/v2024/schemas/LifecyclestateDeleted.yaml @@ -6,6 +6,7 @@ properties: description: Deleted lifecycle state's DTO type. enum: - LIFECYCLE_STATE + - TASK_RESULT example: LIFECYCLE_STATE id: type: string diff --git a/static/api-specs/idn/v2025/schemas/LifecyclestateDeleted.yaml b/static/api-specs/idn/v2025/schemas/LifecyclestateDeleted.yaml index 15ea4f91b..749160f6f 100644 --- a/static/api-specs/idn/v2025/schemas/LifecyclestateDeleted.yaml +++ b/static/api-specs/idn/v2025/schemas/LifecyclestateDeleted.yaml @@ -6,6 +6,7 @@ properties: description: Deleted lifecycle state's DTO type. enum: - LIFECYCLE_STATE + - TASK_RESULT example: LIFECYCLE_STATE id: type: string From 09c9e2e838cbff57885d10b9c400dd426f5c146e Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Mon, 7 Apr 2025 15:44:10 +0000 Subject: [PATCH 30/82] Update to powershell SDK docs: 14313555233 --- .../powershell/Reference/V2024/Models/LifecyclestateDeleted.md | 2 +- .../powershell/Reference/V2025/Models/LifecyclestateDeleted.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/LifecyclestateDeleted.md b/docs/tools/sdk/powershell/Reference/V2024/Models/LifecyclestateDeleted.md index 7cd57a353..ad7457b21 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/LifecyclestateDeleted.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/LifecyclestateDeleted.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'LifecyclestateDeleted', 'V2024Lifecyc Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "LIFECYCLE_STATE" ] | Deleted lifecycle state's DTO type. | [optional] +**Type** | **Enum** [ "LIFECYCLE_STATE", "TASK_RESULT" ] | Deleted lifecycle state's DTO type. | [optional] **Id** | **String** | Deleted lifecycle state ID. | [optional] **Name** | **String** | Deleted lifecycle state's display name. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/LifecyclestateDeleted.md b/docs/tools/sdk/powershell/Reference/V2025/Models/LifecyclestateDeleted.md index 01086415b..2cc1548cc 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/LifecyclestateDeleted.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/LifecyclestateDeleted.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'LifecyclestateDeleted', 'V2025Lifecyc Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "LIFECYCLE_STATE" ] | Deleted lifecycle state's DTO type. | [optional] +**Type** | **Enum** [ "LIFECYCLE_STATE", "TASK_RESULT" ] | Deleted lifecycle state's DTO type. | [optional] **Id** | **String** | Deleted lifecycle state ID. | [optional] **Name** | **String** | Deleted lifecycle state's display name. | [optional] From f9961d00cfb4426198611e273d66c5c6a9f947b9 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Mon, 7 Apr 2025 15:44:32 +0000 Subject: [PATCH 31/82] Update to python SDK docs: 14313563226 --- .../sdk/python/Reference/V2024/Models/LifecyclestateDeleted.md | 2 +- .../sdk/python/Reference/V2025/Models/LifecyclestateDeleted.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LifecyclestateDeleted.md b/docs/tools/sdk/python/Reference/V2024/Models/LifecyclestateDeleted.md index 59cd10f2e..32e0c8386 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/LifecyclestateDeleted.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/LifecyclestateDeleted.md @@ -17,7 +17,7 @@ Deleted lifecycle state. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **Enum** [ 'LIFECYCLE_STATE' ] | Deleted lifecycle state's DTO type. | [optional] +**type** | **Enum** [ 'LIFECYCLE_STATE', 'TASK_RESULT' ] | Deleted lifecycle state's DTO type. | [optional] **id** | **str** | Deleted lifecycle state ID. | [optional] **name** | **str** | Deleted lifecycle state's display name. | [optional] } diff --git a/docs/tools/sdk/python/Reference/V2025/Models/LifecyclestateDeleted.md b/docs/tools/sdk/python/Reference/V2025/Models/LifecyclestateDeleted.md index f6cb0ba1f..0f47b96a2 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/LifecyclestateDeleted.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/LifecyclestateDeleted.md @@ -17,7 +17,7 @@ Deleted lifecycle state. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **Enum** [ 'LIFECYCLE_STATE' ] | Deleted lifecycle state's DTO type. | [optional] +**type** | **Enum** [ 'LIFECYCLE_STATE', 'TASK_RESULT' ] | Deleted lifecycle state's DTO type. | [optional] **id** | **str** | Deleted lifecycle state ID. | [optional] **name** | **str** | Deleted lifecycle state's display name. | [optional] } From 1ef25ba23df1a0d4871cb198af2cd64d9728a8c5 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Mon, 7 Apr 2025 19:20:58 +0000 Subject: [PATCH 32/82] Automated commit by github action: 14317648979 --- static/api-specs/idn/sailpoint-api.v2025.yaml | 2 + .../idn/v2025/paths/revocable-objects.yaml | 56 +++++++++++++++++++ .../schemas/IdentityEntitlementDetails.yaml | 30 ++++++++++ ...entityEntitlementDetailsAccountTarget.yaml | 38 +++++++++++++ ...ntityEntitlementDetailsEntitlementDto.yaml | 51 +++++++++++++++++ 5 files changed, 177 insertions(+) create mode 100644 static/api-specs/idn/v2025/paths/revocable-objects.yaml create mode 100644 static/api-specs/idn/v2025/schemas/IdentityEntitlementDetails.yaml create mode 100644 static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsAccountTarget.yaml create mode 100644 static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsEntitlementDto.yaml diff --git a/static/api-specs/idn/sailpoint-api.v2025.yaml b/static/api-specs/idn/sailpoint-api.v2025.yaml index 8d31b5d55..3da165703 100644 --- a/static/api-specs/idn/sailpoint-api.v2025.yaml +++ b/static/api-specs/idn/sailpoint-api.v2025.yaml @@ -1653,6 +1653,8 @@ paths: $ref: ./v2025/paths/public-identities-config.yaml /requestable-objects: $ref: ./v2025/paths/requestable-object-list.yaml + /access-requests/revocable-objects: + $ref: ./v2025/paths/revocable-objects.yaml /roles: $ref: ./v2025/paths/roles.yaml /roles/{id}: diff --git a/static/api-specs/idn/v2025/paths/revocable-objects.yaml b/static/api-specs/idn/v2025/paths/revocable-objects.yaml new file mode 100644 index 000000000..7c18c25eb --- /dev/null +++ b/static/api-specs/idn/v2025/paths/revocable-objects.yaml @@ -0,0 +1,56 @@ +get: + operationId: getEntitlementDetailsForIdentity + tags: + - Access Requests + summary: Identity Entitlement Details + description: >- + Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. + security: + - userAuth: [idn:requestable-objects:read] + x-sailpoint-userLevels: + - ORG_ADMIN + - USER + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + - in: path + name: identityId + schema: + type: string + required: true + description: The identity ID. + example: 7025c863c2704ba6beeaedf3cb091573 + x-sailpoint-resource-operation-id: listIdentities + - in: path + name: entitlementId + schema: + type: string + required: true + description: The entitlement ID + example: ef38f94347e94562b5bb8424a56397d8 + x-sailpoint-resource-operation-id: listEntitlements + responses: + "200": + description: Entitlement and Account Reference + content: + application/json: + schema: + $ref: "../schemas/IdentityEntitlementDetails.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "404": + $ref: "../responses/404.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetails.yaml b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetails.yaml new file mode 100644 index 000000000..282d1b6b3 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetails.yaml @@ -0,0 +1,30 @@ +type: object +properties: + identityId: + type: string + description: Id of Identity + example: "5928c61f-3f2e-417a-8d65-f76451e2050a" + entitlement: + $ref: './IdentityEntitlementDetailsEntitlementDto.yaml' + sourceId: + type: string + description: Id of Source + example: "b56728da-a24d-4177-a207-2bc4d42cba27" + accountTargets: + description: >- + A list of account targets on the identity provisioned with the requested entitlement. + type: array + items: + $ref: './IdentityEntitlementDetailsAccountTarget.yaml' + example: [ + { + "accountId": "e7ef11cee24542b78618ce017117699f", + "accountName": "Adalberto.XYZ", + "accountUUID": null, + "sourceId": "0108906b66634d9ab7819a03eb263a88", + "sourceName": "ODS-AD-FF-Source [source-XYZ]", + "removeDate": null, + "assignmentId": null, + "revocable": true + } + ] \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsAccountTarget.yaml b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsAccountTarget.yaml new file mode 100644 index 000000000..617b80a4a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsAccountTarget.yaml @@ -0,0 +1,38 @@ +type: object +properties: + accountId: + type: string + description: The id of account + example: "c5ef070e-92c6-4276-a006-98490f132dec" + accountName: + type: EntitlementDto + description: The name of account + example: "Adalberto.XYZ" + accountUUID: + nullable: true + type: string + description: The UUID representation of the account if available + example: "2236c29e-68a6-494d-a469-d072172f46cf" + sourceId: + type: string + description: The id of Source + example: "9269d764-8358-4ab9-9748-d4b7418548ca" + sourceName: + type: string + description: The name of Source + example: "JDBC XYZ Source" + removeDate: + nullable: true + type: string + description: The removal date scheduled for the entitlement on the Identity + example: "2035-01-01T12:00:00.000Z" + assignmentId: + nullable: true + type: string + description: The assignmentId of the entitlement on the Identity + example: "77a5b7b4-262f-4b6a-a2aa-87f84f45f96f" + revocable: + type: boolean + default: false + description: If the entitlement can be revoked + example: true \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsEntitlementDto.yaml b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsEntitlementDto.yaml new file mode 100644 index 000000000..94d65a0b4 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsEntitlementDto.yaml @@ -0,0 +1,51 @@ +type: object +properties: + id: + type: string + description: The entitlement id + example: "2c91808874ff91550175097daaec161c" + name: + type: string + description: The entitlement name + example: "LauncherTest2" + created: + type: string + description: Time when the entitlement was last modified + format: 'date-time' + example: "2020-10-08T18:33:52.029Z" + modified: + type: string + description: Time when the entitlement was last modified + format: 'date-time' + example: "2020-10-08T18:33:52.029Z" + description: + type: string + description: The description of the entitlement + example: "CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local" + nullable: true + type: + type: string + description: The type of the object, will always be "ENTITLEMENT" + example: "ENTITLEMENT" + sourceId: + type: string + description: The source ID + example: 2c9180827ca885d7017ca8ce28a000eb + sourceName: + type: string + description: The source name + example: ODS-AD-Source + owner: + $ref: "./OwnerDto.yaml" + value: + type: string + description: The value of the entitlement + example: "CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local" + flags: + description: a list of properties informing the viewer about the entitlement + type: array + items: + type: string + example: [ + "privileged" + ] From 0067e6e8966735049483ba0b285c71baff8fff16 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Mon, 7 Apr 2025 20:18:24 +0000 Subject: [PATCH 33/82] Automated commit by github action: 14318643266 --- .../idn/v2024/paths/access-requests.yaml | 2 + .../idn/v2024/schemas/AccessRequest.yaml | 13 +++- .../access-requests/AccountItemRef.yaml | 12 ++++ .../access-requests/RequestedForDtoRef.yaml | 14 ++++ .../access-requests/RequestedItemDtoRef.yaml | 65 +++++++++++++++++++ .../access-requests/SourceItemRef.yaml | 13 ++++ .../idn/v2025/paths/access-requests.yaml | 2 + .../idn/v2025/schemas/AccessRequest.yaml | 13 +++- .../access-requests/AccountItemRef.yaml | 12 ++++ .../access-requests/RequestedForDtoRef.yaml | 14 ++++ .../access-requests/RequestedItemDtoRef.yaml | 65 +++++++++++++++++++ .../access-requests/SourceItemRef.yaml | 13 ++++ .../idn/v3/paths/access-requests.yaml | 2 + .../idn/v3/schemas/AccessRequest.yaml | 14 +++- .../access-requests/AccountItemRef.yaml | 12 ++++ .../access-requests/RequestedForDtoRef.yaml | 14 ++++ .../access-requests/RequestedItemDtoRef.yaml | 65 +++++++++++++++++++ .../access-requests/SourceItemRef.yaml | 13 ++++ 18 files changed, 354 insertions(+), 4 deletions(-) create mode 100644 static/api-specs/idn/v2024/schemas/access-requests/AccountItemRef.yaml create mode 100644 static/api-specs/idn/v2024/schemas/access-requests/RequestedForDtoRef.yaml create mode 100644 static/api-specs/idn/v2024/schemas/access-requests/RequestedItemDtoRef.yaml create mode 100644 static/api-specs/idn/v2024/schemas/access-requests/SourceItemRef.yaml create mode 100644 static/api-specs/idn/v2025/schemas/access-requests/AccountItemRef.yaml create mode 100644 static/api-specs/idn/v2025/schemas/access-requests/RequestedForDtoRef.yaml create mode 100644 static/api-specs/idn/v2025/schemas/access-requests/RequestedItemDtoRef.yaml create mode 100644 static/api-specs/idn/v2025/schemas/access-requests/SourceItemRef.yaml create mode 100644 static/api-specs/idn/v3/schemas/access-requests/AccountItemRef.yaml create mode 100644 static/api-specs/idn/v3/schemas/access-requests/RequestedForDtoRef.yaml create mode 100644 static/api-specs/idn/v3/schemas/access-requests/RequestedItemDtoRef.yaml create mode 100644 static/api-specs/idn/v3/schemas/access-requests/SourceItemRef.yaml diff --git a/static/api-specs/idn/v2024/paths/access-requests.yaml b/static/api-specs/idn/v2024/paths/access-requests.yaml index 310abcb2c..060daf117 100644 --- a/static/api-specs/idn/v2024/paths/access-requests.yaml +++ b/static/api-specs/idn/v2024/paths/access-requests.yaml @@ -29,6 +29,7 @@ post: * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + * Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -39,6 +40,7 @@ post: * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. + * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. requestBody: required: true content: diff --git a/static/api-specs/idn/v2024/schemas/AccessRequest.yaml b/static/api-specs/idn/v2024/schemas/AccessRequest.yaml index 078f47ffd..435f78953 100644 --- a/static/api-specs/idn/v2024/schemas/AccessRequest.yaml +++ b/static/api-specs/idn/v2024/schemas/AccessRequest.yaml @@ -5,7 +5,7 @@ properties: type: array items: type: string - example: 2c918084660f45d6016617daa9210584 + example: 2c918084660f45d6016617daa9210584 requestType: $ref: 'AccessRequestType.yaml' requestedItems: @@ -27,5 +27,16 @@ properties: description: >- Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. + requestedForWithRequestedItems: + description: | + Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. + * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided + * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source + * Allows the ability to request items with different remove dates + * Also allows different combinations of request items and identities in the same request + type: array + items: + $ref: './access-requests/RequestedForDtoRef.yaml' + nullable: true required : ["requestedFor", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/access-requests/AccountItemRef.yaml b/static/api-specs/idn/v2024/schemas/access-requests/AccountItemRef.yaml new file mode 100644 index 000000000..351101051 --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/AccountItemRef.yaml @@ -0,0 +1,12 @@ +type: object +properties: + accountUuid: + type: string + nullable: true + description: The uuid for the account, available under the 'objectguid' attribute + example: '{fab7119e-004f-4822-9c33-b8d570d6c6a6}' + nativeIdentity: + type: string + nullable: false + description: The 'distinguishedName' attribute for the account + example: 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/access-requests/RequestedForDtoRef.yaml b/static/api-specs/idn/v2024/schemas/access-requests/RequestedForDtoRef.yaml new file mode 100644 index 000000000..5cad16643 --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/RequestedForDtoRef.yaml @@ -0,0 +1,14 @@ +type: object +properties: + identityId: + type: string + nullable: false + description: The identity id for which the access is requested + example: 'cb89bc2f1ee6445fbea12224c526ba3a' + requestedItems: + description: the details for the access items that are requested for the identity + type: array + items: + $ref: 'RequestedItemDtoRef.yaml' + nullable: false +required : ["identityId", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/access-requests/RequestedItemDtoRef.yaml b/static/api-specs/idn/v2024/schemas/access-requests/RequestedItemDtoRef.yaml new file mode 100644 index 000000000..cb9706b51 --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/RequestedItemDtoRef.yaml @@ -0,0 +1,65 @@ +type : object +properties: + type: + type: string + # Can't use $ref to RequestableObjectType here because it's non-optional on access requests + enum: [ACCESS_PROFILE, ROLE, ENTITLEMENT] + description: The type of the item being requested. + example: ACCESS_PROFILE + id: + type: string + description: ID of Role, Access Profile or Entitlement being requested. + example: 2c9180835d2e5168015d32f890ca1581 + comment: + type: string + description: | + Comment provided by requester. + * Comment is required when the request is of type Revoke Access. + example: Requesting access profile for John Doe + clientMetadata: + type: object + additionalProperties: + type: string + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + example: + requestedAppName: test-app + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + description: >- + Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on + associated APIs such as /account-activities and /access-request-status. + removeDate: + type: string + description: | + The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. + * Specify a date in the future. + * The current SLA for the deprovisioning is 24 hours. + * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. + format: 'date-time' + example: '2020-07-11T21:23:15.000Z' + assignmentId: + type: string + nullable: true + description: | + The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. + * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. + example: 'ee48a191c00d49bf9264eb0a4fc3a9fc' + nativeIdentity: + type: string + nullable: true + description: | + The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. + * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. + example: 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' + accountSelection: + type: array + items: + $ref: 'SourceItemRef.yaml' + nullable: true + description: | + The accounts where the access item will be provisioned to + * Includes selections performed by the user in the event of multiple accounts existing on the same source + * Also includes details for sources where user only has one account +required : ["id", "type"] + diff --git a/static/api-specs/idn/v2024/schemas/access-requests/SourceItemRef.yaml b/static/api-specs/idn/v2024/schemas/access-requests/SourceItemRef.yaml new file mode 100644 index 000000000..2771ebebc --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/SourceItemRef.yaml @@ -0,0 +1,13 @@ +type: object +properties: + sourceId: + type: string + nullable: true + description: The id for the source on which account selections are made + example: 'cb89bc2f1ee6445fbea12224c526ba3a' + accounts: + description: A list of account selections on the source. Currently, only one selection per source is supported. + type: array + items: + $ref: 'AccountItemRef.yaml' + nullable: true \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/access-requests.yaml b/static/api-specs/idn/v2025/paths/access-requests.yaml index 310abcb2c..060daf117 100644 --- a/static/api-specs/idn/v2025/paths/access-requests.yaml +++ b/static/api-specs/idn/v2025/paths/access-requests.yaml @@ -29,6 +29,7 @@ post: * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + * Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -39,6 +40,7 @@ post: * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. + * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. requestBody: required: true content: diff --git a/static/api-specs/idn/v2025/schemas/AccessRequest.yaml b/static/api-specs/idn/v2025/schemas/AccessRequest.yaml index 078f47ffd..435f78953 100644 --- a/static/api-specs/idn/v2025/schemas/AccessRequest.yaml +++ b/static/api-specs/idn/v2025/schemas/AccessRequest.yaml @@ -5,7 +5,7 @@ properties: type: array items: type: string - example: 2c918084660f45d6016617daa9210584 + example: 2c918084660f45d6016617daa9210584 requestType: $ref: 'AccessRequestType.yaml' requestedItems: @@ -27,5 +27,16 @@ properties: description: >- Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. + requestedForWithRequestedItems: + description: | + Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. + * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided + * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source + * Allows the ability to request items with different remove dates + * Also allows different combinations of request items and identities in the same request + type: array + items: + $ref: './access-requests/RequestedForDtoRef.yaml' + nullable: true required : ["requestedFor", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/access-requests/AccountItemRef.yaml b/static/api-specs/idn/v2025/schemas/access-requests/AccountItemRef.yaml new file mode 100644 index 000000000..351101051 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/AccountItemRef.yaml @@ -0,0 +1,12 @@ +type: object +properties: + accountUuid: + type: string + nullable: true + description: The uuid for the account, available under the 'objectguid' attribute + example: '{fab7119e-004f-4822-9c33-b8d570d6c6a6}' + nativeIdentity: + type: string + nullable: false + description: The 'distinguishedName' attribute for the account + example: 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/access-requests/RequestedForDtoRef.yaml b/static/api-specs/idn/v2025/schemas/access-requests/RequestedForDtoRef.yaml new file mode 100644 index 000000000..5cad16643 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/RequestedForDtoRef.yaml @@ -0,0 +1,14 @@ +type: object +properties: + identityId: + type: string + nullable: false + description: The identity id for which the access is requested + example: 'cb89bc2f1ee6445fbea12224c526ba3a' + requestedItems: + description: the details for the access items that are requested for the identity + type: array + items: + $ref: 'RequestedItemDtoRef.yaml' + nullable: false +required : ["identityId", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/access-requests/RequestedItemDtoRef.yaml b/static/api-specs/idn/v2025/schemas/access-requests/RequestedItemDtoRef.yaml new file mode 100644 index 000000000..cb9706b51 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/RequestedItemDtoRef.yaml @@ -0,0 +1,65 @@ +type : object +properties: + type: + type: string + # Can't use $ref to RequestableObjectType here because it's non-optional on access requests + enum: [ACCESS_PROFILE, ROLE, ENTITLEMENT] + description: The type of the item being requested. + example: ACCESS_PROFILE + id: + type: string + description: ID of Role, Access Profile or Entitlement being requested. + example: 2c9180835d2e5168015d32f890ca1581 + comment: + type: string + description: | + Comment provided by requester. + * Comment is required when the request is of type Revoke Access. + example: Requesting access profile for John Doe + clientMetadata: + type: object + additionalProperties: + type: string + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + example: + requestedAppName: test-app + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + description: >- + Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on + associated APIs such as /account-activities and /access-request-status. + removeDate: + type: string + description: | + The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. + * Specify a date in the future. + * The current SLA for the deprovisioning is 24 hours. + * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. + format: 'date-time' + example: '2020-07-11T21:23:15.000Z' + assignmentId: + type: string + nullable: true + description: | + The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. + * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. + example: 'ee48a191c00d49bf9264eb0a4fc3a9fc' + nativeIdentity: + type: string + nullable: true + description: | + The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. + * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. + example: 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' + accountSelection: + type: array + items: + $ref: 'SourceItemRef.yaml' + nullable: true + description: | + The accounts where the access item will be provisioned to + * Includes selections performed by the user in the event of multiple accounts existing on the same source + * Also includes details for sources where user only has one account +required : ["id", "type"] + diff --git a/static/api-specs/idn/v2025/schemas/access-requests/SourceItemRef.yaml b/static/api-specs/idn/v2025/schemas/access-requests/SourceItemRef.yaml new file mode 100644 index 000000000..2771ebebc --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/SourceItemRef.yaml @@ -0,0 +1,13 @@ +type: object +properties: + sourceId: + type: string + nullable: true + description: The id for the source on which account selections are made + example: 'cb89bc2f1ee6445fbea12224c526ba3a' + accounts: + description: A list of account selections on the source. Currently, only one selection per source is supported. + type: array + items: + $ref: 'AccountItemRef.yaml' + nullable: true \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/access-requests.yaml b/static/api-specs/idn/v3/paths/access-requests.yaml index 310abcb2c..060daf117 100644 --- a/static/api-specs/idn/v3/paths/access-requests.yaml +++ b/static/api-specs/idn/v3/paths/access-requests.yaml @@ -29,6 +29,7 @@ post: * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + * Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -39,6 +40,7 @@ post: * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. + * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. requestBody: required: true content: diff --git a/static/api-specs/idn/v3/schemas/AccessRequest.yaml b/static/api-specs/idn/v3/schemas/AccessRequest.yaml index 078f47ffd..8274045f6 100644 --- a/static/api-specs/idn/v3/schemas/AccessRequest.yaml +++ b/static/api-specs/idn/v3/schemas/AccessRequest.yaml @@ -5,7 +5,7 @@ properties: type: array items: type: string - example: 2c918084660f45d6016617daa9210584 + example: 2c918084660f45d6016617daa9210584 requestType: $ref: 'AccessRequestType.yaml' requestedItems: @@ -27,5 +27,15 @@ properties: description: >- Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - + requestedForWithRequestedItems: + description: | + Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. + * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided + * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source + * Allows the ability to request items with different remove dates + * Also allows different combinations of request items and identities in the same request + type: array + items: + $ref: './access-requests/RequestedForDtoRef.yaml' + nullable: true required : ["requestedFor", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/access-requests/AccountItemRef.yaml b/static/api-specs/idn/v3/schemas/access-requests/AccountItemRef.yaml new file mode 100644 index 000000000..351101051 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/access-requests/AccountItemRef.yaml @@ -0,0 +1,12 @@ +type: object +properties: + accountUuid: + type: string + nullable: true + description: The uuid for the account, available under the 'objectguid' attribute + example: '{fab7119e-004f-4822-9c33-b8d570d6c6a6}' + nativeIdentity: + type: string + nullable: false + description: The 'distinguishedName' attribute for the account + example: 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/access-requests/RequestedForDtoRef.yaml b/static/api-specs/idn/v3/schemas/access-requests/RequestedForDtoRef.yaml new file mode 100644 index 000000000..5cad16643 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/access-requests/RequestedForDtoRef.yaml @@ -0,0 +1,14 @@ +type: object +properties: + identityId: + type: string + nullable: false + description: The identity id for which the access is requested + example: 'cb89bc2f1ee6445fbea12224c526ba3a' + requestedItems: + description: the details for the access items that are requested for the identity + type: array + items: + $ref: 'RequestedItemDtoRef.yaml' + nullable: false +required : ["identityId", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/access-requests/RequestedItemDtoRef.yaml b/static/api-specs/idn/v3/schemas/access-requests/RequestedItemDtoRef.yaml new file mode 100644 index 000000000..cb9706b51 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/access-requests/RequestedItemDtoRef.yaml @@ -0,0 +1,65 @@ +type : object +properties: + type: + type: string + # Can't use $ref to RequestableObjectType here because it's non-optional on access requests + enum: [ACCESS_PROFILE, ROLE, ENTITLEMENT] + description: The type of the item being requested. + example: ACCESS_PROFILE + id: + type: string + description: ID of Role, Access Profile or Entitlement being requested. + example: 2c9180835d2e5168015d32f890ca1581 + comment: + type: string + description: | + Comment provided by requester. + * Comment is required when the request is of type Revoke Access. + example: Requesting access profile for John Doe + clientMetadata: + type: object + additionalProperties: + type: string + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + example: + requestedAppName: test-app + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + description: >- + Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on + associated APIs such as /account-activities and /access-request-status. + removeDate: + type: string + description: | + The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. + * Specify a date in the future. + * The current SLA for the deprovisioning is 24 hours. + * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. + format: 'date-time' + example: '2020-07-11T21:23:15.000Z' + assignmentId: + type: string + nullable: true + description: | + The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. + * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. + example: 'ee48a191c00d49bf9264eb0a4fc3a9fc' + nativeIdentity: + type: string + nullable: true + description: | + The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. + * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. + example: 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' + accountSelection: + type: array + items: + $ref: 'SourceItemRef.yaml' + nullable: true + description: | + The accounts where the access item will be provisioned to + * Includes selections performed by the user in the event of multiple accounts existing on the same source + * Also includes details for sources where user only has one account +required : ["id", "type"] + diff --git a/static/api-specs/idn/v3/schemas/access-requests/SourceItemRef.yaml b/static/api-specs/idn/v3/schemas/access-requests/SourceItemRef.yaml new file mode 100644 index 000000000..2771ebebc --- /dev/null +++ b/static/api-specs/idn/v3/schemas/access-requests/SourceItemRef.yaml @@ -0,0 +1,13 @@ +type: object +properties: + sourceId: + type: string + nullable: true + description: The id for the source on which account selections are made + example: 'cb89bc2f1ee6445fbea12224c526ba3a' + accounts: + description: A list of account selections on the source. Currently, only one selection per source is supported. + type: array + items: + $ref: 'AccountItemRef.yaml' + nullable: true \ No newline at end of file From d1ad55be72eaf8342b15a72a8d7ec93ffb0888eb Mon Sep 17 00:00:00 2001 From: Tyler Mairose Date: Tue, 8 Apr 2025 11:43:13 -0400 Subject: [PATCH 34/82] Update versioning strategy --- docs/api/api-versioning-strategy.md | 2 +- docs/api/beta/api-versioning-strategy.md | 2 +- docs/api/v2024/api-versioning-strategy.md | 2 +- docs/api/v2025/api-versioning-strategy.md | 8 ++++---- docs/api/v3/api-versioning-strategy.md | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/api/api-versioning-strategy.md b/docs/api/api-versioning-strategy.md index 1439d89a3..31542a519 100644 --- a/docs/api/api-versioning-strategy.md +++ b/docs/api/api-versioning-strategy.md @@ -96,7 +96,7 @@ When a new annual release is introduced, non-deprecated endpoints will generally Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represent an experimental release that introduces breaking changes, if any exist. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. During each calendar year’s main release (e.g., v2025), an optional experimental release may be introduced in preparation for the following year’s version (e.g., v2026). Blue bars on the timeline represent these experimental releases. For example, in 2025, if breaking changes are required for a public api, an experimental version (v2026) of the api may be published during the v2025 cycle. ![Versioning Timeline](./img/api-versioning-timeline.png) diff --git a/docs/api/beta/api-versioning-strategy.md b/docs/api/beta/api-versioning-strategy.md index 822f8f42c..2a6a41659 100644 --- a/docs/api/beta/api-versioning-strategy.md +++ b/docs/api/beta/api-versioning-strategy.md @@ -96,7 +96,7 @@ When a new annual release is introduced, non-deprecated endpoints will generally Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represents an experimental release that introduces breaking changes, if any exist. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. During each calendar year’s main release (e.g., v2025), an optional experimental release may be introduced in preparation for the following year’s version (e.g., v2026). Blue bars on the timeline represent these experimental releases. For example, in 2025, if breaking changes are required for a public api, an experimental version (v2026) of the api may be published during the v2025 cycle. ![Versioning Timeline](../img/api-versioning-timeline.png) diff --git a/docs/api/v2024/api-versioning-strategy.md b/docs/api/v2024/api-versioning-strategy.md index dfc1ceb22..6a83bbd63 100644 --- a/docs/api/v2024/api-versioning-strategy.md +++ b/docs/api/v2024/api-versioning-strategy.md @@ -96,7 +96,7 @@ When a new annual release is introduced, non-deprecated endpoints will generally Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represents an experimental release that introduces breaking changes, if any exist. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. During each calendar year’s main release (e.g., v2025), an optional experimental release may be introduced in preparation for the following year’s version (e.g., v2026). Blue bars on the timeline represent these experimental releases. For example, in 2025, if breaking changes are required for a public api, an experimental version (v2026) of the api may be published during the v2025 cycle. ![Versioning Timeline](../img/api-versioning-timeline.png) diff --git a/docs/api/v2025/api-versioning-strategy.md b/docs/api/v2025/api-versioning-strategy.md index c25e8dbb0..40466d925 100644 --- a/docs/api/v2025/api-versioning-strategy.md +++ b/docs/api/v2025/api-versioning-strategy.md @@ -88,17 +88,17 @@ If you attempt to invoke an experimental API without specifying the `X-SailPoint ## Release schedule -SailPoint will introduce an annual release which includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. +SailPoint will introduce an annual release that includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. -Each annual release will be accompanied by an experimental release if there is at least one breaking change introduced in the current annual release. This experimental release will be named after the next year. For example, if the current year is 2025, the experimental version will be named v2026. Any breaking changes to public endpoints in a public version throughout the year will be introduced in the experimental version. +Each annual release may be accompanied by an experimental release if it introduces at least one breaking change. For example, if the annual release is v2025 and includes breaking changes, those changes will be introduced as experimental APIs in v2026. When a new annual release is introduced, non-deprecated endpoints will generally be transferred to the new release without modifications. As a result, the same endpoint will usually be able to be accessed via both the old and new versions. Only the latest public release will receive new functionality. If at anytime throughout the year a experimental API is deemed ready for production, it will be released into the current year’s public version, but not previous years. Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represent experimental releases which are available for one year in the preview state before being changed to a production release. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. During each calendar year’s main release (e.g., v2025), an optional experimental release may be introduced in preparation for the following year’s version (e.g., v2026). Blue bars on the timeline represent these experimental releases. For example, in 2025, if breaking changes are required for a public api, an experimental version (v2026) of the api may be published during the v2025 cycle. -![Versioning Timeline](../img/api-versioning-timeline.jpg) +![Versioning Timeline](../img/api-versioning-timeline.png) ## Deprecations diff --git a/docs/api/v3/api-versioning-strategy.md b/docs/api/v3/api-versioning-strategy.md index f6e0b76aa..580d09fa2 100644 --- a/docs/api/v3/api-versioning-strategy.md +++ b/docs/api/v3/api-versioning-strategy.md @@ -96,7 +96,7 @@ When a new annual release is introduced, non-deprecated endpoints will generally Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represents an experimental release that introduces breaking changes, if any exist. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. During each calendar year’s main release (e.g., v2025), an optional experimental release may be introduced in preparation for the following year’s version (e.g., v2026). Blue bars on the timeline represent these experimental releases. For example, in 2025, if breaking changes are required for a public api, an experimental version (v2026) of the api may be published during the v2025 cycle. ![Versioning Timeline](../img/api-versioning-timeline.png) From e6e72e523d26b3fc6afd41ea4c4c04d24dfc7697 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Tue, 8 Apr 2025 19:26:32 +0000 Subject: [PATCH 35/82] Automated commit by github action: 14341927841 --- .../v2024/paths/configuration-hub/scheduled-actions.yaml | 6 +++--- .../schemas/configuration-hub/ScheduledActionPayload.yaml | 2 +- .../schemas/configuration-hub/ScheduledActionResponse.yaml | 2 +- .../v2025/paths/configuration-hub/scheduled-actions.yaml | 6 +++--- .../schemas/configuration-hub/ScheduledActionPayload.yaml | 2 +- .../schemas/configuration-hub/ScheduledActionResponse.yaml | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/static/api-specs/idn/v2024/paths/configuration-hub/scheduled-actions.yaml b/static/api-specs/idn/v2024/paths/configuration-hub/scheduled-actions.yaml index b7b414654..423c63c47 100644 --- a/static/api-specs/idn/v2024/paths/configuration-hub/scheduled-actions.yaml +++ b/static/api-specs/idn/v2024/paths/configuration-hub/scheduled-actions.yaml @@ -33,7 +33,7 @@ get: } }, "startTime": "2024-08-16T14:16:58.389Z", - "cronString": "0 0 * * *" + "cronString": "0 0 * * * *" } ] '400': @@ -69,7 +69,7 @@ post: { "jobType": "BACKUP", "startTime": "2024-08-16T14:16:58.389Z", - "cronString": "0 0 12 * * ?", + "cronString": "0 0 12 * * * *", "timeZoneId": "America/Chicago", "content": { "name": "Daily Backup", @@ -108,7 +108,7 @@ post: } }, "startTime": "2024-08-16T14:16:58.389Z", - "cronString": "0 0 12 * * ?" + "cronString": "0 0 12 * * * *" } '400': $ref: '../../responses/400.yaml' diff --git a/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionPayload.yaml b/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionPayload.yaml index de3982b07..5ed88edba 100644 --- a/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionPayload.yaml +++ b/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionPayload.yaml @@ -19,7 +19,7 @@ properties: cronString: type: string description: Cron expression defining the schedule for this action. Optional for repeated events. - example: "0 0 12 * * ?" + example: "0 0 12 * * * *" timeZoneId: type: string description: Time zone ID for interpreting the cron expression. Optional, will default to current time zone. diff --git a/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionResponse.yaml b/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionResponse.yaml index 2bd527762..934bf1135 100644 --- a/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionResponse.yaml +++ b/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionResponse.yaml @@ -76,7 +76,7 @@ properties: cronString: type: string description: Cron expression defining the schedule for this action. - example: "0 0 12 * * ?" + example: "0 0 12 * * * *" timeZoneId: type: string description: Time zone ID for interpreting the cron expression. diff --git a/static/api-specs/idn/v2025/paths/configuration-hub/scheduled-actions.yaml b/static/api-specs/idn/v2025/paths/configuration-hub/scheduled-actions.yaml index b7b414654..a0837c28b 100644 --- a/static/api-specs/idn/v2025/paths/configuration-hub/scheduled-actions.yaml +++ b/static/api-specs/idn/v2025/paths/configuration-hub/scheduled-actions.yaml @@ -33,7 +33,7 @@ get: } }, "startTime": "2024-08-16T14:16:58.389Z", - "cronString": "0 0 * * *" + "cronString": "0 0 * * * *" } ] '400': @@ -69,7 +69,7 @@ post: { "jobType": "BACKUP", "startTime": "2024-08-16T14:16:58.389Z", - "cronString": "0 0 12 * * ?", + "cronString": "0 0 * * * *", "timeZoneId": "America/Chicago", "content": { "name": "Daily Backup", @@ -108,7 +108,7 @@ post: } }, "startTime": "2024-08-16T14:16:58.389Z", - "cronString": "0 0 12 * * ?" + "cronString": "0 0 * * * *" } '400': $ref: '../../responses/400.yaml' diff --git a/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionPayload.yaml b/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionPayload.yaml index de3982b07..608a5599b 100644 --- a/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionPayload.yaml +++ b/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionPayload.yaml @@ -19,7 +19,7 @@ properties: cronString: type: string description: Cron expression defining the schedule for this action. Optional for repeated events. - example: "0 0 12 * * ?" + example: "0 0 * * * *" timeZoneId: type: string description: Time zone ID for interpreting the cron expression. Optional, will default to current time zone. diff --git a/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionResponse.yaml b/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionResponse.yaml index 2bd527762..8b0d94086 100644 --- a/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionResponse.yaml +++ b/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionResponse.yaml @@ -76,7 +76,7 @@ properties: cronString: type: string description: Cron expression defining the schedule for this action. - example: "0 0 12 * * ?" + example: "0 0 * * * *" timeZoneId: type: string description: Time zone ID for interpreting the cron expression. From a5cc95df8adeda69c974ecbfcfc8b50927ac77c7 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Tue, 8 Apr 2025 16:54:46 -0400 Subject: [PATCH 36/82] fix broken link --- docs/tools/cli/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/cli/index.md b/docs/tools/cli/index.md index cb8f952a9..ef25b0c83 100644 --- a/docs/tools/cli/index.md +++ b/docs/tools/cli/index.md @@ -40,7 +40,7 @@ Learn how to use the SailPoint command line interface (CLI) in this guide. - [PAT Authentication](#pat-authentication) - [Environment variable configuration](#environment-variable-configuration) - [Usage](#usage) -- [GitHub](#github) +- [Support](#Support) - [Contribution](#contribution) - [Questions](#questions) From f220d21f4f1ee4056852e7b9f93870b97a5f8d9a Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Tue, 8 Apr 2025 21:55:38 -0400 Subject: [PATCH 37/82] fix mobile styling for devdays banner and update gitignore for v2025 --- .gitignore | 2 ++ .../homepage/HomepageDeveloperDays/styles.module.css | 7 +++++++ 2 files changed, 9 insertions(+) diff --git a/.gitignore b/.gitignore index de3d8510a..5bb905026 100644 --- a/.gitignore +++ b/.gitignore @@ -36,6 +36,8 @@ yarn.lock /static/code-examples/v3/merged_code_examples.yaml /static/code-examples/v2024/v2024.yaml /static/code-examples/v2024/merged_code_examples.yaml +/static/code-examples/v2025/v2025.yaml +/static/code-examples/v2025/merged_code_examples.yaml /docs/api/v3/* /docs/api/beta/* diff --git a/src/components/homepage/HomepageDeveloperDays/styles.module.css b/src/components/homepage/HomepageDeveloperDays/styles.module.css index 9eff37e41..3acb687ea 100644 --- a/src/components/homepage/HomepageDeveloperDays/styles.module.css +++ b/src/components/homepage/HomepageDeveloperDays/styles.module.css @@ -101,6 +101,10 @@ } @media only screen and (max-width: 1178px) { + .cardIcon { + display: none !important; + } + .carousel { margin-top: 0px; margin-left: 50px; @@ -136,6 +140,9 @@ } } @media only screen and (max-width: 570px) { + .cardIcon { + display: none !important; + } .contentContainer { width: auto; From d84b6752fc509e68a87d567355396d4d3dab92bc Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Tue, 8 Apr 2025 22:12:45 -0400 Subject: [PATCH 38/82] removing merged code examples and v2025.yaml --- .../v2025/merged_code_examples.yaml | 37664 ----- static/code-examples/v2025/v2025.yaml | 118489 --------------- 2 files changed, 156153 deletions(-) delete mode 100644 static/code-examples/v2025/merged_code_examples.yaml delete mode 100644 static/code-examples/v2025/v2025.yaml diff --git a/static/code-examples/v2025/merged_code_examples.yaml b/static/code-examples/v2025/merged_code_examples.yaml deleted file mode 100644 index 9cf725cc6..000000000 --- a/static/code-examples/v2025/merged_code_examples.yaml +++ /dev/null @@ -1,37664 +0,0 @@ -- path: /access-model-metadata/attributes/{key} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#get-access-model-metadata-attribute - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Model Metadata Attribute - - try { - Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-model-metadata#get-access-model-metadata-attribute - source: | - from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.attribute_dto import AttributeDTO - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Access Model Metadata Attribute - - results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key=key, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key, x_sail_point_experimental) - print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) -- path: /access-model-metadata/attributes/{key}/values/{value} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#get-access-model-metadata-attribute-value - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $Value = "public" # String | Technical name of the Attribute value. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Model Metadata Value - - try { - Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-model-metadata#get-access-model-metadata-attribute-value - source: | - from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.attribute_value_dto import AttributeValueDTO - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - value = 'public' # str | Technical name of the Attribute value. # str | Technical name of the Attribute value. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Access Model Metadata Value - - results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key=key, value=value, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental) - print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) -- path: /access-model-metadata/attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) - - # List Access Model Metadata Attributes - - try { - Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-model-metadata#list-access-model-metadata-attribute - source: | - from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.attribute_dto import AttributeDTO - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'name eq \"Privacy\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) - try: - # List Access Model Metadata Attributes - - results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters) - print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) -- path: /access-model-metadata/attributes/{key}/values - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute-value - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Access Model Metadata Values - - try { - Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-model-metadata#list-access-model-metadata-attribute-value - source: | - from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.attribute_value_dto import AttributeValueDTO - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List Access Model Metadata Values - - results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental) - print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) -- path: /access-profiles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#create-access-profile - source: | - $AccessProfile = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "description" : "Collection of entitlements to read/write the employee database", - "source" : { - "name" : "ODS-AD-SOURCE", - "id" : "2c91809773dee3610173fdb0b6061ef4", - "type" : "SOURCE" - }, - "enabled" : true, - "revocationRequestConfig" : { - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ] - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "accessRequestConfig" : { - "commentsRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "name" : "Employee-database-read-write", - "provisioningCriteria" : { - "children" : [ { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, - "modified" : "2021-03-02T20:22:28.104Z", - "id" : "2c91808a7190d06e01719938fcd20792", - "requestable" : true - } - "@ - - # Create Access Profile - - try { - $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile - New-V2025AccessProfile -AccessProfile $Result - - # Below is a request that includes all optional parameters - # New-V2025AccessProfile -AccessProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#create-access-profile - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile import AccessProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - access_profile = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "description" : "Collection of entitlements to read/write the employee database", - "source" : { - "name" : "ODS-AD-SOURCE", - "id" : "2c91809773dee3610173fdb0b6061ef4", - "type" : "SOURCE" - }, - "enabled" : true, - "revocationRequestConfig" : { - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ] - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "accessRequestConfig" : { - "commentsRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "name" : "Employee-database-read-write", - "provisioningCriteria" : { - "children" : [ { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, - "modified" : "2021-03-02T20:22:28.104Z", - "id" : "2c91808a7190d06e01719938fcd20792", - "requestable" : true - }''' # AccessProfile | - try: - # Create Access Profile - new_access_profile = AccessProfile.from_json(access_profile) - results = AccessProfilesApi(api_client).create_access_profile(access_profile=new_access_profile) - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).create_access_profile(new_access_profile) - print("The response of AccessProfilesApi->create_access_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) -- path: /access-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#list-access-profiles - source: | - $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) - - # List Access Profiles - - try { - Get-V2025AccessProfiles - - # Below is a request that includes all optional parameters - # Get-V2025AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfiles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#list-access-profiles - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile import AccessProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) # str | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) - try: - # List Access Profiles - - results = AccessProfilesApi(api_client).list_access_profiles() - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) - print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) -- path: /access-profiles/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#delete-access-profile - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete - - # Delete the specified Access Profile - - try { - Remove-V2025AccessProfile -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025AccessProfile -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#delete-access-profile - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete - try: - # Delete the specified Access Profile - - AccessProfilesApi(api_client).delete_access_profile(id=id) - # Below is a request that includes all optional parameters - # AccessProfilesApi(api_client).delete_access_profile(id) - except Exception as e: - print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) -- path: /access-profiles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#get-access-profile - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile - - # Get an Access Profile - - try { - Get-V2025AccessProfile -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccessProfile -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#get-access-profile - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile import AccessProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile - try: - # Get an Access Profile - - results = AccessProfilesApi(api_client).get_access_profile(id=id) - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).get_access_profile(id) - print("The response of AccessProfilesApi->get_access_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) -- path: /access-profiles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#patch-access-profile - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Access Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025AccessProfile -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025AccessProfile -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AccessProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#patch-access-profile - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile import AccessProfile - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch - json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] | - try: - # Patch a specified Access Profile - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = AccessProfilesApi(api_client).patch_access_profile(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).patch_access_profile(id, new_json_patch_operation) - print("The response of AccessProfilesApi->patch_access_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) -- path: /access-profiles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#delete-access-profiles-in-bulk - source: | - $AccessProfileBulkDeleteRequest = @" - { - "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], - "bestEffortOnly" : true - } - "@ - - # Delete Access Profile(s) - - try { - $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest - Remove-V2025AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfilesInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#delete-access-profiles-in-bulk - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest - from sailpoint.v2025.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - access_profile_bulk_delete_request = '''{ - "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], - "bestEffortOnly" : true - }''' # AccessProfileBulkDeleteRequest | - try: - # Delete Access Profile(s) - new_access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest.from_json(access_profile_bulk_delete_request) - results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(access_profile_bulk_delete_request=new_access_profile_bulk_delete_request) - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(new_access_profile_bulk_delete_request) - print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) -- path: /access-profiles/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#get-access-profile-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Access Profile's Entitlements - - try { - Get-V2025AccessProfileEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfileEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#get-access-profile-entitlements - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121919ecca' # str | ID of the access profile containing the entitlements. # str | ID of the access profile containing the entitlements. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'attribute eq \"memberOf\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - try: - # List Access Profile's Entitlements - - results = AccessProfilesApi(api_client).get_access_profile_entitlements(id=id) - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) - print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) -- path: /access-profiles/bulk-update-requestable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#update-access-profiles-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ - - - # Update Access Profile(s) requestable field. - - try { - $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner - Update-V2025AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AccessProfilesInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#update-access-profiles-in-bulk - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile_bulk_update_request_inner import AccessProfileBulkUpdateRequestInner - from sailpoint.v2025.models.access_profile_update_item import AccessProfileUpdateItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_profile_bulk_update_request_inner = '''[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]''' # List[AccessProfileBulkUpdateRequestInner] | - try: - # Update Access Profile(s) requestable field. - new_access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner.from_json(access_profile_bulk_update_request_inner) - results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental=x_sail_point_experimental, access_profile_bulk_update_request_inner=new_access_profile_bulk_update_request_inner) - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner) - print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) -- path: /access-request-approvals/{approvalId}/approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#approve-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $CommentDto = @" - { - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - } - "@ - - # Approve Access Request Approval - - try { - Approve-V2025AccessRequest -ApprovalId $ApprovalId - - # Below is a request that includes all optional parameters - # Approve-V2025AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025AccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#approve-access-request - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.comment_dto import CommentDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - comment_dto = '''{ - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - }''' # CommentDto | Reviewer's comment. (optional) - try: - # Approve Access Request Approval - - results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id=approval_id) - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto) - print("The response of AccessRequestApprovalsApi->approve_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) -- path: /access-request-approvals/{approvalId}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#forward-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $ForwardApprovalDto = @" - { - "newOwnerId" : "2c91808568c529c60168cca6f90c1314", - "comment" : "2c91808568c529c60168cca6f90c1313" - } - "@ - - # Forward Access Request Approval - - try { - $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto - Invoke-V2025ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ForwardAccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#forward-access-request - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.forward_approval_dto import ForwardApprovalDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - forward_approval_dto = '''{ - "newOwnerId" : "2c91808568c529c60168cca6f90c1314", - "comment" : "2c91808568c529c60168cca6f90c1313" - }''' # ForwardApprovalDto | Information about the forwarded approval. - try: - # Forward Access Request Approval - new_forward_approval_dto = ForwardApprovalDto.from_json(forward_approval_dto) - results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id=approval_id, forward_approval_dto=new_forward_approval_dto) - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, new_forward_approval_dto) - print("The response of AccessRequestApprovalsApi->forward_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) -- path: /access-request-approvals/approval-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#get-access-request-approval-summary - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) - - # Get Access Requests Approvals Number - - try { - Get-V2025AccessRequestApprovalSummary - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestApprovalSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#get-access-request-approval-summary - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.approval_summary import ApprovalSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '2c91808568c529c60168cca6f90c1313' # str | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - from_date = 'from-date=2020-03-19T19:59:11Z' # str | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # str | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) - try: - # Get Access Requests Approvals Number - - results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary() - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary(owner_id, from_date) - print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) -- path: /access-request-approvals/{accessRequestId}/approvers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#list-access-request-approvers - source: | - $AccessRequestId = "2c91808568c529c60168cca6f90c1313" # String | Access Request ID. - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - - # Access Request Approvers - - try { - Get-V2025AccessRequestApprovers -AccessRequestId $AccessRequestId - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestApprovers -AccessRequestId $AccessRequestId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestApprovers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#list-access-request-approvers - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_approvers_list_response import AccessRequestApproversListResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - access_request_id = '2c91808568c529c60168cca6f90c1313' # str | Access Request ID. # str | Access Request ID. - limit = 250 # int | Max number of results to return. (optional) (default to 250) # int | Max number of results to return. (optional) (default to 250) - offset = 10 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - count = False # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) - try: - # Access Request Approvers - - results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id=access_request_id) - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count) - print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) -- path: /access-request-approvals/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#list-completed-approvals - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Completed Access Request Approvals List - - try { - Get-V2025CompletedApprovals - - # Below is a request that includes all optional parameters - # Get-V2025CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompletedApprovals" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#list-completed-approvals - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.completed_approval import CompletedApproval - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '2c91808568c529c60168cca6f90c1313' # str | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) - sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - try: - # Completed Access Request Approvals List - - results = AccessRequestApprovalsApi(api_client).list_completed_approvals() - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) - print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) -- path: /access-request-approvals/pending - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#list-pending-approvals - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Pending Access Request Approvals List - - try { - Get-V2025PendingApprovals - - # Below is a request that includes all optional parameters - # Get-V2025PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingApprovals" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#list-pending-approvals - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.pending_approval import PendingApproval - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '2c91808568c529c60168cca6f90c1313' # str | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) - sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - try: - # Pending Access Request Approvals List - - results = AccessRequestApprovalsApi(api_client).list_pending_approvals() - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) - print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) -- path: /access-request-approvals/{approvalId}/reject - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#reject-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $CommentDto = @" - { - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - } - "@ - - # Reject Access Request Approval - - try { - $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Deny-V2025AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - - # Below is a request that includes all optional parameters - # Deny-V2025AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025AccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#reject-access-request - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.comment_dto import CommentDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - comment_dto = '''{ - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - }''' # CommentDto | Reviewer's comment. - try: - # Reject Access Request Approval - new_comment_dto = CommentDto.from_json(comment_dto) - results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id=approval_id, comment_dto=new_comment_dto) - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto) - print("The response of AccessRequestApprovalsApi->reject_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) -- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-identity-metrics#get-access-request-identity-metrics - source: | - $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. - $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. - $Type = "ENTITLEMENT" # String | Requested access item's type. - - # Return access request identity metrics - - try { - Get-V2025AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestIdentityMetrics" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-identity-metrics#get-access-request-identity-metrics - source: | - from sailpoint.v2025.api.access_request_identity_metrics_api import AccessRequestIdentityMetricsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_id = '7025c863-c270-4ba6-beea-edf3cb091573' # str | Manager's identity ID. # str | Manager's identity ID. - requested_object_id = '2db501be-f0fb-4cc5-a695-334133c52891' # str | Requested access item's ID. # str | Requested access item's ID. - type = 'ENTITLEMENT' # str | Requested access item's type. # str | Requested access item's type. - try: - # Return access request identity metrics - - results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id=identity_id, requested_object_id=requested_object_id, type=type) - # Below is a request that includes all optional parameters - # results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type) - print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) -- path: /access-request-approvals/bulk-approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#approve-bulk-access-request - source: | - $BulkApproveAccessRequest = @" - { - "comment" : "I approve these request items", - "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] - } - "@ - - # Bulk Approve Access Request - - try { - $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest - Approve-V2025BulkAccessRequest -BulkApproveAccessRequest $Result - - # Below is a request that includes all optional parameters - # Approve-V2025BulkAccessRequest -BulkApproveAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025BulkAccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#approve-bulk-access-request - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.bulk_approve_access_request import BulkApproveAccessRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - bulk_approve_access_request = '''{ - "comment" : "I approve these request items", - "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] - }''' # BulkApproveAccessRequest | - try: - # Bulk Approve Access Request - new_bulk_approve_access_request = BulkApproveAccessRequest.from_json(bulk_approve_access_request) - results = AccessRequestsApi(api_client).approve_bulk_access_request(bulk_approve_access_request=new_bulk_approve_access_request) - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).approve_bulk_access_request(new_bulk_approve_access_request) - print("The response of AccessRequestsApi->approve_bulk_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->approve_bulk_access_request: %s\n" % e) -- path: /access-requests/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#cancel-access-request - source: | - $CancelAccessRequest = @" - { - "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I requested this role by mistake." - } - "@ - - # Cancel Access Request - - try { - $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest - Suspend-V2025AccessRequest -CancelAccessRequest $Result - - # Below is a request that includes all optional parameters - # Suspend-V2025AccessRequest -CancelAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025AccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#cancel-access-request - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.cancel_access_request import CancelAccessRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - cancel_access_request = '''{ - "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I requested this role by mistake." - }''' # CancelAccessRequest | - try: - # Cancel Access Request - new_cancel_access_request = CancelAccessRequest.from_json(cancel_access_request) - results = AccessRequestsApi(api_client).cancel_access_request(cancel_access_request=new_cancel_access_request) - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request) - print("The response of AccessRequestsApi->cancel_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) -- path: /access-requests/bulk-cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#cancel-access-request-in-bulk - source: | - $BulkCancelAccessRequest = @" - { - "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], - "comment" : "I requested this role by mistake." - } - "@ - - # Bulk Cancel Access Request - - try { - $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest - Suspend-V2025AccessRequestInBulk -BulkCancelAccessRequest $Result - - # Below is a request that includes all optional parameters - # Suspend-V2025AccessRequestInBulk -BulkCancelAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025AccessRequestInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#cancel-access-request-in-bulk - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.bulk_cancel_access_request import BulkCancelAccessRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - bulk_cancel_access_request = '''{ - "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], - "comment" : "I requested this role by mistake." - }''' # BulkCancelAccessRequest | - try: - # Bulk Cancel Access Request - new_bulk_cancel_access_request = BulkCancelAccessRequest.from_json(bulk_cancel_access_request) - results = AccessRequestsApi(api_client).cancel_access_request_in_bulk(bulk_cancel_access_request=new_bulk_cancel_access_request) - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).cancel_access_request_in_bulk(new_bulk_cancel_access_request) - print("The response of AccessRequestsApi->cancel_access_request_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->cancel_access_request_in_bulk: %s\n" % e) -- path: /access-requests/close - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#close-access-request - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CloseAccessRequest = @" - { - "executionStatus" : "Terminated", - "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "completionStatus" : "Failure", - "message" : "The IdentityNow Administrator manually closed this request." - } - "@ - - # Close Access Request - - try { - $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest - Close-V2025AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result - - # Below is a request that includes all optional parameters - # Close-V2025AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2025AccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#close-access-request - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.close_access_request import CloseAccessRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - close_access_request = '''{ - "executionStatus" : "Terminated", - "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "completionStatus" : "Failure", - "message" : "The IdentityNow Administrator manually closed this request." - }''' # CloseAccessRequest | - try: - # Close Access Request - new_close_access_request = CloseAccessRequest.from_json(close_access_request) - results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental=x_sail_point_experimental, close_access_request=new_close_access_request) - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental, new_close_access_request) - print("The response of AccessRequestsApi->close_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) -- path: /access-requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#create-access-request - source: | - $AccessRequest = @" - { - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], - "clientMetadata" : { - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", - "requestedAppName" : "test-app" - }, - "requestType" : "GRANT_ACCESS", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - } ] - } - "@ - - # Submit Access Request - - try { - $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest - New-V2025AccessRequest -AccessRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025AccessRequest -AccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#create-access-request - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request import AccessRequest - from sailpoint.v2025.models.access_request_response import AccessRequestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], - "clientMetadata" : { - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", - "requestedAppName" : "test-app" - }, - "requestType" : "GRANT_ACCESS", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - } ] - }''' # AccessRequest | - try: - # Submit Access Request - new_access_request = AccessRequest.from_json(access_request) - results = AccessRequestsApi(api_client).create_access_request(access_request=new_access_request) - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).create_access_request(new_access_request) - print("The response of AccessRequestsApi->create_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) -- path: /access-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#get-access-request-config - source: | - - # Get Access Request Configuration - - try { - Get-V2025AccessRequestConfig - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#get-access-request-config - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_config import AccessRequestConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get Access Request Configuration - - results = AccessRequestsApi(api_client).get_access_request_config() - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).get_access_request_config() - print("The response of AccessRequestsApi->get_access_request_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) -- path: /access-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#set-access-request-config - source: | - $AccessRequestConfig = @" - { - "requestOnBehalfOfConfig" : { - "allowRequestOnBehalfOfEmployeeByManager" : true, - "allowRequestOnBehalfOfAnyoneByAnyone" : true - }, - "approvalReminderAndEscalationConfig" : { - "fallbackApproverRef" : { - "name" : "Alison Ferguso", - "id" : "5168015d32f890ca15812c9180835d2e", - "type" : "IDENTITY", - "email" : "alison.ferguso@identitysoon.com" - }, - "maxReminders" : 1, - "daysUntilEscalation" : 0, - "daysBetweenReminders" : 0 - }, - "autoApprovalEnabled" : true, - "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - }, - "reauthorizationEnabled" : true, - "approvalsMustBeExternal" : true - } - "@ - - # Update Access Request Configuration - - try { - $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig - Set-V2025AccessRequestConfig -AccessRequestConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025AccessRequestConfig -AccessRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025AccessRequestConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#set-access-request-config - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_config import AccessRequestConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - access_request_config = '''{ - "requestOnBehalfOfConfig" : { - "allowRequestOnBehalfOfEmployeeByManager" : true, - "allowRequestOnBehalfOfAnyoneByAnyone" : true - }, - "approvalReminderAndEscalationConfig" : { - "fallbackApproverRef" : { - "name" : "Alison Ferguso", - "id" : "5168015d32f890ca15812c9180835d2e", - "type" : "IDENTITY", - "email" : "alison.ferguso@identitysoon.com" - }, - "maxReminders" : 1, - "daysUntilEscalation" : 0, - "daysBetweenReminders" : 0 - }, - "autoApprovalEnabled" : true, - "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - }, - "reauthorizationEnabled" : true, - "approvalsMustBeExternal" : true - }''' # AccessRequestConfig | - try: - # Update Access Request Configuration - new_access_request_config = AccessRequestConfig.from_json(access_request_config) - results = AccessRequestsApi(api_client).set_access_request_config(access_request_config=new_access_request_config) - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).set_access_request_config(new_access_request_config) - print("The response of AccessRequestsApi->set_access_request_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) -- path: /access-request-status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#list-access-request-status - source: | - $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) - $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - - # Access Request Status - - try { - Get-V2025AccessRequestStatus - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#list-access-request-status - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.requested_item_status import RequestedItemStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - requested_by = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - regarding_identity = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - assigned_to = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - count = False # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) - limit = 250 # int | Max number of results to return. (optional) (default to 250) # int | Max number of results to return. (optional) (default to 250) - offset = 10 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - filters = 'accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) - request_state = 'request-state=EXECUTING' # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - try: - # Access Request Status - - results = AccessRequestsApi(api_client).list_access_request_status() - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) - print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) -- path: /access-request-administration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#list-administrators-access-request-status - source: | - $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) - $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - - # Access Request Status for Administrators - - try { - Get-V2025AdministratorsAccessRequestStatus - - # Below is a request that includes all optional parameters - # Get-V2025AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AdministratorsAccessRequestStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#list-administrators-access-request-status - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_admin_item_status import AccessRequestAdminItemStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - requested_by = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - regarding_identity = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - assigned_to = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - count = False # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) - limit = 250 # int | Max number of results to return. (optional) (default to 250) # int | Max number of results to return. (optional) (default to 250) - offset = 10 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - filters = 'accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) - request_state = 'request-state=EXECUTING' # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - try: - # Access Request Status for Administrators - - results = AccessRequestsApi(api_client).list_administrators_access_request_status() - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) - print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) -- path: /account-activities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-activities#get-account-activity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id - - # Get an Account Activity - - try { - Get-V2025AccountActivity -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccountActivity -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountActivity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-activities#get-account-activity - source: | - from sailpoint.v2025.api.account_activities_api import AccountActivitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_activity import AccountActivity - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id - try: - # Get an Account Activity - - results = AccountActivitiesApi(api_client).get_account_activity(id=id) - # Below is a request that includes all optional parameters - # results = AccountActivitiesApi(api_client).get_account_activity(id) - print("The response of AccountActivitiesApi->get_account_activity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) -- path: /account-activities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-activities#list-account-activities - source: | - $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) - - # List Account Activities - - try { - Get-V2025AccountActivities - - # Below is a request that includes all optional parameters - # Get-V2025AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountActivities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-activities#list-account-activities - source: | - from sailpoint.v2025.api.account_activities_api import AccountActivitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_activity import AccountActivity - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = '2c91808568c529c60168cca6f90c1313' # str | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - requested_by = '2c91808568c529c60168cca6f90c1313' # str | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - regarding_identity = '2c91808568c529c60168cca6f90c1313' # str | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'type eq \"Identity Refresh\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) - sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) - try: - # List Account Activities - - results = AccountActivitiesApi(api_client).list_account_activities() - # Below is a request that includes all optional parameters - # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) - print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) -- path: /account-aggregations/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-aggregations#get-account-aggregation-status - source: | - $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # In-progress Account Aggregation status - - try { - Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountAggregationStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-aggregations#get-account-aggregation-status - source: | - from sailpoint.v2025.api.account_aggregations_api import AccountAggregationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_aggregation_status import AccountAggregationStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # In-progress Account Aggregation status - - results = AccountAggregationsApi(api_client).get_account_aggregation_status(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccountAggregationsApi(api_client).get_account_aggregation_status(id, x_sail_point_experimental) - print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2025UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2025.api.account_usages_api import AccountUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) -- path: /accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#create-account - source: | - $AccountAttributesCreate = @" - { - "attributes" : { - "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - } - "@ - - # Create Account - - try { - $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate - New-V2025Account -AccountAttributesCreate $Result - - # Below is a request that includes all optional parameters - # New-V2025Account -AccountAttributesCreate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#create-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_attributes_create import AccountAttributesCreate - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_attributes_create = '''{ - "attributes" : { - "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - }''' # AccountAttributesCreate | - try: - # Create Account - new_account_attributes_create = AccountAttributesCreate.from_json(account_attributes_create) - results = AccountsApi(api_client).create_account(account_attributes_create=new_account_attributes_create) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).create_account(new_account_attributes_create) - print("The response of AccountsApi->create_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->create_account: %s\n" % e) -- path: /accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#list-accounts - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) - - # Accounts List - - try { - Get-V2025Accounts - - # Below is a request that includes all optional parameters - # Get-V2025Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Accounts" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#list-accounts - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account import Account - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - detail_level = 'FULL' # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) - filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) - try: - # Accounts List - - results = AccountsApi(api_client).list_accounts() - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) - print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->list_accounts: %s\n" % e) -- path: /accounts/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#delete-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - - # Delete Account - - try { - Remove-V2025Account -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Account -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#delete-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. - try: - # Delete Account - - results = AccountsApi(api_client).delete_account(id=id) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).delete_account(id) - print("The response of AccountsApi->delete_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->delete_account: %s\n" % e) -- path: /accounts/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#get-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - - # Account Details - - try { - Get-V2025Account -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Account -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#get-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account import Account - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. - try: - # Account Details - - results = AccountsApi(api_client).get_account(id=id) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).get_account(id) - print("The response of AccountsApi->get_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->get_account: %s\n" % e) -- path: /accounts/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#put-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - $AccountAttributes = @" - { - "attributes" : { - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - } - "@ - - # Update Account - - try { - $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes - Send-V2025Account -Id $Id -AccountAttributes $Result - - # Below is a request that includes all optional parameters - # Send-V2025Account -Id $Id -AccountAttributes $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#put-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_attributes import AccountAttributes - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. - account_attributes = '''{ - "attributes" : { - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - }''' # AccountAttributes | - try: - # Update Account - new_account_attributes = AccountAttributes.from_json(account_attributes) - results = AccountsApi(api_client).put_account(id=id, account_attributes=new_account_attributes) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).put_account(id, new_account_attributes) - print("The response of AccountsApi->put_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->put_account: %s\n" % e) -- path: /accounts/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#update-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"[{op=remove, path=/identityId}]"@ - - - # Update Account - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025Account -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025Account -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#update-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. - request_body = '''[{op=remove, path=/identityId}]''' # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - try: - # Update Account - new_request_body = RequestBody.from_json(request_body) - results = AccountsApi(api_client).update_account(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).update_account(id, new_request_body) - print("The response of AccountsApi->update_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /accounts/{id}/remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#delete-account-async - source: | - $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Remove Account - - try { - Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccountAsync" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#delete-account-async - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_result_dto import TaskResultDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Remove Account - - results = AccountsApi(api_client).delete_account_async(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).delete_account_async(id, x_sail_point_experimental) - print("The response of AccountsApi->delete_account_async:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) -- path: /accounts/{id}/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $AccountToggleRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } - "@ - - # Disable Account - - try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Disable-V2025Account -Id $Id -AccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Disable-V2025Account -Id $Id -AccountToggleRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#disable-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_toggle_request import AccountToggleRequest - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - account_toggle_request = '''{ - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - }''' # AccountToggleRequest | - try: - # Disable Account - new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request) - results = AccountsApi(api_client).disable_account(id=id, account_toggle_request=new_account_toggle_request) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).disable_account(id, new_account_toggle_request) - print("The response of AccountsApi->disable_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->disable_account: %s\n" % e) -- path: /identities-accounts/{id}/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-account-for-identity - source: | - $Id = "2c91808384203c2d018437e631158309" # String | The identity id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Disable IDN Account for Identity - - try { - Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025AccountForIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#disable-account-for-identity - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Disable IDN Account for Identity - - results = AccountsApi(api_client).disable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).disable_account_for_identity(id, x_sail_point_experimental) - print("The response of AccountsApi->disable_account_for_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) -- path: /identities-accounts/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-accounts-for-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentitiesAccountsBulkRequest = @" - { - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - } - "@ - - # Disable IDN Accounts for Identities - - try { - $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Disable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - - # Below is a request that includes all optional parameters - # Disable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025AccountsForIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#disable-accounts-for-identities - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse - from sailpoint.v2025.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identities_accounts_bulk_request = '''{ - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - }''' # IdentitiesAccountsBulkRequest | - try: - # Disable IDN Accounts for Identities - new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request) - results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) - print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) -- path: /accounts/{id}/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $AccountToggleRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } - "@ - - # Enable Account - - try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Enable-V2025Account -Id $Id -AccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Enable-V2025Account -Id $Id -AccountToggleRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#enable-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_toggle_request import AccountToggleRequest - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - account_toggle_request = '''{ - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - }''' # AccountToggleRequest | - try: - # Enable Account - new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request) - results = AccountsApi(api_client).enable_account(id=id, account_toggle_request=new_account_toggle_request) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).enable_account(id, new_account_toggle_request) - print("The response of AccountsApi->enable_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->enable_account: %s\n" % e) -- path: /identities-accounts/{id}/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-account-for-identity - source: | - $Id = "2c91808384203c2d018437e631158309" # String | The identity id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Enable IDN Account for Identity - - try { - Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025AccountForIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#enable-account-for-identity - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Enable IDN Account for Identity - - results = AccountsApi(api_client).enable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).enable_account_for_identity(id, x_sail_point_experimental) - print("The response of AccountsApi->enable_account_for_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) -- path: /identities-accounts/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-accounts-for-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentitiesAccountsBulkRequest = @" - { - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - } - "@ - - # Enable IDN Accounts for Identities - - try { - $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Enable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - - # Below is a request that includes all optional parameters - # Enable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025AccountsForIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#enable-accounts-for-identities - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse - from sailpoint.v2025.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identities_accounts_bulk_request = '''{ - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - }''' # IdentitiesAccountsBulkRequest | - try: - # Enable IDN Accounts for Identities - new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request) - results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) - print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) -- path: /accounts/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#get-account-entitlements - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Account Entitlements - - try { - Get-V2025AccountEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#get-account-entitlements - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Account Entitlements - - results = AccountsApi(api_client).get_account_entitlements(id=id) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) - print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) -- path: /accounts/{id}/reload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#submit-reload-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - - # Reload Account - - try { - Submit-V2025ReloadAccount -Id $Id - - # Below is a request that includes all optional parameters - # Submit-V2025ReloadAccount -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025ReloadAccount" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#submit-reload-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - try: - # Reload Account - - results = AccountsApi(api_client).submit_reload_account(id=id) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).submit_reload_account(id) - print("The response of AccountsApi->submit_reload_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) -- path: /accounts/{id}/unlock - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#unlock-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. - $AccountUnlockRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", - "unlockIDNAccount" : false - } - "@ - - # Unlock Account - - try { - $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest - Unlock-V2025Account -Id $Id -AccountUnlockRequest $Result - - # Below is a request that includes all optional parameters - # Unlock-V2025Account -Id $Id -AccountUnlockRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#unlock-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_unlock_request import AccountUnlockRequest - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. - account_unlock_request = '''{ - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", - "unlockIDNAccount" : false - }''' # AccountUnlockRequest | - try: - # Unlock Account - new_account_unlock_request = AccountUnlockRequest.from_json(account_unlock_request) - results = AccountsApi(api_client).unlock_account(id=id, account_unlock_request=new_account_unlock_request) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).unlock_account(id, new_account_unlock_request) - print("The response of AccountsApi->unlock_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->unlock_account: %s\n" % e) -- path: /discovered-applications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#get-discovered-applications - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) - $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) - - # Get Discovered Applications for Tenant - - try { - Get-V2025DiscoveredApplications - - # Below is a request that includes all optional parameters - # Get-V2025DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DiscoveredApplications" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/application-discovery#get-discovered-applications - source: | - from sailpoint.v2025.api.application_discovery_api import ApplicationDiscoveryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) - filter = 'name eq \"Okta\" and description co \"Okta\" and discoverySource in (\"csv\", \"Okta Saas\")' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) - try: - # Get Discovered Applications for Tenant - - results = ApplicationDiscoveryApi(api_client).get_discovered_applications() - # Below is a request that includes all optional parameters - # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) - print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) -- path: /manual-discover-applications-template - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#get-manual-discover-applications-csv-template - source: | - - # Download CSV Template for Discovery - - try { - Get-V2025ManualDiscoverApplicationsCsvTemplate - - # Below is a request that includes all optional parameters - # Get-V2025ManualDiscoverApplicationsCsvTemplate - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/application-discovery#get-manual-discover-applications-csv-template - source: | - from sailpoint.v2025.api.application_discovery_api import ApplicationDiscoveryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Download CSV Template for Discovery - - results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() - # Below is a request that includes all optional parameters - # results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() - print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) -- path: /manual-discover-applications - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#send-manual-discover-applications-csv-template - source: | - $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - - # Upload CSV to Discover Applications - - try { - Send-V2025ManualDiscoverApplicationsCsvTemplate -File $File - - # Below is a request that includes all optional parameters - # Send-V2025ManualDiscoverApplicationsCsvTemplate -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/application-discovery#send-manual-discover-applications-csv-template - source: | - from sailpoint.v2025.api.application_discovery_api import ApplicationDiscoveryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - file = None # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - try: - # Upload CSV to Discover Applications - - ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file=file) - # Below is a request that includes all optional parameters - # ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file) - except Exception as e: - print("Exception when calling ApplicationDiscoveryApi->send_manual_discover_applications_csv_template: %s\n" % e) -- path: /generic-approvals/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/approvals#get-approval - source: | - $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that is to be returned - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get an approval - - try { - Get-V2025Approval -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Approval -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approval" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/approvals#get-approval - source: | - from sailpoint.v2025.api.approvals_api import ApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.approval import Approval - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get an approval - - results = ApprovalsApi(api_client).get_approval(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = ApprovalsApi(api_client).get_approval(id, x_sail_point_experimental) - print("The response of ApprovalsApi->get_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) -- path: /generic-approvals - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/approvals#get-approvals - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Mine = $true # Boolean | Returns the list of approvals for the current caller (optional) - $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID (optional) - $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) - - # Get Approvals - - try { - Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approvals" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/approvals#get-approvals - source: | - from sailpoint.v2025.api.approvals_api import ApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.approval import Approval - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - mine = true # bool | Returns the list of approvals for the current caller (optional) # bool | Returns the list of approvals for the current caller (optional) - requester_id = '17e633e7d57e481569df76323169deb6a' # str | Returns the list of approvals for a given requester ID (optional) # str | Returns the list of approvals for a given requester ID (optional) - filters = 'filters=status eq PENDING' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) - try: - # Get Approvals - - results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters) - print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) -- path: /source-apps - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#create-source-app - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceAppCreateDto = @" - { - "name" : "my app", - "description" : "the source app for engineers", - "accountSource" : { - "name" : "ODS-AD-Source", - "id" : "2c9180827ca885d7017ca8ce28a000eb", - "type" : "SOURCE" - }, - "matchAllAccounts" : true - } - "@ - - # Create source app - - try { - $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto - New-V2025SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result - - # Below is a request that includes all optional parameters - # New-V2025SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#create-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app import SourceApp - from sailpoint.v2025.models.source_app_create_dto import SourceAppCreateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - source_app_create_dto = '''{ - "name" : "my app", - "description" : "the source app for engineers", - "accountSource" : { - "name" : "ODS-AD-Source", - "id" : "2c9180827ca885d7017ca8ce28a000eb", - "type" : "SOURCE" - }, - "matchAllAccounts" : true - }''' # SourceAppCreateDto | - try: - # Create source app - new_source_app_create_dto = SourceAppCreateDto.from_json(source_app_create_dto) - results = AppsApi(api_client).create_source_app(x_sail_point_experimental=x_sail_point_experimental, source_app_create_dto=new_source_app_create_dto) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).create_source_app(x_sail_point_experimental, new_source_app_create_dto) - print("The response of AppsApi->create_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->create_source_app: %s\n" % e) -- path: /source-apps - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-available-source-apps - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - - # List available source apps - - try { - Get-V2025AvailableSourceApps -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AvailableSourceApps" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-available-source-apps - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app import SourceApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - filters = 'name eq \"source app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - try: - # List available source apps - - results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) - print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) -- path: /source-apps/{id}/access-profiles/bulk-remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#delete-access-profiles-from-source-app-by-bulk - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @"[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]"@ - - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # Bulk remove access profiles from the specified source app - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2025AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-V2025AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfilesFromSourceAppByBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#delete-access-profiles-from-source-app-by-bulk - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile_details import AccessProfileDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]''' # List[str] | - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # Bulk remove access profiles from the specified source app - new_request_body = RequestBody.from_json(request_body) - results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit) - print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) -- path: /source-apps/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#delete-source-app - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete source app by ID - - try { - Remove-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#delete-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app import SourceApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete source app by ID - - results = AppsApi(api_client).delete_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).delete_source_app(id, x_sail_point_experimental) - print("The response of AppsApi->delete_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->delete_source_app: %s\n" % e) -- path: /source-apps/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#get-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get source app by ID - - try { - Get-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#get-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app import SourceApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get source app by ID - - results = AppsApi(api_client).get_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).get_source_app(id, x_sail_point_experimental) - print("The response of AppsApi->get_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->get_source_app: %s\n" % e) -- path: /source-apps/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#patch-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch source app by ID - - try { - Update-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#patch-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.source_app_patch_dto import SourceAppPatchDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]''' # List[JsonPatchOperation] | (optional) - try: - # Patch source app by ID - - results = AppsApi(api_client).patch_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).patch_source_app(id, x_sail_point_experimental, new_json_patch_operation) - print("The response of AppsApi->patch_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->patch_source_app: %s\n" % e) -- path: /source-apps/{id}/access-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-access-profiles-for-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "name eq "developer access profile"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List access profiles for the specified source app - - try { - Get-V2025AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfilesForSourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-access-profiles-for-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile_details import AccessProfileDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'name eq \"developer access profile\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - try: - # List access profiles for the specified source app - - results = AppsApi(api_client).list_access_profiles_for_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters) - print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) -- path: /source-apps/all - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-all-source-app - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - $Filters = "enabled eq true" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) - - # List all source apps - - try { - Get-V2025AllSourceApp -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AllSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllSourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-all-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app import SourceApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - filters = 'enabled eq true' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) - try: - # List all source apps - - results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) - print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) -- path: /user-apps/all - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-all-user-apps - source: | - $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List all user apps - - try { - Get-V2025AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllUserApps" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-all-user-apps - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.user_app import UserApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List all user apps - - results = AppsApi(api_client).list_all_user_apps(filters=filters, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) - print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) -- path: /source-apps/assigned - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-assigned-source-app - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) - $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - - # List assigned source apps - - try { - Get-V2025AssignedSourceApp -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AssignedSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AssignedSourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-assigned-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app import SourceApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) - filters = 'name eq \"source app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - try: - # List assigned source apps - - results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) - print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) -- path: /user-apps/{id}/available-accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-available-accounts-for-user-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List available accounts for user app - - try { - Get-V2025AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AvailableAccountsForUserApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-available-accounts-for-user-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.app_account_details import AppAccountDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List available accounts for user app - - results = AppsApi(api_client).list_available_accounts_for_user_app(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count) - print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) -- path: /user-apps - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-owned-user-apps - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) - - # List owned user apps - - try { - Get-V2025OwnedUserApps -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025OwnedUserApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OwnedUserApps" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-owned-user-apps - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.user_app import UserApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) - try: - # List owned user apps - - results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) - print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) -- path: /user-apps/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#patch-user-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch user app by ID - - try { - Update-V2025UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025UserApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#patch-user-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.user_app import UserApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | (optional) - try: - # Patch user app by ID - - results = AppsApi(api_client).patch_user_app(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).patch_user_app(id, x_sail_point_experimental, new_json_patch_operation) - print("The response of AppsApi->patch_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->patch_user_app: %s\n" % e) -- path: /source-apps/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#update-source-apps-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceAppBulkUpdateRequest = @" - { - "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : false - }, { - "op" : "replace", - "path" : "/matchAllAccounts", - "value" : false - } ] - } - "@ - - # Bulk update source apps - - try { - Update-V2025SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -SourceAppBulkUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceAppsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#update-source-apps-in-bulk - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app_bulk_update_request import SourceAppBulkUpdateRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - source_app_bulk_update_request = '''{ - "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : false - }, { - "op" : "replace", - "path" : "/matchAllAccounts", - "value" : false - } ] - }''' # SourceAppBulkUpdateRequest | (optional) - try: - # Bulk update source apps - - AppsApi(api_client).update_source_apps_in_bulk(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # AppsApi(api_client).update_source_apps_in_bulk(x_sail_point_experimental, new_source_app_bulk_update_request) - except Exception as e: - print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) -- path: /auth-profiles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#get-profile-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - - # Get Auth Profile - - try { - Get-V2025ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProfileConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/auth-profile#get-profile-config - source: | - from sailpoint.v2025.api.auth_profile_api import AuthProfileApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.auth_profile import AuthProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. - try: - # Get Auth Profile - - results = AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental=x_sail_point_experimental, id=id) - # Below is a request that includes all optional parameters - # results = AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental, id) - print("The response of AuthProfileApi->get_profile_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) -- path: /auth-profiles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#patch-profile-config - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Auth Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProfileConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/auth-profile#patch-profile-config - source: | - from sailpoint.v2025.api.auth_profile_api import AuthProfileApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.auth_profile import AuthProfile - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | - try: - # Patch a specified Auth Profile - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = AuthProfileApi(api_client).patch_profile_config(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = AuthProfileApi(api_client).patch_profile_config(id, x_sail_point_experimental, new_json_patch_operation) - print("The response of AuthProfileApi->patch_profile_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) -- path: /auth-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#get-profile-config-list - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get list of Auth Profiles - - try { - Get-V2025ProfileConfigList -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ProfileConfigList -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProfileConfigList" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/auth-profile#get-profile-config-list - source: | - from sailpoint.v2025.api.auth_profile_api import AuthProfileApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.auth_profile_summary import AuthProfileSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get list of Auth Profiles - - results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental) - print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) -- path: /auth-users/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-users#get-auth-user - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - - # Auth User Details - - try { - Get-V2025AuthUser -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AuthUser -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthUser" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/auth-users#get-auth-user - source: | - from sailpoint.v2025.api.auth_users_api import AuthUsersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.auth_user import AuthUser - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID - try: - # Auth User Details - - results = AuthUsersApi(api_client).get_auth_user(id=id) - # Below is a request that includes all optional parameters - # results = AuthUsersApi(api_client).get_auth_user(id) - print("The response of AuthUsersApi->get_auth_user:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) -- path: /auth-users/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-users#patch-auth-user - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Auth User Update - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025AuthUser -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025AuthUser -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthUser" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/auth-users#patch-auth-user - source: | - from sailpoint.v2025.api.auth_users_api import AuthUsersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.auth_user import AuthUser - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID - json_patch_operation = '''[{op=replace, path=/capabilities, value=[ORG_ADMIN]}]''' # List[JsonPatchOperation] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - try: - # Auth User Update - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = AuthUsersApi(api_client).patch_auth_user(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = AuthUsersApi(api_client).patch_auth_user(id, new_json_patch_operation) - print("The response of AuthUsersApi->patch_auth_user:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) -- path: /brandings - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#create-branding-item - source: | - $Name = "MyName" # String | name of branding item - $ProductName = "MyProductName" # String | product name - $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) - $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) - $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) - $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) - $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) - $FileStandard = # System.IO.FileInfo | png file with logo (optional) - - # Create a branding item - - try { - New-V2025BrandingItem -Name $Name -ProductName $ProductName - - # Below is a request that includes all optional parameters - # New-V2025BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025BrandingItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/branding#create-branding-item - source: | - from sailpoint.v2025.api.branding_api import BrandingApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.branding_item import BrandingItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'name_example' # str | name of branding item # str | name of branding item - product_name = 'product_name_example' # str | product name # str | product name - action_button_color = 'action_button_color_example' # str | hex value of color for action button (optional) # str | hex value of color for action button (optional) - active_link_color = 'active_link_color_example' # str | hex value of color for link (optional) # str | hex value of color for link (optional) - navigation_color = 'navigation_color_example' # str | hex value of color for navigation bar (optional) # str | hex value of color for navigation bar (optional) - email_from_address = 'email_from_address_example' # str | email from address (optional) # str | email from address (optional) - login_informational_message = 'login_informational_message_example' # str | login information message (optional) # str | login information message (optional) - file_standard = None # bytearray | png file with logo (optional) # bytearray | png file with logo (optional) - try: - # Create a branding item - - results = BrandingApi(api_client).create_branding_item(name=name, product_name=product_name) - # Below is a request that includes all optional parameters - # results = BrandingApi(api_client).create_branding_item(name, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard) - print("The response of BrandingApi->create_branding_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) -- path: /brandings - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#get-branding-list - source: | - - # List of branding items - - try { - Get-V2025BrandingList - - # Below is a request that includes all optional parameters - # Get-V2025BrandingList - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BrandingList" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/branding#get-branding-list - source: | - from sailpoint.v2025.api.branding_api import BrandingApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.branding_item import BrandingItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List of branding items - - results = BrandingApi(api_client).get_branding_list() - # Below is a request that includes all optional parameters - # results = BrandingApi(api_client).get_branding_list() - print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) -- path: /brandings/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#delete-branding - source: | - $Name = "default" # String | The name of the branding item to be deleted - - # Delete a branding item - - try { - Remove-V2025Branding -Name $Name - - # Below is a request that includes all optional parameters - # Remove-V2025Branding -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Branding" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/branding#delete-branding - source: | - from sailpoint.v2025.api.branding_api import BrandingApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'default' # str | The name of the branding item to be deleted # str | The name of the branding item to be deleted - try: - # Delete a branding item - - BrandingApi(api_client).delete_branding(name=name) - # Below is a request that includes all optional parameters - # BrandingApi(api_client).delete_branding(name) - except Exception as e: - print("Exception when calling BrandingApi->delete_branding: %s\n" % e) -- path: /brandings/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#get-branding - source: | - $Name = "default" # String | The name of the branding item to be retrieved - - # Get a branding item - - try { - Get-V2025Branding -Name $Name - - # Below is a request that includes all optional parameters - # Get-V2025Branding -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Branding" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/branding#get-branding - source: | - from sailpoint.v2025.api.branding_api import BrandingApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.branding_item import BrandingItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'default' # str | The name of the branding item to be retrieved # str | The name of the branding item to be retrieved - try: - # Get a branding item - - results = BrandingApi(api_client).get_branding(name=name) - # Below is a request that includes all optional parameters - # results = BrandingApi(api_client).get_branding(name) - print("The response of BrandingApi->get_branding:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling BrandingApi->get_branding: %s\n" % e) -- path: /brandings/{name} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#set-branding-item - source: | - $Name = "default" # String | The name of the branding item to be retrieved - $Name2 = "Name_example" # String | name of branding item - $ProductName = "MyProductName" # String | product name - $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) - $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) - $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) - $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) - $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) - $FileStandard = # System.IO.FileInfo | png file with logo (optional) - - # Update a branding item - - try { - Set-V2025BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName - - # Below is a request that includes all optional parameters - # Set-V2025BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025BrandingItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/branding#set-branding-item - source: | - from sailpoint.v2025.api.branding_api import BrandingApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.branding_item import BrandingItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'default' # str | The name of the branding item to be retrieved # str | The name of the branding item to be retrieved - name2 = 'name_example' # str | name of branding item # str | name of branding item - product_name = 'product_name_example' # str | product name # str | product name - action_button_color = 'action_button_color_example' # str | hex value of color for action button (optional) # str | hex value of color for action button (optional) - active_link_color = 'active_link_color_example' # str | hex value of color for link (optional) # str | hex value of color for link (optional) - navigation_color = 'navigation_color_example' # str | hex value of color for navigation bar (optional) # str | hex value of color for navigation bar (optional) - email_from_address = 'email_from_address_example' # str | email from address (optional) # str | email from address (optional) - login_informational_message = 'login_informational_message_example' # str | login information message (optional) # str | login information message (optional) - file_standard = None # bytearray | png file with logo (optional) # bytearray | png file with logo (optional) - try: - # Update a branding item - - results = BrandingApi(api_client).set_branding_item(name=name, name2=name2, product_name=product_name) - # Below is a request that includes all optional parameters - # results = BrandingApi(api_client).set_branding_item(name, name2, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard) - print("The response of BrandingApi->set_branding_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) -- path: /campaign-filters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#create-campaign-filter - source: | - $CampaignFilterDetails = @" - { - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - } - "@ - - # Create Campaign Filter - - try { - $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - New-V2025CampaignFilter -CampaignFilterDetails $Result - - # Below is a request that includes all optional parameters - # New-V2025CampaignFilter -CampaignFilterDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CampaignFilter" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaign-filters#create-campaign-filter - source: | - from sailpoint.v2025.api.certification_campaign_filters_api import CertificationCampaignFiltersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_filter_details import CampaignFilterDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - campaign_filter_details = '''{ - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - }''' # CampaignFilterDetails | - try: - # Create Campaign Filter - new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details) - results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(campaign_filter_details=new_campaign_filter_details) - # Below is a request that includes all optional parameters - # results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(new_campaign_filter_details) - print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) -- path: /campaign-filters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#list-campaign-filters - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) - - # List Campaign Filters - - try { - Get-V2025CampaignFilters - - # Below is a request that includes all optional parameters - # Get-V2025CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignFilters" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaign-filters#list-campaign-filters - source: | - from sailpoint.v2025.api.certification_campaign_filters_api import CertificationCampaignFiltersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_campaign_filters200_response import ListCampaignFilters200Response - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - start = 0 # int | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - include_system_filters = True # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to True) # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to True) - try: - # List Campaign Filters - - results = CertificationCampaignFiltersApi(api_client).list_campaign_filters() - # Below is a request that includes all optional parameters - # results = CertificationCampaignFiltersApi(api_client).list_campaign_filters(limit, start, include_system_filters) - print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) -- path: /campaign-filters/delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#delete-campaign-filters - source: | - $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. - $RequestBody = @""@ - - - # Deletes Campaign Filters - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2025CampaignFilters -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-V2025CampaignFilters -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CampaignFilters" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaign-filters#delete-campaign-filters - source: | - from sailpoint.v2025.api.certification_campaign_filters_api import CertificationCampaignFiltersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - request_body = '''['request_body_example']''' # List[str] | A json list of IDs of campaign filters to delete. - try: - # Deletes Campaign Filters - new_request_body = RequestBody.from_json(request_body) - CertificationCampaignFiltersApi(api_client).delete_campaign_filters(request_body=new_request_body) - # Below is a request that includes all optional parameters - # CertificationCampaignFiltersApi(api_client).delete_campaign_filters(new_request_body) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e) -- path: /campaign-filters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#get-campaign-filter-by-id - source: | - $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. - - # Get Campaign Filter by ID - - try { - Get-V2025CampaignFilterById -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CampaignFilterById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignFilterById" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaign-filters#get-campaign-filter-by-id - source: | - from sailpoint.v2025.api.certification_campaign_filters_api import CertificationCampaignFiltersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_filter_details import CampaignFilterDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter to be retrieved. # str | The ID of the campaign filter to be retrieved. - try: - # Get Campaign Filter by ID - - results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id) - print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) -- path: /campaign-filters/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#update-campaign-filter - source: | - $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. - $CampaignFilterDetails = @" - { - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - } - "@ - - # Updates a Campaign Filter - - try { - $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - Update-V2025CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result - - # Below is a request that includes all optional parameters - # Update-V2025CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CampaignFilter" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaign-filters#update-campaign-filter - source: | - from sailpoint.v2025.api.certification_campaign_filters_api import CertificationCampaignFiltersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_filter_details import CampaignFilterDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - filter_id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter being modified. # str | The ID of the campaign filter being modified. - campaign_filter_details = '''{ - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - }''' # CampaignFilterDetails | A campaign filter details with updated field values. - try: - # Updates a Campaign Filter - new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details) - results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id=filter_id, campaign_filter_details=new_campaign_filter_details) - # Below is a request that includes all optional parameters - # results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id, new_campaign_filter_details) - print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) -- path: /campaigns/{id}/complete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#complete-campaign - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. - $CampaignCompleteOptions = @" - { - "autoCompleteAction" : "REVOKE" - } - "@ - - # Complete a Campaign - - try { - Complete-V2025Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Complete-V2025Campaign -Id $Id -CampaignCompleteOptions $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025Campaign" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#complete-campaign - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_complete_options import CampaignCompleteOptions - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. - campaign_complete_options = '''{ - "autoCompleteAction" : "REVOKE" - }''' # CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) - try: - # Complete a Campaign - - results = CertificationCampaignsApi(api_client).complete_campaign(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).complete_campaign(id, new_campaign_complete_options) - print("The response of CertificationCampaignsApi->complete_campaign:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) -- path: /campaigns - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#create-campaign - source: | - $Campaign = @" - { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "reviewerId" : "2c91808568c529c60168cca6f90c1313", - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - } - "@ - - # Create a campaign - - try { - $Result = ConvertFrom-JsonToCampaign -Json $Campaign - New-V2025Campaign -Campaign $Result - - # Below is a request that includes all optional parameters - # New-V2025Campaign -Campaign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Campaign" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#create-campaign - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign import Campaign - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - campaign = '''{ - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "reviewerId" : "2c91808568c529c60168cca6f90c1313", - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - }''' # Campaign | - try: - # Create a campaign - new_campaign = Campaign.from_json(campaign) - results = CertificationCampaignsApi(api_client).create_campaign(campaign=new_campaign) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).create_campaign(new_campaign) - print("The response of CertificationCampaignsApi->create_campaign:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) -- path: /campaigns - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-active-campaigns - source: | - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) - - # List Campaigns - - try { - Get-V2025ActiveCampaigns - - # Below is a request that includes all optional parameters - # Get-V2025ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ActiveCampaigns" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-active-campaigns - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"Manager Campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) - try: - # List Campaigns - - results = CertificationCampaignsApi(api_client).get_active_campaigns() - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) - print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) -- path: /campaign-templates - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#create-campaign-template - source: | - $CampaignTemplate = @" - { - "ownerRef" : { - "name" : "Mister Manager", - "id" : "2c918086676d3e0601677611dbde220f", - "type" : "IDENTITY", - "email" : "mr.manager@example.com" - }, - "deadlineDuration" : "P2W", - "created" : "2020-03-05T22:44:00.364Z", - "scheduled" : false, - "name" : "Manager Campaign Template", - "description" : "Template for the annual manager campaign.", - "modified" : "2020-03-05T22:52:09.969Z", - "campaign" : { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "reviewerId" : "2c91808568c529c60168cca6f90c1313", - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - }, - "id" : "2c9079b270a266a60170a277bb960008" - } - "@ - - # Create a Campaign Template - - try { - $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate - New-V2025CampaignTemplate -CampaignTemplate $Result - - # Below is a request that includes all optional parameters - # New-V2025CampaignTemplate -CampaignTemplate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CampaignTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#create-campaign-template - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_template import CampaignTemplate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - campaign_template = '''{ - "ownerRef" : { - "name" : "Mister Manager", - "id" : "2c918086676d3e0601677611dbde220f", - "type" : "IDENTITY", - "email" : "mr.manager@example.com" - }, - "deadlineDuration" : "P2W", - "created" : "2020-03-05T22:44:00.364Z", - "scheduled" : false, - "name" : "Manager Campaign Template", - "description" : "Template for the annual manager campaign.", - "modified" : "2020-03-05T22:52:09.969Z", - "campaign" : { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "reviewerId" : "2c91808568c529c60168cca6f90c1313", - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - }, - "id" : "2c9079b270a266a60170a277bb960008" - }''' # CampaignTemplate | - try: - # Create a Campaign Template - new_campaign_template = CampaignTemplate.from_json(campaign_template) - results = CertificationCampaignsApi(api_client).create_campaign_template(campaign_template=new_campaign_template) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template) - print("The response of CertificationCampaignsApi->create_campaign_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) -- path: /campaign-templates - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-templates - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) - - # List Campaign Templates - - try { - Get-V2025CampaignTemplates - - # Below is a request that includes all optional parameters - # Get-V2025CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignTemplates" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-campaign-templates - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_template import CampaignTemplate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - filters = 'name eq \"manager template\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) - try: - # List Campaign Templates - - results = CertificationCampaignsApi(api_client).get_campaign_templates() - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) - print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) -- path: /campaign-templates/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#delete-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. - - # Delete a Campaign Template - - try { - Remove-V2025CampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025CampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CampaignTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#delete-campaign-template - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted. - try: - # Delete a Campaign Template - - CertificationCampaignsApi(api_client).delete_campaign_template(id=id) - # Below is a request that includes all optional parameters - # CertificationCampaignsApi(api_client).delete_campaign_template(id) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) -- path: /campaign-templates/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. - - # Get a Campaign Template - - try { - Get-V2025CampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-campaign-template - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_template import CampaignTemplate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID. - try: - # Get a Campaign Template - - results = CertificationCampaignsApi(api_client).get_campaign_template(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_campaign_template(id) - print("The response of CertificationCampaignsApi->get_campaign_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) -- path: /campaign-templates/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#patch-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update a Campaign Template - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025CampaignTemplate -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025CampaignTemplate -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CampaignTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#patch-campaign-template - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_template import CampaignTemplate - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}]''' # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - try: - # Update a Campaign Template - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = CertificationCampaignsApi(api_client).patch_campaign_template(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation) - print("The response of CertificationCampaignsApi->patch_campaign_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) -- path: /campaign-templates/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#delete-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. - - # Delete Campaign Template Schedule - - try { - Remove-V2025CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025CampaignTemplateSchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#delete-campaign-template-schedule - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template whose schedule is being deleted. # str | ID of the campaign template whose schedule is being deleted. - try: - # Delete Campaign Template Schedule - - CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id=id) - # Below is a request that includes all optional parameters - # CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) -- path: /campaign-templates/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. - - # Get Campaign Template Schedule - - try { - Get-V2025CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CampaignTemplateSchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-campaign-template-schedule - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.schedule import Schedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template whose schedule is being fetched. # str | ID of the campaign template whose schedule is being fetched. - try: - # Get Campaign Template Schedule - - results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id) - print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) -- path: /campaign-templates/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#set-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. - $Schedule = @" - { - "hours" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "months" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "timeZoneId" : "CST", - "days" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "expiration" : "2000-01-23T04:56:07.000+00:00", - "type" : "WEEKLY" - } - "@ - - # Set Campaign Template Schedule - - try { - Set-V2025CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Set-V2025CampaignTemplateSchedule -Id $Id -Schedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#set-campaign-template-schedule - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.schedule import Schedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template being scheduled. # str | ID of the campaign template being scheduled. - schedule = '''{ - "hours" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "months" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "timeZoneId" : "CST", - "days" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "expiration" : "2000-01-23T04:56:07.000+00:00", - "type" : "WEEKLY" - }''' # Schedule | (optional) - try: - # Set Campaign Template Schedule - - CertificationCampaignsApi(api_client).set_campaign_template_schedule(id=id) - # Below is a request that includes all optional parameters - # CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, new_schedule) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) -- path: /campaigns/delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#delete-campaigns - source: | - $CampaignsDeleteRequest = @" - { - "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] - } - "@ - - # Delete Campaigns - - try { - $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest - Remove-V2025Campaigns -CampaignsDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025Campaigns -CampaignsDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Campaigns" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#delete-campaigns - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaigns_delete_request import CampaignsDeleteRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - campaigns_delete_request = '''{ - "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] - }''' # CampaignsDeleteRequest | IDs of the campaigns to delete. - try: - # Delete Campaigns - new_campaigns_delete_request = CampaignsDeleteRequest.from_json(campaigns_delete_request) - results = CertificationCampaignsApi(api_client).delete_campaigns(campaigns_delete_request=new_campaigns_delete_request) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request) - print("The response of CertificationCampaignsApi->delete_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) -- path: /campaigns/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - - # Get Campaign - - try { - Get-V2025Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Campaign -Id $Id -Detail $Detail - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Campaign" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-campaign - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign to be retrieved. # str | ID of the campaign to be retrieved. - detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - try: - # Get Campaign - - results = CertificationCampaignsApi(api_client).get_campaign(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_campaign(id, detail) - print("The response of CertificationCampaignsApi->get_campaign:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) -- path: /campaigns/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#update-campaign - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update a Campaign - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Campaign -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Campaign -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Campaign" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#update-campaign - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.slim_campaign import SlimCampaign - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. - json_patch_operation = '''[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]''' # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - try: - # Update a Campaign - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = CertificationCampaignsApi(api_client).update_campaign(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation) - print("The response of CertificationCampaignsApi->update_campaign:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) -- path: /campaigns/{id}/reports - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-reports - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. - - # Get Campaign Reports - - try { - Get-V2025CampaignReports -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CampaignReports -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignReports" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-campaign-reports - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_report import CampaignReport - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign whose reports are being fetched. # str | ID of the campaign whose reports are being fetched. - try: - # Get Campaign Reports - - results = CertificationCampaignsApi(api_client).get_campaign_reports(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) - print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) -- path: /campaigns/reports-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-reports-config - source: | - - # Get Campaign Reports Configuration - - try { - Get-V2025CampaignReportsConfig - - # Below is a request that includes all optional parameters - # Get-V2025CampaignReportsConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignReportsConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-campaign-reports-config - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_reports_config import CampaignReportsConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get Campaign Reports Configuration - - results = CertificationCampaignsApi(api_client).get_campaign_reports_config() - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_campaign_reports_config() - print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) -- path: /campaigns/reports-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#set-campaign-reports-config - source: | - $CampaignReportsConfig = @" - { - "identityAttributeColumns" : [ "firstname", "lastname" ] - } - "@ - - # Set Campaign Reports Configuration - - try { - $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig - Set-V2025CampaignReportsConfig -CampaignReportsConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025CampaignReportsConfig -CampaignReportsConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025CampaignReportsConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#set-campaign-reports-config - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_reports_config import CampaignReportsConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - campaign_reports_config = '''{ - "identityAttributeColumns" : [ "firstname", "lastname" ] - }''' # CampaignReportsConfig | Campaign report configuration. - try: - # Set Campaign Reports Configuration - new_campaign_reports_config = CampaignReportsConfig.from_json(campaign_reports_config) - results = CertificationCampaignsApi(api_client).set_campaign_reports_config(campaign_reports_config=new_campaign_reports_config) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config) - print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) -- path: /campaigns/{id}/reassign - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#move - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID - $AdminReviewReassign = @" - { - "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], - "reason" : "reassigned for some reason", - "reassignTo" : { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "IDENTITY" - } - } - "@ - - # Reassign Certifications - - try { - $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign - Move-V2025 -Id $Id -AdminReviewReassign $Result - - # Below is a request that includes all optional parameters - # Move-V2025 -Id $Id -AdminReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2025" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#move - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.admin_review_reassign import AdminReviewReassign - from sailpoint.v2025.models.certification_task import CertificationTask - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification campaign ID # str | The certification campaign ID - admin_review_reassign = '''{ - "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], - "reason" : "reassigned for some reason", - "reassignTo" : { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "IDENTITY" - } - }''' # AdminReviewReassign | - try: - # Reassign Certifications - new_admin_review_reassign = AdminReviewReassign.from_json(admin_review_reassign) - results = CertificationCampaignsApi(api_client).move(id=id, admin_review_reassign=new_admin_review_reassign) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign) - print("The response of CertificationCampaignsApi->move:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) -- path: /campaigns/{id}/activate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-campaign - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. - $ActivateCampaignOptions = @" - { - "timeZone" : "-05:00" - } - "@ - - # Activate a Campaign - - try { - Start-V2025Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025Campaign -Id $Id -ActivateCampaignOptions $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025Campaign" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#start-campaign - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.activate_campaign_options import ActivateCampaignOptions - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. - activate_campaign_options = '''{ - "timeZone" : "-05:00" - }''' # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) - try: - # Activate a Campaign - - results = CertificationCampaignsApi(api_client).start_campaign(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).start_campaign(id, new_activate_campaign_options) - print("The response of CertificationCampaignsApi->start_campaign:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) -- path: /campaigns/{id}/run-remediation-scan - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-campaign-remediation-scan - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. - - # Run Campaign Remediation Scan - - try { - Start-V2025CampaignRemediationScan -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025CampaignRemediationScan -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025CampaignRemediationScan" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#start-campaign-remediation-scan - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign the remediation scan is being run for. # str | ID of the campaign the remediation scan is being run for. - try: - # Run Campaign Remediation Scan - - results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id) - print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) -- path: /campaigns/{id}/run-report/{type} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-campaign-report - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. - $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. - - # Run Campaign Report - - try { - Start-V2025CampaignReport -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Start-V2025CampaignReport -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025CampaignReport" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#start-campaign-report - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_type import ReportType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign the report is being run for. # str | ID of the campaign the report is being run for. - type = sailpoint.v2025.ReportType() # ReportType | Type of the report to run. # ReportType | Type of the report to run. - try: - # Run Campaign Report - - results = CertificationCampaignsApi(api_client).start_campaign_report(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).start_campaign_report(id, type) - print("The response of CertificationCampaignsApi->start_campaign_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) -- path: /campaign-templates/{id}/generate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-generate-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. - - # Generate a Campaign from Template - - try { - Start-V2025GenerateCampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025GenerateCampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025GenerateCampaignTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#start-generate-campaign-template - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_reference import CampaignReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template to use for generation. # str | ID of the campaign template to use for generation. - try: - # Generate a Campaign from Template - - results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id) - print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2025IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2025IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2025IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummaries" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) -- path: /certification-tasks/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-certification-task - source: | - $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID - - # Certification Task by ID - - try { - Get-V2025CertificationTask -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CertificationTask -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CertificationTask" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#get-certification-task - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_task import CertificationTask - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '63b32151-26c0-42f4-9299-8898dc1c9daa' # str | The task ID # str | The task ID - try: - # Certification Task by ID - - results = CertificationsApi(api_client).get_certification_task(id=id) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).get_certification_task(id) - print("The response of CertificationsApi->get_certification_task:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) -- path: /certifications/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-identity-certification - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id - - # Identity Certification by ID - - try { - Get-V2025IdentityCertification -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityCertification -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityCertification" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#get-identity-certification - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_certification_dto import IdentityCertificationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id - try: - # Identity Certification by ID - - results = CertificationsApi(api_client).get_identity_certification(id=id) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).get_identity_certification(id) - print("The response of CertificationsApi->get_identity_certification:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e) -- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-identity-certification-item-permissions - source: | - $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID - $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Permissions for Entitlement Certification Item - - try { - Get-V2025IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId - - # Below is a request that includes all optional parameters - # Get-V2025IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityCertificationItemPermissions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#get-identity-certification-item-permissions - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.permission_dto import PermissionDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - certification_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - item_id = '2c91808671bcbab40171bd945d961227' # str | The certification item ID # str | The certification item ID - filters = 'target eq \"SYS.OBJAUTH2\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Permissions for Entitlement Certification Item - - results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id=certification_id, item_id=item_id) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) - print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) -- path: /certification-tasks - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-pending-certification-tasks - source: | - $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) - - # List of Pending Certification Tasks - - try { - Get-V2025PendingCertificationTasks - - # Below is a request that includes all optional parameters - # Get-V2025PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingCertificationTasks" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#get-pending-certification-tasks - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_task import CertificationTask - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - reviewer_identity = 'Ada.1de82e55078344' # str | The ID of reviewer identity. *me* indicates the current user. (optional) # str | The ID of reviewer identity. *me* indicates the current user. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'type eq \"ADMIN_REASSIGN\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) - try: - # List of Pending Certification Tasks - - results = CertificationsApi(api_client).get_pending_certification_tasks() - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) - print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) -- path: /certifications/{id}/reviewers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#list-certification-reviewers - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) - - # List of Reviewers for certification - - try { - Get-V2025CertificationReviewers -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CertificationReviewers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#list-certification-reviewers - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"Bob\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) - try: - # List of Reviewers for certification - - results = CertificationsApi(api_client).list_certification_reviewers(id=id) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) - print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) -- path: /certifications/{id}/access-review-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#list-identity-access-review-items - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) - $Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) - $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) - $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) - - # List of Access Review Items - - try { - Get-V2025IdentityAccessReviewItems -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessReviewItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#list-identity-access-review-items - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_review_item import AccessReviewItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name,-accessProfile.sourceName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) - entitlements = 'identityEntitlement' # str | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) - access_profiles = 'accessProfile1' # str | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) - roles = 'userRole' # str | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) - try: - # List of Access Review Items - - results = CertificationsApi(api_client).list_identity_access_review_items(id=id) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) - print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) -- path: /certifications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#list-identity-certifications - source: | - $ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) - $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) - - # List Identity Campaign Certifications - - try { - Get-V2025IdentityCertifications - - # Below is a request that includes all optional parameters - # Get-V2025IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityCertifications" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#list-identity-certifications - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_certification_dto import IdentityCertificationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - reviewer_identity = 'me' # str | Reviewer's identity. *me* indicates the current user. (optional) # str | Reviewer's identity. *me* indicates the current user. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) - sorters = 'name,due' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) - try: - # List Identity Campaign Certifications - - results = CertificationsApi(api_client).list_identity_certifications() - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) - print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) -- path: /certifications/{id}/decide - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#make-identity-decision - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions - $ReviewDecision = @"{ - "comments" : "This user no longer needs access to this source", - "decision" : "APPROVE", - "proposedEndDate" : "2017-07-11T18:45:37.098Z", - "recommendation" : { - "reasons" : [ "Reason 1", "Reason 2" ], - "recommendation" : "recommendation", - "timestamp" : "2020-06-01T13:49:37.385Z" - }, - "id" : "ef38f94347e94562b5bb8424a56397d8", - "bulk" : true - }"@ - - - # Decide on a Certification Item - - try { - $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision - Select-V2025IdentityDecision -Id $Id -ReviewDecision $Result - - # Below is a request that includes all optional parameters - # Select-V2025IdentityDecision -Id $Id -ReviewDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2025IdentityDecision" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#make-identity-decision - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_certification_dto import IdentityCertificationDto - from sailpoint.v2025.models.review_decision import ReviewDecision - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the identity campaign certification on which to make decisions # str | The ID of the identity campaign certification on which to make decisions - review_decision = '''[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}]''' # List[ReviewDecision] | A non-empty array of decisions to be made. - try: - # Decide on a Certification Item - new_review_decision = ReviewDecision.from_json(review_decision) - results = CertificationsApi(api_client).make_identity_decision(id=id, review_decision=new_review_decision) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).make_identity_decision(id, new_review_decision) - print("The response of CertificationsApi->make_identity_decision:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) -- path: /certifications/{id}/reassign - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#reassign-identity-certifications - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $ReviewReassign = @" - { - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - } - "@ - - # Reassign Identities or Items - - try { - $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Invoke-V2025ReassignIdentityCertifications -Id $Id -ReviewReassign $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025ReassignIdentityCertifications -Id $Id -ReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ReassignIdentityCertifications" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#reassign-identity-certifications - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_certification_dto import IdentityCertificationDto - from sailpoint.v2025.models.review_reassign import ReviewReassign - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - review_reassign = '''{ - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - }''' # ReviewReassign | - try: - # Reassign Identities or Items - new_review_reassign = ReviewReassign.from_json(review_reassign) - results = CertificationsApi(api_client).reassign_identity_certifications(id=id, review_reassign=new_review_reassign) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).reassign_identity_certifications(id, new_review_reassign) - print("The response of CertificationsApi->reassign_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) -- path: /certifications/{id}/sign-off - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#sign-off-identity-certification - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - - # Finalize Identity Certification Decisions - - try { - Invoke-V2025SignOffIdentityCertification -Id $Id - - # Below is a request that includes all optional parameters - # Invoke-V2025SignOffIdentityCertification -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025SignOffIdentityCertification" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#sign-off-identity-certification - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_certification_dto import IdentityCertificationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - try: - # Finalize Identity Certification Decisions - - results = CertificationsApi(api_client).sign_off_identity_certification(id=id) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).sign_off_identity_certification(id) - print("The response of CertificationsApi->sign_off_identity_certification:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e) -- path: /certifications/{id}/reassign-async - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#submit-reassign-certs-async - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $ReviewReassign = @" - { - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - } - "@ - - # Reassign Certifications Asynchronously - - try { - $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Submit-V2025ReassignCertsAsync -Id $Id -ReviewReassign $Result - - # Below is a request that includes all optional parameters - # Submit-V2025ReassignCertsAsync -Id $Id -ReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025ReassignCertsAsync" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#submit-reassign-certs-async - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_task import CertificationTask - from sailpoint.v2025.models.review_reassign import ReviewReassign - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - review_reassign = '''{ - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - }''' # ReviewReassign | - try: - # Reassign Certifications Asynchronously - new_review_reassign = ReviewReassign.from_json(review_reassign) - results = CertificationsApi(api_client).submit_reassign_certs_async(id=id, review_reassign=new_review_reassign) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign) - print("The response of CertificationsApi->submit_reassign_certs_async:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) -- path: /configuration-hub/deploys - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-deploy - source: | - $DeployRequest = @" - { - "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" - } - "@ - - # Create a Deploy - - try { - $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest - New-V2025Deploy -DeployRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Deploy -DeployRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Deploy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#create-deploy - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.deploy_request import DeployRequest - from sailpoint.v2025.models.deploy_response import DeployResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - deploy_request = '''{ - "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" - }''' # DeployRequest | The deploy request body. - try: - # Create a Deploy - new_deploy_request = DeployRequest.from_json(deploy_request) - results = ConfigurationHubApi(api_client).create_deploy(deploy_request=new_deploy_request) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).create_deploy(new_deploy_request) - print("The response of ConfigurationHubApi->create_deploy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_deploy: %s\n" % e) -- path: /configuration-hub/deploys - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-deploys - source: | - - # List Deploys - - try { - Get-V2025Deploys - - # Below is a request that includes all optional parameters - # Get-V2025Deploys - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Deploys" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#list-deploys - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_deploys200_response import ListDeploys200Response - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Deploys - - results = ConfigurationHubApi(api_client).list_deploys() - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).list_deploys() - print("The response of ConfigurationHubApi->list_deploys:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->list_deploys: %s\n" % e) -- path: /configuration-hub/object-mappings/{sourceOrg} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-object-mapping - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingRequest = @" - { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - } - "@ - - # Creates an object mapping - - try { - $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest - New-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ObjectMapping" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#create-object-mapping - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.object_mapping_request import ObjectMappingRequest - from sailpoint.v2025.models.object_mapping_response import ObjectMappingResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_request = '''{ - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - }''' # ObjectMappingRequest | The object mapping request body. - try: - # Creates an object mapping - new_object_mapping_request = ObjectMappingRequest.from_json(object_mapping_request) - results = ConfigurationHubApi(api_client).create_object_mapping(source_org=source_org, object_mapping_request=new_object_mapping_request) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request) - print("The response of ConfigurationHubApi->create_object_mapping:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) -- path: /configuration-hub/object-mappings/{sourceOrg} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#get-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - - # Gets list of object mappings - - try { - Get-V2025ObjectMappings -SourceOrg $SourceOrg - - # Below is a request that includes all optional parameters - # Get-V2025ObjectMappings -SourceOrg $SourceOrg - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ObjectMappings" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#get-object-mappings - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.object_mapping_response import ObjectMappingResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - try: - # Gets list of object mappings - - results = ConfigurationHubApi(api_client).get_object_mappings(source_org=source_org) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) - print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) -- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingBulkCreateRequest = @" - { - "newObjectsMappings" : [ { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - }, { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - } ] - } - "@ - - # Bulk creates object mappings - - try { - $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest - New-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ObjectMappings" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#create-object-mappings - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.object_mapping_bulk_create_request import ObjectMappingBulkCreateRequest - from sailpoint.v2025.models.object_mapping_bulk_create_response import ObjectMappingBulkCreateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_bulk_create_request = '''{ - "newObjectsMappings" : [ { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - }, { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - } ] - }''' # ObjectMappingBulkCreateRequest | The bulk create object mapping request body. - try: - # Bulk creates object mappings - new_object_mapping_bulk_create_request = ObjectMappingBulkCreateRequest.from_json(object_mapping_bulk_create_request) - results = ConfigurationHubApi(api_client).create_object_mappings(source_org=source_org, object_mapping_bulk_create_request=new_object_mapping_bulk_create_request) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).create_object_mappings(source_org, new_object_mapping_bulk_create_request) - print("The response of ConfigurationHubApi->create_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) -- path: /configuration-hub/scheduled-actions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-scheduled-action - source: | - $ScheduledActionPayload = @" - { - "cronString" : "0 0 12 * * ?", - "timeZoneId" : "America/Chicago", - "startTime" : "2024-08-16T14:16:58.389Z", - "jobType" : "BACKUP", - "content" : { - "sourceTenant" : "tenant-name", - "draftId" : "9012b87d-48ca-439a-868f-2160001da8c3", - "name" : "Daily Backup", - "backupOptions" : { - "includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ], - "objectOptions" : { - "SOURCE" : { - "includedNames" : [ "Source1", "Source2" ] - }, - "ROLE" : { - "includedNames" : [ "Admin Role", "User Role" ] - } - } - }, - "sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2" - } - } - "@ - - # Create Scheduled Action - - try { - $Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload - New-V2025ScheduledAction -ScheduledActionPayload $Result - - # Below is a request that includes all optional parameters - # New-V2025ScheduledAction -ScheduledActionPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ScheduledAction" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#create-scheduled-action - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.scheduled_action_payload import ScheduledActionPayload - from sailpoint.v2025.models.scheduled_action_response import ScheduledActionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - scheduled_action_payload = '''{ - "cronString" : "0 0 12 * * ?", - "timeZoneId" : "America/Chicago", - "startTime" : "2024-08-16T14:16:58.389Z", - "jobType" : "BACKUP", - "content" : { - "sourceTenant" : "tenant-name", - "draftId" : "9012b87d-48ca-439a-868f-2160001da8c3", - "name" : "Daily Backup", - "backupOptions" : { - "includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ], - "objectOptions" : { - "SOURCE" : { - "includedNames" : [ "Source1", "Source2" ] - }, - "ROLE" : { - "includedNames" : [ "Admin Role", "User Role" ] - } - } - }, - "sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2" - } - }''' # ScheduledActionPayload | The scheduled action creation request body. - try: - # Create Scheduled Action - new_scheduled_action_payload = ScheduledActionPayload.from_json(scheduled_action_payload) - results = ConfigurationHubApi(api_client).create_scheduled_action(scheduled_action_payload=new_scheduled_action_payload) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).create_scheduled_action(new_scheduled_action_payload) - print("The response of ConfigurationHubApi->create_scheduled_action:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_scheduled_action: %s\n" % e) -- path: /configuration-hub/scheduled-actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-scheduled-actions - source: | - - # List Scheduled Actions - - try { - Get-V2025ScheduledActions - - # Below is a request that includes all optional parameters - # Get-V2025ScheduledActions - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ScheduledActions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#list-scheduled-actions - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.scheduled_action_response import ScheduledActionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Scheduled Actions - - results = ConfigurationHubApi(api_client).list_scheduled_actions() - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).list_scheduled_actions() - print("The response of ConfigurationHubApi->list_scheduled_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->list_scheduled_actions: %s\n" % e) -- path: /configuration-hub/backups/uploads - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-uploaded-configuration - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. - - # Upload a Configuration - - try { - New-V2025UploadedConfiguration -Data $Data -Name $Name - - # Below is a request that includes all optional parameters - # New-V2025UploadedConfiguration -Data $Data -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025UploadedConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#create-uploaded-configuration - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.backup_response import BackupResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - name = 'name_example' # str | Name that will be assigned to the uploaded configuration file. # str | Name that will be assigned to the uploaded configuration file. - try: - # Upload a Configuration - - results = ConfigurationHubApi(api_client).create_uploaded_configuration(data=data, name=name) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).create_uploaded_configuration(data, name) - print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) -- path: /configuration-hub/backups/uploads - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-uploaded-configurations - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - - # List Uploaded Configurations - - try { - Get-V2025UploadedConfigurations - - # Below is a request that includes all optional parameters - # Get-V2025UploadedConfigurations -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UploadedConfigurations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#list-uploaded-configurations - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.backup_response import BackupResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - filters = 'status eq \"COMPLETE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - try: - # List Uploaded Configurations - - results = ConfigurationHubApi(api_client).list_uploaded_configurations() - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) - print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) -- path: /configuration-hub/backups/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-backup - source: | - $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. - - # Delete a Backup - - try { - Remove-V2025Backup -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Backup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Backup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#delete-backup - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the backup to delete. # str | The id of the backup to delete. - try: - # Delete a Backup - - ConfigurationHubApi(api_client).delete_backup(id=id) - # Below is a request that includes all optional parameters - # ConfigurationHubApi(api_client).delete_backup(id) - except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_backup: %s\n" % e) -- path: /configuration-hub/drafts/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-draft - source: | - $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to delete. - - # Delete a draft - - try { - Remove-V2025Draft -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Draft -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Draft" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#delete-draft - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the draft to delete. # str | The id of the draft to delete. - try: - # Delete a draft - - ConfigurationHubApi(api_client).delete_draft(id=id) - # Below is a request that includes all optional parameters - # ConfigurationHubApi(api_client).delete_draft(id) - except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_draft: %s\n" % e) -- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-object-mapping - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. - - # Deletes an object mapping - - try { - Remove-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId - - # Below is a request that includes all optional parameters - # Remove-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ObjectMapping" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#delete-object-mapping - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_id = '3d6e0144-963f-4bd6-8d8d-d77b4e507ce4' # str | The id of the object mapping to be deleted. # str | The id of the object mapping to be deleted. - try: - # Deletes an object mapping - - ConfigurationHubApi(api_client).delete_object_mapping(source_org=source_org, object_mapping_id=object_mapping_id) - # Below is a request that includes all optional parameters - # ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id) - except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_object_mapping: %s\n" % e) -- path: /configuration-hub/scheduled-actions/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-scheduled-action - source: | - $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. - - # Delete Scheduled Action - - try { - Remove-V2025ScheduledAction -ScheduledActionId $ScheduledActionId - - # Below is a request that includes all optional parameters - # Remove-V2025ScheduledAction -ScheduledActionId $ScheduledActionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ScheduledAction" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#delete-scheduled-action - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - scheduled_action_id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the scheduled action. # str | The ID of the scheduled action. - try: - # Delete Scheduled Action - - ConfigurationHubApi(api_client).delete_scheduled_action(scheduled_action_id=scheduled_action_id) - # Below is a request that includes all optional parameters - # ConfigurationHubApi(api_client).delete_scheduled_action(scheduled_action_id) - except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_scheduled_action: %s\n" % e) -- path: /configuration-hub/scheduled-actions/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#update-scheduled-action - source: | - $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update Scheduled Action - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ScheduledAction" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#update-scheduled-action - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.scheduled_action_response import ScheduledActionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - scheduled_action_id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the scheduled action. # str | The ID of the scheduled action. - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSON Patch document containing the changes to apply to the scheduled action. - try: - # Update Scheduled Action - new_json_patch = JsonPatch.from_json(json_patch) - results = ConfigurationHubApi(api_client).update_scheduled_action(scheduled_action_id=scheduled_action_id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).update_scheduled_action(scheduled_action_id, new_json_patch) - print("The response of ConfigurationHubApi->update_scheduled_action:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->update_scheduled_action: %s\n" % e) -- path: /configuration-hub/backups/uploads/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-uploaded-configuration - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - - # Delete an Uploaded Configuration - - try { - Remove-V2025UploadedConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025UploadedConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025UploadedConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#delete-uploaded-configuration - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration. - try: - # Delete an Uploaded Configuration - - ConfigurationHubApi(api_client).delete_uploaded_configuration(id=id) - # Below is a request that includes all optional parameters - # ConfigurationHubApi(api_client).delete_uploaded_configuration(id) - except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) -- path: /configuration-hub/backups/uploads/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#get-uploaded-configuration - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - - # Get an Uploaded Configuration - - try { - Get-V2025UploadedConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025UploadedConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UploadedConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#get-uploaded-configuration - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.backup_response import BackupResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration. - try: - # Get an Uploaded Configuration - - results = ConfigurationHubApi(api_client).get_uploaded_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).get_uploaded_configuration(id) - print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) -- path: /configuration-hub/deploys/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#get-deploy - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. - - # Get a Deploy - - try { - Get-V2025Deploy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Deploy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Deploy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#get-deploy - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.deploy_response import DeployResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the deploy. # str | The id of the deploy. - try: - # Get a Deploy - - results = ConfigurationHubApi(api_client).get_deploy(id=id) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).get_deploy(id) - print("The response of ConfigurationHubApi->get_deploy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->get_deploy: %s\n" % e) -- path: /configuration-hub/backups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-backups - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - - # List Backups - - try { - Get-V2025Backups - - # Below is a request that includes all optional parameters - # Get-V2025Backups -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Backups" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#list-backups - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.backup_response1 import BackupResponse1 - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - filters = 'status eq \"COMPLETE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - try: - # List Backups - - results = ConfigurationHubApi(api_client).list_backups() - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).list_backups(filters) - print("The response of ConfigurationHubApi->list_backups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) -- path: /configuration-hub/drafts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-drafts - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) - - # List Drafts - - try { - Get-V2025Drafts - - # Below is a request that includes all optional parameters - # Get-V2025Drafts -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Drafts" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#list-drafts - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.draft_response import DraftResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - filters = 'status eq \"COMPLETE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) - try: - # List Drafts - - results = ConfigurationHubApi(api_client).list_drafts() - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).list_drafts(filters) - print("The response of ConfigurationHubApi->list_drafts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) -- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#update-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingBulkPatchRequest = @" - { - "patches" : { - "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : true - } ], - "00bece34-f50d-4227-8878-76f620b5a971" : [ { - "op" : "replace", - "path" : "/targetValue", - "value" : "New Target Value" - } ] - } - } - "@ - - # Bulk updates object mappings - - try { - $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest - Update-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ObjectMappings" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#update-object-mappings - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest - from sailpoint.v2025.models.object_mapping_bulk_patch_response import ObjectMappingBulkPatchResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_bulk_patch_request = '''{ - "patches" : { - "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : true - } ], - "00bece34-f50d-4227-8878-76f620b5a971" : [ { - "op" : "replace", - "path" : "/targetValue", - "value" : "New Target Value" - } ] - } - }''' # ObjectMappingBulkPatchRequest | The object mapping request body. - try: - # Bulk updates object mappings - new_object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest.from_json(object_mapping_bulk_patch_request) - results = ConfigurationHubApi(api_client).update_object_mappings(source_org=source_org, object_mapping_bulk_patch_request=new_object_mapping_bulk_patch_request) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).update_object_mappings(source_org, new_object_mapping_bulk_patch_request) - print("The response of ConfigurationHubApi->update_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) -- path: /connector-customizers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#create-connector-customizer - source: | - $ConnectorCustomizerCreateRequest = @" - { - "name" : "My Custom Connector" - } - "@ - - # Create Connector Customizer - - try { - $Result = ConvertFrom-JsonToConnectorCustomizerCreateRequest -Json $ConnectorCustomizerCreateRequest - New-V2025ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ConnectorCustomizer" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-customizers#create-connector-customizer - source: | - from sailpoint.v2025.api.connector_customizers_api import ConnectorCustomizersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_customizer_create_request import ConnectorCustomizerCreateRequest - from sailpoint.v2025.models.connector_customizer_create_response import ConnectorCustomizerCreateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - connector_customizer_create_request = '''{ - "name" : "My Custom Connector" - }''' # ConnectorCustomizerCreateRequest | Connector customizer to create. - try: - # Create Connector Customizer - new_connector_customizer_create_request = ConnectorCustomizerCreateRequest.from_json(connector_customizer_create_request) - results = ConnectorCustomizersApi(api_client).create_connector_customizer(connector_customizer_create_request=new_connector_customizer_create_request) - # Below is a request that includes all optional parameters - # results = ConnectorCustomizersApi(api_client).create_connector_customizer(new_connector_customizer_create_request) - print("The response of ConnectorCustomizersApi->create_connector_customizer:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorCustomizersApi->create_connector_customizer: %s\n" % e) -- path: /connector-customizers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#list-connector-customizers - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List All Connector Customizers - - try { - Get-V2025ConnectorCustomizers - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorCustomizers -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorCustomizers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-customizers#list-connector-customizers - source: | - from sailpoint.v2025.api.connector_customizers_api import ConnectorCustomizersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_customizers_response import ConnectorCustomizersResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List All Connector Customizers - - results = ConnectorCustomizersApi(api_client).list_connector_customizers() - # Below is a request that includes all optional parameters - # results = ConnectorCustomizersApi(api_client).list_connector_customizers(offset, limit) - print("The response of ConnectorCustomizersApi->list_connector_customizers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorCustomizersApi->list_connector_customizers: %s\n" % e) -- path: /connector-customizers/{id}/versions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#create-connector-customizer-version - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | The id of the connector customizer. - - # Creates a connector customizer version - - try { - New-V2025ConnectorCustomizerVersion -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025ConnectorCustomizerVersion -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ConnectorCustomizerVersion" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-customizers#create-connector-customizer-version - source: | - from sailpoint.v2025.api.connector_customizers_api import ConnectorCustomizersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_customizer_version_create_response import ConnectorCustomizerVersionCreateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | The id of the connector customizer. # str | The id of the connector customizer. - try: - # Creates a connector customizer version - - results = ConnectorCustomizersApi(api_client).create_connector_customizer_version(id=id) - # Below is a request that includes all optional parameters - # results = ConnectorCustomizersApi(api_client).create_connector_customizer_version(id) - print("The response of ConnectorCustomizersApi->create_connector_customizer_version:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorCustomizersApi->create_connector_customizer_version: %s\n" % e) -- path: /connector-customizers/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#delete-connector-customizer - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete. - - # Delete Connector Customizer - - try { - Remove-V2025ConnectorCustomizer -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ConnectorCustomizer -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ConnectorCustomizer" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-customizers#delete-connector-customizer - source: | - from sailpoint.v2025.api.connector_customizers_api import ConnectorCustomizersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to delete. # str | ID of the connector customizer to delete. - try: - # Delete Connector Customizer - - ConnectorCustomizersApi(api_client).delete_connector_customizer(id=id) - # Below is a request that includes all optional parameters - # ConnectorCustomizersApi(api_client).delete_connector_customizer(id) - except Exception as e: - print("Exception when calling ConnectorCustomizersApi->delete_connector_customizer: %s\n" % e) -- path: /connector-customizers/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#get-connector-customizer - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to get. - - # Get connector customizer - - try { - Get-V2025ConnectorCustomizer -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorCustomizer -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorCustomizer" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-customizers#get-connector-customizer - source: | - from sailpoint.v2025.api.connector_customizers_api import ConnectorCustomizersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_customizers_response import ConnectorCustomizersResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to get. # str | ID of the connector customizer to get. - try: - # Get connector customizer - - results = ConnectorCustomizersApi(api_client).get_connector_customizer(id=id) - # Below is a request that includes all optional parameters - # results = ConnectorCustomizersApi(api_client).get_connector_customizer(id) - print("The response of ConnectorCustomizersApi->get_connector_customizer:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorCustomizersApi->get_connector_customizer: %s\n" % e) -- path: /connector-customizers/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#put-connector-customizer - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to update. - $ConnectorCustomizerUpdateRequest = @" - { - "name" : "My Custom Connector" - } - "@ - - # Update Connector Customizer - - try { - Send-V2025ConnectorCustomizer -Id $Id - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorCustomizer -Id $Id -ConnectorCustomizerUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorCustomizer" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-customizers#put-connector-customizer - source: | - from sailpoint.v2025.api.connector_customizers_api import ConnectorCustomizersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_customizer_update_request import ConnectorCustomizerUpdateRequest - from sailpoint.v2025.models.connector_customizer_update_response import ConnectorCustomizerUpdateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to update. # str | ID of the connector customizer to update. - connector_customizer_update_request = '''{ - "name" : "My Custom Connector" - }''' # ConnectorCustomizerUpdateRequest | Connector rule with updated data. (optional) - try: - # Update Connector Customizer - - results = ConnectorCustomizersApi(api_client).put_connector_customizer(id=id) - # Below is a request that includes all optional parameters - # results = ConnectorCustomizersApi(api_client).put_connector_customizer(id, new_connector_customizer_update_request) - print("The response of ConnectorCustomizersApi->put_connector_customizer:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorCustomizersApi->put_connector_customizer: %s\n" % e) -- path: /connector-rules - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#create-connector-rule - source: | - $ConnectorRuleCreateRequest = @" - { - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "type" : "BuildMap" - } - "@ - - # Create Connector Rule - - try { - $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest - New-V2025ConnectorRule -ConnectorRuleCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ConnectorRule -ConnectorRuleCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-rule-management#create-connector-rule - source: | - from sailpoint.v2025.api.connector_rule_management_api import ConnectorRuleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_rule_create_request import ConnectorRuleCreateRequest - from sailpoint.v2025.models.connector_rule_response import ConnectorRuleResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - connector_rule_create_request = '''{ - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "type" : "BuildMap" - }''' # ConnectorRuleCreateRequest | Connector rule to create. - try: - # Create Connector Rule - new_connector_rule_create_request = ConnectorRuleCreateRequest.from_json(connector_rule_create_request) - results = ConnectorRuleManagementApi(api_client).create_connector_rule(connector_rule_create_request=new_connector_rule_create_request) - # Below is a request that includes all optional parameters - # results = ConnectorRuleManagementApi(api_client).create_connector_rule(new_connector_rule_create_request) - print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) -- path: /connector-rules - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#get-connector-rule-list - source: | - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Connector Rules - - try { - Get-V2025ConnectorRuleList - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorRuleList -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorRuleList" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-rule-management#get-connector-rule-list - source: | - from sailpoint.v2025.api.connector_rule_management_api import ConnectorRuleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_rule_response import ConnectorRuleResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Connector Rules - - results = ConnectorRuleManagementApi(api_client).get_connector_rule_list() - # Below is a request that includes all optional parameters - # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(limit, offset, count) - print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) -- path: /connector-rules/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#delete-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. - - # Delete Connector Rule - - try { - Remove-V2025ConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ConnectorRule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-rule-management#delete-connector-rule - source: | - from sailpoint.v2025.api.connector_rule_management_api import ConnectorRuleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete. # str | ID of the connector rule to delete. - try: - # Delete Connector Rule - - ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id) - # Below is a request that includes all optional parameters - # ConnectorRuleManagementApi(api_client).delete_connector_rule(id) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) -- path: /connector-rules/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#get-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. - - # Get Connector Rule - - try { - Get-V2025ConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorRule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-rule-management#get-connector-rule - source: | - from sailpoint.v2025.api.connector_rule_management_api import ConnectorRuleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_rule_response import ConnectorRuleResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to get. # str | ID of the connector rule to get. - try: - # Get Connector Rule - - results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id) - # Below is a request that includes all optional parameters - # results = ConnectorRuleManagementApi(api_client).get_connector_rule(id) - print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) -- path: /connector-rules/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#put-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update. - $ConnectorRuleUpdateRequest = @" - { - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", - "type" : "BuildMap" - } - "@ - - # Update Connector Rule - - try { - Send-V2025ConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorRule -Id $Id -ConnectorRuleUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-rule-management#put-connector-rule - source: | - from sailpoint.v2025.api.connector_rule_management_api import ConnectorRuleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_rule_response import ConnectorRuleResponse - from sailpoint.v2025.models.connector_rule_update_request import ConnectorRuleUpdateRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update. # str | ID of the connector rule to update. - connector_rule_update_request = '''{ - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", - "type" : "BuildMap" - }''' # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional) - try: - # Update Connector Rule - - results = ConnectorRuleManagementApi(api_client).put_connector_rule(id=id) - # Below is a request that includes all optional parameters - # results = ConnectorRuleManagementApi(api_client).put_connector_rule(id, new_connector_rule_update_request) - print("The response of ConnectorRuleManagementApi->put_connector_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->put_connector_rule: %s\n" % e) -- path: /connector-rules/validate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#test-connector-rule - source: | - $SourceCode = @" - { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - } - "@ - - # Validate Connector Rule - - try { - $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode - Test-V2025ConnectorRule -SourceCode $Result - - # Below is a request that includes all optional parameters - # Test-V2025ConnectorRule -SourceCode $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-rule-management#test-connector-rule - source: | - from sailpoint.v2025.api.connector_rule_management_api import ConnectorRuleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_rule_validation_response import ConnectorRuleValidationResponse - from sailpoint.v2025.models.source_code import SourceCode - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_code = '''{ - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }''' # SourceCode | Code to validate. - try: - # Validate Connector Rule - new_source_code = SourceCode.from_json(source_code) - results = ConnectorRuleManagementApi(api_client).test_connector_rule(source_code=new_source_code) - # Below is a request that includes all optional parameters - # results = ConnectorRuleManagementApi(api_client).test_connector_rule(new_source_code) - print("The response of ConnectorRuleManagementApi->test_connector_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->test_connector_rule: %s\n" % e) -- path: /connectors - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#create-custom-connector - source: | - $V3CreateConnectorDto = @" - { - "name" : "custom connector", - "directConnect" : true, - "className" : "sailpoint.connector.OpenConnectorAdapter", - "type" : "custom connector type", - "status" : "RELEASED" - } - "@ - - # Create Custom Connector - - try { - $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto - New-V2025CustomConnector -V3CreateConnectorDto $Result - - # Below is a request that includes all optional parameters - # New-V2025CustomConnector -V3CreateConnectorDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CustomConnector" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#create-custom-connector - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.v3_connector_dto import V3ConnectorDto - from sailpoint.v2025.models.v3_create_connector_dto import V3CreateConnectorDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - v3_create_connector_dto = '''{ - "name" : "custom connector", - "directConnect" : true, - "className" : "sailpoint.connector.OpenConnectorAdapter", - "type" : "custom connector type", - "status" : "RELEASED" - }''' # V3CreateConnectorDto | - try: - # Create Custom Connector - new_v3_create_connector_dto = V3CreateConnectorDto.from_json(v3_create_connector_dto) - results = ConnectorsApi(api_client).create_custom_connector(v3_create_connector_dto=new_v3_create_connector_dto) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto) - print("The response of ConnectorsApi->create_custom_connector:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) -- path: /connectors - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-list - source: | - $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector List - - try { - Get-V2025ConnectorList - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorList" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#get-connector-list - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.v3_connector_dto import V3ConnectorDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - filters = 'directConnect eq \"true\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) - try: - # Get Connector List - - results = ConnectorsApi(api_client).get_connector_list() - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) - print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) -- path: /connectors/{scriptName} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#delete-custom-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Delete Connector by Script Name - - try { - Remove-V2025CustomConnector -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Remove-V2025CustomConnector -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CustomConnector" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#delete-custom-connector - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - try: - # Delete Connector by Script Name - - ConnectorsApi(api_client).delete_custom_connector(script_name=script_name) - # Below is a request that includes all optional parameters - # ConnectorsApi(api_client).delete_custom_connector(script_name) - except Exception as e: - print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e) -- path: /connectors/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector by Script Name - - try { - Get-V2025Connector -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025Connector -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Connector" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#get-connector - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_detail import ConnectorDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) - try: - # Get Connector by Script Name - - results = ConnectorsApi(api_client).get_connector(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).get_connector(script_name, locale) - print("The response of ConnectorsApi->get_connector:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) -- path: /connectors/{scriptName} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#update-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Connector by Script Name - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Connector -ScriptName $ScriptName -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Connector -ScriptName $ScriptName -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Connector" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#update-connector - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_detail import ConnectorDetail - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of connector detail update operations - try: - # Update Connector by Script Name - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ConnectorsApi(api_client).update_connector(script_name=script_name, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).update_connector(script_name, new_json_patch_operation) - print("The response of ConnectorsApi->update_connector:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) -- path: /connectors/{scriptName}/correlation-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-correlation-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - - # Get Connector Correlation Configuration - - try { - Get-V2025ConnectorCorrelationConfig -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorCorrelationConfig -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorCorrelationConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#get-connector-correlation-config - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - try: - # Get Connector Correlation Configuration - - results = ConnectorsApi(api_client).get_connector_correlation_config(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).get_connector_correlation_config(script_name) - print("The response of ConnectorsApi->get_connector_correlation_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_correlation_config: %s\n" % e) -- path: /connectors/{scriptName}/correlation-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-correlation-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector correlation config xml file - - # Update Connector Correlation Configuration - - try { - Send-V2025ConnectorCorrelationConfig -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorCorrelationConfig -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorCorrelationConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#put-connector-correlation-config - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.update_detail import UpdateDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - file = None # bytearray | connector correlation config xml file # bytearray | connector correlation config xml file - try: - # Update Connector Correlation Configuration - - results = ConnectorsApi(api_client).put_connector_correlation_config(script_name=script_name, file=file) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).put_connector_correlation_config(script_name, file) - print("The response of ConnectorsApi->put_connector_correlation_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_correlation_config: %s\n" % e) -- path: /connectors/{scriptName}/source-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-source-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Get Connector Source Configuration - - try { - Get-V2025ConnectorSourceConfig -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorSourceConfig -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorSourceConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#get-connector-source-config - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - try: - # Get Connector Source Configuration - - results = ConnectorsApi(api_client).get_connector_source_config(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).get_connector_source_config(script_name) - print("The response of ConnectorsApi->get_connector_source_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) -- path: /connectors/{scriptName}/source-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-source-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector source config xml file - - # Update Connector Source Configuration - - try { - Send-V2025ConnectorSourceConfig -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorSourceConfig -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorSourceConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#put-connector-source-config - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.update_detail import UpdateDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - file = None # bytearray | connector source config xml file # bytearray | connector source config xml file - try: - # Update Connector Source Configuration - - results = ConnectorsApi(api_client).put_connector_source_config(script_name=script_name, file=file) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).put_connector_source_config(script_name, file) - print("The response of ConnectorsApi->put_connector_source_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) -- path: /connectors/{scriptName}/source-template - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-source-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Get Connector Source Template - - try { - Get-V2025ConnectorSourceTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorSourceTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorSourceTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#get-connector-source-template - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - try: - # Get Connector Source Template - - results = ConnectorsApi(api_client).get_connector_source_template(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).get_connector_source_template(script_name) - print("The response of ConnectorsApi->get_connector_source_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) -- path: /connectors/{scriptName}/source-template - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-source-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector source template xml file - - # Update Connector Source Template - - try { - Send-V2025ConnectorSourceTemplate -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorSourceTemplate -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorSourceTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#put-connector-source-template - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.update_detail import UpdateDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - file = None # bytearray | connector source template xml file # bytearray | connector source template xml file - try: - # Update Connector Source Template - - results = ConnectorsApi(api_client).put_connector_source_template(script_name=script_name, file=file) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).put_connector_source_template(script_name, file) - print("The response of ConnectorsApi->put_connector_source_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) -- path: /connectors/{scriptName}/translations/{locale} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-translations - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - - # Get Connector Translations - - try { - Get-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorTranslations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#get-connector-translations - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" - try: - # Get Connector Translations - - results = ConnectorsApi(api_client).get_connector_translations(script_name=script_name, locale=locale) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).get_connector_translations(script_name, locale) - print("The response of ConnectorsApi->get_connector_translations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) -- path: /connectors/{scriptName}/translations/{locale} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-translations - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - - # Update Connector Translations - - try { - Send-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorTranslations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#put-connector-translations - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.update_detail import UpdateDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" - try: - # Update Connector Translations - - results = ConnectorsApi(api_client).put_connector_translations(script_name=script_name, locale=locale) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).put_connector_translations(script_name, locale) - print("The response of ConnectorsApi->put_connector_translations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) -- path: /form-definitions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition - source: | - $Body = @" - { - "owner" : { - "name" : "Grant Smith", - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "formConditions" : [ { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - }, { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - } ], - "formInput" : [ { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - }, { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - } ], - "name" : "My form", - "description" : "My form description", - "usedBy" : [ { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - }, { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - } ], - "formElements" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - } ] - } - "@ - - # Creates a form definition. - - try { - New-V2025FormDefinition - - # Below is a request that includes all optional parameters - # New-V2025FormDefinition -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinition" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#create-form-definition - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_form_definition_request import CreateFormDefinitionRequest - from sailpoint.v2025.models.form_definition_response import FormDefinitionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - body = '''{ - "owner" : { - "name" : "Grant Smith", - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "formConditions" : [ { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - }, { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - } ], - "formInput" : [ { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - }, { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - } ], - "name" : "My form", - "description" : "My form description", - "usedBy" : [ { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - }, { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - } ], - "formElements" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - } ] - }''' # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) - try: - # Creates a form definition. - - results = CustomFormsApi(api_client).create_form_definition() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).create_form_definition(new_body) - print("The response of CustomFormsApi->create_form_definition:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) -- path: /form-definitions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-definitions-by-tenant - source: | - $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") - - # Export form definitions by tenant. - - try { - Search-V2025FormDefinitionsByTenant - - # Below is a request that includes all optional parameters - # Search-V2025FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormDefinitionsByTenant" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#search-form-definitions-by-tenant - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_form_definitions_by_tenant_response import ListFormDefinitionsByTenantResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - filters = 'name sw \"my form\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') - try: - # Export form definitions by tenant. - - results = CustomFormsApi(api_client).search_form_definitions_by_tenant() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).search_form_definitions_by_tenant(offset, limit, filters, sorters) - print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) -- path: /form-definitions/forms-action-dynamic-schema - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition-dynamic-schema - source: | - $Body = @" - { - "description" : "A description", - "attributes" : { - "formDefinitionId" : "00000000-0000-0000-0000-000000000000" - }, - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "action", - "versionNumber" : 1 - } - "@ - - # Generate JSON Schema dynamically. - - try { - New-V2025FormDefinitionDynamicSchema - - # Below is a request that includes all optional parameters - # New-V2025FormDefinitionDynamicSchema -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinitionDynamicSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#create-form-definition-dynamic-schema - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest - from sailpoint.v2025.models.form_definition_dynamic_schema_response import FormDefinitionDynamicSchemaResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - body = '''{ - "description" : "A description", - "attributes" : { - "formDefinitionId" : "00000000-0000-0000-0000-000000000000" - }, - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "action", - "versionNumber" : 1 - }''' # FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) - try: - # Generate JSON Schema dynamically. - - results = CustomFormsApi(api_client).create_form_definition_dynamic_schema() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(new_body) - print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) -- path: /form-definitions/{formDefinitionID}/upload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition-file-request - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID - $File = # System.IO.FileInfo | File specifying the multipart - - # Upload new form definition file. - - try { - New-V2025FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File - - # Below is a request that includes all optional parameters - # New-V2025FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinitionFileRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#create-form-definition-file-request - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_definition_file_upload_response import FormDefinitionFileUploadResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID String specifying FormDefinitionID # str | FormDefinitionID String specifying FormDefinitionID - file = None # bytearray | File specifying the multipart # bytearray | File specifying the multipart - try: - # Upload new form definition file. - - results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id=form_definition_id, file=file) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id, file) - print("The response of CustomFormsApi->create_form_definition_file_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) -- path: /form-instances - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-instance - source: | - $Body = @" - { - "formInput" : { - "input1" : "Sales" - }, - "standAloneForm" : false, - "createdBy" : { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "WORKFLOW_EXECUTION" - }, - "recipients" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - } ], - "expire" : "2023-08-12T20:14:57.74486Z", - "formDefinitionId" : "00000000-0000-0000-0000-000000000000", - "state" : "ASSIGNED", - "ttl" : 1571827560 - } - "@ - - # Creates a form instance. - - try { - New-V2025FormInstance - - # Below is a request that includes all optional parameters - # New-V2025FormInstance -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormInstance" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#create-form-instance - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_form_instance_request import CreateFormInstanceRequest - from sailpoint.v2025.models.form_instance_response import FormInstanceResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - body = '''{ - "formInput" : { - "input1" : "Sales" - }, - "standAloneForm" : false, - "createdBy" : { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "WORKFLOW_EXECUTION" - }, - "recipients" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - } ], - "expire" : "2023-08-12T20:14:57.74486Z", - "formDefinitionId" : "00000000-0000-0000-0000-000000000000", - "state" : "ASSIGNED", - "ttl" : 1571827560 - }''' # CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) - try: - # Creates a form instance. - - results = CustomFormsApi(api_client).create_form_instance() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).create_form_instance(new_body) - print("The response of CustomFormsApi->create_form_instance:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) -- path: /form-instances - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-instances-by-tenant - source: | - - # List form instances by tenant. - - try { - Search-V2025FormInstancesByTenant - - # Below is a request that includes all optional parameters - # Search-V2025FormInstancesByTenant - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormInstancesByTenant" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#search-form-instances-by-tenant - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_form_instances_by_tenant_response import ListFormInstancesByTenantResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List form instances by tenant. - - results = CustomFormsApi(api_client).search_form_instances_by_tenant() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).search_form_instances_by_tenant() - print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) -- path: /form-definitions/{formDefinitionID} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#delete-form-definition - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - - # Deletes a form definition. - - try { - Remove-V2025FormDefinition -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Remove-V2025FormDefinition -FormDefinitionID $FormDefinitionID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025FormDefinition" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#delete-form-definition - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - try: - # Deletes a form definition. - - results = CustomFormsApi(api_client).delete_form_definition(form_definition_id=form_definition_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).delete_form_definition(form_definition_id) - print("The response of CustomFormsApi->delete_form_definition:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) -- path: /form-definitions/{formDefinitionID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-definition-by-key - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - - # Return a form definition. - - try { - Get-V2025FormDefinitionByKey -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Get-V2025FormDefinitionByKey -FormDefinitionID $FormDefinitionID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormDefinitionByKey" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#get-form-definition-by-key - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_definition_response import FormDefinitionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - try: - # Return a form definition. - - results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id=form_definition_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id) - print("The response of CustomFormsApi->get_form_definition_by_key:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) -- path: /form-definitions/{formDefinitionID} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#patch-form-definition - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) - $Body = @"[{op=replace, path=/description, value=test-description}]"@ - - - # Patch a form definition. - - try { - Update-V2025FormDefinition -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Update-V2025FormDefinition -FormDefinitionID $FormDefinitionID -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025FormDefinition" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#patch-form-definition - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_definition_response import FormDefinitionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - body = '''[{op=replace, path=/description, value=test-description}]''' # List[Dict[str, object]] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) - try: - # Patch a form definition. - - results = CustomFormsApi(api_client).patch_form_definition(form_definition_id=form_definition_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).patch_form_definition(form_definition_id, new_body) - print("The response of CustomFormsApi->patch_form_definition:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) -- path: /form-definitions/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#export-form-definitions-by-tenant - source: | - $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") - - # List form definitions by tenant. - - try { - Export-V2025FormDefinitionsByTenant - - # Below is a request that includes all optional parameters - # Export-V2025FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025FormDefinitionsByTenant" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#export-form-definitions-by-tenant - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - filters = 'name sw \"my form\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') - try: - # List form definitions by tenant. - - results = CustomFormsApi(api_client).export_form_definitions_by_tenant() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) - print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) -- path: /form-definitions/{formDefinitionID}/file/{fileID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-file-from-s3 - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID - $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. - - # Download definition file by fileId. - - try { - Get-V2025FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID - - # Below is a request that includes all optional parameters - # Get-V2025FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FileFromS3" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#get-file-from-s3 - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID Form definition ID # str | FormDefinitionID Form definition ID - file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving. - try: - # Download definition file by fileId. - - results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id=form_definition_id, file_id=file_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id) - print("The response of CustomFormsApi->get_file_from_s3:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) -- path: /form-instances/{formInstanceID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-instance-by-key - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - - # Returns a form instance. - - try { - Get-V2025FormInstanceByKey -FormInstanceID $FormInstanceID - - # Below is a request that includes all optional parameters - # Get-V2025FormInstanceByKey -FormInstanceID $FormInstanceID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormInstanceByKey" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#get-form-instance-by-key - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_instance_response import FormInstanceResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID - try: - # Returns a form instance. - - results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id=form_instance_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id) - print("The response of CustomFormsApi->get_form_instance_by_key:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) -- path: /form-instances/{formInstanceID} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#patch-form-instance - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) - $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ - - - # Patch a form instance. - - try { - Update-V2025FormInstance -FormInstanceID $FormInstanceID - - # Below is a request that includes all optional parameters - # Update-V2025FormInstance -FormInstanceID $FormInstanceID -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025FormInstance" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#patch-form-instance - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_instance_response import FormInstanceResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID - body = '''[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]''' # List[Dict[str, object]] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) - try: - # Patch a form instance. - - results = CustomFormsApi(api_client).patch_form_instance(form_instance_id=form_instance_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).patch_form_instance(form_instance_id, new_body) - print("The response of CustomFormsApi->patch_form_instance:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) -- path: /form-instances/{formInstanceID}/file/{fileID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-instance-file - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID - $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. - - # Download instance file by fileId. - - try { - Get-V2025FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID - - # Below is a request that includes all optional parameters - # Get-V2025FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormInstanceFile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#get-form-instance-file - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_instance_id = '00000000-0000-0000-0000-000000000000' # str | FormInstanceID Form instance ID # str | FormInstanceID Form instance ID - file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving. - try: - # Download instance file by fileId. - - results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id=form_instance_id, file_id=file_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id) - print("The response of CustomFormsApi->get_form_instance_file:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) -- path: /form-definitions/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#import-form-definitions - source: | - - - - - - - $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ - - - # Import form definitions from export. - - try { - Import-V2025FormDefinitions - - # Below is a request that includes all optional parameters - # Import-V2025FormDefinitions -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025FormDefinitions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#import-form-definitions - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.import_form_definitions202_response import ImportFormDefinitions202Response - from sailpoint.v2025.models.import_form_definitions_request_inner import ImportFormDefinitionsRequestInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - body = '''[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]''' # List[ImportFormDefinitionsRequestInner] | Body is the request payload to import form definitions (optional) - try: - # Import form definitions from export. - - results = CustomFormsApi(api_client).import_form_definitions() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).import_form_definitions(new_body) - print("The response of CustomFormsApi->import_form_definitions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) -- path: /form-instances/{formInstanceID}/data-source/{formElementID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-element-data-by-element-id - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - $FormElementID = "1" # String | Form element ID - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) - $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) - - # Retrieves dynamic data by element. - - try { - Search-V2025FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID - - # Below is a request that includes all optional parameters - # Search-V2025FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormElementDataByElementID" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#search-form-element-data-by-element-id - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_form_element_data_by_element_id_response import ListFormElementDataByElementIDResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID - form_element_id = '1' # str | Form element ID # str | Form element ID - limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - filters = 'value eq \"ID01\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) - query = 'support' # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) - try: - # Retrieves dynamic data by element. - - results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id=form_instance_id, form_element_id=form_element_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id, form_element_id, limit, filters, query) - print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) -- path: /form-definitions/predefined-select-options - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-pre-defined-select-options - source: | - - # List predefined select options. - - try { - Search-V2025PreDefinedSelectOptions - - # Below is a request that includes all optional parameters - # Search-V2025PreDefinedSelectOptions - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025PreDefinedSelectOptions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#search-pre-defined-select-options - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_predefined_select_options_response import ListPredefinedSelectOptionsResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List predefined select options. - - results = CustomFormsApi(api_client).search_pre_defined_select_options() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).search_pre_defined_select_options() - print("The response of CustomFormsApi->search_pre_defined_select_options:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) -- path: /form-definitions/{formDefinitionID}/data-source - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#show-preview-data-source - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) - $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) - $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) - $FormElementPreviewRequest = @" - { - "dataSource" : { - "config" : { - "indices" : [ "identities" ], - "query" : "*", - "aggregationBucketField" : "attributes.cloudStatus.exact", - "objectType" : "IDENTITY" - }, - "dataSourceType" : "STATIC" - } - } - "@ - - # Preview form definition data source. - - try { - Show-V2025PreviewDataSource -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Show-V2025PreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2025PreviewDataSource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#show-preview-data-source - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_element_preview_request import FormElementPreviewRequest - from sailpoint.v2025.models.preview_data_source_response import PreviewDataSourceResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - limit = 10 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) - filters = 'value eq \"ID01\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) - query = 'ac' # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) - form_element_preview_request = '''{ - "dataSource" : { - "config" : { - "indices" : [ "identities" ], - "query" : "*", - "aggregationBucketField" : "attributes.cloudStatus.exact", - "objectType" : "IDENTITY" - }, - "dataSourceType" : "STATIC" - } - }''' # FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) - try: - # Preview form definition data source. - - results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id=form_definition_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id, limit, filters, query, new_form_element_preview_request) - print("The response of CustomFormsApi->show_preview_data_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) -- path: /custom-password-instructions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#create-custom-password-instructions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CustomPasswordInstruction = @" - { - "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", - "pageId" : "change-password:enter-password", - "locale" : "en" - } - "@ - - # Create Custom Password Instructions - - try { - $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction - New-V2025CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result - - # Below is a request that includes all optional parameters - # New-V2025CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CustomPasswordInstructions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-password-instructions#create-custom-password-instructions - source: | - from sailpoint.v2025.api.custom_password_instructions_api import CustomPasswordInstructionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.custom_password_instruction import CustomPasswordInstruction - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - custom_password_instruction = '''{ - "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", - "pageId" : "change-password:enter-password", - "locale" : "en" - }''' # CustomPasswordInstruction | - try: - # Create Custom Password Instructions - new_custom_password_instruction = CustomPasswordInstruction.from_json(custom_password_instruction) - results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental=x_sail_point_experimental, custom_password_instruction=new_custom_password_instruction) - # Below is a request that includes all optional parameters - # results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental, new_custom_password_instruction) - print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) -- path: /custom-password-instructions/{pageId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#delete-custom-password-instructions - source: | - $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - - # Delete Custom Password Instructions by page ID - - try { - Remove-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CustomPasswordInstructions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-password-instructions#delete-custom-password-instructions - source: | - from sailpoint.v2025.api.custom_password_instructions_api import CustomPasswordInstructionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) - try: - # Delete Custom Password Instructions by page ID - - CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id=page_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id, x_sail_point_experimental, locale) - except Exception as e: - print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e) -- path: /custom-password-instructions/{pageId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#get-custom-password-instructions - source: | - $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - - # Get Custom Password Instructions by Page ID - - try { - Get-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomPasswordInstructions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-password-instructions#get-custom-password-instructions - source: | - from sailpoint.v2025.api.custom_password_instructions_api import CustomPasswordInstructionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.custom_password_instruction import CustomPasswordInstruction - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) - try: - # Get Custom Password Instructions by Page ID - - results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id=page_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id, x_sail_point_experimental, locale) - print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) -- path: /data-segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#create-data-segment - source: | - $DataSegment = @" - - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment - New-V2025DataSegment -DataSegment $Result - - # Below is a request that includes all optional parameters - # New-V2025DataSegment -DataSegment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DataSegment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#create-data-segment - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.data_segment import DataSegment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data_segment = '''sailpoint.v2025.DataSegment()''' # DataSegment | - try: - # Create Segment - new_data_segment = DataSegment.from_json(data_segment) - results = DataSegmentationApi(api_client).create_data_segment(data_segment=new_data_segment) - # Below is a request that includes all optional parameters - # results = DataSegmentationApi(api_client).create_data_segment(new_data_segment) - print("The response of DataSegmentationApi->create_data_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DataSegmentationApi->create_data_segment: %s\n" % e) -- path: /data-segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#list-data-segments - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Enabled = $true # Boolean | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to $true) - $Unique = $false # Boolean | This returns only one record if set to true and that would be the published record if exists. (optional) (default to $false) - $Published = $true # Boolean | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to $true) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq """ # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) - - # Get Segments - - try { - Get-V2025DataSegments -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DataSegments -XSailPointExperimental $XSailPointExperimental -Enabled $Enabled -Unique $Unique -Published $Published -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegments" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#list-data-segments - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.data_segment import DataSegment - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - enabled = True # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) - unique = False # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) - published = True # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to True) # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to True) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) - try: - # Get Segments - - results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) - print("The response of DataSegmentationApi->list_data_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) -- path: /data-segments/{segmentId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#delete-data-segment - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false) - - # Delete Segment by ID - - try { - Remove-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -Published $Published - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025DataSegment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#delete-data-segment - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - published = False # bool | This determines which version of the segment to delete (optional) (default to False) # bool | This determines which version of the segment to delete (optional) (default to False) - try: - # Delete Segment by ID - - DataSegmentationApi(api_client).delete_data_segment(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # DataSegmentationApi(api_client).delete_data_segment(id, x_sail_point_experimental, published) - except Exception as e: - print("Exception when calling DataSegmentationApi->delete_data_segment: %s\n" % e) -- path: /data-segments/{segmentId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#get-data-segment - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Segment by ID - - try { - Get-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#get-data-segment - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.data_segment import DataSegment - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Segment by ID - - results = DataSegmentationApi(api_client).get_data_segment(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = DataSegmentationApi(api_client).get_data_segment(id, x_sail_point_experimental) - print("The response of DataSegmentationApi->get_data_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DataSegmentationApi->get_data_segment: %s\n" % e) -- path: /data-segments/{segmentId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#patch-data-segment - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to modify. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - $RequestBody = @"[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025DataSegment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#patch-data-segment - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.data_segment import DataSegment - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - try: - # Update Segment - new_request_body = RequestBody.from_json(request_body) - results = DataSegmentationApi(api_client).patch_data_segment(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = DataSegmentationApi(api_client).patch_data_segment(id, x_sail_point_experimental, new_request_body) - print("The response of DataSegmentationApi->patch_data_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DataSegmentationApi->patch_data_segment: %s\n" % e) -- path: /data-segments/{segmentId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#publish-data-segment - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish to publish - $RequestBody = @""@ - - $PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true) - - # Publish segment by ID - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Publish-V2025DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Publish-V2025DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -PublishAll $PublishAll - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2025DataSegment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#publish-data-segment - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''['request_body_example']''' # List[str] | A list of segment ids that you wish to publish - publish_all = True # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) - try: - # Publish segment by ID - new_request_body = RequestBody.from_json(request_body) - DataSegmentationApi(api_client).publish_data_segment(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # DataSegmentationApi(api_client).publish_data_segment(x_sail_point_experimental, new_request_body, publish_all) - except Exception as e: - print("Exception when calling DataSegmentationApi->publish_data_segment: %s\n" % e) -- path: /data-segments/membership/{identityId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#get-data-segment-identity-membership - source: | - $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get SegmentMembership by Identity ID - - try { - Get-V2025DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegmentIdentityMembership" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#get-data-segment-identity-membership - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get SegmentMembership by Identity ID - - results = DataSegmentationApi(api_client).get_data_segment_identity_membership(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = DataSegmentationApi(api_client).get_data_segment_identity_membership(identity_id, x_sail_point_experimental) - print("The response of DataSegmentationApi->get_data_segment_identity_membership:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DataSegmentationApi->get_data_segment_identity_membership: %s\n" % e) -- path: /data-segments/user-enabled/{identityId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#get-data-segmentation-enabled-for-user - source: | - $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Is Segmentation enabled by Identity - - try { - Get-V2025DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegmentationEnabledForUser" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#get-data-segmentation-enabled-for-user - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Is Segmentation enabled by Identity - - results = DataSegmentationApi(api_client).get_data_segmentation_enabled_for_user(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = DataSegmentationApi(api_client).get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental) - print("The response of DataSegmentationApi->get_data_segmentation_enabled_for_user:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DataSegmentationApi->get_data_segmentation_enabled_for_user: %s\n" % e) -- path: /roles/{roleId}/dimensions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#create-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $Dimension = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "name" : "Dimension 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "id" : "2c918086749d78830174a1a40e121518", - "membership" : { - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, - "type" : "STANDARD" - }, - "parentId" : "2c918086749d78830174a1a40e121518" - } - "@ - - # Create a Dimension - - try { - $Result = ConvertFrom-JsonToDimension -Json $Dimension - New-V2025Dimension -RoleId $RoleId -Dimension $Result - - # Below is a request that includes all optional parameters - # New-V2025Dimension -RoleId $RoleId -Dimension $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Dimension" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#create-dimension - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.dimension import Dimension - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "name" : "Dimension 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "id" : "2c918086749d78830174a1a40e121518", - "membership" : { - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, - "type" : "STANDARD" - }, - "parentId" : "2c918086749d78830174a1a40e121518" - }''' # Dimension | - try: - # Create a Dimension - new_dimension = Dimension.from_json(dimension) - results = DimensionsApi(api_client).create_dimension(role_id=role_id, dimension=new_dimension) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).create_dimension(role_id, new_dimension) - print("The response of DimensionsApi->create_dimension:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->create_dimension: %s\n" % e) -- path: /roles/{roleId}/dimensions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#list-dimensions - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq '2c918086749d78830174a1a40e121518'" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Dimensions - - try { - Get-V2025Dimensions -RoleId $RoleId - - # Below is a request that includes all optional parameters - # Get-V2025Dimensions -RoleId $RoleId -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Dimensions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#list-dimensions - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.dimension import Dimension - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \'2c918086749d78830174a1a40e121518\'' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - try: - # List Dimensions - - results = DimensionsApi(api_client).list_dimensions(role_id=role_id) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) - print("The response of DimensionsApi->list_dimensions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) -- path: /roles/{roleId}/dimensions/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#delete-bulk-dimensions - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimensions. - $DimensionBulkDeleteRequest = @" - { - "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - } - "@ - - # Delete Dimension(s) - - try { - $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest - Remove-V2025BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025BulkDimensions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#delete-bulk-dimensions - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.dimension_bulk_delete_request import DimensionBulkDeleteRequest - from sailpoint.v2025.models.task_result_dto import TaskResultDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimensions. # str | Parent Role Id of the dimensions. - dimension_bulk_delete_request = '''{ - "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - }''' # DimensionBulkDeleteRequest | - try: - # Delete Dimension(s) - new_dimension_bulk_delete_request = DimensionBulkDeleteRequest.from_json(dimension_bulk_delete_request) - results = DimensionsApi(api_client).delete_bulk_dimensions(role_id=role_id, dimension_bulk_delete_request=new_dimension_bulk_delete_request) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).delete_bulk_dimensions(role_id, new_dimension_bulk_delete_request) - print("The response of DimensionsApi->delete_bulk_dimensions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->delete_bulk_dimensions: %s\n" % e) -- path: /roles/{roleId}/dimensions/{dimensionId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#delete-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - - # Delete a Dimension - - try { - Remove-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Remove-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Dimension" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#delete-dimension - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension - try: - # Delete a Dimension - - DimensionsApi(api_client).delete_dimension(role_id=role_id, dimension_id=dimension_id) - # Below is a request that includes all optional parameters - # DimensionsApi(api_client).delete_dimension(role_id, dimension_id) - except Exception as e: - print("Exception when calling DimensionsApi->delete_dimension: %s\n" % e) -- path: /roles/{roleId}/dimensions/{dimensionId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#get-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - - # Get a Dimension under Role. - - try { - Get-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Get-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Dimension" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#get-dimension - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.dimension import Dimension - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension - try: - # Get a Dimension under Role. - - results = DimensionsApi(api_client).get_dimension(role_id=role_id, dimension_id=dimension_id) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).get_dimension(role_id, dimension_id) - print("The response of DimensionsApi->get_dimension:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->get_dimension: %s\n" % e) -- path: /roles/{roleId}/dimensions/{dimensionId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#patch-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Dimension - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Dimension" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#patch-dimension - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.dimension import Dimension - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension - json_patch_operation = '''[{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}]''' # List[JsonPatchOperation] | - try: - # Patch a specified Dimension - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = DimensionsApi(api_client).patch_dimension(role_id=role_id, dimension_id=dimension_id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).patch_dimension(role_id, dimension_id, new_json_patch_operation) - print("The response of DimensionsApi->patch_dimension:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->patch_dimension: %s\n" % e) -- path: /roles/{roleId}/dimensions/{dimensionId}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#get-dimension-entitlements - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Dimension's Entitlements - - try { - Get-V2025DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Get-V2025DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DimensionEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#get-dimension-entitlements - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'attribute eq \"memberOf\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - try: - # List Dimension's Entitlements - - results = DimensionsApi(api_client).get_dimension_entitlements(role_id=role_id, dimension_id=dimension_id) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) - print("The response of DimensionsApi->get_dimension_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) -- path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#list-dimension-access-profiles - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "source.id eq "2c91808982f979270182f99e386d00fa"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Dimension's Access Profiles - - try { - Get-V2025DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Get-V2025DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DimensionAccessProfiles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#list-dimension-access-profiles - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile import AccessProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'source.id eq \"2c91808982f979270182f99e386d00fa\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - try: - # List Dimension's Access Profiles - - results = DimensionsApi(api_client).list_dimension_access_profiles(role_id=role_id, dimension_id=dimension_id) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) - print("The response of DimensionsApi->list_dimension_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) -- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#create-access-model-metadata-for-entitlement - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Add metadata to an entitlement. - - try { - New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessModelMetadataForEntitlement" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#create-access-model-metadata-for-entitlement - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. - attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Add metadata to an entitlement. - - results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental) - print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) -- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#delete-access-model-metadata-from-entitlement - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Remove metadata from an entitlement. - - try { - Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessModelMetadataFromEntitlement" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#delete-access-model-metadata-from-entitlement - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. - attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Remove metadata from an entitlement. - - EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental) - except Exception as e: - print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e) -- path: /entitlements/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get an entitlement - - try { - Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlement" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#get-entitlement - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get an entitlement - - results = EntitlementsApi(api_client).get_entitlement(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).get_entitlement(id, x_sail_point_experimental) - print("The response of EntitlementsApi->get_entitlement:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) -- path: /entitlements/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#patch-entitlement - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch an entitlement - - try { - Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Entitlement" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#patch-entitlement - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional) - try: - # Patch an entitlement - - results = EntitlementsApi(api_client).patch_entitlement(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).patch_entitlement(id, x_sail_point_experimental, new_json_patch_operation) - print("The response of EntitlementsApi->patch_entitlement:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) -- path: /entitlements/{id}/entitlement-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement-request-config - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Entitlement Request Config - - try { - Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementRequestConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#get-entitlement-request-config - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement_request_config import EntitlementRequestConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Entitlement Request Config - - results = EntitlementsApi(api_client).get_entitlement_request_config(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).get_entitlement_request_config(id, x_sail_point_experimental) - print("The response of EntitlementsApi->get_entitlement_request_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) -- path: /entitlements/{id}/entitlement-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#put-entitlement-request-config - source: | - $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $EntitlementRequestConfig = @" - { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - } - "@ - - # Replace Entitlement Request Config - - try { - $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig - Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025EntitlementRequestConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#put-entitlement-request-config - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement_request_config import EntitlementRequestConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - entitlement_request_config = '''{ - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - }''' # EntitlementRequestConfig | - try: - # Replace Entitlement Request Config - new_entitlement_request_config = EntitlementRequestConfig.from_json(entitlement_request_config) - results = EntitlementsApi(api_client).put_entitlement_request_config(id=id, x_sail_point_experimental=x_sail_point_experimental, entitlement_request_config=new_entitlement_request_config) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).put_entitlement_request_config(id, x_sail_point_experimental, new_entitlement_request_config) - print("The response of EntitlementsApi->put_entitlement_request_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) -- path: /entitlements/aggregate/sources/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#import-entitlements-by-source - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) - - # Aggregate Entitlements - - try { - Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsBySource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#import-entitlements-by-source - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.load_entitlement_task import LoadEntitlementTask - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - csv_file = None # bytearray | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional) - try: - # Aggregate Entitlements - - results = EntitlementsApi(api_client).import_entitlements_by_source(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).import_entitlements_by_source(id, x_sail_point_experimental, csv_file) - print("The response of EntitlementsApi->import_entitlements_by_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) -- path: /entitlements/{id}/children - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-children - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List of entitlements children - - try { - Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChildren" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#list-entitlement-children - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - filters = 'attribute eq \"memberOf\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - try: - # List of entitlements children - - results = EntitlementsApi(api_client).list_entitlement_children(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) - print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) -- path: /entitlements/{id}/parents - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-parents - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List of entitlements parents - - try { - Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementParents" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#list-entitlement-parents - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - filters = 'attribute eq \"memberOf\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - try: - # List of entitlements parents - - results = EntitlementsApi(api_client).list_entitlement_parents(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) - print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) -- path: /entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlements - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) - $SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) - $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) - $IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - - # Gets a list of entitlements. - - try { - Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#list-entitlements - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) - segmented_for_identity = 'me' # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) - for_segment_ids = '041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649' # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) - include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to True) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) - filters = 'attribute eq \"memberOf\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - try: - # Gets a list of entitlements. - - results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) - print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) -- path: /entitlements/reset/sources/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#reset-source-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Reset Source Entitlements - - try { - Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025SourceEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#reset-source-entitlements - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement_source_reset_base_reference_dto import EntitlementSourceResetBaseReferenceDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Reset Source Entitlements - - results = EntitlementsApi(api_client).reset_source_entitlements(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).reset_source_entitlements(id, x_sail_point_experimental) - print("The response of EntitlementsApi->reset_source_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) -- path: /entitlements/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#update-entitlements-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $EntitlementBulkUpdateRequest = @" - { - "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/privileged", - "value" : false - }, { - "op" : "replace", - "path" : "/requestable", - "value" : false - } ] - } - "@ - - # Bulk update an entitlement list - - try { - $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest - Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#update-entitlements-in-bulk - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement_bulk_update_request import EntitlementBulkUpdateRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - entitlement_bulk_update_request = '''{ - "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/privileged", - "value" : false - }, { - "op" : "replace", - "path" : "/requestable", - "value" : false - } ] - }''' # EntitlementBulkUpdateRequest | - try: - # Bulk update an entitlement list - new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest.from_json(entitlement_bulk_update_request) - EntitlementsApi(api_client).update_entitlements_in_bulk(x_sail_point_experimental=x_sail_point_experimental, entitlement_bulk_update_request=new_entitlement_bulk_update_request) - # Below is a request that includes all optional parameters - # EntitlementsApi(api_client).update_entitlements_in_bulk(x_sail_point_experimental, new_entitlement_bulk_update_request) - except Exception as e: - print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) -- path: /auth-org/network-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#create-auth-org-network-config - source: | - $NetworkConfiguration = @" - { - "range" : [ "1.3.7.2", "255.255.255.252/30" ], - "whitelisted" : true, - "geolocation" : [ "CA", "FR", "HT" ] - } - "@ - - # Create security network configuration. - - try { - $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration - New-V2025AuthOrgNetworkConfig -NetworkConfiguration $Result - - # Below is a request that includes all optional parameters - # New-V2025AuthOrgNetworkConfig -NetworkConfiguration $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#create-auth-org-network-config - source: | - from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.network_configuration import NetworkConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - network_configuration = '''{ - "range" : [ "1.3.7.2", "255.255.255.252/30" ], - "whitelisted" : true, - "geolocation" : [ "CA", "FR", "HT" ] - }''' # NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - try: - # Create security network configuration. - new_network_configuration = NetworkConfiguration.from_json(network_configuration) - results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(network_configuration=new_network_configuration) - # Below is a request that includes all optional parameters - # results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(new_network_configuration) - print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) -- path: /auth-org/network-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-network-config - source: | - - # Get security network configuration. - - try { - Get-V2025AuthOrgNetworkConfig - - # Below is a request that includes all optional parameters - # Get-V2025AuthOrgNetworkConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#get-auth-org-network-config - source: | - from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.network_configuration import NetworkConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get security network configuration. - - results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config() - # Below is a request that includes all optional parameters - # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config() - print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) -- path: /auth-org/network-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-network-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update security network configuration. - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025AuthOrgNetworkConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025AuthOrgNetworkConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#patch-auth-org-network-config - source: | - from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.network_configuration import NetworkConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - json_patch_operation = '''[{op=replace, path=/whitelisted, value=false,}, {op=add, path=/geolocation, value=[AF, HN, ES]}]''' # List[JsonPatchOperation] | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - try: - # Update security network configuration. - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(new_json_patch_operation) - print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) -- path: /workgroups - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#create-workgroup - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $WorkgroupDto = @" - { - "owner" : { - "emailAddress" : "support@sailpoint.com", - "displayName" : "Support", - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "connectionCount" : 1641498673000, - "created" : "2022-01-06T19:51:13Z", - "memberCount" : 1641498673000, - "name" : "DB Access Governance Group", - "description" : "Description of the Governance Group", - "modified" : "2022-01-06T19:51:13Z", - "id" : "2c91808568c529c60168cca6f90c1313" - } - "@ - - # Create a new Governance Group. - - try { - $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto - New-V2025Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result - - # Below is a request that includes all optional parameters - # New-V2025Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workgroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#create-workgroup - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workgroup_dto import WorkgroupDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - workgroup_dto = '''{ - "owner" : { - "emailAddress" : "support@sailpoint.com", - "displayName" : "Support", - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "connectionCount" : 1641498673000, - "created" : "2022-01-06T19:51:13Z", - "memberCount" : 1641498673000, - "name" : "DB Access Governance Group", - "description" : "Description of the Governance Group", - "modified" : "2022-01-06T19:51:13Z", - "id" : "2c91808568c529c60168cca6f90c1313" - }''' # WorkgroupDto | - try: - # Create a new Governance Group. - new_workgroup_dto = WorkgroupDto.from_json(workgroup_dto) - results = GovernanceGroupsApi(api_client).create_workgroup(x_sail_point_experimental=x_sail_point_experimental, workgroup_dto=new_workgroup_dto) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).create_workgroup(x_sail_point_experimental, new_workgroup_dto) - print("The response of GovernanceGroupsApi->create_workgroup:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) -- path: /workgroups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-workgroups - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw "Test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) - - # List Governance Groups - - try { - Get-V2025Workgroups -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Workgroups -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workgroups" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#list-workgroups - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workgroup_dto import WorkgroupDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name sw \"Test\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) - try: - # List Governance Groups - - results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) - print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) -- path: /workgroups/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a Governance Group - - try { - Remove-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workgroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#delete-workgroup - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a Governance Group - - GovernanceGroupsApi(api_client).delete_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # GovernanceGroupsApi(api_client).delete_workgroup(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) -- path: /workgroups/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#get-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Governance Group by Id - - try { - Get-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workgroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#get-workgroup - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workgroup_dto import WorkgroupDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Governance Group by Id - - results = GovernanceGroupsApi(api_client).get_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).get_workgroup(id, x_sail_point_experimental) - print("The response of GovernanceGroupsApi->get_workgroup:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) -- path: /workgroups/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#patch-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Governance Group - - try { - Update-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workgroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#patch-workgroup - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.workgroup_dto import WorkgroupDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[{op=replace, path=/description, value=Governance Group new description.}]''' # List[JsonPatchOperation] | (optional) - try: - # Patch a Governance Group - - results = GovernanceGroupsApi(api_client).patch_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).patch_workgroup(id, x_sail_point_experimental, new_json_patch_operation) - print("The response of GovernanceGroupsApi->patch_workgroup:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) -- path: /workgroups/{workgroupId}/members/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityPreviewResponseIdentity = @""@ - - - # Remove members from Governance Group - - try { - $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Remove-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - - # Below is a request that includes all optional parameters - # Remove-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025WorkgroupMembers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#delete-workgroup-members - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_preview_response_identity import IdentityPreviewResponseIdentity - from sailpoint.v2025.models.workgroup_member_delete_item import WorkgroupMemberDeleteItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_preview_response_identity = '''[sailpoint.v2025.IdentityPreviewResponseIdentity()]''' # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. - try: - # Remove members from Governance Group - new_identity_preview_response_identity = IdentityPreviewResponseIdentity.from_json(identity_preview_response_identity) - results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental, identity_preview_response_identity=new_identity_preview_response_identity) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) - print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) -- path: /workgroups/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroups-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $WorkgroupBulkDeleteRequest = @" - { - "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] - } - "@ - - # Delete Governance Group(s) - - try { - $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest - Remove-V2025WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025WorkgroupsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#delete-workgroups-in-bulk - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workgroup_bulk_delete_request import WorkgroupBulkDeleteRequest - from sailpoint.v2025.models.workgroup_delete_item import WorkgroupDeleteItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - workgroup_bulk_delete_request = '''{ - "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] - }''' # WorkgroupBulkDeleteRequest | - try: - # Delete Governance Group(s) - new_workgroup_bulk_delete_request = WorkgroupBulkDeleteRequest.from_json(workgroup_bulk_delete_request) - results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental=x_sail_point_experimental, workgroup_bulk_delete_request=new_workgroup_bulk_delete_request) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request) - print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) -- path: /workgroups/{workgroupId}/connections - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-connections - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List connections for Governance Group - - try { - Get-V2025Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Connections" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#list-connections - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workgroup_connection_dto import WorkgroupConnectionDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - try: - # List connections for Governance Group - - results = GovernanceGroupsApi(api_client).list_connections(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) - print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) -- path: /workgroups/{workgroupId}/members - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Governance Group Members - - try { - Get-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkgroupMembers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#list-workgroup-members - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_workgroup_members200_response_inner import ListWorkgroupMembers200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - try: - # List Governance Group Members - - results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) - print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) -- path: /workgroups/{workgroupId}/members/bulk-add - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#update-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityPreviewResponseIdentity = @""@ - - - # Add members to Governance Group - - try { - $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Update-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - - # Below is a request that includes all optional parameters - # Update-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025WorkgroupMembers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#update-workgroup-members - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_preview_response_identity import IdentityPreviewResponseIdentity - from sailpoint.v2025.models.workgroup_member_add_item import WorkgroupMemberAddItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_preview_response_identity = '''[sailpoint.v2025.IdentityPreviewResponseIdentity()]''' # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. - try: - # Add members to Governance Group - new_identity_preview_response_identity = IdentityPreviewResponseIdentity.from_json(identity_preview_response_identity) - results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental, identity_preview_response_identity=new_identity_preview_response_identity) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) - print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) -- path: /ai-access-request-recommendations/ignored-items - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Ignore Access Request Recommendation - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2025AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2025AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsIgnoredItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_request_recommendation_action_item_dto = '''{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - }''' # AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. - try: - # Ignore Access Request Recommendation - new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) - results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) -- path: /ai-access-request-recommendations/ignored-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Ignored Access Request Recommendations - - try { - Get-V2025AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsIgnoredItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'identityId eq \"2c9180846b0a0583016b299f210c1314\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - sorters = 'access.id' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - try: - # List Ignored Access Request Recommendations - - results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) -- path: /ai-access-request-recommendations/requested-items - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Accept Access Request Recommendation - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2025AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2025AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsRequestedItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_request_recommendation_action_item_dto = '''{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - }''' # AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. - try: - # Accept Access Request Recommendation - new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) - results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) -- path: /ai-access-request-recommendations/requested-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Accepted Access Request Recommendations - - try { - Get-V2025AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsRequestedItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"2c9180846b0a0583016b299f210c1314\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - sorters = 'access.id' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - try: - # List Accepted Access Request Recommendations - - results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) -- path: /ai-access-request-recommendations/viewed-items - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Mark Viewed Access Request Recommendations - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2025AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2025AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsViewedItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_request_recommendation_action_item_dto = '''{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - }''' # AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. - try: - # Mark Viewed Access Request Recommendations - new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) - results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) -- path: /ai-access-request-recommendations/viewed-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Viewed Access Request Recommendations - - try { - Get-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsViewedItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"2c9180846b0a0583016b299f210c1314\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - sorters = 'access.id' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - try: - # List Viewed Access Request Recommendations - - results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) -- path: /ai-access-request-recommendations/viewed-items/bulk-create - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @"{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - }"@ - - - # Bulk Mark Viewed Access Request Recommendations - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsViewedItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_request_recommendation_action_item_dto = '''[sailpoint.v2025.AccessRequestRecommendationActionItemDto()]''' # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. - try: - # Bulk Mark Viewed Access Request Recommendations - new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) - results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) -- path: /ai-access-request-recommendations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") - $Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) - $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) - - # Identity Access Request Recommendations - - try { - Get-V2025AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_item_detail import AccessRequestRecommendationItemDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_id = 'me' # str | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to 'me') # str | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to 'me') - limit = 15 # int | Max number of results to return. (optional) (default to 15) # int | Max number of results to return. (optional) (default to 15) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - include_translation_messages = False # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to False) # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to False) - filters = 'access.name co \"admin\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) - try: - # Identity Access Request Recommendations - - results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) -- path: /ai-access-request-recommendations/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Request Recommendations config - - try { - Get-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-config - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Access Request Recommendations config - - results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_config(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_config(x_sail_point_experimental) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config: %s\n" % e) -- path: /ai-access-request-recommendations/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#set-access-request-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationConfigDto = @" - { - "scoreThreshold" : 0.5, - "startDateAttribute" : "startDate", - "restrictionAttribute" : "location", - "moverAttribute" : "isMover", - "joinerAttribute" : "isJoiner", - "useRestrictionAttribute" : true - } - "@ - - # Update Access Request Recommendations config - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto - Set-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result - - # Below is a request that includes all optional parameters - # Set-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025AccessRequestRecommendationsConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#set-access-request-recommendations-config - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_request_recommendation_config_dto = '''{ - "scoreThreshold" : 0.5, - "startDateAttribute" : "startDate", - "restrictionAttribute" : "location", - "moverAttribute" : "isMover", - "joinerAttribute" : "isJoiner", - "useRestrictionAttribute" : true - }''' # AccessRequestRecommendationConfigDto | The desired configurations for Access Request Recommender for the tenant. - try: - # Update Access Request Recommendations config - new_access_request_recommendation_config_dto = AccessRequestRecommendationConfigDto.from_json(access_request_recommendation_config_dto) - results = IAIAccessRequestRecommendationsApi(api_client).set_access_request_recommendations_config(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_config_dto=new_access_request_recommendation_config_dto) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).set_access_request_recommendations_config(x_sail_point_experimental, new_access_request_recommendation_config_dto) - print("The response of IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config: %s\n" % e) -- path: /common-access - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#create-common-access - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CommonAccessItemRequest = @" - { - "access" : { - "ownerName" : "ownerName", - "name" : "name", - "description" : "description", - "id" : "id", - "type" : "ACCESS_PROFILE", - "ownerId" : "ownerId" - }, - "status" : "CONFIRMED" - } - "@ - - # Create common access items - - try { - $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest - New-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CommonAccess" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-common-access#create-common-access - source: | - from sailpoint.v2025.api.iai_common_access_api import IAICommonAccessApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.common_access_item_request import CommonAccessItemRequest - from sailpoint.v2025.models.common_access_item_response import CommonAccessItemResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - common_access_item_request = '''{ - "access" : { - "ownerName" : "ownerName", - "name" : "name", - "description" : "description", - "id" : "id", - "type" : "ACCESS_PROFILE", - "ownerId" : "ownerId" - }, - "status" : "CONFIRMED" - }''' # CommonAccessItemRequest | - try: - # Create common access items - new_common_access_item_request = CommonAccessItemRequest.from_json(common_access_item_request) - results = IAICommonAccessApi(api_client).create_common_access(x_sail_point_experimental=x_sail_point_experimental, common_access_item_request=new_common_access_item_request) - # Below is a request that includes all optional parameters - # results = IAICommonAccessApi(api_client).create_common_access(x_sail_point_experimental, new_common_access_item_request) - print("The response of IAICommonAccessApi->create_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) -- path: /common-access - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#get-common-access - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.type eq "ROLE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) - - # Get a paginated list of common access - - try { - Get-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CommonAccess" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-common-access#get-common-access - source: | - from sailpoint.v2025.api.iai_common_access_api import IAICommonAccessApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.common_access_response import CommonAccessResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.type eq \"ROLE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) - try: - # Get a paginated list of common access - - results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) - print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) -- path: /common-access/update-status - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#update-common-access-status-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CommonAccessIDStatus = @"{ - "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], - "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] - }"@ - - - # Bulk update common access status - - try { - $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus - Update-V2025CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result - - # Below is a request that includes all optional parameters - # Update-V2025CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CommonAccessStatusInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-common-access#update-common-access-status-in-bulk - source: | - from sailpoint.v2025.api.iai_common_access_api import IAICommonAccessApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.common_access_id_status import CommonAccessIDStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - common_access_id_status = '''[sailpoint.v2025.CommonAccessIDStatus()]''' # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access - try: - # Bulk update common access status - new_common_access_id_status = CommonAccessIdStatus.from_json(common_access_id_status) - results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(x_sail_point_experimental=x_sail_point_experimental, common_access_id_status=new_common_access_id_status) - # Below is a request that includes all optional parameters - # results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(x_sail_point_experimental, new_common_access_id_status) - print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) -- path: /outliers/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#export-outliers-zip - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - - # IAI Identity Outliers Export - - try { - Export-V2025OutliersZip -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2025OutliersZip -XSailPointExperimental $XSailPointExperimental -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025OutliersZip" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#export-outliers-zip - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) - try: - # IAI Identity Outliers Export - - results = IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental, type) - print("The response of IAIOutliersApi->export_outliers_zip:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) -- path: /outlier-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-identity-outlier-snapshots - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) - $Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) - - # IAI Identity Outliers Summary - - try { - Get-V2025IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOutlierSnapshots" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-identity-outlier-snapshots - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.outlier_summary import OutlierSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) - filters = 'snapshotDate ge \"2022-02-07T20:13:29.356648026Z\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) - sorters = 'snapshotDate' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) - try: - # IAI Identity Outliers Summary - - results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) - print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) -- path: /outliers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-identity-outliers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) - $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) - - # IAI Get Identity Outliers - - try { - Get-V2025IdentityOutliers -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityOutliers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOutliers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-identity-outliers - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.outlier import Outlier - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) - filters = 'attributes.displayName sw \"John\" and certStatus eq \"false\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) - sorters = 'attributes.displayName,firstDetectionDate,-score' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) - try: - # IAI Get Identity Outliers - - results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) - print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) -- path: /outlier-summaries/latest - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-latest-identity-outlier-snapshots - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - - # IAI Identity Outliers Latest Summary - - try { - Get-V2025LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LatestIdentityOutlierSnapshots" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-latest-identity-outlier-snapshots - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.latest_outlier_summary import LatestOutlierSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) - try: - # IAI Identity Outliers Latest Summary - - results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) - print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) -- path: /outlier-feature-summaries/{outlierFeatureId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-outlier-contributing-feature-summary - source: | - $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get identity outlier contibuting feature summary - - try { - Get-V2025OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OutlierContributingFeatureSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-outlier-contributing-feature-summary - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.outlier_feature_summary import OutlierFeatureSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get identity outlier contibuting feature summary - - results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id=outlier_feature_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental) - print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) -- path: /outliers/{outlierId}/contributing-features - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-peer-group-outliers-contributing-features - source: | - $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) - $Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) - - # Get identity outlier's contibuting features - - try { - Get-V2025PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PeerGroupOutliersContributingFeatures" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-peer-group-outliers-contributing-features - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.outlier_contributing_feature import OutlierContributingFeature - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - include_translation_messages = 'include-translation-messages=' # str | Whether or not to include translation messages object in returned response (optional) # str | Whether or not to include translation messages object in returned response (optional) - sorters = 'importance' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) - try: - # Get identity outlier's contibuting features - - results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id=outlier_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters) - print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) -- path: /outliers/ignore - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#ignore-identity-outliers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - - - # IAI Identity Outliers Ignore - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-V2025IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025IgnoreIdentityOutliers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#ignore-identity-outliers - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''['request_body_example']''' # List[str] | - try: - # IAI Identity Outliers Ignore - new_request_body = RequestBody.from_json(request_body) - IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental, new_request_body) - except Exception as e: - print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) -- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#list-outliers-contributing-feature-access-items - source: | - $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id - $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) - $Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) - - # Gets a list of access items associated with each identity outlier contributing feature - - try { - Get-V2025OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OutliersContributingFeatureAccessItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#list-outliers-contributing-feature-access-items - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.outliers_contributing_feature_access_items import OutliersContributingFeatureAccessItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id - contributing_feature_name = 'entitlement_count' # str | The name of contributing feature # str | The name of contributing feature - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - access_type = 'ENTITLEMENT' # str | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) # str | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) - sorters = 'displayName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) - try: - # Gets a list of access items associated with each identity outlier contributing feature - - results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id=outlier_id, contributing_feature_name=contributing_feature_name, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters) - print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) -- path: /outliers/unignore - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#un-ignore-identity-outliers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - - - # IAI Identity Outliers Unignore - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-V2025UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025UnIgnoreIdentityOutliers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#un-ignore-identity-outliers - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''['request_body_example']''' # List[str] | - try: - # IAI Identity Outliers Unignore - new_request_body = RequestBody.from_json(request_body) - IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental, new_request_body) - except Exception as e: - print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) -- path: /peer-group-strategies/{strategy}/identity-outliers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-peer-group-strategies#get-peer-group-outliers - source: | - $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Identity Outliers List - - try { - Get-V2025PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PeerGroupOutliers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-peer-group-strategies#get-peer-group-outliers - source: | - from sailpoint.v2025.api.iai_peer_group_strategies_api import IAIPeerGroupStrategiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.peer_group_member import PeerGroupMember - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Identity Outliers List - - results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy=strategy, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) - print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) -- path: /recommendations/request - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#get-recommendations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RecommendationRequestDto = @" - { - "prescribeMode" : false, - "excludeInterpretations" : false, - "requests" : [ { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - }, { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - } ], - "includeTranslationMessages" : false, - "includeDebugInformation" : true - } - "@ - - # Returns Recommendation Based on Object - - try { - $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto - Get-V2025Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result - - # Below is a request that includes all optional parameters - # Get-V2025Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Recommendations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-recommendations#get-recommendations - source: | - from sailpoint.v2025.api.iai_recommendations_api import IAIRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.recommendation_request_dto import RecommendationRequestDto - from sailpoint.v2025.models.recommendation_response_dto import RecommendationResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - recommendation_request_dto = '''{ - "prescribeMode" : false, - "excludeInterpretations" : false, - "requests" : [ { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - }, { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - } ], - "includeTranslationMessages" : false, - "includeDebugInformation" : true - }''' # RecommendationRequestDto | - try: - # Returns Recommendation Based on Object - new_recommendation_request_dto = RecommendationRequestDto.from_json(recommendation_request_dto) - results = IAIRecommendationsApi(api_client).get_recommendations(x_sail_point_experimental=x_sail_point_experimental, recommendation_request_dto=new_recommendation_request_dto) - # Below is a request that includes all optional parameters - # results = IAIRecommendationsApi(api_client).get_recommendations(x_sail_point_experimental, new_recommendation_request_dto) - print("The response of IAIRecommendationsApi->get_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) -- path: /recommendations/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#get-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get certification recommendation config values - - try { - Get-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RecommendationsConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-recommendations#get-recommendations-config - source: | - from sailpoint.v2025.api.iai_recommendations_api import IAIRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.recommendation_config_dto import RecommendationConfigDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get certification recommendation config values - - results = IAIRecommendationsApi(api_client).get_recommendations_config(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRecommendationsApi(api_client).get_recommendations_config(x_sail_point_experimental) - print("The response of IAIRecommendationsApi->get_recommendations_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) -- path: /recommendations/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#update-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RecommendationConfigDto = @" - { - "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], - "peerGroupPercentageThreshold" : 0.5, - "runAutoSelectOnce" : false, - "onlyTuneThreshold" : false - } - "@ - - # Update certification recommendation config values - - try { - $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto - Update-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result - - # Below is a request that includes all optional parameters - # Update-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RecommendationsConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-recommendations#update-recommendations-config - source: | - from sailpoint.v2025.api.iai_recommendations_api import IAIRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.recommendation_config_dto import RecommendationConfigDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - recommendation_config_dto = '''{ - "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], - "peerGroupPercentageThreshold" : 0.5, - "runAutoSelectOnce" : false, - "onlyTuneThreshold" : false - }''' # RecommendationConfigDto | - try: - # Update certification recommendation config values - new_recommendation_config_dto = RecommendationConfigDto.from_json(recommendation_config_dto) - results = IAIRecommendationsApi(api_client).update_recommendations_config(x_sail_point_experimental=x_sail_point_experimental, recommendation_config_dto=new_recommendation_config_dto) - # Below is a request that includes all optional parameters - # results = IAIRecommendationsApi(api_client).update_recommendations_config(x_sail_point_experimental, new_recommendation_config_dto) - print("The response of IAIRecommendationsApi->update_recommendations_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#create-potential-role-provision-request - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) - $RoleMiningPotentialRoleProvisionRequest = @" - { - "includeIdentities" : true, - "roleName" : "Finance - Accounting", - "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", - "roleDescription" : "General access for accounting department", - "directlyAssignedEntitlements" : false - } - "@ - - # Create request to provision a potential role into an actual role. - - try { - New-V2025PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # New-V2025PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PotentialRoleProvisionRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#create-potential-role-provision-request - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_provision_request import RoleMiningPotentialRoleProvisionRequest - from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - min_entitlement_popularity = 0 # int | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) # int | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) - include_common_access = True # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to True) # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to True) - role_mining_potential_role_provision_request = '''{ - "includeIdentities" : true, - "roleName" : "Finance - Accounting", - "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", - "roleDescription" : "General access for accounting department", - "directlyAssignedEntitlements" : false - }''' # RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) - try: - # Create request to provision a potential role into an actual role. - - results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, min_entitlement_popularity, include_common_access, new_role_mining_potential_role_provision_request) - print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) -- path: /role-mining-sessions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#create-role-mining-sessions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleMiningSessionDto = @" - { - "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", - "prescribedPruneThreshold" : 10, - "pruneThreshold" : 50, - "saved" : true, - "potentialRolesReadyCount" : 0, - "scope" : { - "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], - "attributeFilterCriteria" : { - "displayName" : { - "untranslated" : "Location: Miami" - }, - "ariaLabel" : { - "untranslated" : "Location: Miami" - }, - "data" : { - "displayName" : { - "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" - }, - "name" : "location", - "operator" : "EQUALS", - "values" : [ "Miami" ] - } - }, - "criteria" : "source.name:DataScienceDataset" - }, - "potentialRoleCount" : 0, - "name" : "Saved RM Session - 07/10", - "minNumIdentitiesInPotentialRole" : 20, - "identityCount" : 0, - "type" : "SPECIALIZED" - } - "@ - - # Create a role mining session - - try { - $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto - New-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result - - # Below is a request that includes all optional parameters - # New-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025RoleMiningSessions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#create-role-mining-sessions - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_session_dto import RoleMiningSessionDto - from sailpoint.v2025.models.role_mining_session_response import RoleMiningSessionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - role_mining_session_dto = '''{ - "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", - "prescribedPruneThreshold" : 10, - "pruneThreshold" : 50, - "saved" : true, - "potentialRolesReadyCount" : 0, - "scope" : { - "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], - "attributeFilterCriteria" : { - "displayName" : { - "untranslated" : "Location: Miami" - }, - "ariaLabel" : { - "untranslated" : "Location: Miami" - }, - "data" : { - "displayName" : { - "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" - }, - "name" : "location", - "operator" : "EQUALS", - "values" : [ "Miami" ] - } - }, - "criteria" : "source.name:DataScienceDataset" - }, - "potentialRoleCount" : 0, - "name" : "Saved RM Session - 07/10", - "minNumIdentitiesInPotentialRole" : 20, - "identityCount" : 0, - "type" : "SPECIALIZED" - }''' # RoleMiningSessionDto | Role mining session parameters - try: - # Create a role mining session - new_role_mining_session_dto = RoleMiningSessionDto.from_json(role_mining_session_dto) - results = IAIRoleMiningApi(api_client).create_role_mining_sessions(x_sail_point_experimental=x_sail_point_experimental, role_mining_session_dto=new_role_mining_session_dto) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).create_role_mining_sessions(x_sail_point_experimental, new_role_mining_session_dto) - print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) -- path: /role-mining-sessions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-sessions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) - $Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all role mining sessions - - try { - Get-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSessions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-role-mining-sessions - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_session_dto import RoleMiningSessionDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'saved eq \"true\" and name sw \"RM Session\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) - sorters = 'createdBy,createdDate' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves all role mining sessions - - results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#download-role-mining-potential-role-zip - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Export (download) details for a potential role in a role mining session - - try { - Invoke-V2025DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Invoke-V2025DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025DownloadRoleMiningPotentialRoleZip" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#download-role-mining-potential-role-zip - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - export_id = '4940ffd4-836f-48a3-b2b0-6d498c3fdf40' # str | The id of a previously run export job for this potential role # str | The id of a previously run export job for this potential role - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Export (download) details for a potential role in a role mining session - - results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id=session_id, potential_role_id=potential_role_id, export_id=export_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id, potential_role_id, export_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Export (download) details for a potential role in a role mining session - - try { - Export-V2025RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2025RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#export-role-mining-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Export (download) details for a potential role in a role mining session - - results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role-async - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleMiningPotentialRoleExportRequest = @" - { - "minEntitlementPopularity" : 0, - "includeCommonAccess" : true - } - "@ - - # Asynchronously export details for a potential role in a role mining session and upload to S3 - - try { - Export-V2025RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2025RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleExportRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRoleAsync" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#export-role-mining-potential-role-async - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_export_request import RoleMiningPotentialRoleExportRequest - from sailpoint.v2025.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - role_mining_potential_role_export_request = '''{ - "minEntitlementPopularity" : 0, - "includeCommonAccess" : true - }''' # RoleMiningPotentialRoleExportRequest | (optional) - try: - # Asynchronously export details for a potential role in a role mining session and upload to S3 - - results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, new_role_mining_potential_role_export_request) - print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role-status - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieve status of a potential role export job - - try { - Export-V2025RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2025RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRoleStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#export-role-mining-potential-role-status - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - export_id = '4940ffd4-836f-48a3-b2b0-6d498c3fdf40' # str | The id of a previously run export job for this potential role # str | The id of a previously run export job for this potential role - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Retrieve status of a potential role export job - - results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id=session_id, potential_role_id=potential_role_id, export_id=export_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) -- path: /role-mining-potential-roles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-all-potential-role-summaries - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) - $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all potential role summaries - - try { - Get-V2025AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllPotentialRoleSummaries" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-all-potential-role-summaries - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'createdDate' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) - filters = '(createdByName co \"int\") and (createdById sw \"2c9180907\") and (type eq \"COMMON\") and ((name co \"entt\") or (saved eq true))' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves all potential role summaries - - results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-entitlement-distribution-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) - - # Retrieves entitlement popularity distribution for a potential role in a role mining session - - try { - Get-V2025EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementDistributionPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-entitlement-distribution-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - include_common_access = True # bool | Boolean determining whether common access entitlements will be included or not (optional) # bool | Boolean determining whether common access entitlements will be included or not (optional) - try: - # Retrieves entitlement popularity distribution for a potential role in a role mining session - - results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access) - print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) - $Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) - $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves entitlements for a potential role in a role mining session - - try { - Get-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-entitlements-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_entitlement import RoleMiningEntitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - include_common_access = True # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to True) # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to True) - sorters = 'popularity' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) - filters = 'applicationName sw \"AD\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves entitlements for a potential role in a role mining session - - results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-excluded-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) - $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves excluded entitlements for a potential role in a role mining session - - try { - Get-V2025ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ExcludedEntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-excluded-entitlements-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_entitlement import RoleMiningEntitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'populariity' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) - filters = 'applicationName sw \"AD\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves excluded entitlements for a potential role in a role mining session - - results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-identities-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves identities for a potential role in a role mining session - - try { - Get-V2025IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitiesPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-identities-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_identity import RoleMiningIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'filters_example' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves identities for a potential role in a role mining session - - results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieves a specific potential role - - try { - Get-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentialRole - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Retrieves a specific potential role - - results = IAIRoleMiningApi(api_client).get_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->get_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ - - - # Update a potential role - - try { - $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#patch-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - patch_potential_role_request_inner = '''[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]''' # List[PatchPotentialRoleRequestInner] | - try: - # Update a potential role - new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner.from_json(patch_potential_role_request_inner) - results = IAIRoleMiningApi(api_client).patch_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental, patch_potential_role_request_inner=new_patch_potential_role_request_inner) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, new_patch_potential_role_request_inner) - print("The response of IAIRoleMiningApi->patch_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-applications - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves the applications of a potential role for a role mining session - - try { - Get-V2025PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleApplications" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role-applications - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_application import RoleMiningPotentialRoleApplication - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '62f28d91-7d9f-4d17-be15-666d5b41d77f' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'applicationName sw \"test\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves the applications of a potential role for a role mining session - - results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-entitlements - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves the entitlements of a potential role for a role mining session - - try { - Get-V2025PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role-entitlements - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_entitlements import RoleMiningPotentialRoleEntitlements - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '62f28d91-7d9f-4d17-be15-666d5b41d77f' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'entitlementRef.name sw \"test\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves the entitlements of a potential role for a role mining session - - results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) -- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-source-identity-usage - source: | - $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id - $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves potential role source usage - - try { - Get-V2025PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleSourceIdentityUsage" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role-source-identity-usage - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_source_usage import RoleMiningPotentialRoleSourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id - source_id = '2c9180877620c1460176267f336a106f' # str | A source id # str | A source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = '-usageCount' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves potential role source usage - - results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id=potential_role_id, source_id=source_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-role-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-summaries - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) - $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all potential role summaries - - try { - Get-V2025PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleSummaries" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role-summaries - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'createdDate' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) - filters = '(createdByName co \"int\")and (createdById sw \"2c9180907\")and (type eq \"COMMON\")and ((name co \"entt\")or (saved eq true))' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves all potential role summaries - - results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) -- path: /role-mining-potential-roles/{potentialRoleId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-potential-role - source: | - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieves a specific potential role - - try { - Get-V2025RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-role-mining-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentialRole - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Retrieves a specific potential role - - results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) -- path: /role-mining-potential-roles/{potentialRoleId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-potential-role-0 - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ - - - # Update a potential role - - try { - $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2025PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PotentialRole0" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#patch-potential-role-0 - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - patch_potential_role_request_inner = '''[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]''' # List[PatchPotentialRoleRequestInner] | - try: - # Update a potential role - new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner.from_json(patch_potential_role_request_inner) - results = IAIRoleMiningApi(api_client).patch_potential_role_0(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental, patch_potential_role_request_inner=new_patch_potential_role_request_inner) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, new_patch_potential_role_request_inner) - print("The response of IAIRoleMiningApi->patch_potential_role_0:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->patch_potential_role_0: %s\n" % e) -- path: /role-mining-sessions/{sessionId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-session - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a role mining session - - try { - Get-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSession" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-role-mining-session - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_session_response import RoleMiningSessionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a role mining session - - results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->get_role_mining_session:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) -- path: /role-mining-sessions/{sessionId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-role-mining-session - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a role mining session - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RoleMiningSession" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#patch-role-mining-session - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}]''' # List[JsonPatchOperation] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - try: - # Patch a role mining session - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, x_sail_point_experimental, new_json_patch_operation) - print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-session-status - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get role mining session status state - - try { - Get-V2025RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSessionStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-role-mining-session-status - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_session_status import RoleMiningSessionStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get role mining session status state - - results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) -- path: /role-mining-potential-roles/saved - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-saved-potential-roles - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all saved potential roles - - try { - Get-V2025SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedPotentialRoles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-saved-potential-roles - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_session_draft_role_dto import RoleMiningSessionDraftRoleDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves all saved potential roles - - results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#update-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleMiningPotentialRoleEditEntitlements = @" - { - "ids" : [ "entId1", "entId2" ], - "exclude" : true - } - "@ - - # Edit entitlements for a potential role to exclude some entitlements - - try { - $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements - Update-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result - - # Below is a request that includes all optional parameters - # Update-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#update-entitlements-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentialRole - from sailpoint.v2025.models.role_mining_potential_role_edit_entitlements import RoleMiningPotentialRoleEditEntitlements - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - role_mining_potential_role_edit_entitlements = '''{ - "ids" : [ "entId1", "entId2" ], - "exclude" : true - }''' # RoleMiningPotentialRoleEditEntitlements | Role mining session parameters - try: - # Edit entitlements for a potential role to exclude some entitlements - new_role_mining_potential_role_edit_entitlements = RoleMiningPotentialRoleEditEntitlements.from_json(role_mining_potential_role_edit_entitlements) - results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental, role_mining_potential_role_edit_entitlements=new_role_mining_potential_role_edit_entitlements) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, new_role_mining_potential_role_edit_entitlements) - print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) -- path: /icons/{objectType}/{objectId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/icons#delete-icon - source: | - $ObjectType = "application" # String | Object type. Available options ['application'] - $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete an icon - - try { - Remove-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Icon" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/icons#delete-icon - source: | - from sailpoint.v2025.api.icons_api import IconsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] - object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete an icon - - IconsApi(api_client).delete_icon(object_type=object_type, object_id=object_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # IconsApi(api_client).delete_icon(object_type, object_id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling IconsApi->delete_icon: %s\n" % e) -- path: /icons/{objectType}/{objectId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/icons#set-icon - source: | - $ObjectType = "application" # String | Object type. Available options ['application'] - $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] - - # Update an icon - - try { - Set-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image - - # Below is a request that includes all optional parameters - # Set-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025Icon" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/icons#set-icon - source: | - from sailpoint.v2025.api.icons_api import IconsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.set_icon200_response import SetIcon200Response - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] - object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - image = None # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] - try: - # Update an icon - - results = IconsApi(api_client).set_icon(object_type=object_type, object_id=object_id, x_sail_point_experimental=x_sail_point_experimental, image=image) - # Below is a request that includes all optional parameters - # results = IconsApi(api_client).set_icon(object_type, object_id, x_sail_point_experimental, image) - print("The response of IconsApi->set_icon:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IconsApi->set_icon: %s\n" % e) -- path: /identities/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#delete-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete identity - - try { - Remove-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Identity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#delete-identity - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete identity - - IdentitiesApi(api_client).delete_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # IdentitiesApi(api_client).delete_identity(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) -- path: /identities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#get-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Identity Details - - try { - Get-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Identity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#get-identity - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity import Identity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Identity Details - - results = IdentitiesApi(api_client).get_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).get_identity(id, x_sail_point_experimental) - print("The response of IdentitiesApi->get_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) -- path: /identities/{identityId}/ownership - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#get-identity-ownership-details - source: | - $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get ownership details - - try { - Get-V2025IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOwnershipDetails" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#get-identity-ownership-details - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_ownership_association_details import IdentityOwnershipAssociationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get ownership details - - results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id, x_sail_point_experimental) - print("The response of IdentitiesApi->get_identity_ownership_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) -- path: /identities/{identityId}/role-assignments/{assignmentId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#get-role-assignment - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Role assignment details - - try { - Get-V2025RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#get-role-assignment - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_assignment_dto import RoleAssignmentDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id - assignment_id = '1cbb0705b38c4226b1334eadd8874086' # str | Assignment Id # str | Assignment Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Role assignment details - - results = IdentitiesApi(api_client).get_role_assignment(identity_id=identity_id, assignment_id=assignment_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id, x_sail_point_experimental) - print("The response of IdentitiesApi->get_role_assignment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) -- path: /identities/{identityId}/role-assignments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#get-role-assignments - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) - $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) - - # List role assignments - - try { - Get-V2025RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -RoleId $RoleId -RoleName $RoleName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignments" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#get-role-assignments - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_role_assignments200_response_inner import GetRoleAssignments200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - role_id = 'e7697a1e96d04db1ac7b0f4544915d2c' # str | Role Id to filter the role assignments with (optional) # str | Role Id to filter the role assignments with (optional) - role_name = 'Engineer' # str | Role name to filter the role assignments with (optional) # str | Role name to filter the role assignments with (optional) - try: - # List role assignments - - results = IdentitiesApi(api_client).get_role_assignments(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) - print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) -- path: /identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#list-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) - $Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) - $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Identities - - try { - Get-V2025Identities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Identities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Identities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#list-identities - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity import Identity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'id eq \"6c9079b270a266a60170a2779fcb0006\" or correlated eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) - sorters = 'name,-cloudStatus' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) - default_filter = CORRELATED_ONLY # str | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to CORRELATED_ONLY) # str | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to CORRELATED_ONLY) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Identities - - results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) - print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) -- path: /identities/{id}/reset - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#reset-identity - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Reset an identity - - try { - Reset-V2025Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Reset-V2025Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025Identity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#reset-identity - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Reset an identity - - IdentitiesApi(api_client).reset_identity(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # IdentitiesApi(api_client).reset_identity(identity_id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) -- path: /identities/{id}/verification/account/send - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#send-identity-verification-account-token - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - $SendAccountVerificationRequest = @" - { - "sourceName" : "Active Directory Source", - "via" : "EMAIL_WORK" - } - "@ - - # Send password reset email - - try { - $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest - Send-V2025IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2025IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025IdentityVerificationAccountToken" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#send-identity-verification-account-token - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.send_account_verification_request import SendAccountVerificationRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID - send_account_verification_request = '''{ - "sourceName" : "Active Directory Source", - "via" : "EMAIL_WORK" - }''' # SendAccountVerificationRequest | - try: - # Send password reset email - new_send_account_verification_request = SendAccountVerificationRequest.from_json(send_account_verification_request) - IdentitiesApi(api_client).send_identity_verification_account_token(x_sail_point_experimental=x_sail_point_experimental, id=id, send_account_verification_request=new_send_account_verification_request) - # Below is a request that includes all optional parameters - # IdentitiesApi(api_client).send_identity_verification_account_token(x_sail_point_experimental, id, new_send_account_verification_request) - except Exception as e: - print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) -- path: /identities/invite - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#start-identities-invite - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $InviteIdentitiesRequest = @" - { - "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], - "uninvited" : false - } - "@ - - # Invite identities to register - - try { - $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest - Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result - - # Below is a request that includes all optional parameters - # Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentitiesInvite" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#start-identities-invite - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.invite_identities_request import InviteIdentitiesRequest - from sailpoint.v2025.models.task_status import TaskStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - invite_identities_request = '''{ - "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], - "uninvited" : false - }''' # InviteIdentitiesRequest | - try: - # Invite identities to register - new_invite_identities_request = InviteIdentitiesRequest.from_json(invite_identities_request) - results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental=x_sail_point_experimental, invite_identities_request=new_invite_identities_request) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental, new_invite_identities_request) - print("The response of IdentitiesApi->start_identities_invite:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) -- path: /identities/process - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#start-identity-processing - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ProcessIdentitiesRequest = @" - { - "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] - } - "@ - - # Process a list of identityIds - - try { - $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest - Start-V2025IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result - - # Below is a request that includes all optional parameters - # Start-V2025IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentityProcessing" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#start-identity-processing - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.process_identities_request import ProcessIdentitiesRequest - from sailpoint.v2025.models.task_result_response import TaskResultResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - process_identities_request = '''{ - "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] - }''' # ProcessIdentitiesRequest | - try: - # Process a list of identityIds - new_process_identities_request = ProcessIdentitiesRequest.from_json(process_identities_request) - results = IdentitiesApi(api_client).start_identity_processing(x_sail_point_experimental=x_sail_point_experimental, process_identities_request=new_process_identities_request) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).start_identity_processing(x_sail_point_experimental, new_process_identities_request) - print("The response of IdentitiesApi->start_identity_processing:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) -- path: /identities/{identityId}/synchronize-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#synchronize-attributes-for-identity - source: | - $IdentityId = "MyIdentityId" # String | The Identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Attribute synchronization for single identity. - - try { - Sync-V2025hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Sync-V2025hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025hronizeAttributesForIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#synchronize-attributes-for-identity - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_sync_job import IdentitySyncJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Attribute synchronization for single identity. - - results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id, x_sail_point_experimental) - print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) -- path: /identity-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#create-identity-attribute - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityAttribute = @" - { - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - } - "@ - - # Create Identity Attribute - - try { - $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - New-V2025IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - - # Below is a request that includes all optional parameters - # New-V2025IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-attributes#create-identity-attribute - source: | - from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_attribute import IdentityAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_attribute = '''{ - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - }''' # IdentityAttribute | - try: - # Create Identity Attribute - new_identity_attribute = IdentityAttribute.from_json(identity_attribute) - results = IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental=x_sail_point_experimental, identity_attribute=new_identity_attribute) - # Below is a request that includes all optional parameters - # results = IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental, new_identity_attribute) - print("The response of IdentityAttributesApi->create_identity_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) -- path: /identity-attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#list-identity-attributes - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) - $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) - $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Identity Attributes - - try { - Get-V2025IdentityAttributes -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAttributes -XSailPointExperimental $XSailPointExperimental -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-attributes#list-identity-attributes - source: | - from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_attribute import IdentityAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - include_system = False # bool | Include 'system' attributes in the response. (optional) (default to False) # bool | Include 'system' attributes in the response. (optional) (default to False) - include_silent = False # bool | Include 'silent' attributes in the response. (optional) (default to False) # bool | Include 'silent' attributes in the response. (optional) (default to False) - searchable_only = False # bool | Include only 'searchable' attributes in the response. (optional) (default to False) # bool | Include only 'searchable' attributes in the response. (optional) (default to False) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Identity Attributes - - results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) - print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) -- path: /identity-attributes/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#delete-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Identity Attribute - - try { - Remove-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-attributes#delete-identity-attribute - source: | - from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete Identity Attribute - - IdentityAttributesApi(api_client).delete_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # IdentityAttributesApi(api_client).delete_identity_attribute(name, x_sail_point_experimental) - except Exception as e: - print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) -- path: /identity-attributes/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#get-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Identity Attribute - - try { - Get-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-attributes#get-identity-attribute - source: | - from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_attribute import IdentityAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Identity Attribute - - results = IdentityAttributesApi(api_client).get_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityAttributesApi(api_client).get_identity_attribute(name, x_sail_point_experimental) - print("The response of IdentityAttributesApi->get_identity_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) -- path: /identity-attributes/{name} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#put-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityAttribute = @" - { - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - } - "@ - - # Update Identity Attribute - - try { - $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - Send-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - - # Below is a request that includes all optional parameters - # Send-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025IdentityAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-attributes#put-identity-attribute - source: | - from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_attribute import IdentityAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_attribute = '''{ - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - }''' # IdentityAttribute | - try: - # Update Identity Attribute - new_identity_attribute = IdentityAttribute.from_json(identity_attribute) - results = IdentityAttributesApi(api_client).put_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental, identity_attribute=new_identity_attribute) - # Below is a request that includes all optional parameters - # results = IdentityAttributesApi(api_client).put_identity_attribute(name, x_sail_point_experimental, new_identity_attribute) - print("The response of IdentityAttributesApi->put_identity_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) -- path: /identity-attributes/bulk-delete - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#delete-identity-attributes-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityAttributeNames = @" - { - "ids" : [ "name", "displayName" ] - } - "@ - - # Bulk delete Identity Attributes - - try { - $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames - Remove-V2025IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result - - # Below is a request that includes all optional parameters - # Remove-V2025IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityAttributesInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-attributes#delete-identity-attributes-in-bulk - source: | - from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_attribute_names import IdentityAttributeNames - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_attribute_names = '''{ - "ids" : [ "name", "displayName" ] - }''' # IdentityAttributeNames | - try: - # Bulk delete Identity Attributes - new_identity_attribute_names = IdentityAttributeNames.from_json(identity_attribute_names) - IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental=x_sail_point_experimental, identity_attribute_names=new_identity_attribute_names) - # Below is a request that includes all optional parameters - # IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental, new_identity_attribute_names) - except Exception as e: - print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) -- path: /historical-identities/{id}/compare - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#compare-identity-snapshots - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) - $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) - $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets a difference of count for each access item types for the given identity between 2 snapshots - - try { - Compare-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Compare-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2025IdentitySnapshots" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#compare-identity-snapshots - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_compare_response import IdentityCompareResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - snapshot1 = '2007-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional) - snapshot2 = '2008-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (optional) - access_item_types = '''['access_item_types_example']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Gets a difference of count for each access item types for the given identity between 2 snapshots - - results = IdentityHistoryApi(api_client).compare_identity_snapshots(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count) - print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) -- path: /historical-identities/{id}/compare/{access-type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#compare-identity-snapshots-access-type - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $AccessType = "accessProfile" # String | The specific type which needs to be compared - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) - $Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) - $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets a list of differences of specific accessType for the given identity between 2 snapshots - - try { - Compare-V2025IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Compare-V2025IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2025IdentitySnapshotsAccessType" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#compare-identity-snapshots-access-type - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_item_diff import AccessItemDiff - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - access_type = 'role' # str | The specific type which needs to be compared # str | The specific type which needs to be compared - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_associated = 2007-03-01T13:00:00Z # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) - snapshot1 = '2008-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional) - snapshot2 = '2009-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Gets a list of differences of specific accessType for the given identity between 2 snapshots - - results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id=id, access_type=access_type, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count) - print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) -- path: /historical-identities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-historical-identity - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get latest snapshot of identity - - try { - Get-V2025HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#get-historical-identity - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_history_response import IdentityHistoryResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get latest snapshot of identity - - results = IdentityHistoryApi(api_client).get_historical_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).get_historical_identity(id, x_sail_point_experimental) - print("The response of IdentityHistoryApi->get_historical_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) -- path: /historical-identities/{id}/events - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-historical-identity-events - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) - $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) - - $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ - $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - $AccessItemTypes = @"[entitlement, account]"@ - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Lists all events for the given identity - - try { - Get-V2025HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentityEvents" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#get-historical-identity-events - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - var_from = '2024-03-01T13:00:00Z' # str | The optional instant until which access events are returned (optional) # str | The optional instant until which access events are returned (optional) - event_types = '''['[AccessAddedEvent, AccessRemovedEvent]']''' # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional) - access_item_types = '''['[entitlement, account]']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Lists all events for the given identity - - results = IdentityHistoryApi(api_client).get_historical_identity_events(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count) - print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) -- path: /historical-identities/{id}/snapshots/{date} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-snapshot - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Date = "2007-03-01T13:00:00Z" # String | The specified date - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Gets an identity snapshot at a given date - - try { - Get-V2025IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshot" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#get-identity-snapshot - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_history_response import IdentityHistoryResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Gets an identity snapshot at a given date - - results = IdentityHistoryApi(api_client).get_identity_snapshot(id=id, var_date=var_date, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date, x_sail_point_experimental) - print("The response of IdentityHistoryApi->get_identity_snapshot:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) -- path: /historical-identities/{id}/snapshot-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-snapshot-summary - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) - $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) - $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets the summary for the event count for a specific identity - - try { - Get-V2025IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshotSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#get-identity-snapshot-summary - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.metric_response import MetricResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - before = '2007-03-01T13:00:00Z' # str | The date before which snapshot summary is required (optional) # str | The date before which snapshot summary is required (optional) - interval = 'interval_example' # str | The interval indicating day or month. Defaults to month if not specified (optional) # str | The interval indicating day or month. Defaults to month if not specified (optional) - time_zone = 'UTC' # str | The time zone. Defaults to UTC if not provided (optional) # str | The time zone. Defaults to UTC if not provided (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Gets the summary for the event count for a specific identity - - results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count) - print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) -- path: /historical-identities/{id}/start-date - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-start-date - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Gets the start date of the identity - - try { - Get-V2025IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityStartDate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#get-identity-start-date - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Gets the start date of the identity - - results = IdentityHistoryApi(api_client).get_identity_start_date(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).get_identity_start_date(id, x_sail_point_experimental) - print("The response of IdentityHistoryApi->get_identity_start_date:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) -- path: /historical-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-historical-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) - $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) - $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # Lists all the identities - - try { - Get-V2025HistoricalIdentities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025HistoricalIdentities -XSailPointExperimental $XSailPointExperimental -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#list-historical-identities - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_list_item import IdentityListItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - starts_with_query = 'Ada' # str | This param is used for starts-with search for first, last and display name of the identity (optional) # str | This param is used for starts-with search for first, last and display name of the identity (optional) - is_deleted = true # bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional) - is_active = true # bool | Indicates if we want to only list active or inactive identities. (optional) # bool | Indicates if we want to only list active or inactive identities. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # Lists all the identities - - results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset) - print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) -- path: /historical-identities/{id}/access-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-access-items - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Access Items by Identity - - try { - Get-V2025IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental -Type $Type -Limit $Limit -Count $Count -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#list-identity-access-items - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account (optional) # str | The type of access item for the identity. If not provided, it defaults to account (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Access Items by Identity - - results = IdentityHistoryApi(api_client).list_identity_access_items(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) - print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) -- path: /historical-identities/{id}/snapshots/{date}/access-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-snapshot-access-items - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Date = "2007-03-01T13:00:00Z" # String | The specified date - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "account" # String | The access item type (optional) - - # Gets the list of identity access items at a given date filterd by item type - - try { - Get-V2025IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshotAccessItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#list-identity-snapshot-access-items - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - type = 'account' # str | The access item type (optional) # str | The access item type (optional) - try: - # Gets the list of identity access items at a given date filterd by item type - - results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id=id, var_date=var_date, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) - print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) -- path: /historical-identities/{id}/snapshots - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-snapshots - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) - $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Lists all the snapshots for the identity - - try { - Get-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshots" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#list-identity-snapshots - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - start = '2007-03-01T13:00:00Z' # str | The specified start date (optional) # str | The specified start date (optional) - interval = 'interval_example' # str | The interval indicating the range in day or month for the specified interval-name (optional) # str | The interval indicating the range in day or month for the specified interval-name (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Lists all the snapshots for the identity - - results = IdentityHistoryApi(api_client).list_identity_snapshots(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) - print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) -- path: /identity-profiles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#create-identity-profile - source: | - $IdentityProfile = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - "@ - - # Create Identity Profile - - try { - $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-V2025IdentityProfile -IdentityProfile $Result - - # Below is a request that includes all optional parameters - # New-V2025IdentityProfile -IdentityProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#create-identity-profile - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_profile import IdentityProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - }''' # IdentityProfile | - try: - # Create Identity Profile - new_identity_profile = IdentityProfile.from_json(identity_profile) - results = IdentityProfilesApi(api_client).create_identity_profile(identity_profile=new_identity_profile) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile) - print("The response of IdentityProfilesApi->create_identity_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) -- path: /identity-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#list-identity-profiles - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - - # List Identity Profiles - - try { - Get-V2025IdentityProfiles - - # Below is a request that includes all optional parameters - # Get-V2025IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityProfiles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#list-identity-profiles - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_profile import IdentityProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - try: - # List Identity Profiles - - results = IdentityProfilesApi(api_client).list_identity_profiles() - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) - print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) -- path: /identity-profiles/{identity-profile-id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#delete-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - - # Delete Identity Profile - - try { - Remove-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Remove-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#delete-identity-profile - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_result_simplified import TaskResultSimplified - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. - try: - # Delete Identity Profile - - results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id=identity_profile_id) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id) - print("The response of IdentityProfilesApi->delete_identity_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) -- path: /identity-profiles/{identity-profile-id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#get-identity-profile - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - - # Get Identity Profile - - try { - Get-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#get-identity-profile - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_profile import IdentityProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - try: - # Get Identity Profile - - results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id=identity_profile_id) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id) - print("The response of IdentityProfilesApi->get_identity_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) -- path: /identity-profiles/{identity-profile-id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#update-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Identity Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#update-identity-profile - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_profile import IdentityProfile - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. - json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]''' # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - try: - # Update Identity Profile - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id=identity_profile_id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, new_json_patch_operation) - print("The response of IdentityProfilesApi->update_identity_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) -- path: /identity-profiles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#delete-identity-profiles - source: | - $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. - $RequestBody = @""@ - - - # Delete Identity Profiles - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2025IdentityProfiles -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-V2025IdentityProfiles -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityProfiles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#delete-identity-profiles - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_result_simplified import TaskResultSimplified - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - request_body = '''['request_body_example']''' # List[str] | Identity Profile bulk delete request body. - try: - # Delete Identity Profiles - new_request_body = RequestBody.from_json(request_body) - results = IdentityProfilesApi(api_client).delete_identity_profiles(request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).delete_identity_profiles(new_request_body) - print("The response of IdentityProfilesApi->delete_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) -- path: /identity-profiles/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#export-identity-profiles - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) - - # Export Identity Profiles - - try { - Export-V2025IdentityProfiles - - # Below is a request that includes all optional parameters - # Export-V2025IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025IdentityProfiles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#export-identity-profiles - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_profile_exported_object import IdentityProfileExportedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) - try: - # Export Identity Profiles - - results = IdentityProfilesApi(api_client).export_identity_profiles() - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) - print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) -- path: /identity-profiles/identity-preview - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#generate-identity-preview - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityPreviewRequest = @" - { - "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - } - } - "@ - - # Generate Identity Profile Preview - - try { - $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityPreview" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#generate-identity-preview - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_preview_request import IdentityPreviewRequest - from sailpoint.v2025.models.identity_preview_response import IdentityPreviewResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_preview_request = '''{ - "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - } - }''' # IdentityPreviewRequest | Identity Preview request body. - try: - # Generate Identity Profile Preview - new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request) - results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental=x_sail_point_experimental, identity_preview_request=new_identity_preview_request) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental, new_identity_preview_request) - print("The response of IdentityProfilesApi->generate_identity_preview:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->generate_identity_preview: %s\n" % e) -- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#get-default-identity-attribute-config - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. - - # Get default Identity Attribute Config - - try { - Get-V2025DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-V2025DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultIdentityAttributeConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#get-default-identity-attribute-config - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_attribute_config import IdentityAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID. - try: - # Get default Identity Attribute Config - - results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id=identity_profile_id) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id) - print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) -- path: /identity-profiles/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#import-identity-profiles - source: | - - - - - - $IdentityProfileExportedObject = @"{ - "self" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "version" : 1, - "object" : { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - }"@ - - - # Import Identity Profiles - - try { - $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-V2025IdentityProfiles -IdentityProfileExportedObject $Result - - # Below is a request that includes all optional parameters - # Import-V2025IdentityProfiles -IdentityProfileExportedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025IdentityProfiles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#import-identity-profiles - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_profile_exported_object import IdentityProfileExportedObject - from sailpoint.v2025.models.object_import_result import ObjectImportResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_exported_object = '''[sailpoint.v2025.IdentityProfileExportedObject()]''' # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. - try: - # Import Identity Profiles - new_identity_profile_exported_object = IdentityProfileExportedObject.from_json(identity_profile_exported_object) - results = IdentityProfilesApi(api_client).import_identity_profiles(identity_profile_exported_object=new_identity_profile_exported_object) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).import_identity_profiles(new_identity_profile_exported_object) - print("The response of IdentityProfilesApi->import_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) -- path: /identity-profiles/{identity-profile-id}/process-identities - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#sync-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed - - # Process identities under profile - - try { - Sync-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Sync-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#sync-identity-profile - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID to be processed # str | The Identity Profile ID to be processed - try: - # Process identities under profile - - results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id=identity_profile_id) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id) - print("The response of IdentityProfilesApi->sync_identity_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) -- path: /identity-profiles/{identity-profile-id}/lifecycle-states - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#create-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleState = @" - { - "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], - "emailNotificationOption" : { - "notifyManagers" : true, - "notifySpecificUsers" : true, - "emailAddressList" : [ "test@test.com", "test2@test.com" ], - "notifyAllAdmins" : true - }, - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Lifecycle description", - "accountActions" : [ { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - }, { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } ], - "id" : "id12345", - "identityCount" : 42, - "technicalName" : "Technical Name", - "identityState" : "identityState", - "enabled" : true - } - "@ - - # Create Lifecycle State - - try { - $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState - New-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result - - # Below is a request that includes all optional parameters - # New-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025LifecycleState" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/lifecycle-states#create-lifecycle-state - source: | - from sailpoint.v2025.api.lifecycle_states_api import LifecycleStatesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.lifecycle_state import LifecycleState - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - lifecycle_state = '''{ - "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], - "emailNotificationOption" : { - "notifyManagers" : true, - "notifySpecificUsers" : true, - "emailAddressList" : [ "test@test.com", "test2@test.com" ], - "notifyAllAdmins" : true - }, - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Lifecycle description", - "accountActions" : [ { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - }, { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } ], - "id" : "id12345", - "identityCount" : 42, - "technicalName" : "Technical Name", - "identityState" : "identityState", - "enabled" : true - }''' # LifecycleState | Lifecycle state to be created. - try: - # Create Lifecycle State - new_lifecycle_state = LifecycleState.from_json(lifecycle_state) - results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state=new_lifecycle_state) - # Below is a request that includes all optional parameters - # results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, new_lifecycle_state) - print("The response of LifecycleStatesApi->create_lifecycle_state:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) -- path: /identity-profiles/{identity-profile-id}/lifecycle-states - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#get-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Lists LifecycleStates - - try { - Get-V2025LifecycleStates -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-V2025LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LifecycleStates" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/lifecycle-states#get-lifecycle-states - source: | - from sailpoint.v2025.api.lifecycle_states_api import LifecycleStatesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.lifecycle_state import LifecycleState - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - try: - # Lists LifecycleStates - - results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id=identity_profile_id) - # Below is a request that includes all optional parameters - # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) - print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#delete-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - - # Delete Lifecycle State - - try { - Remove-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Remove-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025LifecycleState" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/lifecycle-states#delete-lifecycle-state - source: | - from sailpoint.v2025.api.lifecycle_states_api import LifecycleStatesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.lifecyclestate_deleted import LifecyclestateDeleted - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID. - try: - # Delete Lifecycle State - - results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id) - # Below is a request that includes all optional parameters - # results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id, lifecycle_state_id) - print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e) -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#get-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - - # Get Lifecycle State - - try { - Get-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Get-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LifecycleState" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/lifecycle-states#get-lifecycle-state - source: | - from sailpoint.v2025.api.lifecycle_states_api import LifecycleStatesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.lifecycle_state import LifecycleState - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID. - try: - # Get Lifecycle State - - results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id) - # Below is a request that includes all optional parameters - # results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id, lifecycle_state_id) - print("The response of LifecycleStatesApi->get_lifecycle_state:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#update-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Lifecycle State - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025LifecycleStates" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/lifecycle-states#update-lifecycle-states - source: | - from sailpoint.v2025.api.lifecycle_states_api import LifecycleStatesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.lifecycle_state import LifecycleState - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID. - json_patch_operation = '''[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/accessProfileIds, value=[2c918087742bab150174407a80f3125e, 2c918087742bab150174407a80f3124f]}, {op=replace, path=/accountActions, value=[{action=ENABLE, sourceIds=[2c9180846a2f82fb016a481c1b1560c5, 2c9180846a2f82fb016a481c1b1560cc]}, {action=DISABLE, sourceIds=[2c91808869a0c9980169a207258513fb]}]}, {op=replace, path=/emailNotificationOption, value={notifyManagers=true, notifyAllAdmins=false, notifySpecificUsers=false, emailAddressList=[]}}]''' # List[JsonPatchOperation] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - try: - # Update Lifecycle State - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id, lifecycle_state_id, new_json_patch_operation) - print("The response of LifecycleStatesApi->update_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /identities/{identity-id}/set-lifecycle-state - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#set-lifecycle-state - source: | - $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. - $SetLifecycleStateRequest = @" - - "@ - - # Set Lifecycle State - - try { - $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest - Set-V2025LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result - - # Below is a request that includes all optional parameters - # Set-V2025LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025LifecycleState" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/lifecycle-states#set-lifecycle-state - source: | - from sailpoint.v2025.api.lifecycle_states_api import LifecycleStatesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.set_lifecycle_state200_response import SetLifecycleState200Response - from sailpoint.v2025.models.set_lifecycle_state_request import SetLifecycleStateRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_id = '2c9180857893f1290178944561990364' # str | ID of the identity to update. # str | ID of the identity to update. - set_lifecycle_state_request = '''sailpoint.v2025.SetLifecycleStateRequest()''' # SetLifecycleStateRequest | - try: - # Set Lifecycle State - new_set_lifecycle_state_request = SetLifecycleStateRequest.from_json(set_lifecycle_state_request) - results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id=identity_id, set_lifecycle_state_request=new_set_lifecycle_state_request) - # Below is a request that includes all optional parameters - # results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id, new_set_lifecycle_state_request) - print("The response of LifecycleStatesApi->set_lifecycle_state:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-V2025MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2025MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-V2025MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAKbaConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-V2025MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2025MFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAKBAConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-V2025MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-V2025MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025MFAConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) -- path: /machine-accounts/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#get-machine-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Machine Account Details - - try { - Get-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccount" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-accounts#get-machine-account - source: | - from sailpoint.v2025.api.machine_accounts_api import MachineAccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_account import MachineAccount - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Machine Account Details - - results = MachineAccountsApi(api_client).get_machine_account(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = MachineAccountsApi(api_client).get_machine_account(id, x_sail_point_experimental) - print("The response of MachineAccountsApi->get_machine_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineAccountsApi->get_machine_account: %s\n" % e) -- path: /machine-accounts/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#update-machine-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ - - - # Update a Machine Account - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MachineAccount" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-accounts#update-machine-account - source: | - from sailpoint.v2025.api.machine_accounts_api import MachineAccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_account import MachineAccount - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - try: - # Update a Machine Account - new_request_body = RequestBody.from_json(request_body) - results = MachineAccountsApi(api_client).update_machine_account(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = MachineAccountsApi(api_client).update_machine_account(id, x_sail_point_experimental, new_request_body) - print("The response of MachineAccountsApi->update_machine_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e) -- path: /machine-accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#list-machine-accounts - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) - - # Machine Accounts List - - try { - Get-V2025MachineAccounts -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccounts" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-accounts#list-machine-accounts - source: | - from sailpoint.v2025.api.machine_accounts_api import MachineAccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_account import MachineAccount - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) - try: - # Machine Accounts List - - results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of MachineAccountsApi->list_machine_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) -- path: /machine-identities - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#create-machine-identity - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MachineIdentity = @" - { - "created" : "2015-05-28T14:07:17Z", - "businessApplication" : "ADService", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "", - "attributes" : "{\"Region\":\"EU\"}", - "id" : "id12345", - "manuallyEdited" : true - } - "@ - - # Create Machine Identities - - try { - $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity - New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result - - # Below is a request that includes all optional parameters - # New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025MachineIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-identities#create-machine-identity - source: | - from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_identity import MachineIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - machine_identity = '''{ - "created" : "2015-05-28T14:07:17Z", - "businessApplication" : "ADService", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "", - "attributes" : "{\"Region\":\"EU\"}", - "id" : "id12345", - "manuallyEdited" : true - }''' # MachineIdentity | - try: - # Create Machine Identities - new_machine_identity = MachineIdentity.from_json(machine_identity) - results = MachineIdentitiesApi(api_client).create_machine_identity(x_sail_point_experimental=x_sail_point_experimental, machine_identity=new_machine_identity) - # Below is a request that includes all optional parameters - # results = MachineIdentitiesApi(api_client).create_machine_identity(x_sail_point_experimental, new_machine_identity) - print("The response of MachineIdentitiesApi->create_machine_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineIdentitiesApi->create_machine_identity: %s\n" % e) -- path: /machine-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#list-machine-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) - $Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Machine Identities - - try { - Get-V2025MachineIdentities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MachineIdentities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-identities#list-machine-identities - source: | - from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_identity import MachineIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) - sorters = 'businessApplication' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Machine Identities - - results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, filters, sorters, count, limit, offset) - print("The response of MachineIdentitiesApi->list_machine_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) -- path: /machine-identities/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#delete-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete machine identity - - try { - Remove-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MachineIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-identities#delete-machine-identity - source: | - from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete machine identity - - MachineIdentitiesApi(api_client).delete_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # MachineIdentitiesApi(api_client).delete_machine_identity(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling MachineIdentitiesApi->delete_machine_identity: %s\n" % e) -- path: /machine-identities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#get-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Machine Identity Details - - try { - Get-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-identities#get-machine-identity - source: | - from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_identity import MachineIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Machine Identity Details - - results = MachineIdentitiesApi(api_client).get_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = MachineIdentitiesApi(api_client).get_machine_identity(id, x_sail_point_experimental) - print("The response of MachineIdentitiesApi->get_machine_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineIdentitiesApi->get_machine_identity: %s\n" % e) -- path: /machine-identities/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#update-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ - - - # Update a Machine Identity - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MachineIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-identities#update-machine-identity - source: | - from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_identity import MachineIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - try: - # Update a Machine Identity - new_request_body = RequestBody.from_json(request_body) - results = MachineIdentitiesApi(api_client).update_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = MachineIdentitiesApi(api_client).update_machine_identity(id, x_sail_point_experimental, new_request_body) - print("The response of MachineIdentitiesApi->update_machine_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineIdentitiesApi->update_machine_identity: %s\n" % e) -- path: /managed-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#create-managed-client - source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ - - # Create Managed Client - - try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-V2025ManagedClient -ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedClient -ManagedClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clients#create-managed-client - source: | - from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_client import ManagedClient - from sailpoint.v2025.models.managed_client_request import ManagedClientRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_client_request = '''{ - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - }''' # ManagedClientRequest | - try: - # Create Managed Client - new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) - results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) - print("The response of ManagedClientsApi->create_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) -- path: /managed-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-clients - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - - # Get Managed Clients - - try { - Get-V2025ManagedClients - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClients" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clients#get-managed-clients - source: | - from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - try: - # Get Managed Clients - - results = ManagedClientsApi(api_client).get_managed_clients() - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) - print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#delete-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Delete Managed Client - - try { - Remove-V2025ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clients#delete-managed-client - source: | - from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Delete Managed Client - - ManagedClientsApi(api_client).delete_managed_client(id=id) - # Below is a request that includes all optional parameters - # ManagedClientsApi(api_client).delete_managed_client(id) - except Exception as e: - print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Get Managed Client - - try { - Get-V2025ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clients#get-managed-client - source: | - from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Get Managed Client - - results = ManagedClientsApi(api_client).get_managed_client(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client(id) - print("The response of ManagedClientsApi->get_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#update-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025ManagedClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clients#update-managed-client - source: | - from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Client - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) - print("The response of ManagedClientsApi->update_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. - - # Get Managed Client Status - - try { - Get-V2025ManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClientStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_client_status import ManagedClientStatus - from sailpoint.v2025.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. - type = sailpoint.v2025.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. - try: - # Get Managed Client Status - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - $ManagedClusterType = @" - { - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - } - "@ - - # Create new Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType - New-V2025ManagedClusterType -ManagedClusterType $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedClusterType -ManagedClusterType $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - $Type = "IDN" # String | Type descriptor (optional) - $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) - $Org = "denali-xyz" # String | Pinned org (or default) (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Managed Cluster Types - - try { - Get-V2025ManagedClusterTypes - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterTypes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Delete a Managed Cluster Type - - try { - Remove-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Get a Managed Cluster Type - - try { - Get-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update a Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) -- path: /managed-clusters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-V2025ManagedCluster -ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedCluster -ManagedClusterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedCluster" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#create-managed-cluster - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster import ManagedCluster - from sailpoint.v2025.models.managed_cluster_request import ManagedClusterRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_request = '''{ - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - }''' # ManagedClusterRequest | - try: - # Create Create Managed Cluster - new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) - results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) - print("The response of ManagedClustersApi->create_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-V2025ManagedClusters - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusters" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Get Managed Clusters - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-V2025ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedCluster" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#delete-managed-cluster - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) - try: - # Delete Managed Cluster - - ManagedClustersApi(api_client).delete_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) - except Exception as e: - print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-V2025ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedCluster" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - try: - # Get Managed Cluster - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025ManagedCluster -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedCluster -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedCluster" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#update-managed-cluster - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Cluster - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) - print("The response of ManagedClustersApi->update_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-V2025ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ClientLogConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. - try: - # Get Managed Cluster Log Configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-V2025ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2025ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ClientLogConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.client_log_configuration import ClientLogConfiguration - from sailpoint.v2025.models.put_client_log_configuration_request import PutClientLogConfigurationRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. - put_client_log_configuration_request = '''sailpoint.v2025.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. - try: - # Update Managed Cluster Log Configuration - new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id}/manualUpgrade - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#update - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. - - # Trigger Manual Upgrade for Managed Cluster - - try { - Update-V2025 -Id $Id - - # Below is a request that includes all optional parameters - # Update-V2025 -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#update - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.cluster_manual_upgrade import ClusterManualUpgrade - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to trigger manual upgrade. # str | ID of managed cluster to trigger manual upgrade. - try: - # Trigger Manual Upgrade for Managed Cluster - - results = ManagedClustersApi(api_client).update(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).update(id) - print("The response of ManagedClustersApi->update:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->update: %s\n" % e) -- path: /multihosts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#create-multi-host-integration - source: | - $MultiHostIntegrationsCreate = @" - { - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "connector" : "multihost-microsoft-sql-server", - "connectorAttributes" : { - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "created" : "2022-02-08T14:50:03.827Z", - "name" : "My Multi-Host Integration", - "description" : "This is the Multi-Host Integration.", - "modified" : "2024-01-23T18:08:50.897Z" - } - "@ - - # Create Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate - New-V2025MultiHostIntegration -MultiHostIntegrationsCreate $Result - - # Below is a request that includes all optional parameters - # New-V2025MultiHostIntegration -MultiHostIntegrationsCreate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025MultiHostIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#create-multi-host-integration - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integrations import MultiHostIntegrations - from sailpoint.v2025.models.multi_host_integrations_create import MultiHostIntegrationsCreate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_host_integrations_create = '''{ - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "connector" : "multihost-microsoft-sql-server", - "connectorAttributes" : { - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "created" : "2022-02-08T14:50:03.827Z", - "name" : "My Multi-Host Integration", - "description" : "This is the Multi-Host Integration.", - "modified" : "2024-01-23T18:08:50.897Z" - }''' # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create - try: - # Create Multi-Host Integration - new_multi_host_integrations_create = MultiHostIntegrationsCreate.from_json(multi_host_integrations_create) - results = MultiHostIntegrationApi(api_client).create_multi_host_integration(multi_host_integrations_create=new_multi_host_integrations_create) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).create_multi_host_integration(new_multi_host_integrations_create) - print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->create_multi_host_integration: %s\n" % e) -- path: /multihosts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multi-host-integrations-list - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - - # List All Existing Multi-Host Integrations - - try { - Get-V2025MultiHostIntegrationsList - - # Below is a request that includes all optional parameters - # Get-V2025MultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultiHostIntegrationsList" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-multi-host-integrations-list - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integrations import MultiHostIntegrations - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - try: - # List All Existing Multi-Host Integrations - - results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list() - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) - print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) -- path: /multihosts/{multihostId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#create-sources-within-multi-host - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - $MultiHostIntegrationsCreateSources = @"{ - "connectorAttributes" : { - "authType" : "SQLAuthentication", - "url" : "jdbc:sqlserver://178.18.41.118:1433", - "user" : "username", - "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "name" : "My Source", - "description" : "This is the corporate directory." - }"@ - - - # Create Sources Within Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources - New-V2025SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result - - # Below is a request that includes all optional parameters - # New-V2025SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourcesWithinMultiHost" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#create-sources-within-multi-host - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integrations_create_sources import MultiHostIntegrationsCreateSources - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. - multi_host_integrations_create_sources = '''[sailpoint.v2025.MultiHostIntegrationsCreateSources()]''' # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. - try: - # Create Sources Within Multi-Host Integration - new_multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources.from_json(multi_host_integrations_create_sources) - MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id=multihost_id, multi_host_integrations_create_sources=new_multi_host_integrations_create_sources) - # Below is a request that includes all optional parameters - # MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id, new_multi_host_integrations_create_sources) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->create_sources_within_multi_host: %s\n" % e) -- path: /multihosts/{multihostId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#delete-multi-host - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. - - # Delete Multi-Host Integration - - try { - Remove-V2025MultiHost -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Remove-V2025MultiHost -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MultiHost" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#delete-multi-host - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of Multi-Host Integration to delete. # str | ID of Multi-Host Integration to delete. - try: - # Delete Multi-Host Integration - - MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id=multihost_id) - # Below is a request that includes all optional parameters - # MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->delete_multi_host: %s\n" % e) -- path: /multihosts/{multihostId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multi-host-integrations - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - - # Get Multi-Host Integration By ID - - try { - Get-V2025MultiHostIntegrations -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-V2025MultiHostIntegrations -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultiHostIntegrations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-multi-host-integrations - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integrations import MultiHostIntegrations - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. - try: - # Get Multi-Host Integration By ID - - results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id=multihost_id) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id) - print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations: %s\n" % e) -- path: /multihosts/{multihostId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#update-multi-host-sources - source: | - $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. - $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ - - - # Update Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner - Update-V2025MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MultiHostSources" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#update-multi-host-sources - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.update_multi_host_sources_request_inner import UpdateMultiHostSourcesRequestInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = 'anId' # str | ID of the Multi-Host Integration to update. # str | ID of the Multi-Host Integration to update. - update_multi_host_sources_request_inner = '''[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]''' # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. - try: - # Update Multi-Host Integration - new_update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner.from_json(update_multi_host_sources_request_inner) - MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id=multihost_id, update_multi_host_sources_request_inner=new_update_multi_host_sources_request_inner) - # Below is a request that includes all optional parameters - # MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id, new_update_multi_host_sources_request_inner) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->update_multi_host_sources: %s\n" % e) -- path: /multihosts/{multihostId}/acctAggregationGroups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-acct-aggregation-groups - source: | - $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Account-Aggregation-Groups by Multi-Host ID - - try { - Get-V2025AcctAggregationGroups -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-V2025AcctAggregationGroups -MultihostId $MultihostId -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AcctAggregationGroups" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-acct-aggregation-groups - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List Account-Aggregation-Groups by Multi-Host ID - - results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id=multihost_id) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id, offset, limit) - print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) -- path: /multihosts/{multiHostId}/entitlementAggregationGroups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-entitlement-aggregation-groups - source: | - $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Entitlement-Aggregation-Groups by Integration ID - - try { - Get-V2025EntitlementAggregationGroups -MultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementAggregationGroups -MultiHostId $MultiHostId -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementAggregationGroups" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-entitlement-aggregation-groups - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_host_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List Entitlement-Aggregation-Groups by Integration ID - - results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id=multi_host_id) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id, offset, limit) - print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) -- path: /multihosts/{multiHostId}/sources/errors - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multi-host-source-creation-errors - source: | - $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration - - # List Multi-Host Source Creation Errors - - try { - Get-V2025MultiHostSourceCreationErrors -MultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-V2025MultiHostSourceCreationErrors -MultiHostId $MultiHostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultiHostSourceCreationErrors" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-multi-host-source-creation-errors - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_creation_errors import SourceCreationErrors - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_host_id = '004091cb79b04636b88662afa50a4440' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration - try: - # List Multi-Host Source Creation Errors - - results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id=multi_host_id) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) - print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) -- path: /multihosts/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multihost-integration-types - source: | - - # List Multi-Host Integration Types - - try { - Get-V2025MultihostIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-V2025MultihostIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultihostIntegrationTypes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-multihost-integration-types - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integration_template_type import MultiHostIntegrationTemplateType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Multi-Host Integration Types - - results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() - print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) -- path: /multihosts/{multihostId}/sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-sources-within-multi-host - source: | - $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Sources Within Multi-Host Integration - - try { - Get-V2025SourcesWithinMultiHost -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-V2025SourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourcesWithinMultiHost" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-sources-within-multi-host - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_sources import MultiHostSources - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Sources Within Multi-Host Integration - - results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id=multihost_id) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) - print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) -- path: /multihosts/{multihostId}/sources/testConnection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#test-connection-multi-host-sources - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration - - # Test Configuration For Multi-Host Integration - - try { - Test-V2025ConnectionMultiHostSources -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Test-V2025ConnectionMultiHostSources -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ConnectionMultiHostSources" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#test-connection-multi-host-sources - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = '2c91808568c529c60168cca6f90c1324' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration - try: - # Test Configuration For Multi-Host Integration - - MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id=multihost_id) - # Below is a request that includes all optional parameters - # MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->test_connection_multi_host_sources: %s\n" % e) -- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#test-source-connection-multihost - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration - $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration - - # Test Configuration For Multi-Host Integration's Single Source - - try { - Test-V2025SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-V2025SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConnectionMultihost" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#test-source-connection-multihost - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_source_connection_multihost200_response import TestSourceConnectionMultihost200Response - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration - source_id = '2c91808568c529f60168cca6f90c1324' # str | ID of the source within the Multi-Host Integration # str | ID of the source within the Multi-Host Integration - try: - # Test Configuration For Multi-Host Integration's Single Source - - results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id=multihost_id, source_id=source_id) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id, source_id) - print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->test_source_connection_multihost: %s\n" % e) -- path: /non-employee-approvals/{id}/approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#approve-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeApprovalDecision = @" - { - "comment" : "Approved by manager" - } - "@ - - # Approve a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-V2025NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Approve-V2025NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#approve-non-employee-request - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_approval_decision import NonEmployeeApprovalDecision - from sailpoint.v2025.models.non_employee_approval_item import NonEmployeeApprovalItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) - non_employee_approval_decision = '''{ - "comment" : "Approved by manager" - }''' # NonEmployeeApprovalDecision | - try: - # Approve a Non-Employee Request - new_non_employee_approval_decision = NonEmployeeApprovalDecision.from_json(non_employee_approval_decision) - results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id=id, non_employee_approval_decision=new_non_employee_approval_decision) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, new_non_employee_approval_decision) - print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) -- path: /non-employee-records - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-record - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2025NonEmployeeRecord -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2025NonEmployeeRecord -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#create-non-employee-record - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_record import NonEmployeeRecord - from sailpoint.v2025.models.non_employee_request_body import NonEmployeeRequestBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - non_employee_request_body = '''{ - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - }''' # NonEmployeeRequestBody | Non-Employee record creation request body. - try: - # Create Non-Employee Record - new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) - results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(non_employee_request_body=new_non_employee_request_body) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) -- path: /non-employee-records - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-records - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - - # List Non-Employee Records - - try { - Get-V2025NonEmployeeRecords - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRecords" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#list-non-employee-records - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_record import NonEmployeeRecord - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'accountName,sourceId' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) - filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - try: - # List Non-Employee Records - - results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records() - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) -- path: /non-employee-requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-request - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2025NonEmployeeRequest -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2025NonEmployeeRequest -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#create-non-employee-request - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_request import NonEmployeeRequest - from sailpoint.v2025.models.non_employee_request_body import NonEmployeeRequestBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - non_employee_request_body = '''{ - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - }''' # NonEmployeeRequestBody | Non-Employee creation request body - try: - # Create Non-Employee Request - new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) - results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(non_employee_request_body=new_non_employee_request_body) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) -- path: /non-employee-requests - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-requests - source: | - $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - - # List Non-Employee Requests - - try { - Get-V2025NonEmployeeRequests -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRequests" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#list-non-employee-requests - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_request import NonEmployeeRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = 'e136567de87e4d029e60b3c3c55db56d' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'created,approvalStatus' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) - filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - try: - # List Non-Employee Requests - - results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for=requested_for) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) -- path: /non-employee-sources - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-source - source: | - $NonEmployeeSourceRequestBody = @" - { - "owner" : { - "id" : "2c91808570313110017040b06f344ec9" - }, - "managementWorkgroup" : "123299", - "accountManagers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ], - "name" : "Retail", - "description" : "Source description", - "approvers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ] - } - "@ - - # Create Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-V2025NonEmployeeSource -NonEmployeeSourceRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2025NonEmployeeSource -NonEmployeeSourceRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeSource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#create-non-employee-source - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_source_request_body import NonEmployeeSourceRequestBody - from sailpoint.v2025.models.non_employee_source_with_cloud_external_id import NonEmployeeSourceWithCloudExternalId - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - non_employee_source_request_body = '''{ - "owner" : { - "id" : "2c91808570313110017040b06f344ec9" - }, - "managementWorkgroup" : "123299", - "accountManagers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ], - "name" : "Retail", - "description" : "Source description", - "approvers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ] - }''' # NonEmployeeSourceRequestBody | Non-Employee source creation request body. - try: - # Create Non-Employee Source - new_non_employee_source_request_body = NonEmployeeSourceRequestBody.from_json(non_employee_source_request_body) - results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(non_employee_source_request_body=new_non_employee_source_request_body) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(new_non_employee_source_request_body) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) -- path: /non-employee-sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-sources - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) - $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) - $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - - # List Non-Employee Sources - - try { - Get-V2025NonEmployeeSources - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSources" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#list-non-employee-sources - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_source_with_ne_count import NonEmployeeSourceWithNECount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - requested_for = 'me' # str | Identity the request was made for. Use 'me' to indicate the current user. (optional) # str | Identity the request was made for. Use 'me' to indicate the current user. (optional) - non_employee_count = False # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) - sorters = 'name,created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - try: - # List Non-Employee Sources - - results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources() - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) -- path: /non-employee-sources/{sourceId}/schema-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - $NonEmployeeSchemaAttributeBody = @" - { - "helpText" : "The unique identifier for the account", - "label" : "Account Name", - "placeholder" : "Enter a unique user name for this account.", - "type" : "TEXT", - "technicalName" : "account.name", - "required" : true - } - "@ - - # Create a new Schema Attribute for Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - - # Below is a request that includes all optional parameters - # New-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute - from sailpoint.v2025.models.non_employee_schema_attribute_body import NonEmployeeSchemaAttributeBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - non_employee_schema_attribute_body = '''{ - "helpText" : "The unique identifier for the account", - "label" : "Account Name", - "placeholder" : "Enter a unique user name for this account.", - "type" : "TEXT", - "technicalName" : "account.name", - "required" : true - }''' # NonEmployeeSchemaAttributeBody | - try: - # Create a new Schema Attribute for Non-Employee Source - new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody.from_json(non_employee_schema_attribute_body) - results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id=source_id, non_employee_schema_attribute_body=new_non_employee_schema_attribute_body) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, new_non_employee_schema_attribute_body) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) -- path: /non-employee-sources/{sourceId}/schema-attributes - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Delete all custom schema attributes for Non-Employee Source - - try { - Remove-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - try: - # Delete all custom schema attributes for Non-Employee Source - - NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id=source_id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source_schema_attributes: %s\n" % e) -- path: /non-employee-sources/{sourceId}/schema-attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # List Schema Attributes Non-Employee Source - - try { - Get-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - try: - # List Schema Attributes Non-Employee Source - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id=source_id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) -- path: /non-employee-records/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - - # Delete Non-Employee Record - - try { - Remove-V2025NonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#delete-non-employee-record - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) - try: - # Delete Non-Employee Record - - NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id=id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) -- path: /non-employee-records/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - - # Get a Non-Employee Record - - try { - Get-V2025NonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-record - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_record import NonEmployeeRecord - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) - try: - # Get a Non-Employee Record - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id=id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) -- path: /non-employee-records/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#patch-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Non-Employee Record - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025NonEmployeeRecord -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025NonEmployeeRecord -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#patch-non-employee-record - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.non_employee_record import NonEmployeeRecord - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) - json_patch_operation = '''[{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}]''' # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - try: - # Patch Non-Employee Record - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) -- path: /non-employee-records/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#update-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Update Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-V2025NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#update-non-employee-record - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_record import NonEmployeeRecord - from sailpoint.v2025.models.non_employee_request_body import NonEmployeeRequestBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) - non_employee_request_body = '''{ - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - }''' # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - try: - # Update Non-Employee Record - new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) - results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id=id, non_employee_request_body=new_non_employee_request_body) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body) - print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) -- path: /non-employee-records/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk - source: | - $DeleteNonEmployeeRecordsInBulkRequest = @" - - "@ - - # Delete Multiple Non-Employee Records - - try { - $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest - Remove-V2025NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.delete_non_employee_records_in_bulk_request import DeleteNonEmployeeRecordsInBulkRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - delete_non_employee_records_in_bulk_request = '''sailpoint.v2025.DeleteNonEmployeeRecordsInBulkRequest()''' # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. - try: - # Delete Multiple Non-Employee Records - new_delete_non_employee_records_in_bulk_request = DeleteNonEmployeeRecordsInBulkRequest.from_json(delete_non_employee_records_in_bulk_request) - NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(delete_non_employee_records_in_bulk_request=new_delete_non_employee_records_in_bulk_request) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(new_delete_non_employee_records_in_bulk_request) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_records_in_bulk: %s\n" % e) -- path: /non-employee-requests/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-request - source: | - $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format - - # Delete Non-Employee Request - - try { - Remove-V2025NonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#delete-non-employee-request - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format - try: - # Delete Non-Employee Request - - NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id=id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) -- path: /non-employee-requests/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-request - source: | - $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) - - # Get a Non-Employee Request - - try { - Get-V2025NonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-request - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_request import NonEmployeeRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) - try: - # Get a Non-Employee Request - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id=id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Delete a Schema Attribute for Non-Employee Source - - try { - Remove-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) - source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - try: - # Delete a Schema Attribute for Non-Employee Source - - NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id, source_id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_schema_attribute: %s\n" % e) -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Get Schema Attribute Non-Employee Source - - try { - Get-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) - source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - try: - # Get Schema Attribute Non-Employee Source - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id, source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Schema Attribute for Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) - source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - json_patch_operation = '''[{op=replace, path=/label, value={new attribute label=null}}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. - try: - # Patch a Schema Attribute for Non-Employee Source - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, new_json_patch_operation) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) -- path: /non-employee-sources/{sourceId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source - source: | - $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - - # Delete Non-Employee Source - - try { - Remove-V2025NonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeSource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id - try: - # Delete Non-Employee Source - - NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id=source_id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) -- path: /non-employee-sources/{sourceId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-source - source: | - $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id - - # Get a Non-Employee Source - - try { - Get-V2025NonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-source - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_source import NonEmployeeSource - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id - try: - # Get a Non-Employee Source - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id=source_id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) -- path: /non-employee-sources/{sourceId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#patch-non-employee-source - source: | - $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeSource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#patch-non-employee-source - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.non_employee_source import NonEmployeeSource - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id - json_patch_operation = '''[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]''' # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - try: - # Patch a Non-Employee Source - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id=source_id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) -- path: /non-employee-sources/{id}/non-employees/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#export-non-employee-records - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - - # Exports Non-Employee Records to CSV - - try { - Export-V2025NonEmployeeRecords -Id $Id - - # Below is a request that includes all optional parameters - # Export-V2025NonEmployeeRecords -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025NonEmployeeRecords" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#export-non-employee-records - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) - try: - # Exports Non-Employee Records to CSV - - NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id=id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) -- path: /non-employee-sources/{id}/schema-attributes-template/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) - - # Exports Source Schema Template - - try { - Export-V2025NonEmployeeSourceSchemaTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Export-V2025NonEmployeeSourceSchemaTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025NonEmployeeSourceSchemaTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID) - try: - # Exports Source Schema Template - - NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id=id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_source_schema_template: %s\n" % e) -- path: /non-employee-approvals/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) - - # Get a non-employee approval item detail - - try { - Get-V2025NonEmployeeApproval -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeApproval" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_approval_item_detail import NonEmployeeApprovalItemDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) - include_detail = true # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) - try: - # Get a non-employee approval item detail - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id=id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, include_detail) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) -- path: /non-employee-approvals/summary/{requested-for} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval-summary - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Approval Requests - - try { - Get-V2025NonEmployeeApprovalSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeApprovalSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeApprovalSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval-summary - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_approval_summary import NonEmployeeApprovalSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = '2c91808280430dfb0180431a59440460' # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - try: - # Get Summary of Non-Employee Approval Requests - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for=requested_for) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) -- path: /non-employee-sources/{id}/non-employee-bulk-upload/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) - - # Obtain the status of bulk upload on the source - - try { - Get-V2025NonEmployeeBulkUploadStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeBulkUploadStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeBulkUploadStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_bulk_upload_status import NonEmployeeBulkUploadStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source ID (UUID) # str | Source ID (UUID) - try: - # Obtain the status of bulk upload on the source - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id=id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) -- path: /non-employee-requests/summary/{requested-for} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-request-summary - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Requests - - try { - Get-V2025NonEmployeeRequestSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRequestSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRequestSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-request-summary - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_request_summary import NonEmployeeRequestSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = '2c91808280430dfb0180431a59440460' # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - try: - # Get Summary of Non-Employee Requests - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for=requested_for) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) -- path: /non-employee-sources/{id}/non-employee-bulk-upload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - $Data = # System.IO.FileInfo | - - # Imports, or Updates, Non-Employee Records - - try { - Import-V2025NonEmployeeRecordsInBulk -Id $Id -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2025NonEmployeeRecordsInBulk -Id $Id -Data $Data - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025NonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_bulk_upload_job import NonEmployeeBulkUploadJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) - data = None # bytearray | # bytearray | - try: - # Imports, or Updates, Non-Employee Records - - results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id=id, data=data) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id, data) - print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) -- path: /non-employee-approvals - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-approvals - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Get List of Non-Employee Approval Requests - - try { - Get-V2025NonEmployeeApprovals - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeApprovals" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#list-non-employee-approvals - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_approval_item import NonEmployeeApprovalItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = '2c91808280430dfb0180431a59440460' # str | The identity for whom the request was made. *me* indicates the current user. (optional) # str | The identity for whom the request was made. *me* indicates the current user. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'approvalStatus eq \"Pending\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) - sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - try: - # Get List of Non-Employee Approval Requests - - results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals() - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) -- path: /non-employee-approvals/{id}/reject - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#reject-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeRejectApprovalDecision = @" - { - "comment" : "approved" - } - "@ - - # Reject a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-V2025NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Deny-V2025NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#reject-non-employee-request - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_approval_item import NonEmployeeApprovalItem - from sailpoint.v2025.models.non_employee_reject_approval_decision import NonEmployeeRejectApprovalDecision - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) - non_employee_reject_approval_decision = '''{ - "comment" : "approved" - }''' # NonEmployeeRejectApprovalDecision | - try: - # Reject a Non-Employee Request - new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision.from_json(non_employee_reject_approval_decision) - results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id=id, non_employee_reject_approval_decision=new_non_employee_reject_approval_decision) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision) - print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) -- path: /verified-domains - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-domain-dkim - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $DomainAddress = @" - { - "domain" : "sailpoint.com" - } - "@ - - # Verify domain address via DKIM - - try { - $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress - New-V2025DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result - - # Below is a request that includes all optional parameters - # New-V2025DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DomainDkim" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#create-domain-dkim - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.domain_address import DomainAddress - from sailpoint.v2025.models.domain_status_dto import DomainStatusDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - domain_address = '''{ - "domain" : "sailpoint.com" - }''' # DomainAddress | - try: - # Verify domain address via DKIM - new_domain_address = DomainAddress.from_json(domain_address) - results = NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental=x_sail_point_experimental, domain_address=new_domain_address) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental, new_domain_address) - print("The response of NotificationsApi->create_domain_dkim:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) -- path: /verified-domains - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-dkim-attributes - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get DKIM Attributes - - try { - Get-V2025DkimAttributes -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DkimAttributes -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DkimAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#get-dkim-attributes - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.dkim_attributes import DkimAttributes - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get DKIM Attributes - - results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) - print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) -- path: /notification-templates - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-notification-template - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TemplateDto = @" - { - "slackTemplate" : "slackTemplate", - "footer" : "footer", - "teamsTemplate" : "teamsTemplate", - "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", - "created" : "2020-01-01T00:00:00Z", - "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", - "medium" : "EMAIL", - "locale" : "en", - "body" : "Please go to the task manager", - "name" : "Task Manager Subscription", - "replyTo" : "$__global.emailFromAddress", - "header" : "header", - "modified" : "2020-01-01T00:00:00Z", - "from" : "$__global.emailFromAddress", - "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", - "key" : "cloud_manual_work_item_summary" - } - "@ - - # Create Notification Template - - try { - $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto - New-V2025NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result - - # Below is a request that includes all optional parameters - # New-V2025NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NotificationTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#create-notification-template - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.template_dto import TemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - template_dto = '''{ - "slackTemplate" : "slackTemplate", - "footer" : "footer", - "teamsTemplate" : "teamsTemplate", - "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", - "created" : "2020-01-01T00:00:00Z", - "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", - "medium" : "EMAIL", - "locale" : "en", - "body" : "Please go to the task manager", - "name" : "Task Manager Subscription", - "replyTo" : "$__global.emailFromAddress", - "header" : "header", - "modified" : "2020-01-01T00:00:00Z", - "from" : "$__global.emailFromAddress", - "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", - "key" : "cloud_manual_work_item_summary" - }''' # TemplateDto | - try: - # Create Notification Template - new_template_dto = TemplateDto.from_json(template_dto) - results = NotificationsApi(api_client).create_notification_template(x_sail_point_experimental=x_sail_point_experimental, template_dto=new_template_dto) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).create_notification_template(x_sail_point_experimental, new_template_dto) - print("The response of NotificationsApi->create_notification_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) -- path: /notification-templates - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-templates - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "medium eq "EMAIL"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - - # List Notification Templates - - try { - Get-V2025NotificationTemplates -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplates" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#list-notification-templates - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.template_dto import TemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'medium eq \"EMAIL\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - try: - # List Notification Templates - - results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) - print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) -- path: /verified-from-addresses - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-verified-from-address - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $EmailStatusDto = @" - { - "isVerifiedByDomain" : false, - "verificationStatus" : "PENDING", - "id" : "id", - "email" : "sender@example.com" - } - "@ - - # Create Verified From Address - - try { - $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto - New-V2025VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result - - # Below is a request that includes all optional parameters - # New-V2025VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025VerifiedFromAddress" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#create-verified-from-address - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.email_status_dto import EmailStatusDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - email_status_dto = '''{ - "isVerifiedByDomain" : false, - "verificationStatus" : "PENDING", - "id" : "id", - "email" : "sender@example.com" - }''' # EmailStatusDto | - try: - # Create Verified From Address - new_email_status_dto = EmailStatusDto.from_json(email_status_dto) - results = NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental=x_sail_point_experimental, email_status_dto=new_email_status_dto) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental, new_email_status_dto) - print("The response of NotificationsApi->create_verified_from_address:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) -- path: /verified-from-addresses - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-from-addresses - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "email eq "john.doe@company.com"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) - $Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) - - # List From Addresses - - try { - Get-V2025FromAddresses -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025FromAddresses -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FromAddresses" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#list-from-addresses - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.email_status_dto import EmailStatusDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'email eq \"john.doe@company.com\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) - sorters = 'email' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) - try: - # List From Addresses - - results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) -- path: /notification-templates/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#delete-notification-templates-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TemplateBulkDeleteDto = @"{ - "medium" : "EMAIL", - "locale" : "en", - "key" : "cloud_manual_work_item_summary" - }"@ - - - # Bulk Delete Notification Templates - - try { - $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto - Remove-V2025NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result - - # Below is a request that includes all optional parameters - # Remove-V2025NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NotificationTemplatesInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#delete-notification-templates-in-bulk - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.template_bulk_delete_dto import TemplateBulkDeleteDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - template_bulk_delete_dto = '''[sailpoint.v2025.TemplateBulkDeleteDto()]''' # List[TemplateBulkDeleteDto] | - try: - # Bulk Delete Notification Templates - new_template_bulk_delete_dto = TemplateBulkDeleteDto.from_json(template_bulk_delete_dto) - NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental=x_sail_point_experimental, template_bulk_delete_dto=new_template_bulk_delete_dto) - # Below is a request that includes all optional parameters - # NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental, new_template_bulk_delete_dto) - except Exception as e: - print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) -- path: /verified-from-addresses/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#delete-verified-from-address - source: | - $Id = "MyId" # String | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Verified From Address - - try { - Remove-V2025VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025VerifiedFromAddress" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#delete-verified-from-address - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'id_example' # str | # str | - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete Verified From Address - - NotificationsApi(api_client).delete_verified_from_address(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # NotificationsApi(api_client).delete_verified_from_address(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) -- path: /mail-from-attributes/{identity} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-mail-from-attributes - source: | - $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get MAIL FROM Attributes - - try { - Get-V2025MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MailFromAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#get-mail-from-attributes - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mail_from_attributes import MailFromAttributes - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get MAIL FROM Attributes - - results = NotificationsApi(api_client).get_mail_from_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).get_mail_from_attributes(id, x_sail_point_experimental) - print("The response of NotificationsApi->get_mail_from_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) -- path: /notification-templates/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-notification-template - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Notification Template By Id - - try { - Get-V2025NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#get-notification-template - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.template_dto import TemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Notification Template By Id - - results = NotificationsApi(api_client).get_notification_template(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).get_notification_template(id, x_sail_point_experimental) - print("The response of NotificationsApi->get_notification_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) -- path: /notification-template-context - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-notifications-template-context - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Notification Template Context - - try { - Get-V2025NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationsTemplateContext" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#get-notifications-template-context - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.notification_template_context import NotificationTemplateContext - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Notification Template Context - - results = NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental) - print("The response of NotificationsApi->get_notifications_template_context:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) -- path: /notification-preferences/{key} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-preferences - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Notification Preferences for tenant. - - try { - Get-V2025NotificationPreferences -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationPreferences -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationPreferences" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#list-notification-preferences - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.preferences_dto import PreferencesDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List Notification Preferences for tenant. - - results = NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental) - print("The response of NotificationsApi->list_notification_preferences:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) -- path: /notification-template-defaults - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-template-defaults - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "key eq "cloud_manual_work_item_summary"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - - # List Notification Template Defaults - - try { - Get-V2025NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplateDefaults" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#list-notification-template-defaults - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.template_dto_default import TemplateDtoDefault - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'key eq \"cloud_manual_work_item_summary\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - try: - # List Notification Template Defaults - - results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) - print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) -- path: /mail-from-attributes - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#put-mail-from-attributes - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MailFromAttributesDto = @" - { - "identity" : "BobSmith@sailpoint.com", - "mailFromDomain" : "example.sailpoint.com" - } - "@ - - # Change MAIL FROM domain - - try { - $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto - Send-V2025MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result - - # Below is a request that includes all optional parameters - # Send-V2025MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025MailFromAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#put-mail-from-attributes - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mail_from_attributes import MailFromAttributes - from sailpoint.v2025.models.mail_from_attributes_dto import MailFromAttributesDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - mail_from_attributes_dto = '''{ - "identity" : "BobSmith@sailpoint.com", - "mailFromDomain" : "example.sailpoint.com" - }''' # MailFromAttributesDto | - try: - # Change MAIL FROM domain - new_mail_from_attributes_dto = MailFromAttributesDto.from_json(mail_from_attributes_dto) - results = NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental=x_sail_point_experimental, mail_from_attributes_dto=new_mail_from_attributes_dto) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental, new_mail_from_attributes_dto) - print("The response of NotificationsApi->put_mail_from_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) -- path: /send-test-notification - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#send-test-notification - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SendTestNotificationRequestDto = @" - { - "context" : "{}", - "medium" : "EMAIL", - "key" : "cloud_manual_work_item_summary" - } - "@ - - # Send Test Notification - - try { - $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto - Send-V2025TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result - - # Below is a request that includes all optional parameters - # Send-V2025TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TestNotification" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#send-test-notification - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.send_test_notification_request_dto import SendTestNotificationRequestDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - send_test_notification_request_dto = '''{ - "context" : "{}", - "medium" : "EMAIL", - "key" : "cloud_manual_work_item_summary" - }''' # SendTestNotificationRequestDto | - try: - # Send Test Notification - new_send_test_notification_request_dto = SendTestNotificationRequestDto.from_json(send_test_notification_request_dto) - NotificationsApi(api_client).send_test_notification(x_sail_point_experimental=x_sail_point_experimental, send_test_notification_request_dto=new_send_test_notification_request_dto) - # Below is a request that includes all optional parameters - # NotificationsApi(api_client).send_test_notification(x_sail_point_experimental, new_send_test_notification_request_dto) - except Exception as e: - print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) -- path: /oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#create-oauth-client - source: | - $CreateOAuthClientRequest = @" - { - "internal" : false, - "businessName" : "Acme-Solar", - "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", - "refreshTokenValiditySeconds" : 86400, - "type" : "CONFIDENTIAL", - "redirectUris" : [ "http://localhost:12345" ], - "enabled" : true, - "accessType" : "OFFLINE", - "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], - "strongAuthSupported" : false, - "homepageUrl" : "http://localhost:12345", - "accessTokenValiditySeconds" : 750, - "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], - "name" : "Demo API Client", - "claimsSupported" : false - } - "@ - - # Create OAuth Client - - try { - $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-V2025OauthClient -CreateOAuthClientRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025OauthClient -CreateOAuthClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025OauthClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/o-auth-clients#create-oauth-client - source: | - from sailpoint.v2025.api.o_auth_clients_api import OAuthClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_o_auth_client_request import CreateOAuthClientRequest - from sailpoint.v2025.models.create_o_auth_client_response import CreateOAuthClientResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_o_auth_client_request = '''{ - "internal" : false, - "businessName" : "Acme-Solar", - "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", - "refreshTokenValiditySeconds" : 86400, - "type" : "CONFIDENTIAL", - "redirectUris" : [ "http://localhost:12345" ], - "enabled" : true, - "accessType" : "OFFLINE", - "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], - "strongAuthSupported" : false, - "homepageUrl" : "http://localhost:12345", - "accessTokenValiditySeconds" : 750, - "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], - "name" : "Demo API Client", - "claimsSupported" : false - }''' # CreateOAuthClientRequest | - try: - # Create OAuth Client - new_create_o_auth_client_request = CreateOAuthClientRequest.from_json(create_o_auth_client_request) - results = OAuthClientsApi(api_client).create_oauth_client(create_o_auth_client_request=new_create_o_auth_client_request) - # Below is a request that includes all optional parameters - # results = OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request) - print("The response of OAuthClientsApi->create_oauth_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) -- path: /oauth-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#list-oauth-clients - source: | - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - - # List OAuth Clients - - try { - Get-V2025OauthClients - - # Below is a request that includes all optional parameters - # Get-V2025OauthClients -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OauthClients" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/o-auth-clients#list-oauth-clients - source: | - from sailpoint.v2025.api.o_auth_clients_api import OAuthClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_o_auth_client_response import GetOAuthClientResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - try: - # List OAuth Clients - - results = OAuthClientsApi(api_client).list_oauth_clients() - # Below is a request that includes all optional parameters - # results = OAuthClientsApi(api_client).list_oauth_clients(filters) - print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) -- path: /oauth-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#delete-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Delete OAuth Client - - try { - Remove-V2025OauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025OauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025OauthClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/o-auth-clients#delete-oauth-client - source: | - from sailpoint.v2025.api.o_auth_clients_api import OAuthClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id - try: - # Delete OAuth Client - - OAuthClientsApi(api_client).delete_oauth_client(id=id) - # Below is a request that includes all optional parameters - # OAuthClientsApi(api_client).delete_oauth_client(id) - except Exception as e: - print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) -- path: /oauth-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#get-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Get OAuth Client - - try { - Get-V2025OauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025OauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OauthClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/o-auth-clients#get-oauth-client - source: | - from sailpoint.v2025.api.o_auth_clients_api import OAuthClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_o_auth_client_response import GetOAuthClientResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id - try: - # Get OAuth Client - - results = OAuthClientsApi(api_client).get_oauth_client(id=id) - # Below is a request that includes all optional parameters - # results = OAuthClientsApi(api_client).get_oauth_client(id) - print("The response of OAuthClientsApi->get_oauth_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) -- path: /oauth-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#patch-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch OAuth Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025OauthClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025OauthClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025OauthClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/o-auth-clients#patch-oauth-client - source: | - from sailpoint.v2025.api.o_auth_clients_api import OAuthClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_o_auth_client_response import GetOAuthClientResponse - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id - json_patch_operation = '''[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - try: - # Patch OAuth Client - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = OAuthClientsApi(api_client).patch_oauth_client(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation) - print("The response of OAuthClientsApi->patch_oauth_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) -- path: /org-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/org-config#get-org-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Org Config Settings - - try { - Get-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OrgConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/org-config#get-org-config - source: | - from sailpoint.v2025.api.org_config_api import OrgConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.org_config import OrgConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Org Config Settings - - results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental) - print("The response of OrgConfigApi->get_org_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) -- path: /org-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/org-config#patch-org-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Org Config - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025OrgConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/org-config#patch-org-config - source: | - from sailpoint.v2025.api.org_config_api import OrgConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.org_config import OrgConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[{op=replace, path=/timeZone, value=America/Toronto}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - try: - # Patch Org Config - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental, new_json_patch_operation) - print("The response of OrgConfigApi->patch_org_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) -- path: /org-config/valid-time-zones - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/org-config#get-valid-time-zones - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Get Valid Time Zones - - try { - Get-V2025ValidTimeZones -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ValidTimeZones" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/org-config#get-valid-time-zones - source: | - from sailpoint.v2025.api.org_config_api import OrgConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Get Valid Time Zones - - results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count) - print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) -- path: /password-org-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#create-password-org-config - source: | - $PasswordOrgConfig = @" - { - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - } - "@ - - # Create Password Org Config - - try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - New-V2025PasswordOrgConfig -PasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # New-V2025PasswordOrgConfig -PasswordOrgConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordOrgConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-configuration#create-password-org-config - source: | - from sailpoint.v2025.api.password_configuration_api import PasswordConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_org_config import PasswordOrgConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - password_org_config = '''{ - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - }''' # PasswordOrgConfig | - try: - # Create Password Org Config - new_password_org_config = PasswordOrgConfig.from_json(password_org_config) - results = PasswordConfigurationApi(api_client).create_password_org_config(password_org_config=new_password_org_config) - # Below is a request that includes all optional parameters - # results = PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config) - print("The response of PasswordConfigurationApi->create_password_org_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) -- path: /password-org-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#get-password-org-config - source: | - - # Get Password Org Config - - try { - Get-V2025PasswordOrgConfig - - # Below is a request that includes all optional parameters - # Get-V2025PasswordOrgConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordOrgConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-configuration#get-password-org-config - source: | - from sailpoint.v2025.api.password_configuration_api import PasswordConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_org_config import PasswordOrgConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get Password Org Config - - results = PasswordConfigurationApi(api_client).get_password_org_config() - # Below is a request that includes all optional parameters - # results = PasswordConfigurationApi(api_client).get_password_org_config() - print("The response of PasswordConfigurationApi->get_password_org_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) -- path: /password-org-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#put-password-org-config - source: | - $PasswordOrgConfig = @" - { - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - } - "@ - - # Update Password Org Config - - try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - Send-V2025PasswordOrgConfig -PasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025PasswordOrgConfig -PasswordOrgConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PasswordOrgConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-configuration#put-password-org-config - source: | - from sailpoint.v2025.api.password_configuration_api import PasswordConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_org_config import PasswordOrgConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - password_org_config = '''{ - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - }''' # PasswordOrgConfig | - try: - # Update Password Org Config - new_password_org_config = PasswordOrgConfig.from_json(password_org_config) - results = PasswordConfigurationApi(api_client).put_password_org_config(password_org_config=new_password_org_config) - # Below is a request that includes all optional parameters - # results = PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config) - print("The response of PasswordConfigurationApi->put_password_org_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) -- path: /password-dictionary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-dictionary#get-password-dictionary - source: | - - # Get Password Dictionary - - try { - Get-V2025PasswordDictionary - - # Below is a request that includes all optional parameters - # Get-V2025PasswordDictionary - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordDictionary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-dictionary#get-password-dictionary - source: | - from sailpoint.v2025.api.password_dictionary_api import PasswordDictionaryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get Password Dictionary - - results = PasswordDictionaryApi(api_client).get_password_dictionary() - # Below is a request that includes all optional parameters - # results = PasswordDictionaryApi(api_client).get_password_dictionary() - print("The response of PasswordDictionaryApi->get_password_dictionary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) -- path: /password-dictionary - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-dictionary#put-password-dictionary - source: | - $File = # System.IO.FileInfo | (optional) - - # Update Password Dictionary - - try { - Send-V2025PasswordDictionary - - # Below is a request that includes all optional parameters - # Send-V2025PasswordDictionary -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PasswordDictionary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-dictionary#put-password-dictionary - source: | - from sailpoint.v2025.api.password_dictionary_api import PasswordDictionaryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - file = None # bytearray | (optional) # bytearray | (optional) - try: - # Update Password Dictionary - - PasswordDictionaryApi(api_client).put_password_dictionary() - # Below is a request that includes all optional parameters - # PasswordDictionaryApi(api_client).put_password_dictionary(file) - except Exception as e: - print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) -- path: /generate-password-reset-token/digit - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-management#create-digit-token - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $PasswordDigitTokenReset = @" - { - "durationMinutes" : 5, - "length" : 8, - "userId" : "Abby.Smith" - } - "@ - - # Generate a digit token - - try { - $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset - New-V2025DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result - - # Below is a request that includes all optional parameters - # New-V2025DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DigitToken" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-management#create-digit-token - source: | - from sailpoint.v2025.api.password_management_api import PasswordManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_digit_token import PasswordDigitToken - from sailpoint.v2025.models.password_digit_token_reset import PasswordDigitTokenReset - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - password_digit_token_reset = '''{ - "durationMinutes" : 5, - "length" : 8, - "userId" : "Abby.Smith" - }''' # PasswordDigitTokenReset | - try: - # Generate a digit token - new_password_digit_token_reset = PasswordDigitTokenReset.from_json(password_digit_token_reset) - results = PasswordManagementApi(api_client).create_digit_token(x_sail_point_experimental=x_sail_point_experimental, password_digit_token_reset=new_password_digit_token_reset) - # Below is a request that includes all optional parameters - # results = PasswordManagementApi(api_client).create_digit_token(x_sail_point_experimental, new_password_digit_token_reset) - print("The response of PasswordManagementApi->create_digit_token:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) -- path: /password-change-status/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-management#get-password-change-status - source: | - $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID - - # Get Password Change Request Status - - try { - Get-V2025PasswordChangeStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025PasswordChangeStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordChangeStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-management#get-password-change-status - source: | - from sailpoint.v2025.api.password_management_api import PasswordManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_status import PasswordStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID - try: - # Get Password Change Request Status - - results = PasswordManagementApi(api_client).get_password_change_status(id=id) - # Below is a request that includes all optional parameters - # results = PasswordManagementApi(api_client).get_password_change_status(id) - print("The response of PasswordManagementApi->get_password_change_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) -- path: /query-password-info - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-management#query-password-info - source: | - $PasswordInfoQueryDTO = @" - { - "sourceName" : "My-AD", - "userName" : "Abby.Smith" - } - "@ - - # Query Password Info - - try { - $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO - Search-V2025PasswordInfo -PasswordInfoQueryDTO $Result - - # Below is a request that includes all optional parameters - # Search-V2025PasswordInfo -PasswordInfoQueryDTO $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025PasswordInfo" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-management#query-password-info - source: | - from sailpoint.v2025.api.password_management_api import PasswordManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_info import PasswordInfo - from sailpoint.v2025.models.password_info_query_dto import PasswordInfoQueryDTO - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - password_info_query_dto = '''{ - "sourceName" : "My-AD", - "userName" : "Abby.Smith" - }''' # PasswordInfoQueryDTO | - try: - # Query Password Info - new_password_info_query_dto = PasswordInfoQueryDto.from_json(password_info_query_dto) - results = PasswordManagementApi(api_client).query_password_info(password_info_query_dto=new_password_info_query_dto) - # Below is a request that includes all optional parameters - # results = PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto) - print("The response of PasswordManagementApi->query_password_info:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) -- path: /set-password - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-management#set-password - source: | - $PasswordChangeRequest = @" - { - "sourceId" : "8a807d4c73c545510173c545d4b60246", - "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", - "identityId" : "8a807d4c73c545510173c545f0a002ff", - "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", - "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" - } - "@ - - # Set Identity's Password - - try { - $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest - Set-V2025Password -PasswordChangeRequest $Result - - # Below is a request that includes all optional parameters - # Set-V2025Password -PasswordChangeRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025Password" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-management#set-password - source: | - from sailpoint.v2025.api.password_management_api import PasswordManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_change_request import PasswordChangeRequest - from sailpoint.v2025.models.password_change_response import PasswordChangeResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - password_change_request = '''{ - "sourceId" : "8a807d4c73c545510173c545d4b60246", - "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", - "identityId" : "8a807d4c73c545510173c545f0a002ff", - "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", - "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" - }''' # PasswordChangeRequest | - try: - # Set Identity's Password - new_password_change_request = PasswordChangeRequest.from_json(password_change_request) - results = PasswordManagementApi(api_client).set_password(password_change_request=new_password_change_request) - # Below is a request that includes all optional parameters - # results = PasswordManagementApi(api_client).set_password(new_password_change_request) - print("The response of PasswordManagementApi->set_password:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) -- path: /password-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#create-password-policy - source: | - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : 1939056206564, - "validateAgainstAccountId" : false, - "dateCreated" : 1639056206564, - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Create Password Policy - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-policies#create-password-policy - source: | - from sailpoint.v2025.api.password_policies_api import PasswordPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_policy_v3_dto import PasswordPolicyV3Dto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - password_policy_v3_dto = '''{ - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : 1939056206564, - "validateAgainstAccountId" : false, - "dateCreated" : 1639056206564, - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - }''' # PasswordPolicyV3Dto | - try: - # Create Password Policy - new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) - results = PasswordPoliciesApi(api_client).create_password_policy(password_policy_v3_dto=new_password_policy_v3_dto) - # Below is a request that includes all optional parameters - # results = PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto) - print("The response of PasswordPoliciesApi->create_password_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) -- path: /password-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#list-password-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Password Policies - - try { - Get-V2025PasswordPolicies - - # Below is a request that includes all optional parameters - # Get-V2025PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicies" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-policies#list-password-policies - source: | - from sailpoint.v2025.api.password_policies_api import PasswordPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_policy_v3_dto import PasswordPolicyV3Dto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Password Policies - - results = PasswordPoliciesApi(api_client).list_password_policies() - # Below is a request that includes all optional parameters - # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) - print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) -- path: /password-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#delete-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. - - # Delete Password Policy by ID - - try { - Remove-V2025PasswordPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025PasswordPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PasswordPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-policies#delete-password-policy - source: | - from sailpoint.v2025.api.password_policies_api import PasswordPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. - try: - # Delete Password Policy by ID - - PasswordPoliciesApi(api_client).delete_password_policy(id=id) - # Below is a request that includes all optional parameters - # PasswordPoliciesApi(api_client).delete_password_policy(id) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) -- path: /password-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#get-password-policy-by-id - source: | - $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. - - # Get Password Policy by ID - - try { - Get-V2025PasswordPolicyById -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025PasswordPolicyById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicyById" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-policies#get-password-policy-by-id - source: | - from sailpoint.v2025.api.password_policies_api import PasswordPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_policy_v3_dto import PasswordPolicyV3Dto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. - try: - # Get Password Policy by ID - - results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id=id) - # Below is a request that includes all optional parameters - # results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id) - print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) -- path: /password-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#set-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : 1939056206564, - "validateAgainstAccountId" : false, - "dateCreated" : 1639056206564, - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Update Password Policy by ID - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025PasswordPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-policies#set-password-policy - source: | - from sailpoint.v2025.api.password_policies_api import PasswordPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_policy_v3_dto import PasswordPolicyV3Dto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ff808081838d9e9d01838da6a03e0007' # str | The ID of password policy to update. # str | The ID of password policy to update. - password_policy_v3_dto = '''{ - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : 1939056206564, - "validateAgainstAccountId" : false, - "dateCreated" : 1639056206564, - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - }''' # PasswordPolicyV3Dto | - try: - # Update Password Policy by ID - new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) - results = PasswordPoliciesApi(api_client).set_password_policy(id=id, password_policy_v3_dto=new_password_policy_v3_dto) - # Below is a request that includes all optional parameters - # results = PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto) - print("The response of PasswordPoliciesApi->set_password_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) -- path: /password-sync-groups - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#create-password-sync-group - source: | - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Create Password Sync Group - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-V2025PasswordSyncGroup -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # New-V2025PasswordSyncGroup -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordSyncGroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-sync-groups#create-password-sync-group - source: | - from sailpoint.v2025.api.password_sync_groups_api import PasswordSyncGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_sync_group import PasswordSyncGroup - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - password_sync_group = '''{ - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - }''' # PasswordSyncGroup | - try: - # Create Password Sync Group - new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) - results = PasswordSyncGroupsApi(api_client).create_password_sync_group(password_sync_group=new_password_sync_group) - # Below is a request that includes all optional parameters - # results = PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group) - print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) -- path: /password-sync-groups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#get-password-sync-groups - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Get Password Sync Group List - - try { - Get-V2025PasswordSyncGroups - - # Below is a request that includes all optional parameters - # Get-V2025PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordSyncGroups" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-sync-groups#get-password-sync-groups - source: | - from sailpoint.v2025.api.password_sync_groups_api import PasswordSyncGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_sync_group import PasswordSyncGroup - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Get Password Sync Group List - - results = PasswordSyncGroupsApi(api_client).get_password_sync_groups() - # Below is a request that includes all optional parameters - # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) - print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) -- path: /password-sync-groups/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#delete-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. - - # Delete Password Sync Group by ID - - try { - Remove-V2025PasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025PasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PasswordSyncGroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-sync-groups#delete-password-sync-group - source: | - from sailpoint.v2025.api.password_sync_groups_api import PasswordSyncGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to delete. # str | The ID of password sync group to delete. - try: - # Delete Password Sync Group by ID - - PasswordSyncGroupsApi(api_client).delete_password_sync_group(id=id) - # Below is a request that includes all optional parameters - # PasswordSyncGroupsApi(api_client).delete_password_sync_group(id) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) -- path: /password-sync-groups/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#get-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. - - # Get Password Sync Group by ID - - try { - Get-V2025PasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025PasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordSyncGroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-sync-groups#get-password-sync-group - source: | - from sailpoint.v2025.api.password_sync_groups_api import PasswordSyncGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_sync_group import PasswordSyncGroup - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to retrieve. # str | The ID of password sync group to retrieve. - try: - # Get Password Sync Group by ID - - results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id=id) - # Below is a request that includes all optional parameters - # results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id) - print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) -- path: /password-sync-groups/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#update-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Update Password Sync Group by ID - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-V2025PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # Update-V2025PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PasswordSyncGroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-sync-groups#update-password-sync-group - source: | - from sailpoint.v2025.api.password_sync_groups_api import PasswordSyncGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_sync_group import PasswordSyncGroup - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to update. # str | The ID of password sync group to update. - password_sync_group = '''{ - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - }''' # PasswordSyncGroup | - try: - # Update Password Sync Group by ID - new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) - results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id=id, password_sync_group=new_password_sync_group) - # Below is a request that includes all optional parameters - # results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group) - print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) -- path: /personal-access-tokens - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#create-personal-access-token - source: | - $CreatePersonalAccessTokenRequest = @" - { - "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], - "accessTokenValiditySeconds" : 36900, - "name" : "NodeJS Integration" - } - "@ - - # Create Personal Access Token - - try { - $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-V2025PersonalAccessToken -CreatePersonalAccessTokenRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025PersonalAccessToken -CreatePersonalAccessTokenRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PersonalAccessToken" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/personal-access-tokens#create-personal-access-token - source: | - from sailpoint.v2025.api.personal_access_tokens_api import PersonalAccessTokensApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest - from sailpoint.v2025.models.create_personal_access_token_response import CreatePersonalAccessTokenResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_personal_access_token_request = '''{ - "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], - "accessTokenValiditySeconds" : 36900, - "name" : "NodeJS Integration" - }''' # CreatePersonalAccessTokenRequest | Name and scope of personal access token. - try: - # Create Personal Access Token - new_create_personal_access_token_request = CreatePersonalAccessTokenRequest.from_json(create_personal_access_token_request) - results = PersonalAccessTokensApi(api_client).create_personal_access_token(create_personal_access_token_request=new_create_personal_access_token_request) - # Below is a request that includes all optional parameters - # results = PersonalAccessTokensApi(api_client).create_personal_access_token(new_create_personal_access_token_request) - print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) -- path: /personal-access-tokens - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#list-personal-access-tokens - source: | - $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - - # List Personal Access Tokens - - try { - Get-V2025PersonalAccessTokens - - # Below is a request that includes all optional parameters - # Get-V2025PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PersonalAccessTokens" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/personal-access-tokens#list-personal-access-tokens - source: | - from sailpoint.v2025.api.personal_access_tokens_api import PersonalAccessTokensApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_personal_access_token_response import GetPersonalAccessTokenResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '2c9180867b50d088017b554662fb281e' # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) - filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - try: - # List Personal Access Tokens - - results = PersonalAccessTokensApi(api_client).list_personal_access_tokens() - # Below is a request that includes all optional parameters - # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) - print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) -- path: /personal-access-tokens/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#delete-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id - - # Delete Personal Access Token - - try { - Remove-V2025PersonalAccessToken -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025PersonalAccessToken -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PersonalAccessToken" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/personal-access-tokens#delete-personal-access-token - source: | - from sailpoint.v2025.api.personal_access_tokens_api import PersonalAccessTokensApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id - try: - # Delete Personal Access Token - - PersonalAccessTokensApi(api_client).delete_personal_access_token(id=id) - # Below is a request that includes all optional parameters - # PersonalAccessTokensApi(api_client).delete_personal_access_token(id) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) -- path: /personal-access-tokens/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#patch-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Personal Access Token - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025PersonalAccessToken -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025PersonalAccessToken -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PersonalAccessToken" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/personal-access-tokens#patch-personal-access-token - source: | - from sailpoint.v2025.api.personal_access_tokens_api import PersonalAccessTokensApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_personal_access_token_response import GetPersonalAccessTokenResponse - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id - json_patch_operation = '''[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - try: - # Patch Personal Access Token - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation) - print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) -- path: /public-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/public-identities#get-public-identities - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) - $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Get list of public identities - - try { - Get-V2025PublicIdentities - - # Below is a request that includes all optional parameters - # Get-V2025PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PublicIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/public-identities#get-public-identities - source: | - from sailpoint.v2025.api.public_identities_api import PublicIdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.public_identity import PublicIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'firstname eq \"John\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) - add_core_filters = False # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Get list of public identities - - results = PublicIdentitiesApi(api_client).get_public_identities() - # Below is a request that includes all optional parameters - # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) - print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) -- path: /public-identities-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/public-identities-config#get-public-identity-config - source: | - - # Get the Public Identities Configuration - - try { - Get-V2025PublicIdentityConfig - - # Below is a request that includes all optional parameters - # Get-V2025PublicIdentityConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PublicIdentityConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/public-identities-config#get-public-identity-config - source: | - from sailpoint.v2025.api.public_identities_config_api import PublicIdentitiesConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.public_identity_config import PublicIdentityConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get the Public Identities Configuration - - results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() - # Below is a request that includes all optional parameters - # results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() - print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) -- path: /public-identities-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/public-identities-config#update-public-identity-config - source: | - $PublicIdentityConfig = @" - { - "modified" : "2018-06-25T20:22:28.104Z", - "attributes" : [ { - "name" : "Country", - "key" : "country" - }, { - "name" : "Country", - "key" : "country" - } ], - "modifiedBy" : { - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - } - "@ - - # Update the Public Identities Configuration - - try { - $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-V2025PublicIdentityConfig -PublicIdentityConfig $Result - - # Below is a request that includes all optional parameters - # Update-V2025PublicIdentityConfig -PublicIdentityConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PublicIdentityConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/public-identities-config#update-public-identity-config - source: | - from sailpoint.v2025.api.public_identities_config_api import PublicIdentitiesConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.public_identity_config import PublicIdentityConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - public_identity_config = '''{ - "modified" : "2018-06-25T20:22:28.104Z", - "attributes" : [ { - "name" : "Country", - "key" : "country" - }, { - "name" : "Country", - "key" : "country" - } ], - "modifiedBy" : { - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }''' # PublicIdentityConfig | - try: - # Update the Public Identities Configuration - new_public_identity_config = PublicIdentityConfig.from_json(public_identity_config) - results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(public_identity_config=new_public_identity_config) - # Below is a request that includes all optional parameters - # results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config) - print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) -- path: /reports/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#cancel-report - source: | - $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel - - # Cancel Report - - try { - Suspend-V2025Report -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2025Report -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025Report" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/reports-data-extraction#cancel-report - source: | - from sailpoint.v2025.api.reports_data_extraction_api import ReportsDataExtractionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel - try: - # Cancel Report - - ReportsDataExtractionApi(api_client).cancel_report(id=id) - # Below is a request that includes all optional parameters - # ReportsDataExtractionApi(api_client).cancel_report(id) - except Exception as e: - print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) -- path: /reports/{taskResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#get-report - source: | - $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report - $FileFormat = "csv" # String | Output format of the requested report file - $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) - $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) - - # Get Report File - - try { - Get-V2025Report -TaskResultId $TaskResultId -FileFormat $FileFormat - - # Below is a request that includes all optional parameters - # Get-V2025Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Report" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/reports-data-extraction#get-report - source: | - from sailpoint.v2025.api.reports_data_extraction_api import ReportsDataExtractionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report - file_format = 'csv' # str | Output format of the requested report file # str | Output format of the requested report file - name = 'Identities Details Report' # str | preferred Report file name, by default will be used report name from task result. (optional) # str | preferred Report file name, by default will be used report name from task result. (optional) - auditable = False # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) - try: - # Get Report File - - results = ReportsDataExtractionApi(api_client).get_report(task_result_id=task_result_id, file_format=file_format) - # Below is a request that includes all optional parameters - # results = ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, name, auditable) - print("The response of ReportsDataExtractionApi->get_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) -- path: /reports/{taskResultId}/result - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#get-report-result - source: | - $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report - $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) - - # Get Report Result - - try { - Get-V2025ReportResult -TaskResultId $TaskResultId - - # Below is a request that includes all optional parameters - # Get-V2025ReportResult -TaskResultId $TaskResultId -Completed $Completed - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReportResult" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/reports-data-extraction#get-report-result - source: | - from sailpoint.v2025.api.reports_data_extraction_api import ReportsDataExtractionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_results import ReportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report - completed = False # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) - try: - # Get Report Result - - results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id=task_result_id) - # Below is a request that includes all optional parameters - # results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id, completed) - print("The response of ReportsDataExtractionApi->get_report_result:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) -- path: /reports/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#start-report - source: | - $ReportDetails = @" - { - "reportType" : "ACCOUNTS", - "arguments" : { - "application" : "2c9180897e7742b2017e781782f705b9", - "sourceName" : "Active Directory" - } - } - "@ - - # Run Report - - try { - $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails - Start-V2025Report -ReportDetails $Result - - # Below is a request that includes all optional parameters - # Start-V2025Report -ReportDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025Report" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/reports-data-extraction#start-report - source: | - from sailpoint.v2025.api.reports_data_extraction_api import ReportsDataExtractionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_details import ReportDetails - from sailpoint.v2025.models.task_result_details import TaskResultDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_details = '''{ - "reportType" : "ACCOUNTS", - "arguments" : { - "application" : "2c9180897e7742b2017e781782f705b9", - "sourceName" : "Active Directory" - } - }''' # ReportDetails | - try: - # Run Report - new_report_details = ReportDetails.from_json(report_details) - results = ReportsDataExtractionApi(api_client).start_report(report_details=new_report_details) - # Below is a request that includes all optional parameters - # results = ReportsDataExtractionApi(api_client).start_report(new_report_details) - print("The response of ReportsDataExtractionApi->start_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) -- path: /requestable-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/requestable-objects#list-requestable-objects - source: | - $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) - $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) - - $Types = @"ROLE,ACCESS_PROFILE"@ - $Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) - $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) - - $Statuses = @"[ASSIGNED, PENDING]"@ - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Requestable Objects List - - try { - Get-V2025RequestableObjects - - # Below is a request that includes all optional parameters - # Get-V2025RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RequestableObjects" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/requestable-objects#list-requestable-objects - source: | - from sailpoint.v2025.api.requestable_objects_api import RequestableObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.requestable_object import RequestableObject - from sailpoint.v2025.models.requestable_object_request_status import RequestableObjectRequestStatus - from sailpoint.v2025.models.requestable_object_type import RequestableObjectType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_id = 'e7eab60924f64aa284175b9fa3309599' # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) - types = '''[sailpoint.v2025.RequestableObjectType()]''' # List[RequestableObjectType] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) - term = 'Finance Role' # str | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) # str | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) - statuses = '''[sailpoint.v2025.RequestableObjectRequestStatus()]''' # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name sw \"bob\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Requestable Objects List - - results = RequestableObjectsApi(api_client).list_requestable_objects() - # Below is a request that includes all optional parameters - # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) - print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) -- path: /role-insights/requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#create-role-insight-requests - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Generate insights for roles - - try { - New-V2025RoleInsightRequests -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # New-V2025RoleInsightRequests -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025RoleInsightRequests" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#create-role-insight-requests - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insights_response import RoleInsightsResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Generate insights for roles - - results = RoleInsightsApi(api_client).create_role_insight_requests(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).create_role_insight_requests(x_sail_point_experimental) - print("The response of RoleInsightsApi->create_role_insight_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) -- path: /role-insights/{insightId}/entitlement-changes/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#download-role-insights-entitlements-changes - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) - $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Download entitlement insights for a role - - try { - Invoke-V2025DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Invoke-V2025DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025DownloadRoleInsightsEntitlementsChanges" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#download-role-insights-entitlements-changes - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'identitiesWithAccess' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) - filters = 'name sw \"r\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - try: - # Download entitlement insights for a role - - results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) - print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) -- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-entitlement-changes-identities - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "name sw "Jan"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - - # Get identities for a suggested entitlement (for a role) - - try { - Get-V2025EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChangesIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-entitlement-changes-identities - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insights_identities import RoleInsightsIdentities - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id - entitlement_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The entitlement id # str | The entitlement id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - has_entitlement = False # bool | Identity has this entitlement or not (optional) (default to False) # bool | Identity has this entitlement or not (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'name sw \"Jan\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - try: - # Get identities for a suggested entitlement (for a role) - - results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id=insight_id, entitlement_id=entitlement_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters) - print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) -- path: /role-insights/{insightId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insight - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a single role insight - - try { - Get-V2025RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsight" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insight - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insight import RoleInsight - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a single role insight - - results = RoleInsightsApi(api_client).get_role_insight(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_role_insight(insight_id, x_sail_point_experimental) - print("The response of RoleInsightsApi->get_role_insight:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) -- path: /role-insights - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) - $Filters = "name sw "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) - - # Get role insights - - try { - Get-V2025RoleInsights -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsights -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsights" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insight import RoleInsight - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'numberOfUpdates' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) - filters = 'name sw \"John\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) - try: - # Get role insights - - results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) - print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) -- path: /role-insights/{insightId}/current-entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-current-entitlements - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Get current entitlement for a role - - try { - Get-V2025RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsCurrentEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights-current-entitlements - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insights_entitlement import RoleInsightsEntitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'name sw \"r\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - try: - # Get current entitlement for a role - - results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) - print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) -- path: /role-insights/{insightId}/entitlement-changes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-entitlements-changes - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) - $Filters = "name sw "Admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Get entitlement insights for a role - - try { - Get-V2025RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsEntitlementsChanges" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights-entitlements-changes - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insights_entitlement_changes import RoleInsightsEntitlementChanges - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) - filters = 'name sw \"Admin\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - try: - # Get entitlement insights for a role - - results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) - print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) -- path: /role-insights/requests/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-requests - source: | - $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Returns metadata from prior request. - - try { - Get-V2025RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsRequests" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights-requests - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insights_response import RoleInsightsResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Returns metadata from prior request. - - results = RoleInsightsApi(api_client).get_role_insights_requests(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_role_insights_requests(id, x_sail_point_experimental) - print("The response of RoleInsightsApi->get_role_insights_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) -- path: /role-insights/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-summary - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get role insights summary information - - try { - Get-V2025RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights-summary - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insights_summary import RoleInsightsSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get role insights summary information - - results = RoleInsightsApi(api_client).get_role_insights_summary(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_role_insights_summary(x_sail_point_experimental) - print("The response of RoleInsightsApi->get_role_insights_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) -- path: /roles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#create-role - source: | - $Role = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "dimensional" : false, - "created" : "2021-03-01T22:32:58.104Z", - "dimensionRefs" : [ { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - }, { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - } ], - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "membership" : { - "identities" : [ { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } ], - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, - "type" : "IDENTITY_LIST" - }, - "enabled" : true, - "revocationRequestConfig" : { - "commentsRequired" : false, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : false - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "legacyMembershipInfo" : { - "type" : "IDENTITY_LIST" - }, - "accessRequestConfig" : { - "commentsRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "name" : "Role 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "accessModelMetadata" : { - "attributes" : [ { - "key" : "iscPrivacy", - "name" : "Privacy", - "multiselect" : false, - "status" : "active", - "type" : "governance", - "objectTypes" : [ "all" ], - "description" : "Specifies the level of privacy associated with an access item.", - "values" : [ { - "value" : "public", - "name" : "Public", - "status" : "active" - } ] - } ] - }, - "id" : "2c918086749d78830174a1a40e121518", - "requestable" : true - } - "@ - - # Create a Role - - try { - $Result = ConvertFrom-JsonToRole -Json $Role - New-V2025Role -Role $Result - - # Below is a request that includes all optional parameters - # New-V2025Role -Role $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Role" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#create-role - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role import Role - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "dimensional" : false, - "created" : "2021-03-01T22:32:58.104Z", - "dimensionRefs" : [ { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - }, { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - } ], - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "membership" : { - "identities" : [ { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } ], - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, - "type" : "IDENTITY_LIST" - }, - "enabled" : true, - "revocationRequestConfig" : { - "commentsRequired" : false, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : false - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "legacyMembershipInfo" : { - "type" : "IDENTITY_LIST" - }, - "accessRequestConfig" : { - "commentsRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "name" : "Role 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "accessModelMetadata" : { - "attributes" : [ { - "key" : "iscPrivacy", - "name" : "Privacy", - "multiselect" : false, - "status" : "active", - "type" : "governance", - "objectTypes" : [ "all" ], - "description" : "Specifies the level of privacy associated with an access item.", - "values" : [ { - "value" : "public", - "name" : "Public", - "status" : "active" - } ] - } ] - }, - "id" : "2c918086749d78830174a1a40e121518", - "requestable" : true - }''' # Role | - try: - # Create a Role - new_role = Role.from_json(role) - results = RolesApi(api_client).create_role(role=new_role) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).create_role(new_role) - print("The response of RolesApi->create_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->create_role: %s\n" % e) -- path: /roles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#list-roles - source: | - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) - - # List Roles - - try { - Get-V2025Roles - - # Below is a request that includes all optional parameters - # Get-V2025Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Roles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#list-roles - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role import Role - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) - try: - # List Roles - - results = RolesApi(api_client).list_roles() - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) - print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->list_roles: %s\n" % e) -- path: /roles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-bulk-roles - source: | - $RoleBulkDeleteRequest = @" - { - "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - } - "@ - - # Delete Role(s) - - try { - $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-V2025BulkRoles -RoleBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025BulkRoles -RoleBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025BulkRoles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#delete-bulk-roles - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_bulk_delete_request import RoleBulkDeleteRequest - from sailpoint.v2025.models.task_result_dto import TaskResultDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_bulk_delete_request = '''{ - "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - }''' # RoleBulkDeleteRequest | - try: - # Delete Role(s) - new_role_bulk_delete_request = RoleBulkDeleteRequest.from_json(role_bulk_delete_request) - results = RolesApi(api_client).delete_bulk_roles(role_bulk_delete_request=new_role_bulk_delete_request) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request) - print("The response of RolesApi->delete_bulk_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) -- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-metadata-from-role-by-key-and-value - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - - # Remove a Metadata From Role. - - try { - Remove-V2025MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - - # Below is a request that includes all optional parameters - # Remove-V2025MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MetadataFromRoleByKeyAndValue" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#delete-metadata-from-role-by-key-and-value - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808c74ff913f0175097daa9d59cd' # str | The role's id. # str | The role's id. - attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. - try: - # Remove a Metadata From Role. - - RolesApi(api_client).delete_metadata_from_role_by_key_and_value(id=id, attribute_key=attribute_key, attribute_value=attribute_value) - # Below is a request that includes all optional parameters - # RolesApi(api_client).delete_metadata_from_role_by_key_and_value(id, attribute_key, attribute_value) - except Exception as e: - print("Exception when calling RolesApi->delete_metadata_from_role_by_key_and_value: %s\n" % e) -- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#update-attribute-key-and-value-to-role - source: | - $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - - # Add a Metadata to Role. - - try { - Update-V2025AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - - # Below is a request that includes all optional parameters - # Update-V2025AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AttributeKeyAndValueToRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#update-attribute-key-and-value-to-role - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role import Role - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c24359c389374d0fb8585698a2189e3d' # str | The Id of a role # str | The Id of a role - attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. - try: - # Add a Metadata to Role. - - results = RolesApi(api_client).update_attribute_key_and_value_to_role(id=id, attribute_key=attribute_key, attribute_value=attribute_value) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).update_attribute_key_and_value_to_role(id, attribute_key, attribute_value) - print("The response of RolesApi->update_attribute_key_and_value_to_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->update_attribute_key_and_value_to_role: %s\n" % e) -- path: /roles/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - - # Delete a Role - - try { - Remove-V2025Role -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Role -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Role" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#delete-role - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role - try: - # Delete a Role - - RolesApi(api_client).delete_role(id=id) - # Below is a request that includes all optional parameters - # RolesApi(api_client).delete_role(id) - except Exception as e: - print("Exception when calling RolesApi->delete_role: %s\n" % e) -- path: /roles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - - # Get a Role - - try { - Get-V2025Role -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Role -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Role" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#get-role - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role import Role - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role - try: - # Get a Role - - results = RolesApi(api_client).get_role(id=id) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).get_role(id) - print("The response of RolesApi->get_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->get_role: %s\n" % e) -- path: /roles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#patch-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Role - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Role -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Role -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Role" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#patch-role - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.role import Role - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch - json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | - try: - # Patch a specified Role - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).patch_role(id, new_json_patch_operation) - print("The response of RolesApi->patch_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->patch_role: %s\n" % e) -- path: /roles/access-model-metadata/bulk-update - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-bulk-update-status - source: | - - # Get Bulk-Update Statuses - - try { - Get-V2025BulkUpdateStatus - - # Below is a request that includes all optional parameters - # Get-V2025BulkUpdateStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BulkUpdateStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#get-bulk-update-status - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_get_all_bulk_update_response import RoleGetAllBulkUpdateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get Bulk-Update Statuses - - results = RolesApi(api_client).get_bulk_update_status() - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).get_bulk_update_status() - print("The response of RolesApi->get_bulk_update_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) -- path: /roles/access-model-metadata/bulk-update/id - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-bulk-update-status-by-id - source: | - $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. - - # Get Bulk-Update Status by ID - - try { - Get-V2025BulkUpdateStatusById -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025BulkUpdateStatusById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BulkUpdateStatusById" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#get-bulk-update-status-by-id - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_bulk_update_response import RoleBulkUpdateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c24359c389374d0fb8585698a2189e3d' # str | The Id of the bulk update task. # str | The Id of the bulk update task. - try: - # Get Bulk-Update Status by ID - - results = RolesApi(api_client).get_bulk_update_status_by_id(id=id) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).get_bulk_update_status_by_id(id) - print("The response of RolesApi->get_bulk_update_status_by_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->get_bulk_update_status_by_id: %s\n" % e) -- path: /roles/{id}/assigned-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role-assigned-identities - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) - $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) - - # List Identities assigned a Role - - try { - Get-V2025RoleAssignedIdentities -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignedIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#get-role-assigned-identities - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_identity import RoleIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role for which the assigned Identities are to be listed # str | ID of the Role for which the assigned Identities are to be listed - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name sw Joe' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) - sorters = 'aliasName,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) - try: - # List Identities assigned a Role - - results = RolesApi(api_client).get_role_assigned_identities(id=id) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) - print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) -- path: /roles/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | Containing role's ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Role's Entitlements - - try { - Get-V2025RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#get-role-entitlements - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'attribute eq \"memberOf\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - try: - # List Role's Entitlements - - results = RolesApi(api_client).get_role_entitlements(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) -- path: /roles/filter - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#search-roles-by-filter - source: | - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) - $RoleListFilterDTO = @" - { - "ammKeyValues" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "secret" ] - } ], - "filters" : "dimensional eq false" - } - "@ - - # Filter Roles by Metadata - - try { - Search-V2025RolesByFilter - - # Below is a request that includes all optional parameters - # Search-V2025RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -RoleListFilterDTO $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025RolesByFilter" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#search-roles-by-filter - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role import Role - from sailpoint.v2025.models.role_list_filter_dto import RoleListFilterDTO - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - limit = 50 # int | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) - role_list_filter_dto = '''{ - "ammKeyValues" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "secret" ] - } ], - "filters" : "dimensional eq false" - }''' # RoleListFilterDTO | (optional) - try: - # Filter Roles by Metadata - - results = RolesApi(api_client).search_roles_by_filter() - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).search_roles_by_filter(for_subadmin, limit, offset, count, sorters, for_segment_ids, include_unsegmented, new_role_list_filter_dto) - print("The response of RolesApi->search_roles_by_filter:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->search_roles_by_filter: %s\n" % e) -- path: /roles/access-model-metadata/bulk-update/filter - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-filter - source: | - $RoleMetadataBulkUpdateByFilterRequest = @" - { - "values" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "topSecret" ] - } ], - "filters" : " requestable eq false", - "replaceScope" : "ALL", - "operation" : "REPLACE" - } - "@ - - # Bulk-Update Roles' Metadata by Filters - - try { - $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest - Update-V2025RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByFilter" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#update-roles-metadata-by-filter - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_bulk_update_response import RoleBulkUpdateResponse - from sailpoint.v2025.models.role_metadata_bulk_update_by_filter_request import RoleMetadataBulkUpdateByFilterRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_metadata_bulk_update_by_filter_request = '''{ - "values" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "topSecret" ] - } ], - "filters" : " requestable eq false", - "replaceScope" : "ALL", - "operation" : "REPLACE" - }''' # RoleMetadataBulkUpdateByFilterRequest | - try: - # Bulk-Update Roles' Metadata by Filters - new_role_metadata_bulk_update_by_filter_request = RoleMetadataBulkUpdateByFilterRequest.from_json(role_metadata_bulk_update_by_filter_request) - results = RolesApi(api_client).update_roles_metadata_by_filter(role_metadata_bulk_update_by_filter_request=new_role_metadata_bulk_update_by_filter_request) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).update_roles_metadata_by_filter(new_role_metadata_bulk_update_by_filter_request) - print("The response of RolesApi->update_roles_metadata_by_filter:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->update_roles_metadata_by_filter: %s\n" % e) -- path: /roles/access-model-metadata/bulk-update/ids - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-ids - source: | - $RoleMetadataBulkUpdateByIdRequest = @" - { - "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], - "values" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "topSecret" ] - } ], - "replaceScope" : "ALL", - "operation" : "REPLACE" - } - "@ - - # Bulk-Update Roles' Metadata by ID - - try { - $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest - Update-V2025RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByIds" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#update-roles-metadata-by-ids - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_bulk_update_response import RoleBulkUpdateResponse - from sailpoint.v2025.models.role_metadata_bulk_update_by_id_request import RoleMetadataBulkUpdateByIdRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_metadata_bulk_update_by_id_request = '''{ - "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], - "values" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "topSecret" ] - } ], - "replaceScope" : "ALL", - "operation" : "REPLACE" - }''' # RoleMetadataBulkUpdateByIdRequest | - try: - # Bulk-Update Roles' Metadata by ID - new_role_metadata_bulk_update_by_id_request = RoleMetadataBulkUpdateByIdRequest.from_json(role_metadata_bulk_update_by_id_request) - results = RolesApi(api_client).update_roles_metadata_by_ids(role_metadata_bulk_update_by_id_request=new_role_metadata_bulk_update_by_id_request) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).update_roles_metadata_by_ids(new_role_metadata_bulk_update_by_id_request) - print("The response of RolesApi->update_roles_metadata_by_ids:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->update_roles_metadata_by_ids: %s\n" % e) -- path: /roles/access-model-metadata/bulk-update/query - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-query - source: | - $RoleMetadataBulkUpdateByQueryRequest = @" - { - "query" : { - "query\"" : { - "indices" : [ "roles" ], - "queryType" : "TEXT", - "textQuery" : { - "terms" : [ "test123" ], - "fields" : [ "id" ], - "matchAny" : false, - "contains" : true - }, - "includeNested" : false - } - }, - "values" : [ { - "attributeValue" : [ "topSecret" ], - "attributeKey" : "iscFederalClassifications" - }, { - "attributeValue" : [ "topSecret" ], - "attributeKey" : "iscFederalClassifications" - } ], - "replaceScope" : "ALL", - "operation" : "REPLACE" - } - "@ - - # Bulk-Update Roles' Metadata by Query - - try { - $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest - Update-V2025RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByQuery" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#update-roles-metadata-by-query - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_bulk_update_response import RoleBulkUpdateResponse - from sailpoint.v2025.models.role_metadata_bulk_update_by_query_request import RoleMetadataBulkUpdateByQueryRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_metadata_bulk_update_by_query_request = '''{ - "query" : { - "query\"" : { - "indices" : [ "roles" ], - "queryType" : "TEXT", - "textQuery" : { - "terms" : [ "test123" ], - "fields" : [ "id" ], - "matchAny" : false, - "contains" : true - }, - "includeNested" : false - } - }, - "values" : [ { - "attributeValue" : [ "topSecret" ], - "attributeKey" : "iscFederalClassifications" - }, { - "attributeValue" : [ "topSecret" ], - "attributeKey" : "iscFederalClassifications" - } ], - "replaceScope" : "ALL", - "operation" : "REPLACE" - }''' # RoleMetadataBulkUpdateByQueryRequest | - try: - # Bulk-Update Roles' Metadata by Query - new_role_metadata_bulk_update_by_query_request = RoleMetadataBulkUpdateByQueryRequest.from_json(role_metadata_bulk_update_by_query_request) - results = RolesApi(api_client).update_roles_metadata_by_query(role_metadata_bulk_update_by_query_request=new_role_metadata_bulk_update_by_query_request) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).update_roles_metadata_by_query(new_role_metadata_bulk_update_by_query_request) - print("The response of RolesApi->update_roles_metadata_by_query:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration - source: | - $Id = "12345" # String | The id of the integration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a SIM integration - - try { - Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a SIM integration details. - - try { - Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a SIM integration details. - - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2025SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2025SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-V2025SodPolicies - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - try: - # List SOD policies - - results = SODPoliciesApi(api_client).list_sod_policies() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2025SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2025SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2025SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2025SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2025SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2025EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2025SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2025.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2025.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2025SpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2025SpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.export_payload import ExportPayload - from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-V2025SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-V2025SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-V2025SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-V2025SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2025SpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.import_options import ImportOptions - from sailpoint.v2025.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects - source: | - - # Get config object details - - try { - Get-V2025SpConfigObjects - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get config object details - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) -- path: /saved-searches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#create-saved-search - source: | - $CreateSavedSearchRequest = @" - - "@ - - # Create a saved search - - try { - $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-V2025SavedSearch -CreateSavedSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025SavedSearch -CreateSavedSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SavedSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/saved-search#create-saved-search - source: | - from sailpoint.v2025.api.saved_search_api import SavedSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_saved_search_request import CreateSavedSearchRequest - from sailpoint.v2025.models.saved_search import SavedSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_saved_search_request = '''sailpoint.v2025.CreateSavedSearchRequest()''' # CreateSavedSearchRequest | The saved search to persist. - try: - # Create a saved search - new_create_saved_search_request = CreateSavedSearchRequest.from_json(create_saved_search_request) - results = SavedSearchApi(api_client).create_saved_search(create_saved_search_request=new_create_saved_search_request) - # Below is a request that includes all optional parameters - # results = SavedSearchApi(api_client).create_saved_search(new_create_saved_search_request) - print("The response of SavedSearchApi->create_saved_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) -- path: /saved-searches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#list-saved-searches - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) - - # A list of Saved Searches - - try { - Get-V2025SavedSearches - - # Below is a request that includes all optional parameters - # Get-V2025SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedSearches" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/saved-search#list-saved-searches - source: | - from sailpoint.v2025.api.saved_search_api import SavedSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.saved_search import SavedSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'owner.id eq \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) - try: - # A list of Saved Searches - - results = SavedSearchApi(api_client).list_saved_searches() - # Below is a request that includes all optional parameters - # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) - print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) -- path: /saved-searches/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#delete-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete document by ID - - try { - Remove-V2025SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SavedSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/saved-search#delete-saved-search - source: | - from sailpoint.v2025.api.saved_search_api import SavedSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - try: - # Delete document by ID - - SavedSearchApi(api_client).delete_saved_search(id=id) - # Below is a request that includes all optional parameters - # SavedSearchApi(api_client).delete_saved_search(id) - except Exception as e: - print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) -- path: /saved-searches/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#get-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Return saved search by ID - - try { - Get-V2025SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/saved-search#get-saved-search - source: | - from sailpoint.v2025.api.saved_search_api import SavedSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.saved_search import SavedSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - try: - # Return saved search by ID - - results = SavedSearchApi(api_client).get_saved_search(id=id) - # Below is a request that includes all optional parameters - # results = SavedSearchApi(api_client).get_saved_search(id) - print("The response of SavedSearchApi->get_saved_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) -- path: /saved-searches/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#put-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SavedSearch = @" - { - "owner" : { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2018-06-25T20:22:28.104Z", - "columns" : { - "identity" : [ { - "field" : "displayName", - "header" : "Display Name" - }, { - "field" : "e-mail", - "header" : "Work Email" - } ] - }, - "query" : "@accounts(disabled:true)", - "description" : "Disabled accounts", - "orderBy" : { - "identity" : [ "lastName", "firstName" ], - "role" : [ "name" ] - }, - "sort" : [ "displayName" ], - "filters" : { - "terms" : [ "account_count", "account_count" ], - "range" : { - "lower" : { - "inclusive" : false, - "value" : "1" - }, - "upper" : { - "inclusive" : false, - "value" : "1" - } - }, - "exclude" : false, - "type" : "RANGE" - }, - "ownerId" : "2c91808568c529c60168cca6f90c1313", - "indices" : [ "identities" ], - "public" : false, - "name" : "Disabled accounts", - "modified" : "2018-06-25T20:22:28.104Z", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "fields" : [ "disabled" ] - } - "@ - - # Updates an existing saved search - - try { - $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-V2025SavedSearch -Id $Id -SavedSearch $Result - - # Below is a request that includes all optional parameters - # Send-V2025SavedSearch -Id $Id -SavedSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SavedSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/saved-search#put-saved-search - source: | - from sailpoint.v2025.api.saved_search_api import SavedSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.saved_search import SavedSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - saved_search = '''{ - "owner" : { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2018-06-25T20:22:28.104Z", - "columns" : { - "identity" : [ { - "field" : "displayName", - "header" : "Display Name" - }, { - "field" : "e-mail", - "header" : "Work Email" - } ] - }, - "query" : "@accounts(disabled:true)", - "description" : "Disabled accounts", - "orderBy" : { - "identity" : [ "lastName", "firstName" ], - "role" : [ "name" ] - }, - "sort" : [ "displayName" ], - "filters" : { - "terms" : [ "account_count", "account_count" ], - "range" : { - "lower" : { - "inclusive" : false, - "value" : "1" - }, - "upper" : { - "inclusive" : false, - "value" : "1" - } - }, - "exclude" : false, - "type" : "RANGE" - }, - "ownerId" : "2c91808568c529c60168cca6f90c1313", - "indices" : [ "identities" ], - "public" : false, - "name" : "Disabled accounts", - "modified" : "2018-06-25T20:22:28.104Z", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "fields" : [ "disabled" ] - }''' # SavedSearch | The saved search to persist. - try: - # Updates an existing saved search - new_saved_search = SavedSearch.from_json(saved_search) - results = SavedSearchApi(api_client).put_saved_search(id=id, saved_search=new_saved_search) - # Below is a request that includes all optional parameters - # results = SavedSearchApi(api_client).put_saved_search(id, new_saved_search) - print("The response of SavedSearchApi->put_saved_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) -- path: /saved-searches/{id}/execute - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#execute-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SearchArguments = @" - { - "owner" : "", - "recipients" : [ { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - } - "@ - - # Execute a saved search by ID - - try { - $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-V2025ExecuteSavedSearch -Id $Id -SearchArguments $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025ExecuteSavedSearch -Id $Id -SearchArguments $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ExecuteSavedSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/saved-search#execute-saved-search - source: | - from sailpoint.v2025.api.saved_search_api import SavedSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.search_arguments import SearchArguments - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - search_arguments = '''{ - "owner" : "", - "recipients" : [ { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - }''' # SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - try: - # Execute a saved search by ID - new_search_arguments = SearchArguments.from_json(search_arguments) - SavedSearchApi(api_client).execute_saved_search(id=id, search_arguments=new_search_arguments) - # Below is a request that includes all optional parameters - # SavedSearchApi(api_client).execute_saved_search(id, new_search_arguments) - except Exception as e: - print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e) -- path: /scheduled-searches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#create-scheduled-search - source: | - $CreateScheduledSearchRequest = @" - {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} - "@ - - # Create a new scheduled search - - try { - $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-V2025ScheduledSearch -CreateScheduledSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ScheduledSearch -CreateScheduledSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/scheduled-search#create-scheduled-search - source: | - from sailpoint.v2025.api.scheduled_search_api import ScheduledSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_scheduled_search_request import CreateScheduledSearchRequest - from sailpoint.v2025.models.scheduled_search import ScheduledSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_scheduled_search_request = '''{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}''' # CreateScheduledSearchRequest | The scheduled search to persist. - try: - # Create a new scheduled search - new_create_scheduled_search_request = CreateScheduledSearchRequest.from_json(create_scheduled_search_request) - results = ScheduledSearchApi(api_client).create_scheduled_search(create_scheduled_search_request=new_create_scheduled_search_request) - # Below is a request that includes all optional parameters - # results = ScheduledSearchApi(api_client).create_scheduled_search(new_create_scheduled_search_request) - print("The response of ScheduledSearchApi->create_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) -- path: /scheduled-searches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#list-scheduled-search - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - - # List scheduled searches - - try { - Get-V2025ScheduledSearch - - # Below is a request that includes all optional parameters - # Get-V2025ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/scheduled-search#list-scheduled-search - source: | - from sailpoint.v2025.api.scheduled_search_api import ScheduledSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.scheduled_search import ScheduledSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - try: - # List scheduled searches - - results = ScheduledSearchApi(api_client).list_scheduled_search() - # Below is a request that includes all optional parameters - # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) - print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) -- path: /scheduled-searches/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#delete-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete a Scheduled Search - - try { - Remove-V2025ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/scheduled-search#delete-scheduled-search - source: | - from sailpoint.v2025.api.scheduled_search_api import ScheduledSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - try: - # Delete a Scheduled Search - - ScheduledSearchApi(api_client).delete_scheduled_search(id=id) - # Below is a request that includes all optional parameters - # ScheduledSearchApi(api_client).delete_scheduled_search(id) - except Exception as e: - print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e) -- path: /scheduled-searches/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#get-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Scheduled Search - - try { - Get-V2025ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/scheduled-search#get-scheduled-search - source: | - from sailpoint.v2025.api.scheduled_search_api import ScheduledSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.scheduled_search import ScheduledSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - try: - # Get a Scheduled Search - - results = ScheduledSearchApi(api_client).get_scheduled_search(id=id) - # Below is a request that includes all optional parameters - # results = ScheduledSearchApi(api_client).get_scheduled_search(id) - print("The response of ScheduledSearchApi->get_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) -- path: /scheduled-searches/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#update-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $ScheduledSearch = @" - { - "owner" : { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "displayQueryDetails" : false, - "created" : "", - "description" : "Daily disabled accounts", - "ownerId" : "2c9180867624cbd7017642d8c8c81f67", - "enabled" : false, - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "recipients" : [ { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - } ], - "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", - "name" : "Daily disabled accounts", - "modified" : "", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "emailEmptyResults" : false - } - "@ - - # Update an existing Scheduled Search - - try { - $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-V2025ScheduledSearch -Id $Id -ScheduledSearch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ScheduledSearch -Id $Id -ScheduledSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/scheduled-search#update-scheduled-search - source: | - from sailpoint.v2025.api.scheduled_search_api import ScheduledSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.scheduled_search import ScheduledSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - scheduled_search = '''{ - "owner" : { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "displayQueryDetails" : false, - "created" : "", - "description" : "Daily disabled accounts", - "ownerId" : "2c9180867624cbd7017642d8c8c81f67", - "enabled" : false, - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "recipients" : [ { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - } ], - "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", - "name" : "Daily disabled accounts", - "modified" : "", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "emailEmptyResults" : false - }''' # ScheduledSearch | The scheduled search to persist. - try: - # Update an existing Scheduled Search - new_scheduled_search = ScheduledSearch.from_json(scheduled_search) - results = ScheduledSearchApi(api_client).update_scheduled_search(id=id, scheduled_search=new_scheduled_search) - # Below is a request that includes all optional parameters - # results = ScheduledSearchApi(api_client).update_scheduled_search(id, new_scheduled_search) - print("The response of ScheduledSearchApi->update_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) -- path: /scheduled-searches/{id}/unsubscribe - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#unsubscribe-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $TypedReference = @" - { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - "@ - - # Unsubscribe a recipient from Scheduled Search - - try { - $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-V2025UnsubscribeScheduledSearch -Id $Id -TypedReference $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025UnsubscribeScheduledSearch -Id $Id -TypedReference $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025UnsubscribeScheduledSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/scheduled-search#unsubscribe-scheduled-search - source: | - from sailpoint.v2025.api.scheduled_search_api import ScheduledSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.typed_reference import TypedReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - typed_reference = '''{ - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }''' # TypedReference | The recipient to be removed from the scheduled search. - try: - # Unsubscribe a recipient from Scheduled Search - new_typed_reference = TypedReference.from_json(typed_reference) - ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id=id, typed_reference=new_typed_reference) - # Below is a request that includes all optional parameters - # ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id, new_typed_reference) - except Exception as e: - print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e) -- path: /search/aggregate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search#search-aggregate - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Perform a Search Query Aggregation - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2025Aggregate -Search $Result - - # Below is a request that includes all optional parameters - # Search-V2025Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Aggregate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search#search-aggregate - source: | - from sailpoint.v2025.api.search_api import SearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.aggregation_result import AggregationResult - from sailpoint.v2025.models.search import Search - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - search = '''{ - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - }''' # Search | - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Perform a Search Query Aggregation - new_search = Search.from_json(search) - results = SearchApi(api_client).search_aggregate(search=new_search) - # Below is a request that includes all optional parameters - # results = SearchApi(api_client).search_aggregate(new_search, offset, limit, count) - print("The response of SearchApi->search_aggregate:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchApi->search_aggregate: %s\n" % e) -- path: /search/count - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search#search-count - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - - # Count Documents Satisfying a Query - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2025Count -Search $Result - - # Below is a request that includes all optional parameters - # Search-V2025Count -Search $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Count" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search#search-count - source: | - from sailpoint.v2025.api.search_api import SearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.search import Search - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - search = '''{ - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - }''' # Search | - try: - # Count Documents Satisfying a Query - new_search = Search.from_json(search) - SearchApi(api_client).search_count(search=new_search) - # Below is a request that includes all optional parameters - # SearchApi(api_client).search_count(new_search) - except Exception as e: - print("Exception when calling SearchApi->search_count: %s\n" % e) -- path: /search/{index}/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search#search-get - source: | - $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Document by ID - - try { - Search-V2025Get -Index $Index -Id $Id - - # Below is a request that includes all optional parameters - # Search-V2025Get -Index $Index -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Get" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search#search-get - source: | - from sailpoint.v2025.api.search_api import SearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - index = 'identities' # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - try: - # Get a Document by ID - - results = SearchApi(api_client).search_get(index=index, id=id) - # Below is a request that includes all optional parameters - # results = SearchApi(api_client).search_get(index, id) - print("The response of SearchApi->search_get:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchApi->search_get: %s\n" % e) -- path: /search - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search#search-post - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Perform Search - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2025Post -Search $Result - - # Below is a request that includes all optional parameters - # Search-V2025Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Post" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search#search-post - source: | - from sailpoint.v2025.api.search_api import SearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.search import Search - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - search = '''{ - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - }''' # Search | - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Perform Search - new_search = Search.from_json(search) - results = SearchApi(api_client).search_post(search=new_search) - # Below is a request that includes all optional parameters - # results = SearchApi(api_client).search_post(new_search, offset, limit, count) - print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchApi->search_post: %s\n" % e) -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#create-search-attribute-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ - - # Create Extended Search Attributes - - try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SearchAttributeConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#create-search-attribute-config - source: | - from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - search_attribute_config = '''{ - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - }''' # SearchAttributeConfig | - try: - # Create Extended Search Attributes - new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) - results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental=x_sail_point_experimental, search_attribute_config=new_search_attribute_config) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental, new_search_attribute_config) - print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#get-search-attribute-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Extended Search Attributes - - try { - Get-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SearchAttributeConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#get-search-attribute-config - source: | - from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Extended Search Attributes - - results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental, limit, offset) - print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#delete-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Extended Search Attribute - - try { - Remove-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SearchAttributeConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#delete-search-attribute-config - source: | - from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete Extended Search Attribute - - SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Extended Search Attribute - - try { - Get-V2025SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SingleSearchAttributeConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Extended Search Attribute - - results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name, x_sail_point_experimental) - print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#patch-search-attribute-config - source: | - $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Extended Search Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SearchAttributeConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#patch-search-attribute-config - source: | - from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | - try: - # Update Extended Search Attribute - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, x_sail_point_experimental, new_json_patch_operation) - print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) -- path: /segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#create-segment - source: | - $Segment = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-V2025Segment -Segment $Result - - # Below is a request that includes all optional parameters - # New-V2025Segment -Segment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Segment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/segments#create-segment - source: | - from sailpoint.v2025.api.segments_api import SegmentsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - segment = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - }''' # Segment | - try: - # Create Segment - new_segment = Segment.from_json(segment) - results = SegmentsApi(api_client).create_segment(segment=new_segment) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).create_segment(new_segment) - print("The response of SegmentsApi->create_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->create_segment: %s\n" % e) -- path: /segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#list-segments - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Segments - - try { - Get-V2025Segments - - # Below is a request that includes all optional parameters - # Get-V2025Segments -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Segments" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/segments#list-segments - source: | - from sailpoint.v2025.api.segments_api import SegmentsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Segments - - results = SegmentsApi(api_client).list_segments() - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).list_segments(limit, offset, count) - print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->list_segments: %s\n" % e) -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-V2025Segment -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Segment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/segments#delete-segment - source: | - from sailpoint.v2025.api.segments_api import SegmentsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. - try: - # Delete Segment by ID - - SegmentsApi(api_client).delete_segment(id=id) - # Below is a request that includes all optional parameters - # SegmentsApi(api_client).delete_segment(id) - except Exception as e: - print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) -- path: /segments/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-V2025Segment -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Segment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/segments#get-segment - source: | - from sailpoint.v2025.api.segments_api import SegmentsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. - try: - # Get Segment by ID - - results = SegmentsApi(api_client).get_segment(id=id) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).get_segment(id) - print("The response of SegmentsApi->get_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->get_segment: %s\n" % e) -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#patch-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025Segment -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025Segment -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Segment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/segments#patch-segment - source: | - from sailpoint.v2025.api.segments_api import SegmentsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. - request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - try: - # Update Segment - new_request_body = RequestBody.from_json(request_body) - results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).patch_segment(id, new_request_body) - print("The response of SegmentsApi->patch_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#create-service-desk-integration - source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ - - # Create new Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-V2025ServiceDeskIntegration -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-V2025ServiceDeskIntegration -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#create-service-desk-integration - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create - try: - # Create new Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integrations - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List existing Service Desk integrations - - try { - Get-V2025ServiceDeskIntegrations - - # Below is a request that includes all optional parameters - # Get-V2025ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegrations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#get-service-desk-integrations - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'name eq \"John Doe\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List existing Service Desk integrations - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#delete-service-desk-integration - source: | - $Id = "anId" # String | ID of Service Desk integration to delete - - # Delete a Service Desk integration - - try { - Remove-V2025ServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#delete-service-desk-integration - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete - try: - # Delete a Service Desk integration - - ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to get - - # Get a Service Desk integration - - try { - Get-V2025ServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#get-service-desk-integration - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get - try: - # Get a Service Desk integration - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#patch-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - - "@ - - # Patch a Service Desk Integration - - try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2025ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#patch-service-desk-integration - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v2025.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - try: - # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) - print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#put-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ - - # Update a Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-V2025ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # Send-V2025ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#put-service-desk-integration - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of the integration to update - try: - # Update a Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - - # Service Desk integration template by scriptName - - try { - Get-V2025ServiceDeskIntegrationTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025ServiceDeskIntegrationTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegrationTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#get-service-desk-integration-template - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get - try: - # Service Desk integration template by scriptName - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration-types - source: | - - # List Service Desk integration types - - try { - Get-V2025ServiceDeskIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-V2025ServiceDeskIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegrationTypes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#get-service-desk-integration-types - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Service Desk integration types - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-status-check-details - source: | - - # Get the time check configuration - - try { - Get-V2025StatusCheckDetails - - # Below is a request that includes all optional parameters - # Get-V2025StatusCheckDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusCheckDetails" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#get-status-check-details - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get the time check configuration - - results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#update-status-check-details - source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ - - # Update the time check configuration - - try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-V2025StatusCheckDetails -QueuedCheckConfigDetails $Result - - # Below is a request that includes all optional parameters - # Update-V2025StatusCheckDetails -QueuedCheckConfigDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025StatusCheckDetails" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#update-status-check-details - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - queued_check_config_details = '''{ - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - }''' # QueuedCheckConfigDetails | The modified time check configuration - try: - # Update the time check configuration - new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) - results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) - print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-V2025StatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025StatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-V2025UsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) -- path: /sources/{sourceId}/provisioning-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#create-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - $ProvisioningPolicyDto = @" - { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } - "@ - - # Create Provisioning Policy - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-V2025ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # New-V2025ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#create-provisioning-policy - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id - provisioning_policy_dto = '''{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - }''' # ProvisioningPolicyDto | - try: - # Create Provisioning Policy - new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) - results = SourcesApi(api_client).create_provisioning_policy(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto) - print("The response of SourcesApi->create_provisioning_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) -- path: /sources/{sourceId}/provisioning-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#list-provisioning-policies - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - - # Lists ProvisioningPolicies - - try { - Get-V2025ProvisioningPolicies -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025ProvisioningPolicies -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProvisioningPolicies" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#list-provisioning-policies - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id - try: - # Lists ProvisioningPolicies - - results = SourcesApi(api_client).list_provisioning_policies(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).list_provisioning_policies(source_id) - print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) -- path: /sources - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source - source: | - $Source = @" - { - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - } - "@ - $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) - - # Creates a source in IdentityNow. - - try { - $Result = ConvertFrom-JsonToSource -Json $Source - New-V2025Source -Source $Result - - # Below is a request that includes all optional parameters - # New-V2025Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Source" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#create-source - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source import Source - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source = '''{ - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - }''' # Source | - provision_as_csv = false # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) - try: - # Creates a source in IdentityNow. - new_source = Source.from_json(source) - results = SourcesApi(api_client).create_source(source=new_source) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).create_source(new_source, provision_as_csv) - print("The response of SourcesApi->create_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->create_source: %s\n" % e) -- path: /sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#list-sources - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) - $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) - $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) - - # Lists all sources in IdentityNow. - - try { - Get-V2025Sources - - # Below is a request that includes all optional parameters - # Get-V2025Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Sources" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#list-sources - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source import Source - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"Employees\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) - for_subadmin = 'name' # str | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # str | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) - include_idn_source = False # bool | Include the IdentityNow source in the response. (optional) (default to False) # bool | Include the IdentityNow source in the response. (optional) (default to False) - try: - # Lists all sources in IdentityNow. - - results = SourcesApi(api_client).list_sources() - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) - print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->list_sources: %s\n" % e) -- path: /sources/{sourceId}/schedules - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Schedule1 = @" - - "@ - - # Create Schedule on Source - - try { - $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 - New-V2025SourceSchedule -SourceId $SourceId -Schedule1 $Result - - # Below is a request that includes all optional parameters - # New-V2025SourceSchedule -SourceId $SourceId -Schedule1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#create-source-schedule - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.schedule1 import Schedule1 - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - schedule1 = '''sailpoint.v2025.Schedule1()''' # Schedule1 | - try: - # Create Schedule on Source - new_schedule1 = Schedule1.from_json(schedule1) - results = SourcesApi(api_client).create_source_schedule(source_id=source_id, schedule1=new_schedule1) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).create_source_schedule(source_id, new_schedule1) - print("The response of SourcesApi->create_source_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->create_source_schedule: %s\n" % e) -- path: /sources/{sourceId}/schedules - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schedules - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # List Schedules on Source - - try { - Get-V2025SourceSchedules -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025SourceSchedules -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchedules" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-schedules - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.schedule1 import Schedule1 - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - try: - # List Schedules on Source - - results = SourcesApi(api_client).get_source_schedules(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_schedules(source_id) - print("The response of SourcesApi->get_source_schedules:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) -- path: /sources/{sourceId}/schemas - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Schema = @" - { - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" - } - "@ - - # Create Schema on Source - - try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - New-V2025SourceSchema -SourceId $SourceId -Schema $Result - - # Below is a request that includes all optional parameters - # New-V2025SourceSchema -SourceId $SourceId -Schema $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#create-source-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - model_schema = '''sailpoint.v2025.ModelSchema()''' # ModelSchema | - try: - # Create Schema on Source - new_model_schema = ModelSchema.from_json(model_schema) - results = SourcesApi(api_client).create_source_schema(source_id=source_id, model_schema=new_model_schema) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).create_source_schema(source_id, new_model_schema) - print("The response of SourcesApi->create_source_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) -- path: /sources/{sourceId}/schemas - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schemas - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) - $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) - - # List Schemas on Source - - try { - Get-V2025SourceSchemas -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchemas" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-schemas - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - include_types = 'group' # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) - include_names = 'account' # str | A comma-separated list of schema names to filter result. (optional) # str | A comma-separated list of schema names to filter result. (optional) - try: - # List Schemas on Source - - results = SourcesApi(api_client).get_source_schemas(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) - print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) -- path: /sources/{id}/remove-accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-accounts-async - source: | - $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Remove All Accounts in a Source - - try { - Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccountsAsync" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#delete-accounts-async - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_result_dto import TaskResultDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Remove All Accounts in a Source - - results = SourcesApi(api_client).delete_accounts_async(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).delete_accounts_async(id, x_sail_point_experimental) - print("The response of SourcesApi->delete_accounts_async:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) -- path: /sources/{sourceId}/native-change-detection-config - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-native-change-detection-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Native Change Detection Configuration - - try { - Remove-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#delete-native-change-detection-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete Native Change Detection Configuration - - SourcesApi(api_client).delete_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SourcesApi(api_client).delete_native_change_detection_config(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) -- path: /sources/{sourceId}/native-change-detection-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-native-change-detection-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Native Change Detection Configuration - - try { - Get-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-native-change-detection-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.native_change_detection_config import NativeChangeDetectionConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Native Change Detection Configuration - - results = SourcesApi(api_client).get_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_native_change_detection_config(id, x_sail_point_experimental) - print("The response of SourcesApi->get_native_change_detection_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) -- path: /sources/{sourceId}/native-change-detection-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-native-change-detection-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $NativeChangeDetectionConfig = @" - { - "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], - "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], - "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], - "allNonEntitlementAttributes" : false, - "allEntitlements" : false, - "enabled" : true - } - "@ - - # Update Native Change Detection Configuration - - try { - $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig - Send-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025NativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#put-native-change-detection-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.native_change_detection_config import NativeChangeDetectionConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - native_change_detection_config = '''{ - "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], - "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], - "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], - "allNonEntitlementAttributes" : false, - "allEntitlements" : false, - "enabled" : true - }''' # NativeChangeDetectionConfig | - try: - # Update Native Change Detection Configuration - new_native_change_detection_config = NativeChangeDetectionConfig.from_json(native_change_detection_config) - results = SourcesApi(api_client).put_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental, native_change_detection_config=new_native_change_detection_config) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).put_native_change_detection_config(id, x_sail_point_experimental, new_native_change_detection_config) - print("The response of SourcesApi->put_native_change_detection_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - - # Delete Provisioning Policy by UsageType - - try { - Remove-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - - # Below is a request that includes all optional parameters - # Remove-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#delete-provisioning-policy - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.usage_type import UsageType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. - usage_type = sailpoint.v2025.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - try: - # Delete Provisioning Policy by UsageType - - SourcesApi(api_client).delete_provisioning_policy(source_id=source_id, usage_type=usage_type) - # Below is a request that includes all optional parameters - # SourcesApi(api_client).delete_provisioning_policy(source_id, usage_type) - except Exception as e: - print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - - # Get Provisioning Policy by UsageType - - try { - Get-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - - # Below is a request that includes all optional parameters - # Get-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-provisioning-policy - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto - from sailpoint.v2025.models.usage_type import UsageType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. - usage_type = sailpoint.v2025.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - try: - # Get Provisioning Policy by UsageType - - results = SourcesApi(api_client).get_provisioning_policy(source_id=source_id, usage_type=usage_type) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_provisioning_policy(source_id, usage_type) - print("The response of SourcesApi->get_provisioning_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $ProvisioningPolicyDto = @" - { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } - "@ - - # Update Provisioning Policy by UsageType - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Send-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#put-provisioning-policy - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto - from sailpoint.v2025.models.usage_type import UsageType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. - usage_type = sailpoint.v2025.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - provisioning_policy_dto = '''{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - }''' # ProvisioningPolicyDto | - try: - # Update Provisioning Policy by UsageType - new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) - results = SourcesApi(api_client).put_provisioning_policy(source_id=source_id, usage_type=usage_type, provisioning_policy_dto=new_provisioning_policy_dto) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, new_provisioning_policy_dto) - print("The response of SourcesApi->put_provisioning_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Partial update of Provisioning Policy - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-provisioning-policy - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto - from sailpoint.v2025.models.usage_type import UsageType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - usage_type = sailpoint.v2025.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - json_patch_operation = '''[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. - try: - # Partial update of Provisioning Policy - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SourcesApi(api_client).update_provisioning_policy(source_id=source_id, usage_type=usage_type, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, new_json_patch_operation) - print("The response of SourcesApi->update_provisioning_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) -- path: /sources/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Delete Source by ID - - try { - Remove-V2025Source -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Source -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Source" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#delete-source - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.delete_source202_response import DeleteSource202Response - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - try: - # Delete Source by ID - - results = SourcesApi(api_client).delete_source(id=id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).delete_source(id) - print("The response of SourcesApi->delete_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->delete_source: %s\n" % e) -- path: /sources/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Get Source by ID - - try { - Get-V2025Source -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Source -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Source" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source import Source - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - try: - # Get Source by ID - - results = SourcesApi(api_client).get_source(id=id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source(id) - print("The response of SourcesApi->get_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source: %s\n" % e) -- path: /sources/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Source = @" - { - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - } - "@ - - # Update Source (Full) - - try { - $Result = ConvertFrom-JsonToSource -Json $Source - Send-V2025Source -Id $Id -Source $Result - - # Below is a request that includes all optional parameters - # Send-V2025Source -Id $Id -Source $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Source" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#put-source - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source import Source - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - source = '''{ - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - }''' # Source | - try: - # Update Source (Full) - new_source = Source.from_json(source) - results = SourcesApi(api_client).put_source(id=id, source=new_source) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).put_source(id, new_source) - print("The response of SourcesApi->put_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->put_source: %s\n" % e) -- path: /sources/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Source -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Source -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Source" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-source - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.source import Source - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - json_patch_operation = '''[{op=replace, path=/description, value=new description}]''' # List[JsonPatchOperation] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - try: - # Update Source (Partial) - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SourcesApi(api_client).update_source(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_source(id, new_json_patch_operation) - print("The response of SourcesApi->update_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_source: %s\n" % e) -- path: /sources/{sourceId}/schedules/{scheduleType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - - # Delete Source Schedule by type. - - try { - Remove-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - - # Below is a request that includes all optional parameters - # Remove-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#delete-source-schedule - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. - try: - # Delete Source Schedule by type. - - SourcesApi(api_client).delete_source_schedule(source_id=source_id, schedule_type=schedule_type) - # Below is a request that includes all optional parameters - # SourcesApi(api_client).delete_source_schedule(source_id, schedule_type) - except Exception as e: - print("Exception when calling SourcesApi->delete_source_schedule: %s\n" % e) -- path: /sources/{sourceId}/schedules/{scheduleType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - - # Get Source Schedule by Type - - try { - Get-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - - # Below is a request that includes all optional parameters - # Get-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-schedule - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.schedule1 import Schedule1 - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. - try: - # Get Source Schedule by Type - - results = SourcesApi(api_client).get_source_schedule(source_id=source_id, schedule_type=schedule_type) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_schedule(source_id, schedule_type) - print("The response of SourcesApi->get_source_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_schedule: %s\n" % e) -- path: /sources/{sourceId}/schedules/{scheduleType} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source Schedule (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-source-schedule - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.schedule1 import Schedule1 - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. - json_patch_operation = '''[{op=replace, path=/cronExpression, value=0 0 6 * * ?}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. - try: - # Update Source Schedule (Partial) - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SourcesApi(api_client).update_source_schedule(source_id=source_id, schedule_type=schedule_type, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_source_schedule(source_id, schedule_type, new_json_patch_operation) - print("The response of SourcesApi->update_source_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_source_schedule: %s\n" % e) -- path: /sources/{sourceId}/schemas/{schemaId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - - # Delete Source Schema by ID - - try { - Remove-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Remove-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#delete-source-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. - try: - # Delete Source Schema by ID - - SourcesApi(api_client).delete_source_schema(source_id=source_id, schema_id=schema_id) - # Below is a request that includes all optional parameters - # SourcesApi(api_client).delete_source_schema(source_id, schema_id) - except Exception as e: - print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) -- path: /sources/{sourceId}/schemas/{schemaId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - - # Get Source Schema by ID - - try { - Get-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Get-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. - try: - # Get Source Schema by ID - - results = SourcesApi(api_client).get_source_schema(source_id=source_id, schema_id=schema_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_schema(source_id, schema_id) - print("The response of SourcesApi->get_source_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) -- path: /sources/{sourceId}/schemas/{schemaId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $Schema = @" - { - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" - } - "@ - - # Update Source Schema (Full) - - try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result - - # Below is a request that includes all optional parameters - # Send-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SourceSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#put-source-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. - model_schema = '''sailpoint.v2025.ModelSchema()''' # ModelSchema | - try: - # Update Source Schema (Full) - new_model_schema = ModelSchema.from_json(model_schema) - results = SourcesApi(api_client).put_source_schema(source_id=source_id, schema_id=schema_id, model_schema=new_model_schema) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema) - print("The response of SourcesApi->put_source_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) -- path: /sources/{sourceId}/schemas/{schemaId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source Schema (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-source-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. - json_patch_operation = '''[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. - try: - # Update Source Schema (Partial) - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SourcesApi(api_client).update_source_schema(source_id=source_id, schema_id=schema_id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_source_schema(source_id, schema_id, new_json_patch_operation) - print("The response of SourcesApi->update_source_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /sources/{id}/schemas/accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-accounts-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - - # Downloads source accounts schema template - - try { - Get-V2025AccountsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccountsSchema -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountsSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-accounts-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id - try: - # Downloads source accounts schema template - - SourcesApi(api_client).get_accounts_schema(id=id) - # Below is a request that includes all optional parameters - # SourcesApi(api_client).get_accounts_schema(id) - except Exception as e: - print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) -- path: /sources/{id}/schemas/accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-accounts-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $File = # System.IO.FileInfo | (optional) - - # Uploads source accounts schema template - - try { - Import-V2025AccountsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Import-V2025AccountsSchema -Id $Id -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025AccountsSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#import-accounts-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id - file = None # bytearray | (optional) # bytearray | (optional) - try: - # Uploads source accounts schema template - - results = SourcesApi(api_client).import_accounts_schema(id=id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_accounts_schema(id, file) - print("The response of SourcesApi->import_accounts_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) -- path: /sources/{id}/correlation-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-correlation-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - - # Get Source Correlation Configuration - - try { - Get-V2025CorrelationConfig -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CorrelationConfig -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CorrelationConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-correlation-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.correlation_config import CorrelationConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - try: - # Get Source Correlation Configuration - - results = SourcesApi(api_client).get_correlation_config(id=id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_correlation_config(id) - print("The response of SourcesApi->get_correlation_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) -- path: /sources/{id}/correlation-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-correlation-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $CorrelationConfig = @" - { - "attributeAssignments" : [ { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - }, { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - } ], - "name" : "Source [source] Account Correlation", - "id" : "2c9180835d191a86015d28455b4a2329" - } - "@ - - # Update Source Correlation Configuration - - try { - $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig - Send-V2025CorrelationConfig -Id $Id -CorrelationConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025CorrelationConfig -Id $Id -CorrelationConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025CorrelationConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#put-correlation-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.correlation_config import CorrelationConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - correlation_config = '''{ - "attributeAssignments" : [ { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - }, { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - } ], - "name" : "Source [source] Account Correlation", - "id" : "2c9180835d191a86015d28455b4a2329" - }''' # CorrelationConfig | - try: - # Update Source Correlation Configuration - new_correlation_config = CorrelationConfig.from_json(correlation_config) - results = SourcesApi(api_client).put_correlation_config(id=id, correlation_config=new_correlation_config) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).put_correlation_config(id, new_correlation_config) - print("The response of SourcesApi->put_correlation_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) -- path: /sources/{id}/schemas/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-entitlements-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) - - # Downloads source entitlements schema template - - try { - Get-V2025EntitlementsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementsSchema -Id $Id -SchemaName $SchemaName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementsSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-entitlements-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id - schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) - try: - # Downloads source entitlements schema template - - SourcesApi(api_client).get_entitlements_schema(id=id) - # Below is a request that includes all optional parameters - # SourcesApi(api_client).get_entitlements_schema(id, schema_name) - except Exception as e: - print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) -- path: /sources/{id}/schemas/entitlements - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-entitlements-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) - $File = # System.IO.FileInfo | (optional) - - # Uploads source entitlements schema template - - try { - Import-V2025EntitlementsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Import-V2025EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#import-entitlements-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id - schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) - file = None # bytearray | (optional) # bytearray | (optional) - try: - # Uploads source entitlements schema template - - results = SourcesApi(api_client).import_entitlements_schema(id=id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_entitlements_schema(id, schema_name, file) - print("The response of SourcesApi->import_entitlements_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) -- path: /sources/{id}/attribute-sync-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-attr-sync-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Attribute Sync Config - - try { - Get-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceAttrSyncConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-attr-sync-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.attr_sync_source_config import AttrSyncSourceConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Attribute Sync Config - - results = SourcesApi(api_client).get_source_attr_sync_config(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_attr_sync_config(id, x_sail_point_experimental) - print("The response of SourcesApi->get_source_attr_sync_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) -- path: /sources/{id}/attribute-sync-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source-attr-sync-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AttrSyncSourceConfig = @" - { - "attributes" : [ { - "name" : "email", - "displayName" : "Email", - "enabled" : true, - "target" : "mail" - }, { - "name" : "firstname", - "displayName" : "First Name", - "enabled" : false, - "target" : "givenName" - } ], - "source" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - } - } - "@ - - # Update Attribute Sync Config - - try { - $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig - Send-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SourceAttrSyncConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#put-source-attr-sync-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.attr_sync_source_config import AttrSyncSourceConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - attr_sync_source_config = '''{ - "attributes" : [ { - "name" : "email", - "displayName" : "Email", - "enabled" : true, - "target" : "mail" - }, { - "name" : "firstname", - "displayName" : "First Name", - "enabled" : false, - "target" : "givenName" - } ], - "source" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - } - }''' # AttrSyncSourceConfig | - try: - # Update Attribute Sync Config - new_attr_sync_source_config = AttrSyncSourceConfig.from_json(attr_sync_source_config) - results = SourcesApi(api_client).put_source_attr_sync_config(id=id, x_sail_point_experimental=x_sail_point_experimental, attr_sync_source_config=new_attr_sync_source_config) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).put_source_attr_sync_config(id, x_sail_point_experimental, new_attr_sync_source_config) - print("The response of SourcesApi->put_source_attr_sync_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) -- path: /sources/{id}/connectors/source-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-config - source: | - $Id = "cef3ee201db947c5912551015ba0c679" # String | The Source id - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Gets source config with language-translations - - try { - Get-V2025SourceConfig -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SourceConfig -Id $Id -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_detail import ConnectorDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'cef3ee201db947c5912551015ba0c679' # str | The Source id # str | The Source id - locale = 'en' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) - try: - # Gets source config with language-translations - - results = SourcesApi(api_client).get_source_config(id=id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_config(id, locale) - print("The response of SourcesApi->get_source_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_config: %s\n" % e) -- path: /sources/{sourceId}/connections - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-connections - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Get Source Connections by ID - - try { - Get-V2025SourceConnections -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025SourceConnections -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceConnections" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-connections - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_connections_dto import SourceConnectionsDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - try: - # Get Source Connections by ID - - results = SourcesApi(api_client).get_source_connections(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_connections(source_id) - print("The response of SourcesApi->get_source_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_connections: %s\n" % e) -- path: /sources/{id}/entitlement-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-entitlement-request-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Source Entitlement Request Configuration - - try { - Get-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-entitlement-request-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_entitlement_request_config import SourceEntitlementRequestConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Source Entitlement Request Configuration - - results = SourcesApi(api_client).get_source_entitlement_request_config(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_entitlement_request_config(x_sail_point_experimental) - print("The response of SourcesApi->get_source_entitlement_request_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) -- path: /sources/{id}/entitlement-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-entitlement-request-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceEntitlementRequestConfig = @" - { - "accessRequestConfig" : { - "denialCommentRequired" : false, - "approvalSchemes" : [ { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - } ], - "requestCommentRequired" : true - } - } - "@ - - # Update Source Entitlement Request Configuration - - try { - $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Update-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-source-entitlement-request-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_entitlement_request_config import SourceEntitlementRequestConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - source_entitlement_request_config = '''{ - "accessRequestConfig" : { - "denialCommentRequired" : false, - "approvalSchemes" : [ { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - } ], - "requestCommentRequired" : true - } - }''' # SourceEntitlementRequestConfig | - try: - # Update Source Entitlement Request Configuration - new_source_entitlement_request_config = SourceEntitlementRequestConfig.from_json(source_entitlement_request_config) - results = SourcesApi(api_client).update_source_entitlement_request_config(x_sail_point_experimental=x_sail_point_experimental, source_entitlement_request_config=new_source_entitlement_request_config) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_source_entitlement_request_config(x_sail_point_experimental, new_source_entitlement_request_config) - print("The response of SourcesApi->update_source_entitlement_request_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) -- path: /sources/{sourceId}/source-health - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-health - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - - # Fetches source health by id - - try { - Get-V2025SourceHealth -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025SourceHealth -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceHealth" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-health - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_health_dto import SourceHealthDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - try: - # Fetches source health by id - - results = SourcesApi(api_client).get_source_health(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_health(source_id) - print("The response of SourcesApi->get_source_health:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_health: %s\n" % e) -- path: /sources/{id}/load-accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-accounts - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) - $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) - - # Account Aggregation - - try { - Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025Accounts" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#import-accounts - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.load_accounts_task import LoadAccountsTask - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - file = None # bytearray | The CSV file containing the source accounts to aggregate. (optional) # bytearray | The CSV file containing the source accounts to aggregate. (optional) - disable_optimization = 'disable_optimization_example' # str | Use this flag to reprocess every account whether or not the data has changed. (optional) # str | Use this flag to reprocess every account whether or not the data has changed. (optional) - try: - # Account Aggregation - - results = SourcesApi(api_client).import_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_accounts(id, x_sail_point_experimental, file, disable_optimization) - print("The response of SourcesApi->import_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->import_accounts: %s\n" % e) -- path: /sources/{sourceId}/upload-connector-file - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-connector-file - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $File = # System.IO.FileInfo | (optional) - - # Upload connector file to source - - try { - Import-V2025ConnectorFile -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Import-V2025ConnectorFile -SourceId $SourceId -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025ConnectorFile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#import-connector-file - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source import Source - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - file = None # bytearray | (optional) # bytearray | (optional) - try: - # Upload connector file to source - - results = SourcesApi(api_client).import_connector_file(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_connector_file(source_id, file) - print("The response of SourcesApi->import_connector_file:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) -- path: /sources/{id}/load-uncorrelated-accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-uncorrelated-accounts - source: | - $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $File = # System.IO.FileInfo | (optional) - - # Process Uncorrelated Accounts - - try { - Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025UncorrelatedAccounts" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#import-uncorrelated-accounts - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.load_uncorrelated_accounts_task import LoadUncorrelatedAccountsTask - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - file = None # bytearray | (optional) # bytearray | (optional) - try: - # Process Uncorrelated Accounts - - results = SourcesApi(api_client).import_uncorrelated_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_uncorrelated_accounts(id, x_sail_point_experimental, file) - print("The response of SourcesApi->import_uncorrelated_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) -- path: /sources/{sourceId}/connector/ping-cluster - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#ping-cluster - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - - # Ping cluster for source connector - - try { - Ping-V2025Cluster -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Ping-V2025Cluster -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2025Cluster" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#ping-cluster - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.status_response import StatusResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source - try: - # Ping cluster for source connector - - results = SourcesApi(api_client).ping_cluster(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).ping_cluster(source_id) - print("The response of SourcesApi->ping_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) -- path: /sources/{sourceId}/connector/peek-resource-objects - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#search-resource-objects - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - $ResourceObjectsRequest = @" - { - "maxCount" : 100, - "objectType" : "group" - } - "@ - - # Peek source connector's resource objects - - try { - $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest - Search-V2025ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result - - # Below is a request that includes all optional parameters - # Search-V2025ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025ResourceObjects" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#search-resource-objects - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.resource_objects_request import ResourceObjectsRequest - from sailpoint.v2025.models.resource_objects_response import ResourceObjectsResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source - resource_objects_request = '''{ - "maxCount" : 100, - "objectType" : "group" - }''' # ResourceObjectsRequest | - try: - # Peek source connector's resource objects - new_resource_objects_request = ResourceObjectsRequest.from_json(resource_objects_request) - results = SourcesApi(api_client).search_resource_objects(source_id=source_id, resource_objects_request=new_resource_objects_request) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).search_resource_objects(source_id, new_resource_objects_request) - print("The response of SourcesApi->search_resource_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->search_resource_objects: %s\n" % e) -- path: /sources/{id}/synchronize-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#sync-attributes-for-source - source: | - $Id = "MyId" # String | The Source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Synchronize single source attributes. - - try { - Sync-V2025AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Sync-V2025AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025AttributesForSource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#sync-attributes-for-source - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_sync_job import SourceSyncJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'id_example' # str | The Source id # str | The Source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Synchronize single source attributes. - - results = SourcesApi(api_client).sync_attributes_for_source(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).sync_attributes_for_source(id, x_sail_point_experimental) - print("The response of SourcesApi->sync_attributes_for_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) -- path: /sources/{sourceId}/connector/test-configuration - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#test-source-configuration - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - - # Test configuration for source connector - - try { - Test-V2025SourceConfiguration -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-V2025SourceConfiguration -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#test-source-configuration - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.status_response import StatusResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source - try: - # Test configuration for source connector - - results = SourcesApi(api_client).test_source_configuration(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).test_source_configuration(source_id) - print("The response of SourcesApi->test_source_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) -- path: /sources/{sourceId}/connector/check-connection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#test-source-connection - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. - - # Check connection for source connector. - - try { - Test-V2025SourceConnection -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-V2025SourceConnection -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConnection" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#test-source-connection - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.status_response import StatusResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source. - try: - # Check connection for source connector. - - results = SourcesApi(api_client).test_source_connection(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).test_source_connection(source_id) - print("The response of SourcesApi->test_source_connection:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) -- path: /sources/{sourceId}/password-policies - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-password-policy-holders - source: | - $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $PasswordPolicyHoldersDtoInner = @""@ - - - # Update Password Policy - - try { - $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner - Update-V2025PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PasswordPolicyHolders" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-password-policy-holders - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_policy_holders_dto_inner import PasswordPolicyHoldersDtoInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id - password_policy_holders_dto_inner = '''[sailpoint.v2025.PasswordPolicyHoldersDtoInner()]''' # List[PasswordPolicyHoldersDtoInner] | - try: - # Update Password Policy - new_password_policy_holders_dto_inner = PasswordPolicyHoldersDtoInner.from_json(password_policy_holders_dto_inner) - results = SourcesApi(api_client).update_password_policy_holders(source_id=source_id, password_policy_holders_dto_inner=new_password_policy_holders_dto_inner) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) - print("The response of SourcesApi->update_password_policy_holders:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) -- path: /sources/{sourceId}/provisioning-policies/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-provisioning-policies-in-bulk - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ProvisioningPolicyDto = @"{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - }"@ - - - # Bulk Update Provisioning Policies - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-V2025ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Update-V2025ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProvisioningPoliciesInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-provisioning-policies-in-bulk - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - provisioning_policy_dto = '''[sailpoint.v2025.ProvisioningPolicyDto()]''' # List[ProvisioningPolicyDto] | - try: - # Bulk Update Provisioning Policies - new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) - results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) - print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) -- path: /suggested-entitlement-description-batches/{batchId}/stats - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#get-sed-batch-stats - source: | - $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id - - # Submit Sed Batch Stats Request - - try { - Get-V2025SedBatchStats -BatchId $BatchId - - # Below is a request that includes all optional parameters - # Get-V2025SedBatchStats -BatchId $BatchId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SedBatchStats" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#get-sed-batch-stats - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed_batch_stats import SedBatchStats - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id - try: - # Submit Sed Batch Stats Request - - results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id=batch_id) - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id) - print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) -- path: /suggested-entitlement-description-batches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#get-sed-batches - source: | - - # List Sed Batch Request - - try { - Get-V2025SedBatches - - # Below is a request that includes all optional parameters - # Get-V2025SedBatches - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SedBatches" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#get-sed-batches - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed_batch_status import SedBatchStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Sed Batch Request - - results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches() - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches() - print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) -- path: /suggested-entitlement-description-batches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-batch-request - source: | - $SedBatchRequest = @" - { - "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] - } - "@ - - # Submit Sed Batch Request - - try { - Submit-V2025SedBatchRequest - - # Below is a request that includes all optional parameters - # Submit-V2025SedBatchRequest -SedBatchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedBatchRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#submit-sed-batch-request - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed_batch_request import SedBatchRequest - from sailpoint.v2025.models.sed_batch_response import SedBatchResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sed_batch_request = '''{ - "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] - }''' # SedBatchRequest | Sed Batch Request (optional) - try: - # Submit Sed Batch Request - - results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request() - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(new_sed_batch_request) - print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) -- path: /suggested-entitlement-descriptions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#list-seds - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) - $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) - $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) - $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) - $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) - - # List Suggested Entitlement Descriptions - - try { - Get-V2025Seds - - # Below is a request that includes all optional parameters - # Get-V2025Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Seds" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#list-seds - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed import Sed - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'displayName co \"Read and Write\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) - sorters = 'sorters=displayName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) - count_only = False # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to False) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to False) - requested_by_anyone = False # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to False) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to False) - show_pending_status_only = False # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to False) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to False) - try: - # List Suggested Entitlement Descriptions - - results = SuggestedEntitlementDescriptionApi(api_client).list_seds() - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) - print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) -- path: /suggested-entitlement-descriptions - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#patch-sed - source: | - $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id - $SedPatch = @"{ - "op" : "replace", - "path" : "status", - "value" : "approved" - }"@ - - - # Patch Suggested Entitlement Description - - try { - $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-V2025Sed -Id $Id -SedPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025Sed -Id $Id -SedPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Sed" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#patch-sed - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed import Sed - from sailpoint.v2025.models.sed_patch import SedPatch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id - sed_patch = '''[sailpoint.v2025.SedPatch()]''' # List[SedPatch] | Sed Patch Request - try: - # Patch Suggested Entitlement Description - new_sed_patch = SedPatch.from_json(sed_patch) - results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id=id, sed_patch=new_sed_patch) - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, new_sed_patch) - print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) -- path: /suggested-entitlement-description-approvals - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-approval - source: | - $SedApproval = @"{ - "items" : "016629d1-1d25-463f-97f3-c6686846650" - }"@ - - - # Submit Bulk Approval Request - - try { - $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-V2025SedApproval -SedApproval $Result - - # Below is a request that includes all optional parameters - # Submit-V2025SedApproval -SedApproval $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedApproval" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#submit-sed-approval - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed_approval import SedApproval - from sailpoint.v2025.models.sed_approval_status import SedApprovalStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sed_approval = '''[sailpoint.v2025.SedApproval()]''' # List[SedApproval] | Sed Approval - try: - # Submit Bulk Approval Request - new_sed_approval = SedApproval.from_json(sed_approval) - results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(sed_approval=new_sed_approval) - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) - print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) -- path: /suggested-entitlement-description-assignments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-assignment - source: | - $SedAssignment = @" - { - "assignee" : { - "type" : "SOURCE_OWNER", - "value" : "016629d1-1d25-463f-97f3-c6686846650" - }, - "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] - } - "@ - - # Submit Sed Assignment Request - - try { - $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-V2025SedAssignment -SedAssignment $Result - - # Below is a request that includes all optional parameters - # Submit-V2025SedAssignment -SedAssignment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedAssignment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#submit-sed-assignment - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed_assignment import SedAssignment - from sailpoint.v2025.models.sed_assignment_response import SedAssignmentResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sed_assignment = '''{ - "assignee" : { - "type" : "SOURCE_OWNER", - "value" : "016629d1-1d25-463f-97f3-c6686846650" - }, - "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] - }''' # SedAssignment | Sed Assignment Request - try: - # Submit Sed Assignment Request - new_sed_assignment = SedAssignment.from_json(sed_assignment) - results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(sed_assignment=new_sed_assignment) - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(new_sed_assignment) - print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) -- path: /tagged-objects/{type}/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#delete-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. - - # Delete Object Tags - - try { - Remove-V2025TaggedObject -Type $Type -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025TaggedObject -Type $Type -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TaggedObject" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#delete-tagged-object - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'ROLE' # str | The type of object to delete tags from. # str | The type of object to delete tags from. - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object to delete tags from. # str | The ID of the object to delete tags from. - try: - # Delete Object Tags - - TaggedObjectsApi(api_client).delete_tagged_object(type=type, id=id) - # Below is a request that includes all optional parameters - # TaggedObjectsApi(api_client).delete_tagged_object(type, id) - except Exception as e: - print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) -- path: /tagged-objects/{type}/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#get-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - - # Get Tagged Object - - try { - Get-V2025TaggedObject -Type $Type -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025TaggedObject -Type $Type -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObject" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#get-tagged-object - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tagged_object import TaggedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'ROLE' # str | The type of tagged object to retrieve. # str | The type of tagged object to retrieve. - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. - try: - # Get Tagged Object - - results = TaggedObjectsApi(api_client).get_tagged_object(type=type, id=id) - # Below is a request that includes all optional parameters - # results = TaggedObjectsApi(api_client).get_tagged_object(type, id) - print("The response of TaggedObjectsApi->get_tagged_object:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) -- path: /tagged-objects/{type}/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#put-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. - $TaggedObject = @" - { - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Update Tagged Object - - try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-V2025TaggedObject -Type $Type -Id $Id -TaggedObject $Result - - # Below is a request that includes all optional parameters - # Send-V2025TaggedObject -Type $Type -Id $Id -TaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TaggedObject" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#put-tagged-object - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tagged_object import TaggedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'ROLE' # str | The type of tagged object to update. # str | The type of tagged object to update. - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to update. # str | The ID of the object reference to update. - tagged_object = '''{ - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - }''' # TaggedObject | - try: - # Update Tagged Object - new_tagged_object = TaggedObject.from_json(tagged_object) - results = TaggedObjectsApi(api_client).put_tagged_object(type=type, id=id, tagged_object=new_tagged_object) - # Below is a request that includes all optional parameters - # results = TaggedObjectsApi(api_client).put_tagged_object(type, id, new_tagged_object) - print("The response of TaggedObjectsApi->put_tagged_object:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) -- path: /tagged-objects/bulk-remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#delete-tags-to-many-object - source: | - $BulkRemoveTaggedObject = @" - { - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Remove Tags from Multiple Objects - - try { - $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject - Remove-V2025TagsToManyObject -BulkRemoveTaggedObject $Result - - # Below is a request that includes all optional parameters - # Remove-V2025TagsToManyObject -BulkRemoveTaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TagsToManyObject" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#delete-tags-to-many-object - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.bulk_remove_tagged_object import BulkRemoveTaggedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - bulk_remove_tagged_object = '''{ - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "tags" : [ "BU_FINANCE", "PCI" ] - }''' # BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - try: - # Remove Tags from Multiple Objects - new_bulk_remove_tagged_object = BulkRemoveTaggedObject.from_json(bulk_remove_tagged_object) - TaggedObjectsApi(api_client).delete_tags_to_many_object(bulk_remove_tagged_object=new_bulk_remove_tagged_object) - # Below is a request that includes all optional parameters - # TaggedObjectsApi(api_client).delete_tags_to_many_object(new_bulk_remove_tagged_object) - except Exception as e: - print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) -- path: /tagged-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#list-tagged-objects - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) - - # List Tagged Objects - - try { - Get-V2025TaggedObjects - - # Below is a request that includes all optional parameters - # Get-V2025TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObjects" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#list-tagged-objects - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tagged_object import TaggedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'tagName eq \"BU_FINANCE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) - try: - # List Tagged Objects - - results = TaggedObjectsApi(api_client).list_tagged_objects() - # Below is a request that includes all optional parameters - # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) - print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) -- path: /tagged-objects - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#set-tag-to-object - source: | - $TaggedObject = @" - { - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Add Tag to Object - - try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-V2025TagToObject -TaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-V2025TagToObject -TaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TagToObject" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#set-tag-to-object - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tagged_object import TaggedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - tagged_object = '''{ - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - }''' # TaggedObject | - try: - # Add Tag to Object - new_tagged_object = TaggedObject.from_json(tagged_object) - TaggedObjectsApi(api_client).set_tag_to_object(tagged_object=new_tagged_object) - # Below is a request that includes all optional parameters - # TaggedObjectsApi(api_client).set_tag_to_object(new_tagged_object) - except Exception as e: - print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) -- path: /tagged-objects/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#list-tagged-objects-by-type - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) - - # List Tagged Objects by Type - - try { - Get-V2025TaggedObjectsByType -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObjectsByType" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#list-tagged-objects-by-type - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tagged_object import TaggedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'ROLE' # str | The type of tagged object to retrieve. # str | The type of tagged object to retrieve. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'objectRef.id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) - try: - # List Tagged Objects by Type - - results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type=type) - # Below is a request that includes all optional parameters - # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) - print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) -- path: /tagged-objects/bulk-add - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#set-tags-to-many-objects - source: | - $BulkAddTaggedObject = @" - { - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "operation" : "MERGE", - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Tag Multiple Objects - - try { - $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject - Set-V2025TagsToManyObjects -BulkAddTaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-V2025TagsToManyObjects -BulkAddTaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TagsToManyObjects" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#set-tags-to-many-objects - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.bulk_add_tagged_object import BulkAddTaggedObject - from sailpoint.v2025.models.bulk_tagged_object_response import BulkTaggedObjectResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - bulk_add_tagged_object = '''{ - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "operation" : "MERGE", - "tags" : [ "BU_FINANCE", "PCI" ] - }''' # BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - try: - # Tag Multiple Objects - new_bulk_add_tagged_object = BulkAddTaggedObject.from_json(bulk_add_tagged_object) - results = TaggedObjectsApi(api_client).set_tags_to_many_objects(bulk_add_tagged_object=new_bulk_add_tagged_object) - # Below is a request that includes all optional parameters - # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) - print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) -- path: /task-status/pending-tasks - method: HEAD - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-pending-task-headers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieve Pending Task List Headers - - try { - Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTaskHeaders" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/task-management#get-pending-task-headers - source: | - from sailpoint.v2025.api.task_management_api import TaskManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieve Pending Task List Headers - - TaskManagementApi(api_client).get_pending_task_headers(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # TaskManagementApi(api_client).get_pending_task_headers(x_sail_point_experimental, offset, limit, count) - except Exception as e: - print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e) -- path: /task-status/pending-tasks - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-pending-tasks - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieve Pending Task Status List - - try { - Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTasks" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/task-management#get-pending-tasks - source: | - from sailpoint.v2025.api.task_management_api import TaskManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_status import TaskStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieve Pending Task Status List - - results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count) - print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) -- path: /task-status/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-task-status - source: | - $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Task Status by ID - - try { - Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/task-management#get-task-status - source: | - from sailpoint.v2025.api.task_management_api import TaskManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_status import TaskStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Task Status by ID - - results = TaskManagementApi(api_client).get_task_status(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TaskManagementApi(api_client).get_task_status(id, x_sail_point_experimental) - print("The response of TaskManagementApi->get_task_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) -- path: /task-status/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#update-task-status - source: | - $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Task Status by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025TaskStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/task-management#update-task-status - source: | - from sailpoint.v2025.api.task_management_api import TaskManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.task_status import TaskStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the object. - try: - # Update Task Status by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = TaskManagementApi(api_client).update_task_status(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = TaskManagementApi(api_client).update_task_status(id, x_sail_point_experimental, new_json_patch_operation) - print("The response of TaskManagementApi->update_task_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) -- path: /task-status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-task-status-list - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "completionStatus eq "Success"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) - $Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) - - # Retrieve Task Status List - - try { - Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatusList" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/task-management#get-task-status-list - source: | - from sailpoint.v2025.api.task_management_api import TaskManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_status import TaskStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'completionStatus eq \"Success\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) - sorters = '-created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) - try: - # Retrieve Task Status List - - results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) -- path: /tenant - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tenant#get-tenant - source: | - - # Get Tenant Information. - - try { - Get-V2025Tenant - - # Below is a request that includes all optional parameters - # Get-V2025Tenant - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Tenant" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tenant#get-tenant - source: | - from sailpoint.v2025.api.tenant_api import TenantApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tenant import Tenant - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get Tenant Information. - - results = TenantApi(api_client).get_tenant() - # Below is a request that includes all optional parameters - # results = TenantApi(api_client).get_tenant() - print("The response of TenantApi->get_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TenantApi->get_tenant: %s\n" % e) -- path: /tenant-context - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tenant-context#get-tenant-context - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieve tenant context - - try { - Get-V2025TenantContext -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TenantContext -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantContext" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tenant-context#get-tenant-context - source: | - from sailpoint.v2025.api.tenant_context_api import TenantContextApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_tenant_context200_response_inner import GetTenantContext200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Retrieve tenant context - - results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental) - print("The response of TenantContextApi->get_tenant_context:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TenantContextApi->get_tenant_context: %s\n" % e) -- path: /tenant-context - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tenant-context#patch-tenant-context - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @" - { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } - "@ - - # Update tenant context - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025TenantContext" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tenant-context#patch-tenant-context - source: | - from sailpoint.v2025.api.tenant_context_api import TenantContextApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }''' # JsonPatchOperation | - try: - # Update tenant context - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - TenantContextApi(api_client).patch_tenant_context(x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # TenantContextApi(api_client).patch_tenant_context(x_sail_point_experimental, new_json_patch_operation) - except Exception as e: - print("Exception when calling TenantContextApi->patch_tenant_context: %s\n" % e) -- path: /transforms - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#create-transform - source: | - $Transform = @" - { - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" - } - "@ - - # Create transform - - try { - $Result = ConvertFrom-JsonToTransform -Json $Transform - New-V2025Transform -Transform $Result - - # Below is a request that includes all optional parameters - # New-V2025Transform -Transform $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Transform" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/transforms#create-transform - source: | - from sailpoint.v2025.api.transforms_api import TransformsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.transform import Transform - from sailpoint.v2025.models.transform_read import TransformRead - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - transform = '''{ - "name" : "Timestamp To Date", - "attributes" : "{}", - "type" : "dateFormat" - }''' # Transform | The transform to be created. - try: - # Create transform - new_transform = Transform.from_json(transform) - results = TransformsApi(api_client).create_transform(transform=new_transform) - # Below is a request that includes all optional parameters - # results = TransformsApi(api_client).create_transform(new_transform) - print("The response of TransformsApi->create_transform:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TransformsApi->create_transform: %s\n" % e) -- path: /transforms - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#list-transforms - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) - $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) - - # List transforms - - try { - Get-V2025Transforms - - # Below is a request that includes all optional parameters - # Get-V2025Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Transforms" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/transforms#list-transforms - source: | - from sailpoint.v2025.api.transforms_api import TransformsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.transform_read import TransformRead - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - name = 'ExampleTransformName123' # str | Name of the transform to retrieve from the list. (optional) # str | Name of the transform to retrieve from the list. (optional) - filters = 'name eq \"Uppercase\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) - try: - # List transforms - - results = TransformsApi(api_client).list_transforms() - # Below is a request that includes all optional parameters - # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) - print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TransformsApi->list_transforms: %s\n" % e) -- path: /transforms/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#delete-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete - - # Delete a transform - - try { - Remove-V2025Transform -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Transform -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Transform" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/transforms#delete-transform - source: | - from sailpoint.v2025.api.transforms_api import TransformsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete - try: - # Delete a transform - - TransformsApi(api_client).delete_transform(id=id) - # Below is a request that includes all optional parameters - # TransformsApi(api_client).delete_transform(id) - except Exception as e: - print("Exception when calling TransformsApi->delete_transform: %s\n" % e) -- path: /transforms/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#get-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve - - # Transform by ID - - try { - Get-V2025Transform -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Transform -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Transform" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/transforms#get-transform - source: | - from sailpoint.v2025.api.transforms_api import TransformsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.transform_read import TransformRead - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve - try: - # Transform by ID - - results = TransformsApi(api_client).get_transform(id=id) - # Below is a request that includes all optional parameters - # results = TransformsApi(api_client).get_transform(id) - print("The response of TransformsApi->get_transform:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TransformsApi->get_transform: %s\n" % e) -- path: /transforms/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#update-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update - $Transform = @" - { - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" - } - "@ - - # Update a transform - - try { - Update-V2025Transform -Id $Id - - # Below is a request that includes all optional parameters - # Update-V2025Transform -Id $Id -Transform $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Transform" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/transforms#update-transform - source: | - from sailpoint.v2025.api.transforms_api import TransformsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.transform import Transform - from sailpoint.v2025.models.transform_read import TransformRead - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to update # str | ID of the transform to update - transform = '''{ - "name" : "Timestamp To Date", - "attributes" : "{}", - "type" : "dateFormat" - }''' # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) - try: - # Update a transform - - results = TransformsApi(api_client).update_transform(id=id) - # Below is a request that includes all optional parameters - # results = TransformsApi(api_client).update_transform(id, new_transform) - print("The response of TransformsApi->update_transform:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TransformsApi->update_transform: %s\n" % e) -- path: /trigger-invocations/{id}/complete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#complete-trigger-invocation - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CompleteInvocation = @" - { - "output" : { - "approved" : false - }, - "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "error" : "Access request is denied." - } - "@ - - # Complete Trigger Invocation - - try { - $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation - Complete-V2025TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result - - # Below is a request that includes all optional parameters - # Complete-V2025TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025TriggerInvocation" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#complete-trigger-invocation - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.complete_invocation import CompleteInvocation - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - complete_invocation = '''{ - "output" : { - "approved" : false - }, - "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "error" : "Access request is denied." - }''' # CompleteInvocation | - try: - # Complete Trigger Invocation - new_complete_invocation = CompleteInvocation.from_json(complete_invocation) - TriggersApi(api_client).complete_trigger_invocation(id=id, x_sail_point_experimental=x_sail_point_experimental, complete_invocation=new_complete_invocation) - # Below is a request that includes all optional parameters - # TriggersApi(api_client).complete_trigger_invocation(id, x_sail_point_experimental, new_complete_invocation) - except Exception as e: - print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) -- path: /trigger-subscriptions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#create-subscription - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SubscriptionPostRequest = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "triggerId" : "idn:access-requested", - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - } - "@ - - # Create a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest - New-V2025Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Subscription" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#create-subscription - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.subscription import Subscription - from sailpoint.v2025.models.subscription_post_request import SubscriptionPostRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - subscription_post_request = '''{ - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "triggerId" : "idn:access-requested", - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - }''' # SubscriptionPostRequest | - try: - # Create a Subscription - new_subscription_post_request = SubscriptionPostRequest.from_json(subscription_post_request) - results = TriggersApi(api_client).create_subscription(x_sail_point_experimental=x_sail_point_experimental, subscription_post_request=new_subscription_post_request) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).create_subscription(x_sail_point_experimental, new_subscription_post_request) - print("The response of TriggersApi->create_subscription:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->create_subscription: %s\n" % e) -- path: /trigger-subscriptions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-subscriptions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) - $Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) - - # List Subscriptions - - try { - Get-V2025Subscriptions -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Subscriptions -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Subscriptions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#list-subscriptions - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.subscription import Subscription - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"12cff757-c0c0-413b-8ad7-2a47956d1e89\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) - sorters = 'triggerName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) - try: - # List Subscriptions - - results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) -- path: /trigger-subscriptions/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#delete-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a Subscription - - try { - Remove-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Subscription" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#delete-subscription - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a Subscription - - TriggersApi(api_client).delete_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # TriggersApi(api_client).delete_subscription(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) -- path: /trigger-subscriptions/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#patch-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SubscriptionPatchRequestInner = @""@ - - - # Patch a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner - Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Subscription" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#patch-subscription - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.subscription import Subscription - from sailpoint.v2025.models.subscription_patch_request_inner import SubscriptionPatchRequestInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - subscription_patch_request_inner = '''[sailpoint.v2025.SubscriptionPatchRequestInner()]''' # List[SubscriptionPatchRequestInner] | - try: - # Patch a Subscription - new_subscription_patch_request_inner = SubscriptionPatchRequestInner.from_json(subscription_patch_request_inner) - results = TriggersApi(api_client).patch_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental, subscription_patch_request_inner=new_subscription_patch_request_inner) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).patch_subscription(id, x_sail_point_experimental, new_subscription_patch_request_inner) - print("The response of TriggersApi->patch_subscription:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) -- path: /trigger-subscriptions/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#update-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SubscriptionPutRequest = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - } - "@ - - # Update a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest - Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Subscription" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#update-subscription - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.subscription import Subscription - from sailpoint.v2025.models.subscription_put_request import SubscriptionPutRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - subscription_put_request = '''{ - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - }''' # SubscriptionPutRequest | - try: - # Update a Subscription - new_subscription_put_request = SubscriptionPutRequest.from_json(subscription_put_request) - results = TriggersApi(api_client).update_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental, subscription_put_request=new_subscription_put_request) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).update_subscription(id, x_sail_point_experimental, new_subscription_put_request) - print("The response of TriggersApi->update_subscription:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->update_subscription: %s\n" % e) -- path: /trigger-invocations/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-trigger-invocation-status - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "triggerId eq "idn:access-request-dynamic-approver"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) - - # List Latest Invocation Statuses - - try { - Get-V2025TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TriggerInvocationStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#list-trigger-invocation-status - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.invocation_status import InvocationStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'triggerId eq \"idn:access-request-dynamic-approver\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) - sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) - try: - # List Latest Invocation Statuses - - results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) -- path: /triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-triggers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "idn:access-request-post-approval"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) - - # List Triggers - - try { - Get-V2025Triggers -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Triggers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Triggers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#list-triggers - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.trigger import Trigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"idn:access-request-post-approval\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) - try: - # List Triggers - - results = TriggersApi(api_client).list_triggers(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->list_triggers: %s\n" % e) -- path: /trigger-invocations/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#start-test-trigger-invocation - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TestInvocation = @" - { - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - }, - "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], - "triggerId" : "idn:access-request-post-approval", - "contentJson" : { - "workflowId" : 1234 - } - } - "@ - - # Start a Test Invocation - - try { - $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation - Start-V2025TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result - - # Below is a request that includes all optional parameters - # Start-V2025TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025TestTriggerInvocation" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#start-test-trigger-invocation - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.invocation import Invocation - from sailpoint.v2025.models.test_invocation import TestInvocation - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - test_invocation = '''{ - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - }, - "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], - "triggerId" : "idn:access-request-post-approval", - "contentJson" : { - "workflowId" : 1234 - } - }''' # TestInvocation | - try: - # Start a Test Invocation - new_test_invocation = TestInvocation.from_json(test_invocation) - results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental=x_sail_point_experimental, test_invocation=new_test_invocation) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation) - print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) -- path: /trigger-subscriptions/validate-filter - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#test-subscription-filter - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ValidateFilterInputDto = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - } - } - "@ - - # Validate a Subscription Filter - - try { - $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto - Test-V2025SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result - - # Below is a request that includes all optional parameters - # Test-V2025SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SubscriptionFilter" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#test-subscription-filter - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.validate_filter_input_dto import ValidateFilterInputDto - from sailpoint.v2025.models.validate_filter_output_dto import ValidateFilterOutputDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - validate_filter_input_dto = '''{ - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - } - }''' # ValidateFilterInputDto | - try: - # Validate a Subscription Filter - new_validate_filter_input_dto = ValidateFilterInputDto.from_json(validate_filter_input_dto) - results = TriggersApi(api_client).test_subscription_filter(x_sail_point_experimental=x_sail_point_experimental, validate_filter_input_dto=new_validate_filter_input_dto) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).test_subscription_filter(x_sail_point_experimental, new_validate_filter_input_dto) - print("The response of TriggersApi->test_subscription_filter:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) -- path: /ui-metadata/tenant - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/ui-metadata#get-tenant-ui-metadata - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a tenant UI metadata - - try { - Get-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantUiMetadata" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/ui-metadata#get-tenant-ui-metadata - source: | - from sailpoint.v2025.api.ui_metadata_api import UIMetadataApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a tenant UI metadata - - results = UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental) - print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) -- path: /ui-metadata/tenant - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/ui-metadata#set-tenant-ui-metadata - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TenantUiMetadataItemUpdateRequest = @" - { - "usernameEmptyText" : "Please provide your work email address...", - "usernameLabel" : "Email", - "iframeWhiteList" : "http://example.com http://example2.com" - } - "@ - - # Update tenant UI metadata - - try { - $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest - Set-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result - - # Below is a request that includes all optional parameters - # Set-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TenantUiMetadata" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/ui-metadata#set-tenant-ui-metadata - source: | - from sailpoint.v2025.api.ui_metadata_api import UIMetadataApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse - from sailpoint.v2025.models.tenant_ui_metadata_item_update_request import TenantUiMetadataItemUpdateRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - tenant_ui_metadata_item_update_request = '''{ - "usernameEmptyText" : "Please provide your work email address...", - "usernameLabel" : "Email", - "iframeWhiteList" : "http://example.com http://example2.com" - }''' # TenantUiMetadataItemUpdateRequest | - try: - # Update tenant UI metadata - new_tenant_ui_metadata_item_update_request = TenantUiMetadataItemUpdateRequest.from_json(tenant_ui_metadata_item_update_request) - results = UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental=x_sail_point_experimental, tenant_ui_metadata_item_update_request=new_tenant_ui_metadata_item_update_request) - # Below is a request that includes all optional parameters - # results = UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental, new_tenant_ui_metadata_item_update_request) - print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) -- path: /vendor-connector-mappings - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#create-vendor-connector-mapping - source: | - $VendorConnectorMapping = @" - { - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - } - "@ - - # Create Vendor Connector Mapping - - try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-V2025VendorConnectorMapping -VendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # New-V2025VendorConnectorMapping -VendorConnectorMapping $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025VendorConnectorMapping" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/vendor-connector-mappings#create-vendor-connector-mapping - source: | - from sailpoint.v2025.api.vendor_connector_mappings_api import VendorConnectorMappingsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.vendor_connector_mapping import VendorConnectorMapping - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - vendor_connector_mapping = '''{ - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - }''' # VendorConnectorMapping | - try: - # Create Vendor Connector Mapping - new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping) - results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping) - # Below is a request that includes all optional parameters - # results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(new_vendor_connector_mapping) - print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) -- path: /vendor-connector-mappings - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#delete-vendor-connector-mapping - source: | - $VendorConnectorMapping = @" - { - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - } - "@ - - # Delete Vendor Connector Mapping - - try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-V2025VendorConnectorMapping -VendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # Remove-V2025VendorConnectorMapping -VendorConnectorMapping $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025VendorConnectorMapping" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/vendor-connector-mappings#delete-vendor-connector-mapping - source: | - from sailpoint.v2025.api.vendor_connector_mappings_api import VendorConnectorMappingsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response - from sailpoint.v2025.models.vendor_connector_mapping import VendorConnectorMapping - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - vendor_connector_mapping = '''{ - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - }''' # VendorConnectorMapping | - try: - # Delete Vendor Connector Mapping - new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping) - results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping) - # Below is a request that includes all optional parameters - # results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(new_vendor_connector_mapping) - print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) -- path: /vendor-connector-mappings - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#get-vendor-connector-mappings - source: | - - # List Vendor Connector Mappings - - try { - Get-V2025VendorConnectorMappings - - # Below is a request that includes all optional parameters - # Get-V2025VendorConnectorMappings - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025VendorConnectorMappings" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/vendor-connector-mappings#get-vendor-connector-mappings - source: | - from sailpoint.v2025.api.vendor_connector_mappings_api import VendorConnectorMappingsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.vendor_connector_mapping import VendorConnectorMapping - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Vendor Connector Mappings - - results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() - # Below is a request that includes all optional parameters - # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() - print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#approve-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Approve an Approval Item - - try { - Approve-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Approve-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025ApprovalItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#approve-approval-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Approve an Approval Item - - results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->approve_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#approve-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk approve Approval Items - - try { - Approve-V2025ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Approve-V2025ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#approve-approval-items-in-bulk - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk approve Approval Items - - results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) - print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#complete-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) - - # Complete a Work Item - - try { - Complete-V2025WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Complete-V2025WorkItem -Id $Id -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025WorkItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#complete-work-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) - try: - # Complete a Work Item - - results = WorkItemsApi(api_client).complete_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).complete_work_item(id, new_body) - print("The response of WorkItemsApi->complete_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-work-item - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - - # Get a Work Item - - try { - Get-V2025WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkItem -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-work-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. - try: - # Get a Work Item - - results = WorkItemsApi(api_client).get_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_item(id) - print("The response of WorkItemsApi->get_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#forward-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ - - # Forward a Work Item - - try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-V2025ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ForwardWorkItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#forward-work-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_item_forward import WorkItemForward - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - work_item_forward = '''{ - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - }''' # WorkItemForward | - try: - # Forward a Work Item - new_work_item_forward = WorkItemForward.from_json(work_item_forward) - WorkItemsApi(api_client).forward_work_item(id=id, x_sail_point_experimental=x_sail_point_experimental, work_item_forward=new_work_item_forward) - # Below is a request that includes all optional parameters - # WorkItemsApi(api_client).forward_work_item(id, x_sail_point_experimental, new_work_item_forward) - except Exception as e: - print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) -- path: /work-items/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Completed Work Items - - try { - Get-V2025CompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-V2025CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompletedWorkItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-completed-work-items - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Completed Work Items - - results = WorkItemsApi(api_client).get_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) - print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-count-completed-work-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - - # Count Completed Work Items - - try { - Get-V2025CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CountCompletedWorkItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-count-completed-work-items - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Completed Work Items - - results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental, owner_id) - print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) -- path: /work-items/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-count-work-items - source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - - # Count Work Items - - try { - Get-V2025CountWorkItems - - # Below is a request that includes all optional parameters - # Get-V2025CountWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CountWorkItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-count-work-items - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Work Items - - results = WorkItemsApi(api_client).get_count_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_work_items(owner_id) - print("The response of WorkItemsApi->get_count_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) -- path: /work-items/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-work-items-summary - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Work Items Summary - - try { - Get-V2025WorkItemsSummary - - # Below is a request that includes all optional parameters - # Get-V2025WorkItemsSummary -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItemsSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-work-items-summary - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items_summary import WorkItemsSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Work Items Summary - - results = WorkItemsApi(api_client).get_work_items_summary() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) - print("The response of WorkItemsApi->get_work_items_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) -- path: /work-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#list-work-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # List Work Items - - try { - Get-V2025WorkItems - - # Below is a request that includes all optional parameters - # Get-V2025WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#list-work-items - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # List Work Items - - results = WorkItemsApi(api_client).list_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) - print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#reject-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Reject an Approval Item - - try { - Deny-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Deny-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025ApprovalItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#reject-approval-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Reject an Approval Item - - results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->reject_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#reject-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk reject Approval Items - - try { - Deny-V2025ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Deny-V2025ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#reject-approval-items-in-bulk - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk reject Approval Items - - results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) - print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#submit-account-selection - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - - # Submit Account Selections - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-V2025AccountSelection -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Submit-V2025AccountSelection -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025AccountSelection" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#submit-account-selection - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName - try: - # Submit Account Selections - new_request_body = RequestBody.from_json(request_body) - results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) - print("The response of WorkItemsApi->submit_account_selection:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) -- path: /reassignment-configurations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#create-reassignment-configuration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - - # Create a Reassignment Configuration - - try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-V2025ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ReassignmentConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#create-reassignment-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.configuration_item_request import ConfigurationItemRequest - from sailpoint.v2025.models.configuration_item_response import ConfigurationItemResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - configuration_item_request = '''{ - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - }''' # ConfigurationItemRequest | - try: - # Create a Reassignment Configuration - new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) - results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental, new_configuration_item_request) - print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) -- path: /reassignment-configurations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#list-reassignment-configurations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Reassignment Configurations - - try { - Get-V2025ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfigurations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#list-reassignment-configurations - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.configuration_response import ConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List Reassignment Configurations - - results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) - print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) -- path: /reassignment-configurations/{identityId}/{configType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#delete-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Reassignment Configuration - - try { - Remove-V2025ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ReassignmentConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#delete-reassignment-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.config_type_enum import ConfigTypeEnum - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - config_type = sailpoint.v2025.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete Reassignment Configuration - - WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental) - except Exception as e: - print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) -- path: /reassignment-configurations/{identityId}/evaluate/{configType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-evaluate-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - - $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ - - # Evaluate Reassignment Configuration - - try { - Get-V2025EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EvaluateReassignmentConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-evaluate-reassignment-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.config_type_enum import ConfigTypeEnum - from sailpoint.v2025.models.evaluate_response import EvaluateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - config_type = sailpoint.v2025.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - exclusion_filters = '''['SELF_REVIEW_DELEGATION']''' # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - try: - # Evaluate Reassignment Configuration - - results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) - print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) -- path: /reassignment-configurations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-reassignment-config-types - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Reassignment Config Types - - try { - Get-V2025ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfigTypes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-reassignment-config-types - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.config_type import ConfigType - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List Reassignment Config Types - - results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) -- path: /reassignment-configurations/{identityId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Reassignment Configuration - - try { - Get-V2025ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-reassignment-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.configuration_response import ConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Reassignment Configuration - - results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id, x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) -- path: /reassignment-configurations/{identityId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#put-reassignment-config - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - - # Update Reassignment Configuration - - try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-V2025ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2025ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ReassignmentConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#put-reassignment-config - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.configuration_item_request import ConfigurationItemRequest - from sailpoint.v2025.models.configuration_item_response import ConfigurationItemResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - configuration_item_request = '''{ - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - }''' # ConfigurationItemRequest | - try: - # Update Reassignment Configuration - new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) - results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id, x_sail_point_experimental, new_configuration_item_request) - print("The response of WorkReassignmentApi->put_reassignment_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) -- path: /reassignment-configurations/tenant-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-tenant-config-configuration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Tenant-wide Reassignment Configuration settings - - try { - Get-V2025TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantConfigConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-tenant-config-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tenant_configuration_response import TenantConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Tenant-wide Reassignment Configuration settings - - results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) -- path: /reassignment-configurations/tenant-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#put-tenant-configuration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TenantConfigurationRequest = @" - { - "configDetails" : { - "disabled" : true - } - } - "@ - - # Update Tenant-wide Reassignment Configuration settings - - try { - $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-V2025TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2025TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TenantConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#put-tenant-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tenant_configuration_request import TenantConfigurationRequest - from sailpoint.v2025.models.tenant_configuration_response import TenantConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - tenant_configuration_request = '''{ - "configDetails" : { - "disabled" : true - } - }''' # TenantConfigurationRequest | - try: - # Update Tenant-wide Reassignment Configuration settings - new_tenant_configuration_request = TenantConfigurationRequest.from_json(tenant_configuration_request) - results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental=x_sail_point_experimental, tenant_configuration_request=new_tenant_configuration_request) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental, new_tenant_configuration_request) - print("The response of WorkReassignmentApi->put_tenant_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2025Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2025Workflows - - # Below is a request that includes all optional parameters - # Get-V2025Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2025WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2025Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2025Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.v2025.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2025WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2025WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-V2025CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-V2025WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2025WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-V2025WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v2025/v2025.yaml b/static/code-examples/v2025/v2025.yaml deleted file mode 100644 index d5cd03aaa..000000000 --- a/static/code-examples/v2025/v2025.yaml +++ /dev/null @@ -1,118489 +0,0 @@ -openapi: 3.0.1 -info: - title: Identity Security Cloud V2025 API - description: Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. - termsOfService: https://developer.sailpoint.com/discuss/tos - contact: - name: Developer Relations - url: https://developer.sailpoint.com/discuss/api-help - license: - name: MIT - url: https://opensource.org/licenses/MIT - version: v2025 -servers: - - url: https://{tenant}.api.identitynow.com/v2025 - description: This is the production API server. - variables: - tenant: - default: sailpoint - description: This is the name of your tenant, typically your company's name. - - url: https://{apiUrl}/v2025 - description: This is the V2025 API server. - variables: - apiUrl: - default: sailpoint.api.identitynow.com - description: This is the api url of your tenant -tags: - - name: Access Model Metadata - description: | - Use this API to create and manage metadata attributes for your Access Model. - Access Model Metadata allows you to add contextual information to your ISC Access Model items using pre-defined metadata for risk, regulations, privacy levels, etc., or by creating your own metadata attributes to reflect the unique needs of your organization. This release of the API includes support for entitlement metadata. Support for role and access profile metadata will be introduced in a subsequent release. - - Common usages for Access Model metadata include: - - - Organizing and categorizing access items to make it easier for your users to search for and find the access rights they want to request, certify, or manage. - - - Providing richer information about access that is being acted on to allow stakeholders to make better decisions when approving, certifying, or managing access rights. - - - Identifying access that may requires additional approval requirements or be subject to more frequent review. - - name: Access Profiles - description: | - Use this API to implement and customize access profile functionality. - With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely. - - Access profiles group entitlements, which represent access rights on sources. - - For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. - - An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. - - When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. - - When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. - - Identity Security Cloud uses access profiles in many features, including the following: - - - Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. - - - Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. - - - Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. - - - Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. - - In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. - Administrators can enable and disable an access profile, and they can also make the following configurations: - - - Manage Entitlements: Manage the profile's access by adding and removing entitlements. - - - Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. - Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. - - - Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source. - - Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. - - name: Access Request Approvals - description: | - Use this API to implement and customize access request approval functionality. - With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. - This enables more qualified users to review access requests and the others to spend their time on other tasks. - - In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. - For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. - For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. - If the administrator designates a governance group as the required approver, any governance group member can approve the requests. - - When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. - - In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. - If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request. - If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. - The required approver can then view any completed access requests under the Reviewed tab. - - Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. - - name: Access Request Identity Metrics - description: | - Use this API to implement access request identity metrics functionality. - With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity. - This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source. - This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions. - - name: Access Requests - description: | - Use this API to implement and customize access request functionality. - With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. - This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. - - Identity Security Cloud's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. - - In the Request Center in Identity Security Cloud, users can view available applications, roles, and entitlements and request access to them. - If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. - - Users can use My Requests to track and/or cancel the requests. - - In My Team on the Identity Security Cloud Home, managers can submit requests to revoke their team members' access. - They can use the My Requests tab under Request Center to track and/or cancel the requests. - - Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. - - name: Account Activities - description: | - Use this API to implement account activity tracking functionality. - With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system. - - An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. - In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. - - Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types: - - - Access Request: These include any access requests the source account is involved in. - - - Account Attribute Updates: These include updates to a single attribute on an account on a source. - - - Account State Update: These include locking or unlocking actions on an account on a source. - - - Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. - - - Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. - Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. - - - Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. - When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. - Account Activity does not include attribute updates that occur as a result of aggregation. - - - Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. - These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. - - - Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. - - - Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. - - - Password Change: These include password changes on sources. - - Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. - - name: Account Aggregations - description: | - Use this API to implement account aggregation progress tracking functionality. - With this functionality in place, administrators can view in-progress account aggregations, their statuses, and their relevant details. - - An account aggregation refers to the process Identity Security Cloud uses to gather and load account data from a source into Identity Security Cloud. - - Whenever Identity Security Cloud is in the process of aggregating a source, it adds an entry to the Aggregation Activity Log, along with its relevant details. - To view aggregation activity, administrators can select the Connections drop-down menu, select Sources, and select the relevant source, select its Import Data tab, and select Account Aggregation. - In Account Aggregation, administrators can view the account aggregations' statuses and details in the Account Activity Log. - - Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about account aggregations. - - name: Account Usages - description: | - Use this API to implement account usage insight functionality. - With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. - This allows organizations to get the information they need to start optimizing and securing source account usage. - - name: Accounts - description: | - Use this API to implement and customize account functionality. - With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud. - - In Identity Security Cloud, an account refers to a user's account on a supported source. - This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud. - - Administrators can correlate users' identities with the users' accounts on the different sources they use. - This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively. - - To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. - - To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. - Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. - - Accounts can have the following statuses: - - - Enabled: The account is enabled. The user can access it. - - - Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes. - - - Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. - - - Pending: The account is currently updating. This status typically lasts seconds. - - Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. - - Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. - - name: Application Discovery - description: | - Use this API to implement application discovery functionality. - With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names. - - name: Approvals - description: | - Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them. - - The main advantages this API has vs [Access Request Approvals](https://developer.sailpoint.com/docs/api/v2025/access-request-approvals) are that you can use it to get generic approvals individually or in batches and make changes to those approvals. - - name: Apps - description: | - Use this API to implement source application functionality. - With this functionality in place, you can create, customize, and manage applications within sources. - - name: Auth Profile - description: | - Use this API to implement Auth Profile functionality. - With this functionality in place, users can read authentication profiles and make changes to them. - - An authentication profile represents an identity profile's authentication configuration. - When the identity profile is created, its authentication profile is also created. - An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies. - - name: Auth Users - description: | - Use this API to implement user authentication system functionality. - With this functionality in place, users can get a user's authentication system details, including their capabilities, and modify those capabilities. - The user's capabilities refer to their access to different systems, or authorization, within the tenant, like access to certifications (CERT_ADMIN) or reports (REPORT_ADMIN). - These capabilities also determine a user's access to the different APIs. - This API provides users with a way to determine a user's access and make quick and easy changes to that access. - - name: Branding - description: | - Use this API to implement and customize branding functionality. - With this functionality in place, administrators can get and manage existing branding items, and they can also create new branding items and configure them for use throughout Identity Security Cloud. - The Branding APIs provide administrators with a way to customize branding items. - This customization includes details like their colors, logos, and other information. - Refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) for more information about certifications. - - name: Certification Campaign Filters - description: | - Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify. - - For example, if for a certification campaign an organization wants to certify only specific users or entitlements, then those can be included/excluded on the basis of campaign filters. - - For more information about creating a campaign filter, refer to [Creating a Campaign Filter](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#creating-a-campaign-filter) - - You can create campaign filters using any of the following criteria types: - - - Access Profile : This criteria type includes or excludes access profiles from a campaign. - - - Account Attribute : This criteria type includes or excludes certification items that match a specified value in an account attribute. - - - Entitlement : This criteria type includes or excludes entitlements from a campaign. - - - Identity : This criteria type includes or excludes specific identities from your campaign. - - - Identity Attribute : This criteria type includes or excludes identities based on whether they have an identity attribute that matches criteria you've chosen. - - - Role : This criteria type includes or excludes roles, as opposed to identities. - - - Source : This criteria type includes or excludes entitlements from a source you select. - - For more information about these criteria types, refer to [Types of Campaign Filters](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#types-of-campaign-filters) - - Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter. - - For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification. - - name: Certification Campaigns - description: | - Use this API to implement certification campaign functionality. - With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. - Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. - Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. - - A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. - These certifications serve as a way of showing that a user's access has been reviewed and approved. - Multiple certifications by different reviewers are often required to approve a user's access. - A set of multiple certifications is called a certification campaign. - - For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. - Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. - - Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: - - You can create these types of campaigns without using any search queries in Identity Security Cloud: - - - ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. - You only need to provide a name and description to create one. - - - Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. - You only need to provide a name and description to create one. - You can specify the sources whose owners you want involved or just run it across all sources. - - For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). - - One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. - This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. - For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. - - You can use Identity Security Cloud search queries to create these types of campaigns: - - - Identities: Use this campaign type to review and revoke access items for specific identities. - You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. - - - Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. - You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. - - - Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. - You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. - - - Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. - You can use this campaign type to view all the uncorrelated accounts for a source and certify them. - - For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). - - Once you have generated your campaign, it becomes available for preview. - An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. - - Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. - Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). - - When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. - Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. - - Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. - Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. - - Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. - In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. - In this situation, the certification campaign completes once all the remediation requests are completed. - - The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. - - For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). - - name: Certification Summaries - description: | - Use this API to implement certification summary functionality. - With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness. - Implementing certification summary functionality improves organizations' ability to review their [certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes. - - A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. - These certifications serve as a way of showing that a user's access has been reviewed and approved. - Multiple certifications by different reviewers are often required to approve a user's access. - A set of multiple certifications is called a certification campaign. - - For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. - Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. - - Certification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed. - For example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected. - - name: Certifications - description: | - Use this API to implement certification functionality. - With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. - Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. - - A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. - These serve as a way of showing that a user's access has been reviewed and approved. - Multiple certifications by different reviewers are often required to approve a user's access. - A set of multiple certifications is called a certification campaign. - - For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. - Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. - - Organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. - Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. - - When a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. - Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. - - Once a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process. - Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. - - Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. - In this situation, the certification campaign completes once all the remediation requests are completed. - - name: Configuration Hub - description: | - Use this API to implement and customize configuration settings management. With this functionality, you can access the Configuration Hub actions and build your own automated pipeline for Identity Security Cloud configuration change delivery and deployment. - - Common usages for Configuration Hub includes: - - - Upload configuration file - Configuration files can be managed and deployed using Configuration Hub by uploading a JSON file which contains configuration data. - - Manage object mapping - Create rules to map and substitute attributes when migrating configurations. - - Manage backups for configuration settings - - Manage configuration drafts - - Upload configurations and manage object mappings between tenants. - - Refer to [Using the SailPoint Configuration Hub](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html) for more information about Configuration Hub. - - name: Connector Customizers - description: | - Saas Connectivity Customizers are cloud-based connector customizers. The customizers allow you to customize the out of the box connectors in a similar way to how you can use rules to customize VA (virtual appliance) based connectors. - - Use these APIs to implement connector customizers functionality. - - name: Connector Rule Management - description: | - Use this API to implement connector rule management functionality. - With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way. - - In Identity Security Cloud (ISC), [rules](https://developer.sailpoint.com/docs/extensibility/rules) serve as a flexible configuration framework you can leverage to perform complex or advanced configurations. - [Connector-executed rules](https://developer.sailpoint.com/docs/extensibility/rules/connector-rules) are rules that are executed in the ISC virtual appliance (VA), usually extensions of the [connector](https://documentation.sailpoint.com/connectors/isc/landingpages/help/landingpages/isc_landing.html) itself, the bridge between the data source and ISC. - - This API allows administrators to view existing connector-executed rules, make changes to them, delete them, and create new ones from the available types. - - name: Connectors - description: | - Use this API to implement connector functionality. - With this functionality in place, administrators can view available connectors. - - Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources. - For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems. - This ensures account entitlements and states are correct throughout the organization. - - In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. - - Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud. - - Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. - - Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud. - - name: Custom Forms - description: | - Use this API to build and manage custom forms. - With this functionality in place, administrators can create and view form definitions and form instances. - - Forms are composed of sections and fields. Sections split the form into logical groups of fields and fields are the data collection points within the form. Configure conditions to modify elements of the form as the responder provides input. Create form inputs to pass information from a calling feature, like a workflow, to your form. - - Forms can be used within workflows as an action or as a trigger. The Form Action allows you to assign a form as a step in a running workflow, suspending the workflow until the form is submitted or times out, and the workflow resumes. The Form Submitted Trigger initiates a workflow when a form is submitted. The trigger can be configured to initiate on submission of a full form, a form element with any value, or a form element with a particular value. - - Refer to [Forms](https://documentation.sailpoint.com/saas/help/forms/index.html) for more information about using forms in Identity Security Cloud. - - name: Custom Password Instructions - description: | - Use this API to implement custom password instruction functionality. - With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames. - This allows administrators to emphasize password policies or provide organization-specific instructions. - - Administrators must first use [Update Password Org Config](https://developer.sailpoint.com/docs/api/v2025/put-password-org-config/) to set `customInstructionsEnabled` to `true`. - - Once they have enabled custom instructions, they can use [Create Custom Password Instructions](https://developer.sailpoint.com/docs/api/v2025/create-custom-password-instructions/) to create custom page content for the specific pageId they select. - - For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails. - - Refer to [Creating Custom Instruction Text](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html#creating-custom-instruction-text) for more information about creating custom password instructions. - - name: Data Segmentation - description: | - This service is responsible for creating segments that will determine how access is delegated to identities - withing the organization. - - name: Dimensions - description: |- - Use this API to implement and customize dynamic role functionality. With this functionality in place, administrators can create dimensions and configure them for use throughout Identity Security Cloud. Identity Security Cloud can use established criteria to automatically assign the dimensions to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. Entitlements represent the most granular level of access in Identity Security Cloud. - Access profiles represent the next level and often group entitlements. Dimension represent access selectively based on the evaluation of contextual information that is available or provided. Each Dimension include context attributes and access selection expressions which map criteria to access right assignments. Each dimension can contain up to 5 context attributes. Dynamic Access Roles represent the broadest level of access and often group access profiles ,entitlements and dimensions.Each Dynamic Access Role may contain one or more Dimensions. - - name: Discovered Applications - description: | - Use this API to retrieve all the available discovered apps for a given tenant id. - - name: Entitlements - description: | - Use this API to implement and customize entitlement functionality. - With this functionality in place, administrators can view entitlements and configure them for use throughout Identity Security Cloud in certifications, access profiles, and roles. - Administrators in Identity Security Cloud can then grant users access to the entitlements or configure them so users themselves can request access to the entitlements whenever they need them. - With a good approval process, this entitlement functionality allows users to gain the specific access they need on sources quickly and securely. - - Entitlements represent access rights on sources. - Entitlements are the most granular form of access in Identity Security Cloud. - Entitlements are often grouped into access profiles, and access profiles themselves are often grouped into roles, the broadest form of access in Identity Security Cloud. - - For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. - - An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. - - An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. - - When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. - - When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. - - When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. - - Administrators often use roles and access profiles within those roles to manage access so that users can gain access more quickly, but the hierarchy of access all starts with entitlements. - - Anywhere entitlements appear, you can select them to find more information about the following: - - - Cloud Access Details: These provide details about the cloud access entitlements on cloud-enabled sources. - - - Permissions: Permissions represent individual units of read/write/admin access to a system. - - - Relationships: These list each entitlement's parent and child relationships. - - - Type: This is the entitlement's type. Some sources support multiple types, each with a different attribute schema. - - Identity Security Cloud uses entitlements in many features, including the following: - - - Certifications: Entitlements can be revoked from an identity that no longer needs them. - - - Roles: Roles can group access profiles which themselves group entitlements. You can grant and revoke access on a broad level with roles. Role membership criteria can grant roles to identities based on whether they have certain entitlements or attributes. - - - Access Profiles: Access profiles group entitlements. - They are the most important units of access in Identity Security Cloud. - Identity Security Cloud uses them in provisioning, certifications, and access requests, and administrators can configure them to grant very broad or very granular access. - - You cannot delete entitlements directly from Identity Security Cloud. - Entitlements are deleted based on their inclusion in aggregations. - - Refer to [Deleting Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html#deleting-entitlements) more information about deleting entitlements. - - Refer to [Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html) for more information about entitlements. - - name: Global Tenant Security Settings - description: | - Use this API to implement and customize global tenant security settings. - With this functionality in place, administrators can manage the global security settings that a tenant/org has. - This API can be used to configure the networks and Geographies allowed to access Identity Security Cloud URLs. - - name: Governance Groups - description: | - Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout Identity Security Cloud. - - A governance group is a group of users that can make governance decisions about access. If your organization has the Access Request or Certifications service, you can configure governance groups to review access requests or certifications. A governance group can determine whether specific access is appropriate for a user. - - Refer to [Creating and Managing Governance Groups](https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html) for more information about how to build Governance Groups in the visual builder in the Identity Security Cloud UI. - - name: IAI Access Request Recommendations - - name: IAI Common Access - - name: IAI Message Catalogs - - name: IAI Outliers - - name: IAI Peer Group Strategies - - name: IAI Recommendations - - name: IAI Role Mining - - name: Icons - description: | - Use this API to implement functionality related to object icons (application icons for example). - With this functionality in place, administrators can set or remove an icon for specific object type for use throughout Identity Security Cloud. - - name: Identities - description: | - Use this API to implement identity functionality. - With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes. - - Identity Security Cloud uses identities as users' authoritative accounts. Identities can own other accounts, entitlements, and attributes. - - An identity has a variety of attributes, such as an account name, an email address, a job title, and more. - These identity attributes can be correlated with different attributes on different sources. - For example, the identity John.Smith can own an account in the GitHub source with the account name John-Smith-Org, and Identity Security Cloud knows they are the same person with the same access and attributes. - - In Identity Security Cloud, administrators often set up these synchronizations to get triggered automatically with a change or to run on a schedule. - To manually synchronize attributes for an identity, administrators can use the Identities drop-down menu and select Identity List to view the list of identities. - They can then select the identity they want to manually synchronize and use the hamburger menu to select 'Synchronize Attributes.' - Doing so immediately begins the attribute synchronization and analyzes all accounts for the selected identity. - - Refer to [Synchronizing Attributes](https://documentation.sailpoint.com/saas/help/provisioning/attr_sync.html) for more information about synchronizing attributes. - - name: Identity Attributes - - name: Identity History - - name: Identity Profiles - description: | - Use this API to implement identity profile functionality. - With this functionality in place, administrators can view identity profiles and their configurations. - - Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. - - In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. - This list shows some details about each identity profile, along with its status. - They can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. - - Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. - - name: Lifecycle States - description: | - Use this API to implement and customize lifecycle state functionality. - With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. - - A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' - When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. - The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. - This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. - - Administrators can create a variety of custom lifecycle states. Refer to [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas. - - Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state. - - In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. - - In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: - - - Enable/disable the lifecycle state for the identity profile. - - - Enable/disable source accounts for the identity profile's lifecycle state. - - - Add existing access profiles to grant to the identity profiles in that lifecycle state. - - - Create a new access profile to grant to the identity profile in that lifecycle state. - - Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. - To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. - For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. - - During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. - If the identities are missing access, Identity Security Cloud provisions that access. - - Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. - Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. - - An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' - Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. - - Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. - - name: Machine Accounts - - name: Machine Identities - - name: Managed Clients - description: | - Use this API to implement managed client functionality. - With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. - - name: Managed Cluster Types - description: | - Use this API to implement managed cluster types functionality. - With this functionality in place, administrators can modify and delete existing managed cluster types and create new ones. - - name: Managed Clusters - description: | - Use this API to implement managed cluster functionality. - With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. - - name: Manual Discover Applications - description: | - Use this API to manually upload application names to be correlated to an ISC connector. - - name: Manual Discover Applications Template - description: | - Use this API to download the CSV template to send to the application discovery service. - - name: MFA Configuration - description: Configure and test multifactor authentication (MFA) methods - - name: MFA Controller - description: This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method - - name: Multi-Host Integration - description: | - Use this API to build a Multi-Host Integration. - Multi-Host Integration will help customers to configure and manage similar type of target system in Identity Security Cloud. - In Identity Security Cloud, administrators can create a Multi-Host Integration by going to Admin > Connections > Multi-Host Sources and selecting 'Create.' - - name: Non-Employee Lifecycle Management - description: | - Use this API to implement non-employee lifecycle management functionality. - With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. - This allows organizations to provide secure access to non-employees and control that access. - - The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. - Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. - Organizations can have a maximum of 50 non-employee sources. - - By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: - - - SailPoint is not responsible for storing sensitive data. - You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud. - - - You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. - - To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source. - - To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. - They must then specify 'Non-Employee' in the 'Source Type' field. - Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. - - To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. - They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. - - Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. - To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. - Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. - - Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. - - Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. - - name: Notifications - - name: OAuth Clients - description: | - Use this API to implement OAuth client functionality. - With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API. - Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API. - - name: Org Config - description: | - Use this API to implement organization configuration functionality. - Administrators can use this functionality to manage organization settings, such as time zones. - - name: Password Configuration - description: | - Use this API to implement organization password configuration functionality. - With this functionality in place, organization administrators can create organization-specific password configurations. - - These configurations include details like custom password instructions, as well as digit token length and duration. - - Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. - - name: Password Dictionary - description: | - Use this API to implement password dictionary functionality. - With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. - - A password dictionary is a list of words or characters that users are prevented from including in their passwords. - This can help protect users from themselves and force them to create passwords that are not easy to break. - - A password dictionary must meet the following requirements to for the API to handle them correctly: - - - It must be in .txt format. - - - All characters must be UTF-8 characters. - - - Each line must contain a single word or character with no spaces or whitespace characters. - - - It must contain at least one line other than the locale string. - - - Each line must not exceed 128 characters. - - - The file must not exceed 2500 lines. - - Administrators should also consider the following when they create their dictionaries: - - - Lines starting with a # represent comments. - - - All words in the password dictionary are case-insensitive. - For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. - - - The dictionary uses substring matching. - For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. - Users can then select 'Change Password' to update their passwords. - - Administrators must do the following to create a password dictionary: - - - Create the text file that will contain the prohibited password values. - - - If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` - - The languageCode value refers to the language's 2-letter ISO 639-1 code. - The countryCode value refers to the country's 2-letter ISO 3166-1 code. - - Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. - - - Upload the .txt file to Identity Security Cloud with [Update Password Dictionary](https://developer.sailpoint.com/docs/api/v2025/put-password-dictionary). Uploading a new file always overwrites the previous dictionary file. - - Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. - - Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. - - name: Password Management - description: | - Use this API to implement password management functionality. - With this functionality in place, users can manage their identity passwords for all their applications. - - In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. - Password Manager lists the user's identity's applications, possibly grouped to share passwords. - Users can then select 'Change Password' to update their passwords. - - Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. - Password Manager may list the applications and sources in the following groups: - - - Password Group: This refers to a group of applications that share a password. - For example, a user can use the same password for Google Drive, Google Mail, and YouTube. - Updating the password for the password group updates the password for all its included applications. - - - Multi-Application Source: This refers to a source with multiple applications that share a password. - For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. - Updating the password for the multi-application source updates the password for all its included applications. - - - Applications: These are applications that do not share passwords with other applications. - - An organization may require some authentication for users to update their passwords. - Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. - - Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. - - name: Password Policies - description: | - Use these APIs to implement password policies functionality. - These APIs allow you to define the policy parameters for choosing passwords. - - IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns. - If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org. - - In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups. - Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies. - - name: Password Sync Groups - description: | - Use this API to implement password sync group functionality. - With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. - This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. - - A password sync group is a group of applications that shares a password. - Administrators create these groups by grouping the applications' sources. - For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. - A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. - - The following are required for administrators to create a password sync group in Identity Security Cloud: - - - At least two direct connect sources connected to Identity Security Cloud and configured for Password Management. - - - Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. - - - At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. - - In the Admin panel in Identity Security Cloud, administrators can use the Password Mgmt dropdown menu to select Sync Groups. - To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. - - Administrators can also delete sync groups in Identity Security Cloud, but they should know the following before they do: - - - Passwords related to the associated sources will become independent, so changing one will not change the others anymore. - - - Passwords for the sources' connected applications will also become independent. - - - Password policies assigned to the sync group are then assigned directly to the associated sources. - To change the password policy for a source, administrators must edit it directly. - - Once the password sync group has been created, users can update the password for the group in Password Manager. - - Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. - - name: Personal Access Tokens - description: | - Use this API to implement personal access token (PAT) functionality. - With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud. - - PATs embed user information into the client ID and secret. - This replaces the API clients' need to store and provide a username and password to establish a connection, improving Identity Security Cloud organizations' integration security. - - In Identity Security Cloud, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. - They must then provide a description about the token's purpose. - They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. - - Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs. - - name: Public Identities - description: | - Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/v2025/public-identities-config/) to enable non-administrators to view identities' publicly visible attributes. - With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. - This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. - - name: Public Identities Config - description: | - Use this API to implement public identity configuration functionality. - With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. - This can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. - - By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. - However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. - Administrators can use this API to make those necessary identity attributes public to non-administrators. - - For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. - If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/v2025/update-public-identity-config/) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. - - name: Reports Data Extraction - description: | - Use this API to implement reports lifecycle managing and monitoring. - With this functionality in place, users can run reports, view their results, and cancel reports in progress. - This can be potentially helpful for auditing purposes. - - name: Requestable Objects - description: | - Use this API to implement requestable object functionality. - With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/v2025/access-requests/), along with their statuses. - This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. - - name: Role Insights - - name: Roles - description: | - Use this API to implement and customize role functionality. - With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud. - Identity Security Cloud can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. - - Entitlements represent the most granular level of access in Identity Security Cloud. - Access profiles represent the next level and often group entitlements. - Roles represent the broadest level of access and often group access profiles. - - For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. - - An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. - - An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. - - When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. - - When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. - - When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. - - Roles often represent positions within organizations. - For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. - If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. - - In Identity Security Cloud, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. - Administrators can enable and disable the role, and they can also make the following configurations: - - - Manage Access: Manage the role's access by adding or removing access profiles. - - - Define Assignment: Define the criteria Identity Security Cloud uses to assign the role to identities. - Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. - Use the second, 'Identity List,' to specify the identities for assignment. - - - Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. - Do not configure a role to be requestable without establishing a secure access request approval process for that role first. - - Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/access/roles.html) for more information about roles. - - name: Saved Search - description: | - Use this API to implement saved search functionality. - With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them. - - Search queries in Identity Security Cloud can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries. - It also opens the possibility to configure Identity Security Cloud to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources. - Refer to [Scheduled Search](https://developer.sailpoint.com/docs/api/v2025/scheduled-search/) for more information about running saved searches on a schedule. - - In Identity Security Cloud, users can save searches under a name, and then they can access that saved search and run it again when they want. - - Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. - - name: Scheduled Search - description: | - Use this API to implement scheduled search functionality. - With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and Identity Security Cloud emails them the search results. - Users can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves. - - One of the greatest benefits of saving searches is the ability to run those searches on a schedule. - This is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources. - For example, the manager Amanda Ross can schedule a saved search "manager.name:amanda.ross AND attributes.location:austin" on a schedule to regularly stay aware of changes with the Austin employees reporting to her. - Identity Security Cloud emails her the search results when the search runs, so she can work on other tasks instead of actively running this search. - - In Identity Security Cloud, scheduling a search involves a subscription. - Users can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time). - The user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails. - - By default, subscriptions exclude detailed results from the emails, for security purposes. - Including detailed results about user access in an email may expose sensitive information. - However, the subscription creator can choose to include the information in the emails. - - By default, Identity Security Cloud sends emails to the subscribers even when the searches do not return new results. - However, the subscription creator can choose to suppress these empty emails. - - Users can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run. - A saved search can have up to 10 subscriptions configured at a time. - - The subscription creator can enable, disable, or delete the subscription. - - Refer to [Subscribing to Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html#subscribing-to-saved-searches) for more information about scheduling searches and subscribing to them. - - name: Search - description: | - Use this API to implement search functionality. - With search functionality in place, users can search their tenants for nearly any information from throughout their organizations. - - Identity Security Cloud enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. - Its search goes through all those sources and finds the results quickly and specifically. - - The search query is flexible - it can be very broad or very narrow. - The search only returns results for searchable objects it is filtering for. - The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. - By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." - - Users can further narrow their results by using Identity Security Cloud's specific syntax and punctuation to structure their queries. - For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. - Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. - - Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about Identity Security Cloud's search and its different possibilities. - - The search feature uses Elasticsearch as a datastore and query engine. - The power of Elasticsearch makes this feature suitable for ad-hoc reporting. - However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. - This ingestion process introduces a latency from when the operational data is created to when it is available in search. - Depending on the system load, this can take a few seconds to a few minutes. - Please keep this latency in mind when you use search. - - name: Search Attribute Configuration - description: | - Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v2025/search). - With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want. - - Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. - Its search goes through all those sources and finds the results quickly and specifically. - - The search query is flexible - it can be very broad or very narrow. - The search only returns results for searchable objects it is filtering for. - The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. - By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." - - Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries. - For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. - Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. - - Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about ISC's search and its different possibilities. - - With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search. - - name: Segments - description: | - Use this API to implement and customize access request segment functionality. - With this functionality in place, administrators can create and manage access request segments. - Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. - - Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. - For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. - The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. - - In Identity Security Cloud, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. - This page lists all the existing access request segments, along with their statuses, enabled or disabled. - Administrators can use this page to create, edit, enable, disable, and delete segments. - To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. - These items can be access profiles, roles, or entitlements. - - When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. - - Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in Identity Security Cloud. - - name: Service Desk Integration - description: | - Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution. - Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk. - - In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' - - To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. - Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in Identity Security Cloud. - - Administrators can create various service desk integrations, all with their own nuances. - The following service desk integrations are available: - - - [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) - - - [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) - - - [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) - - - [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) - - - [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) - - - [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) - - - [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) - - name: SIM Integrations - description: | - Use this API to administer IdentityNow's Service Integration Module, or SIM integration with ServiceNow, so that it converts IdentityNow provisioning actions into tickets in ServiceNow. - - ServiceNow is a software platform that supports IT service management and automates common business processes for requesting and fulfilling service requests across a business enterprise. - - You must have an IdentityNow ServiceNow ServiceDesk license to use this integration. Contact your Customer Success Manager for more information. - - Service Desk integration for IdentityNow and in deprecation - not available for new implementation, as of July 21st, 2021. As per SailPoint’s [support policy](https://community.sailpoint.com/t5/Connector-Directory/SailPoint-Support-Policy-for-Connectivity/ta-p/79422), all existing SailPoint IdentityNow customers using this legacy integration will be supported until July 2022. - - name: SOD Policies - description: | - Use this API to implement and manage "separation of duties" (SOD) policies. - With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. - - "Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. - For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. - Any changes to major system configurations should be approved by someone other than the person requesting the change. - - Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. - These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. - - To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'. - To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. - They can search for the entitlements they want to add to these access lists. - - >Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. - - Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. - These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. - The other users can then better help to enforce these SOD policies. - - To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'. - They can create a subscription to the policy and schedule it to run at a regular interval. - - Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. - - Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. - - name: SOD Violations - description: | - Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. - With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. - - "Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. - For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. - Any changes to major system configurations should be approved by someone other than the person requesting the change. - - Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. - These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. - - Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. - These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. - The other users can then better help to enforce these SOD policies. - - Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. - This second option is a good way to prevent SOD violations from triggering at all. - - Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. - - name: Source Usages - description: | - Use this API to implement source usage insight functionality. - With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. - This allows organizations to get the information they need to start optimizing and securing source usage. - - name: Sources - description: | - Use this API to implement and customize source functionality. - With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. - - [Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. - Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. - Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. - Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. - If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. - If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. - These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. - - In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. - They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. - Admins go to Connections > Sources to see a list of the existing source representations in their organizations. - They can create new sources or select existing ones. - - To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. - Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. - - Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. - Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. - SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. - Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. - Refer to the following links for more information about two useful connectors: - - - [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). - - - [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. - - Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. - - When admins select existing sources, they can view the following information about the source: - - - Associated connections (any associated identity profiles, apps, or references to the source in a transform). - - - Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. - - - Associated entitlements (sets of access rights on sources). - - - Associated access profiles (groupings of entitlements). - - The user account data and the entitlements update with each data aggregation from the source. - Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. - Admins can view a history of these aggregations, and they can also run manual imports. - Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. - - Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. - To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. - Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. - To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. - Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. - - Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. - Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. - - Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. - Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. - - name: SP-Config - description: Import and export configuration for some objects between tenants. - - name: Suggested Entitlement Description - description: | - Use this API to implement Suggested Entitlement Description (SED) functionality. - SED functionality leverages the power of LLM to generate suggested entitlement descriptions. - Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC). - - name: Tagged Objects - description: | - Use this API to implement object tagging functionality. - With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud. - - In Identity Security Cloud, users can search their tenants for information and add tags objects they find. - Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. - - For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. - Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. - The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. - When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. - - With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). - You can use the API to tag all these objects: - - - Access profiles - - - Applications - - - Certification campaigns - - - Entitlements - - - Identities - - - Roles - - - SOD (separation of duties) policies - - - Sources - - You can also use the API to directly find, create, and manage tagged objects without using search queries. - - There are limits to tags: - - - You can have up to 500 different tags in your tenant. - - - You can apply up to 30 tags to one object. - - - You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. - - Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud. - - These are the types of information often expressed in tags: - - - Affected departments - - - Compliance and regulatory categories - - - Remediation urgency levels - - - Risk levels - - Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud. - - name: Task Management - - name: Tenant - description: API for reading tenant details. - - name: Tenant Context - description: | - The purpose of this API is to manage key-value pairs specific to a tenant's context, enabling dynamic configuration and personalized settings per tenant. - Context key-value pairs will consist of common terms and acronyms used within your organization. - - name: Transforms - description: | - The purpose of this API is to expose functionality for the manipulation of Transform objects. - Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having - to write code. - - Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms. - - name: Triggers - description: | - Event Triggers provide real-time updates to changes in Identity Security Cloud so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. Identity Security Cloud provides a user interface within the admin console to create and manage trigger subscriptions. These endpoints allow for programatically creating and managing trigger subscriptions. - - There are two types of event triggers: - * `FIRE_AND_FORGET`: This trigger type will send a payload to each subscriber without needing a response. Each trigger of this type has a limit of **50 subscriptions**. - * `REQUEST_RESPONSE`: This trigger type will send a payload to a subscriber and expect a response back. Each trigger of this type may only have **one subscription**. - - ## Available Event Triggers - Production ready event triggers that are available in all tenants. - - | Name | ID | Type | Trigger condition | - |-|-|-|-| - | [Access Request Dynamic Approval](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval/) | idn:access-request-dynamic-approver | REQUEST_RESPONSE |After an access request is submitted. Expects the subscriber to respond with the ID of an identity or workgroup to add to the approval workflow. | - | [Access Request Decision](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-decision/) | idn:access-request-post-approval | FIRE_AND_FORGET | After an access request is approved. | - | [Access Request Submitted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-submitted/) | idn:access-request-pre-approval | REQUEST_RESPONSE | After an access request is submitted. Expects the subscriber to respond with an approval decision. | - | [Account Aggregation Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:account-aggregation-completed | FIRE_AND_FORGET | After an account aggregation completed, terminated, failed. | - | Account Attributes Changed | idn:account-attributes-changed | FIRE_AND_FORGET | After an account aggregation, and one or more account attributes have changed. | - | Account Correlated | idn:account-correlated | FIRE_AND_FORGET | After an account is added to an identity. | - | Accounts Collected for Aggregation | idn:aggregation-accounts-collected | FIRE_AND_FORGET | New, changed, and deleted accounts have been gathered during an aggregation and are being processed. | - | Account Uncorrelated | idn:account-uncorrelated | FIRE_AND_FORGET | After an account is removed from an identity. | - | Campaign Activated | idn:campaign-activated | FIRE_AND_FORGET | After a campaign is activated. | - | Campaign Ended | idn:campaign-ended | FIRE_AND_FORGET | After a campaign ends. | - | Campaign Generated | idn:campaign-generated | FIRE_AND_FORGET | After a campaign finishes generating. | - | Certification Signed Off | idn:certification-signed-off | FIRE_AND_FORGET | After a certification is signed off by its reviewer. | - | [Identity Attributes Changed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:identity-attributes-changed | FIRE_AND_FORGET | After One or more identity attributes changed. | - | [Identity Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-created/) | idn:identity-created | FIRE_AND_FORGET | After an identity is created. | - | [Provisioning Action Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) | idn:post-provisioning | FIRE_AND_FORGET | After a provisioning action completed on a source. | - | [Scheduled Search](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/scheduled-search/) | idn:saved-search-complete | FIRE_AND_FORGET | After a scheduled search completed. | - | [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-created/) | idn:source-created | FIRE_AND_FORGET | After a source is created. | - | [Source Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-deleted/) | idn:source-deleted | FIRE_AND_FORGET | After a source is deleted. | - | [Source Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-updated/) | idn:source-updated | FIRE_AND_FORGET | After configuration changes have been made to a source. | - | [VA Cluster Status Change](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/va-cluster-status-change/) | idn:va-cluster-status-change | FIRE_AND_FORGET | After the status of a VA cluster has changed. | - - ## Early Access Event Triggers - Triggers that are in-development and not ready for production use. Please contact support to enable these triggers in your tenant. - - | Name | ID | Type | Trigger condition | - |-|-|-|-| - | [Identity Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-deleted/) | idn:identity-deleted | FIRE_AND_FORGET | After an identity is deleted. | - | [Source Account Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-created/) | idn:source-account-created | FIRE_AND_FORGET | After a source account is created. | - | [Source Account Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-deleted/) | idn:source-account-deleted | FIRE_AND_FORGET | After a source account is deleted. | - | [Source Account Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-updated/) | idn:source-account-updated | FIRE_AND_FORGET | After a source account is changed. | - - name: UI Metadata - description: |- - API for managing UI Metadata. Use this API to manage metadata about your User Interface. - For example you can set the iFrameWhitelist parameter to permit another domain to encapsulate IDN within an iframe or set the usernameEmptyText to change the placeholder text for Username on your tenant's login screen. - - name: Vendor Connector Mappings - description: | - Vendors use ISC connectors to connect their source data to ISC, but the data in their source and the data in ISC may be stored in different formats. - Connector mappings allow vendors to match their data on both sides of the connection. - The vendors can then track and manage access across their sources from ISC. - This API allows you to create and manage these vendor connector mappings. - - name: Work Items - description: | - Use this API to implement work item functionality. - With this functionality in place, users can manage their work items (tasks). - - Work items refer to the tasks users see in Identity Security Cloud's Task Manager. - They can see the pending work items they need to complete, as well as the work items they have already completed. - Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. - For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. - Once the user completes the work item, the work item will be listed with his or her other completed work items. - - To complete work items, users can use their dashboards and select the 'My Tasks' widget. - The widget will list any work items they need to complete, and they can select the work item from the list to review its details. - When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. - - Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. - - name: Work Reassignment - description: | - Use this API to implement work reassignment functionality. - - Work Reassignment allows access request reviews, certifications, and manual provisioning tasks assigned to a user to be reassigned to a different user. This is primarily used for: - - - Temporarily redirecting work for users who are out of office, such as on vacation or sick leave - - Permanently redirecting work for users who should not be assigned these tasks at all, such as senior executives or service identities - - Users can define reassignments for themselves, managers can add them for their team members, and administrators can configure them on any user’s behalf. Work assigned during the specified reassignment timeframes will be automatically reassigned to the designated user as it is created. - - Refer to [Work Reassignment](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html) for more information about this topic. - - name: Workflows - description: | - Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. -x-webhooks: - AccessRequestDecision: - post: - summary: Access Request Decision - operationId: accessRequestDecisionEvent - description: |- - This event trigger fires after an access request is approved or denied. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Access Request Decision](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-decision). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Access Request Post Approval - type: object - required: - - accessRequestId - - requestedFor - - requestedItemsStatus - - requestedBy - properties: - accessRequestId: - type: string - description: The unique ID of the access request. - example: 2c91808b6ef1d43e016efba0ce470904 - requestedFor: - required: - - id - - type - - name - type: array - description: Identities access was requested for. - items: - type: object - description: Identity the access item is requested for. - properties: - type: - type: string - description: DTO type of identity the access item is requested for. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity the access item is requested for. - example: 2c4180a46faadee4016fb4e018c20626 - name: - type: string - description: Human-readable display name of identity the access item is requested for. - example: Robert Robinson - minItems: 1 - maxItems: 10 - requestedItemsStatus: - description: Details on the outcome of each access item. - type: array - items: - type: object - required: - - id - - name - - type - - operation - - approvalInfo - properties: - id: - type: string - description: The unique ID of the access item being requested. - example: 2c91808b6ef1d43e016efba0ce470904 - name: - type: string - description: The human friendly name of the access item. - example: Engineering Access - description: - nullable: true - type: string - description: Detailed description of the access item. - example: Access to engineering database - type: - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: The type of access item. - example: ACCESS_PROFILE - operation: - enum: - - Add - - Remove - description: The action to perform on the access item. - example: Add - comment: - nullable: true - type: string - description: A comment from the identity requesting the access. - example: William needs this access to do his job. - clientMetadata: - description: Additional customer defined metadata about the access item. - nullable: true - type: object - additionalProperties: true - example: - applicationName: My application - approvalInfo: - description: A list of one or more approvers for the access request. - type: array - items: - type: object - required: - - approvalDecision - - approverName - - approver - properties: - approvalComment: - nullable: true - type: string - description: A comment left by the approver. - example: This access looks good. Approved. - approvalDecision: - enum: - - APPROVED - - DENIED - description: The final decision of the approver. - example: APPROVED - approverName: - type: string - description: The name of the approver - example: Stephen.Austin - approver: - required: - - id - - type - - name - allOf: - - type: object - description: Identity who approved the access item request. - properties: - type: - type: string - description: DTO type of identity who approved the access item request. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity who approved the access item request. - example: 2c3780a46faadee4016fb4e018c20652 - name: - type: string - description: Human-readable display name of identity who approved the access item request. - example: Allen Albertson - description: The identity of the approver. - properties: - type: - enum: - - IDENTITY - example: IDENTITY - description: The type of object that is referenced - requestedBy: - required: - - id - - type - - name - allOf: - - type: object - description: Access item requester's identity. - properties: - type: - type: string - description: Access item requester's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Access item requester's identity ID. - example: 2c7180a46faadee4016fb4e018c20648 - name: - type: string - description: Access item owner's human-readable display name. - example: William Wilson - AccessRequestDynamicApproval: - post: - summary: Access Request Dynamic Approval - operationId: accessRequestDynamicApprovalEvent - description: |- - This event trigger fires after an access request is submitted but before the request is approved or denied. You can use this trigger as a way to route the access request to an additional approval step by an identity or governance group. - This is a `REQUEST_RESPONSE` event trigger. This trigger type expects a response from the subscribers with directions about how to proceed with the event. You can only have one subscriber per event. For more information about this event trigger, refer to [Access Request Dynamic Approval](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval). - >**Note: If there is an active subscription to the [Access Request Submitted trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-submitted), this trigger is invoked after the Access Request Submitted trigger, only if the response to that trigger was to approve the request.** - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Access Request Dynamic Approver - type: object - required: - - accessRequestId - - requestedFor - - requestedItems - - requestedBy - properties: - accessRequestId: - type: string - description: | - The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. - example: 4b4d982dddff4267ab12f0f1e72b5a6d - requestedFor: - type: array - description: Identities access was requested for. - items: - $ref: '#/x-webhooks/AccessRequestDecision/post/requestBody/content/application~1json/schema/properties/requestedFor/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/AccessItemRequestedForDto.yaml - minItems: 1 - maxItems: 10 - requestedItems: - description: The access items that are being requested. - type: array - items: - type: object - required: - - id - - name - - type - - operation - properties: - id: - type: string - description: The unique ID of the access item. - example: 2c91808b6ef1d43e016efba0ce470904 - name: - type: string - description: Human friendly name of the access item. - example: Engineering Access - description: - nullable: true - type: string - description: Extended description of the access item. - example: Engineering Access - type: - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: The type of access item being requested. - example: ACCESS_PROFILE - operation: - enum: - - Add - - Remove - description: Grant or revoke the access item - example: Add - comment: - nullable: true - type: string - description: A comment from the requestor on why the access is needed. - example: William needs this access for his day to day job activities. - minItems: 1 - maxItems: 25 - requestedBy: - allOf: - - $ref: '#/x-webhooks/AccessRequestDecision/post/requestBody/content/application~1json/schema/properties/requestedBy/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/AccessItemRequesterDto.yaml - responses: - required: true - content: - application/json: - schema: - title: Access Request Dynamic Approval Response - type: object - required: - - id - - type - - name - properties: - id: - type: string - description: Unique identifier of the approver to add to the approval process. If there is none, send an empty value "". - example: 2c91808b6ef1d43e016efba0ce470906 - type: - type: string - description: Type of approver to add to the approval process. If there is none, send an empty value "". - enum: - - IDENTITY - - GOVERNANCE_GROUP - example: IDENTITY - name: - type: string - description: Name of the approver to add to the approval process. If there is none, send an empty value "". - example: Adam Adams - AccessRequestSubmitted: - post: - summary: Access Request Submitted - operationId: accessRequestSubmittedEvent - description: |- - This event trigger fires after an access request is submitted but before the request is approved or denied. A service subscribing to the trigger can respond in real-time to approve or deny the request. - This is a `REQUEST_RESPONSE` event trigger. This trigger type expects a response from the subscribers with directions about how to proceed with the event. You can only have one subscriber per event. For more information about this event trigger, refer to [Access Request Submitted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-submitted). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Access Request Pre Approval - type: object - required: - - accessRequestId - - requestedFor - - requestedItems - - requestedBy - properties: - accessRequestId: - type: string - description: The unique ID of the access request. - example: 2c91808b6ef1d43e016efba0ce470904 - requestedFor: - required: - - id - - type - - name - type: array - description: Identities access was requested for. - items: - $ref: '#/x-webhooks/AccessRequestDecision/post/requestBody/content/application~1json/schema/properties/requestedFor/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/AccessItemRequestedForDto.yaml - minItems: 1 - maxItems: 10 - requestedItems: - description: Details of the access items being requested. - type: array - items: - type: object - required: - - id - - name - - type - - operation - properties: - id: - type: string - description: The unique ID of the access item being requested. - example: 2c91808b6ef1d43e016efba0ce470904 - name: - type: string - description: The human friendly name of the access item. - example: Engineering Access - description: - nullable: true - type: string - description: Detailed description of the access item. - example: Access to engineering database - type: - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: The type of access item. - example: ACCESS_PROFILE - operation: - enum: - - Add - - Remove - description: The action to perform on the access item. - example: Add - comment: - nullable: true - type: string - description: A comment from the identity requesting the access. - example: William needs this access to do his job. - minItems: 1 - maxItems: 25 - requestedBy: - required: - - id - - type - - name - allOf: - - $ref: '#/x-webhooks/AccessRequestDecision/post/requestBody/content/application~1json/schema/properties/requestedBy/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/AccessItemRequesterDto.yaml - responses: - required: true - content: - application/json: - schema: - title: Access Request Submitted Response - type: object - required: - - approved - - comment - - approver - properties: - approved: - type: boolean - description: Approval or denial of the request by the subscribing service. - example: true - comment: - type: string - description: Comment from the subscribing service approving or denying the request. - example: This access has passed preliminary approval. - approver: - type: string - description: Name of the subscribing service approving the request. This doesn't normally have to be the name of an existing identity in ISC, but it does if you have an active subscription to the [Access Request Decision trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-decision). If you don't provide the `username` of an existing identity in your tenant, your Access Request Decision subscriptions will never trigger. - example: AcmeCorpExternalIntegration - AccountAggregationCompleted: - post: - summary: Account Aggregation Completed - operationId: accountAggregationCompletedEvent - description: |- - This event trigger fires after a source aggregation has either succeeded or failed in collecting source accounts but before Identity Security Cloud (ISC) processes the aggregation. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Account Aggregation Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Account Aggregation Completed - type: object - required: - - source - - status - - started - - completed - - errors - - warnings - - stats - properties: - source: - required: - - type - - name - - id - type: object - description: The source the accounts are being aggregated from. - properties: - type: - type: string - description: The DTO type of the source the accounts are being aggregated from. - enum: - - SOURCE - example: SOURCE - id: - type: string - description: The ID of the source the accounts are being aggregated from. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Display name of the source the accounts are being aggregated from. - example: HR Active Directory - status: - description: The overall status of the aggregation. - enum: - - Success - - Failed - - Terminated - example: Success - started: - type: string - format: date-time - description: The date and time when the account aggregation started. - example: '2020-06-29T22:01:50.474Z' - completed: - type: string - format: date-time - description: The date and time when the account aggregation finished. - example: '2020-06-29T22:02:04.090Z' - errors: - nullable: true - description: A list of errors that occurred during the aggregation. - type: array - items: - type: string - description: A descriptive error message. - example: Accounts unable to be aggregated. - warnings: - nullable: true - description: A list of warnings that occurred during the aggregation. - type: array - items: - type: string - description: A descriptive warning message. - example: Account Skipped - stats: - type: object - description: Overall statistics about the account aggregation. - required: - - scanned - - unchanged - - changed - - added - - removed - properties: - scanned: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: The number of accounts which were scanned / iterated over. - example: 200 - unchanged: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: The number of accounts which existed before, but had no changes. - example: 190 - changed: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: The number of accounts which existed before, but had changes. - example: 6 - added: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: The number of accounts which are new - have not existed before. - example: 4 - removed: - type: integer - minimum: 0 - maximum: 2147483647 - format: int32 - description: The number accounts which existed before, but no longer exist (thus getting removed). - example: 3 - CampaignActivated: - post: - summary: Campaign Activated - operationId: campaignActivatedEvent - description: |- - This event trigger fires after a certification campaign is activated. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Campaign Activated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/campaign-activated). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Campaign Activated - type: object - required: - - campaign - properties: - campaign: - type: object - description: Details about the certification campaign that was activated. - required: - - id - - name - - description - - created - - deadline - - type - - campaignOwner - - status - properties: - id: - type: string - description: Unique ID for the campaign. - example: 2c91808576f886190176f88cac5a0010 - name: - type: string - description: The human friendly name of the campaign. - example: Manager Access Campaign - description: - type: string - description: Extended description of the campaign. - example: Audit access for all employees. - created: - type: string - format: date-time - description: The date and time the campaign was created. - example: '2021-02-16T03:04:45.815Z' - modified: - nullable: true - type: string - format: date-time - description: The date and time the campaign was last modified. - example: '2021-02-16T03:06:45.815Z' - deadline: - type: string - format: date-time - description: The date and time the campaign is due. - example: '2021-03-16T03:04:45.815Z' - type: - description: The type of campaign. - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - - ROLE_COMPOSITION - example: MANAGER - campaignOwner: - type: object - description: Details of the identity that owns the campaign. - required: - - id - - displayName - - email - properties: - id: - type: string - description: The unique ID of the identity. - example: 37f080867702c1910177031320c40n27 - displayName: - type: string - description: The human friendly name of the identity. - example: John Snow - email: - type: string - description: The primary email address of the identity. - example: john.snow@example.com - status: - enum: - - ACTIVE - description: The current status of the campaign. - example: ACTIVE - CampaignEnded: - post: - summary: Campaign Ended - operationId: campaignEndedEvent - description: |- - This event trigger fires after a certification campaign ends. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Campaign Ended](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/campaign-ended). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Campaign Ended - type: object - required: - - campaign - properties: - campaign: - type: object - description: Details about the certification campaign that ended. - required: - - id - - name - - description - - created - - deadline - - type - - campaignOwner - - status - properties: - id: - type: string - description: Unique ID for the campaign. - example: 2c91808576f886190176f88cac5a0010 - name: - type: string - description: The human friendly name of the campaign. - example: Manager Access Campaign - description: - type: string - description: Extended description of the campaign. - example: Audit access for all employees. - created: - type: string - format: date-time - description: The date and time the campaign was created. - example: '2021-02-16T03:04:45.815Z' - modified: - nullable: true - type: string - format: date-time - description: The date and time the campaign was last modified. - example: '2021-03-16T03:06:45.815Z' - deadline: - type: string - format: date-time - description: The date and time the campaign is due. - example: '2021-03-16T03:04:45.815Z' - type: - description: The type of campaign. - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - - ROLE_COMPOSITION - example: MANAGER - campaignOwner: - type: object - description: Details of the identity that owns the campaign. - required: - - id - - displayName - - email - properties: - id: - type: string - description: The unique ID of the identity. - example: 37f080867702c1910177031320c40n27 - displayName: - type: string - description: The human friendly name of the identity. - example: John Snow - email: - type: string - description: The primary email address of the identity. - example: john.snow@example.com - status: - enum: - - COMPLETED - description: The current status of the campaign. - example: COMPLETED - CampaignGenerated: - post: - summary: Campaign Generated - operationId: campaignGeneratedEvent - description: |- - This event trigger fires after a certification campaign has generated and moved into the 'Preview Ready' state but hasn't been activated yet. A typical use case for this event trigger is to use it to immediately activate a campaign once it is generated. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Campaign Generated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/campaign-generated). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Campaign Generated - type: object - required: - - campaign - properties: - campaign: - description: Details about the campaign that was generated. - type: object - required: - - id - - name - - description - - created - - type - - campaignOwner - - status - properties: - id: - type: string - description: The unique ID of the campaign. - example: 2c91808576f886190176f88cac5a0010 - name: - type: string - description: Human friendly name of the campaign. - example: Manager Access Campaign - description: - type: string - description: Extended description of the campaign. - example: Audit access for all employees. - created: - type: string - format: date-time - description: The date and time the campaign was created. - example: '2021-02-16T03:04:45.815Z' - modified: - nullable: true - type: string - description: The date and time the campaign was last modified. - example: '2021-02-17T03:04:45.815Z' - deadline: - nullable: true - type: string - description: The date and time when the campaign must be finished by. - example: '2021-02-18T03:04:45.815Z' - type: - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - - ROLE_COMPOSITION - description: The type of campaign that was generated. - example: MANAGER - campaignOwner: - type: object - description: The identity that owns the campaign. - required: - - id - - displayName - - email - properties: - id: - type: string - description: The unique ID of the identity. - example: 37f080867702c1910177031320c40n27 - displayName: - type: string - description: The display name of the identity. - example: John Snow - email: - type: string - description: The primary email address of the identity. - example: john.snow@example.com - status: - enum: - - STAGED - - ACTIVATING - - ACTIVE - description: The current status of the campaign. - example: STAGED - CertificationSignedOff: - post: - summary: Certification Signed Off - operationId: certificationSignedOffEvent - description: |- - This event trigger fires after a certification is signed off on and moves to the 'End' status. Do not confuse this event trigger with the Campaign End trigger. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Certification Sign Off](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/certification-signed-off). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Certification Signed Off - type: object - required: - - certification - properties: - certification: - description: The certification campaign that was signed off on. - required: - - id - - name - - created - allOf: - - type: object - required: - - campaignRef - - completed - - decisionsMade - - decisionsTotal - - due - - signed - - reviewer - - campaignOwner - - hasErrors - - phase - - entitiesCompleted - - entitiesTotal - properties: - campaignRef: - $ref: '#/components/schemas/Certification/properties/campaign' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignReference.yaml - phase: - $ref: '#/components/schemas/Certification/properties/phase' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertificationPhase.yaml - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - signed: - type: string - format: date-time - description: The date the reviewer signed off on the certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - $ref: '#/components/schemas/Certification/properties/reviewer' - description: A reference to the reviewer of the campaign. - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Reviewer.yaml - reassignment: - $ref: '#/components/schemas/Certification/properties/reassignment' - nullable: true - description: A reference to a reviewer that this campaign has been reassigned to. - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Reassignment.yaml - hasErrors: - type: boolean - example: false - description: Indicates it the certification has any errors. - errorMessage: - type: string - nullable: true - example: The certification has an error - description: A message indicating what the error is. - completed: - type: boolean - description: Indicates if all certification decisions have been made. - example: false - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made by the reviewer. - example: 20 - format: int32 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions for the certification. - example: 40 - format: int32 - entitiesCompleted: - type: integer - description: The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. - example: 5 - format: int32 - entitiesTotal: - type: integer - format: int32 - description: The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. - example: 10 - properties: - id: - type: string - description: Unique ID of the certification. - example: 2c91808576f886190176f88caf0d0067 - name: - type: string - description: The name of the certification. - example: Manager Access Review for Alice Baker - created: - type: string - format: date-time - description: The date and time the certification was created. - example: '2020-02-16T03:04:45.815Z' - modified: - nullable: true - type: string - format: date-time - description: The date and time the certification was last modified. - example: '2020-02-16T03:06:45.815Z' - FormSubmitted: - post: - summary: Form Submitted - operationId: formSubmittedEvent - description: |- - This event trigger fires after a user has submitted a [custom form](https://documentation.sailpoint.com/saas/help/forms/index.html) in Identity Security Cloud (ISC). - A typical use case for this trigger is to immediately take actions based on the data in the submitted form. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Form Submitted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/form-submitted). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Form Submitted - type: object - required: - - submittedAt - - tenantId - - formInstanceId - - formDefinitionId - - name - - createdBy - - submittedBy - - formData - properties: - submittedAt: - type: date-time - description: Date and time when the user submitted the form. - example: '2020-06-29T22:01:50.474Z' - tenantId: - type: string - description: ISC tenant's unique identifier. - example: 2c9180845d1edece015d27a9717c3e19 - formInstanceId: - type: string - description: Form instance's unique identifier. - example: 2c9180835d2e5168015d32f890ca1582 - formDefinitionId: - type: string - description: Form definition's unique identifier. - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Form's name. - example: Open Service Request - createdBy: - type: object - description: Origin of the form creation. - required: - - type - - id - properties: - type: - type: string - description: Form creation origin's type. - enum: - - WORKFLOW_EXECUTION - - SOURCE - example: WORKFLOW_EXECUTION - id: - type: string - description: Unique identifier of the origin of the form creation. - example: 2c9180845d1edece015d27a9717c3e19 - submittedBy: - type: object - description: Identity who submitted the form. - required: - - type - - id - - name - properties: - type: - type: string - description: DTO type of the identity who submitted the form. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Unique identifier of the identity who submitted the form. - example: 2c9180845d1edece015d27a9717c3e19 - name: - type: string - description: Name of the identity who submitted the form. - example: Rob.Robertson - formData: - type: object - description: Data in the submitted form. - nullable: true - additionalProperties: true - example: - department: IT - requestType: New Laptop - laptop: New Laptop type for Engineer - comments: My laptop is running slowly, and I need to get a shiny new laptop to get my work done. Thanks! - IdentityAttributesChanged: - post: - summary: Identity Attributes Changed - operationId: identityAttributesChangedEvent - description: |- - This event trigger fires when Identity Security Cloud (ISC) detects an identity attribute change. ISC identity attribute changes occur when account attributes aggregated from an authoritative source differ from an identity's current attributes during an identity refresh. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Identity Attributes Changed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-attribute-changed). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Identity Attributes Changed - type: object - required: - - identity - - changes - properties: - identity: - required: - - id - - type - - name - type: object - description: Identity whose attributes changed. - properties: - type: - type: string - description: DTO type of identity whose attributes changed. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity whose attributes changed. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Display name of identity whose attributes changed. - example: Michael Michaels - changes: - description: A list of one or more identity attributes that changed on the identity. - type: array - items: - type: object - required: - - attribute - properties: - attribute: - type: string - description: The name of the identity attribute that changed. - example: department - oldValue: - description: The value of the identity attribute before it changed. - nullable: true - example: sales - oneOf: - - type: string - - type: boolean - - type: array - items: - type: string - - type: object - nullable: true - additionalProperties: - oneOf: - - type: string - - type: number - - type: integer - - type: boolean - newValue: - description: The value of the identity attribute after it changed. - example: marketing - oneOf: - - type: string - - type: boolean - - type: array - items: - type: string - - type: object - nullable: true - additionalProperties: - oneOf: - - type: string - - type: number - - type: integer - - type: boolean - IdentityCreated: - post: - summary: Identity Created - operationId: identityCreatedEvent - description: |- - This event trigger fires when Identity Security Cloud (ISC) detects a new identity during an aggregation and refresh from an authoritative source. ISC detects a new identity when it finds an account from an authoritative source that isn't correlated to an existing identity. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Identity Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-created). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Identity Created - type: object - required: - - identity - - attributes - properties: - identity: - required: - - id - - type - - name - type: object - description: Created identity. - properties: - type: - type: string - description: Created identity's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Created identity ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Created identity's display name. - example: Michael Michaels - attributes: - type: object - description: The attributes assigned to the identity. Attributes are determined by the identity profile. - additionalProperties: true - example: - firstname: John - NativeChangeAccountCreated: - post: - summary: Native Change Account Created - operationId: nativeChangeAccountCreatedEvent - description: |- - This event trigger fires when Identity Security Cloud (ISC) aggregates data from an external source and detects that a new account exists on the source. The external source must meet these criteria for you to receive this type of event: - * Native Change Detection (NCD) is enabled. - * Account Create operations are monitored. - * At least one attribute selected for monitoring has changed. - - In addition to having NCD enabled, There are two ways to configure a source for NCD: - * Invoke the 'Update Native Change Detection' configuration for each source you want to receive NCD events from. - * Configure the NCD options on the source in the source configuration user interface (UI). - - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Native Change Account Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/native-change-account-created). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Source Account Created - type: object - required: - - id - - nativeIdentifier - - sourceId - - sourceName - - identityId - - identityName - - attributes - properties: - uuid: - type: string - description: Source unique identifier for the identity. UUID is generated by the source system. - example: b7264868-7201-415f-9118-b581d431c688 - id: - type: string - description: SailPoint generated unique identifier. - example: ee769173319b41d19ccec35ba52f237b - nativeIdentifier: - type: string - description: Unique ID of the account on the source. - example: E009 - sourceId: - type: string - description: The ID of the source. - example: 2c918082814e693601816e09471b29b6 - sourceName: - type: string - description: The name of the source. - example: Active Directory - identityId: - type: string - description: The ID of the identity that is correlated with this account. - example: ee769173319b41d19ccec6c235423237b - identityName: - type: string - description: The name of the identity that is correlated with this account. - example: john.doe - attributes: - type: object - additionalProperties: true - description: The attributes of the account. The contents of attributes depends on the account schema for the source. - example: - firstname: John - lastname: Doe - email: john.doe@gmail.com - department: Sales - displayName: John Doe - created: '2020-04-27T16:48:33.597Z' - employeeNumber: E009 - uid: E009 - inactive: 'true' - phone: null - identificationNumber: E009 - NativeChangeAccountDeleted: - post: - summary: Native Change Account Deleted - operationId: nativeChangeAccountDeletedEvent - description: |- - This event trigger fires when Identity Security Cloud (ISC) aggregates data from an external source and detects that an account has been deleted from the source. The external source must meet these criteria for you to receive this type of event: - * Native Change Detection (NCD) is enabled. - * Account Delete operations are monitored. - * At least one attribute selected for monitoring has changed. - - In addition to having NCD enabled, There are two ways to configure a source for NCD: - * Invoke the 'Update Native Change Detection' configuration for each source you want to receive NCD events from. - * Configure the NCD options on the source in the source configuration user interface (UI). - - A typical use for this event trigger would be to notify the correlated identity's manager and the source owner when the account is deleted. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Native Change Account Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/native-change-account-deleted). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Source Account Deleted - type: object - required: - - id - - nativeIdentifier - - sourceId - - sourceName - - identityId - - identityName - - attributes - properties: - uuid: - type: string - description: Source unique identifier for the identity. UUID is generated by the source system. - example: b7264868-7201-415f-9118-b581d431c688 - id: - type: string - description: SailPoint generated unique identifier. - example: ee769173319b41d19ccec35ba52f237b - nativeIdentifier: - type: string - description: Unique ID of the account on the source. - example: E009 - sourceId: - type: string - description: The ID of the source. - example: 2c918082814e693601816e09471b29b6 - sourceName: - type: string - description: The name of the source. - example: Active Directory - identityId: - type: string - description: The ID of the identity that is correlated with this account. - example: ee769173319b41d19ccec6c235423237b - identityName: - type: string - description: The name of the identity that is correlated with this account. - example: john.doe - attributes: - type: object - additionalProperties: true - description: The attributes of the account. The contents of attributes depends on the account schema for the source. - example: - firstname: John - lastname: Doe - email: john.doe@gmail.com - department: Sales - displayName: John Doe - created: '2020-04-27T16:48:33.597Z' - employeeNumber: E009 - uid: E009 - inactive: 'true' - phone: null - identificationNumber: E009 - NativeChangeAccountUpdated: - post: - summary: Native Change Account Updated - operationId: nativeChangeAccountUpdatedEvent - description: |- - This event trigger fires when Identity Security Cloud (ISC) aggregates data from an external source and detects that an account has been updated on the source. The external source must meet these criteria for you to receive this type of event: - * Native Change Detection (NCD) is enabled. - * Account Update operations are monitored. - * At least one attribute selected for monitoring has changed. - - In addition to having NCD enabled, There are two ways to configure a source for NCD: - * Invoke the 'Update Native Change Detection' configuration for each source you want to receive NCD events from. - * Configure the NCD options on the source in the source configuration user interface (UI). - - A typical use for this event trigger would be to notify the correlated identity's manager and the source owner when the account is deleted. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Native Change Account Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/native-change-account-updated). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Source Account Updated - type: object - required: - - id - - nativeIdentifier - - sourceId - - sourceName - - identityId - - identityName - - attributes - properties: - uuid: - type: string - description: Source unique identifier for the identity. UUID is generated by the source system. - example: b7264868-7201-415f-9118-b581d431c688 - id: - type: string - description: SailPoint generated unique identifier. - example: ee769173319b41d19ccec35ba52f237b - nativeIdentifier: - type: string - description: Unique ID of the account on the source. - example: E009 - sourceId: - type: string - description: The ID of the source. - example: 2c918082814e693601816e09471b29b6 - sourceName: - type: string - description: The name of the source. - example: Active Directory - identityId: - type: string - description: The ID of the identity that is correlated with this account. - example: ee769173319b41d19ccec6c235423237b - identityName: - type: string - description: The name of the identity that is correlated with this account. - example: john.doe - attributes: - type: object - additionalProperties: true - description: The attributes of the account. The contents of attributes depends on the account schema for the source. - example: - firstname: John - lastname: Doe - email: john.doe@gmail.com - department: Sales - displayName: John Doe - created: '2020-04-27T16:48:33.597Z' - employeeNumber: E009 - uid: E009 - inactive: 'true' - phone: null - identificationNumber: E009 - OutlierDetected: - post: - summary: Outlier Detected - operationId: outlierDetectedEvent - description: |- - This event trigger fires when Identity Security Cloud (ISC) detects that identities have unusual access relative their peers. ISC calculates outliers daily, flags the outliers, and notifies the trigger's subscribers when it detects them. - These are the requirements to use the trigger: - * Your organization must have Access Insights, which it needs to access Identity Outliers. - * Your organization must have at a configured source that it has loaded account data from. - * Your organization's accound data must be onboarded into AI-Driven Identity Security. - - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Outlier Detected](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/outlier-detected). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Outlier Detected - type: object - required: - - identity - - outlierType - - score - properties: - identity: - required: - - id - - type - - name - type: object - description: Identity with unusual access, relative to its peers. - properties: - type: - type: string - description: Identity's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity's unique ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Identity's name. - example: Michael Michaels - outlierType: - type: string - description: Identity's outlier type. - enum: - - LOW_SIMILARITY - example: LOW_SIMILARITY - score: - type: number - description: Dissimilarity score that determines whether the identity is an outlier, ranging from `0.0` to `1.0`. The higher the score, the more likely the identity is an outlier. - format: decimal - example: 0.82 - ProvisioningCompleted: - post: - summary: Provisioning Completed - operationId: provisioningCompletedEvent - description: |- - This event trigger fires after Identity Security Cloud (ISC) provisions access to an account. This trigger provides organizations with a flexible way to extend the provisioning workflow after an identity's access has changed within ISC. - These are the requirements to use the trigger: - * An oAuth client must be configured with the `ORG_ADMIN` authority. - * The organization has enabled the `ARSENAL_ALLOW_POSTPROVISIONING_TRIGGERS` feature flag. - * Connectors are configured for provisioning into the target applications. - * The organization is configured for automated provisioning. Different event contexts require different setups. For more information about these setups, refer to [Provisioning Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed). - - To provision access to a target application, the source's connector must support these features: - * `ENABLE`: The ability to enable or disable accounts. - * `UNLOCK`: The ability to lock or unlock accounts. - * `PROVISIONING`: The ability to write to accounts. - * `PASSWORD`: The ability to update account passwords. - - For a list of supported connectors and features, refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/isc/landingpages/help/landingpages/isc_landing.html). For more information about configuring sources for provisioning in ISC, refer to [Configuring Source Account Provisioning](https://documentation.sailpoint.com/saas/help/provisioning/create_profile.html). - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Provisioning Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Provisioning Completed - type: object - required: - - trackingNumber - - sources - - recipient - - accountRequests - properties: - trackingNumber: - type: string - description: The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. - example: 4b4d982dddff4267ab12f0f1e72b5a6d - sources: - type: string - description: One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. - example: Corp AD, Corp LDAP, Corp Salesforce - action: - nullable: true - type: string - description: Origin of where the provisioning request came from. - example: IdentityRefresh - errors: - nullable: true - description: A list of any accumulated error messages that occurred during provisioning. - type: array - items: - type: string - example: Connector AD Failed - warnings: - nullable: true - description: A list of any accumulated warning messages that occurred during provisioning. - type: array - items: - type: string - example: Notification Skipped due to invalid email - recipient: - required: - - id - - type - - name - type: object - description: Provisioning recpient. - properties: - type: - type: string - description: Provisioning recipient DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Provisioning recipient's identity ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Provisioning recipient's display name. - example: Michael Michaels - requester: - nullable: true - required: - - id - - type - - name - type: object - description: Provisioning requester's identity. - properties: - type: - type: string - description: Provisioning requester's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Provisioning requester's identity ID. - example: 2c7180a46faadee4016fb4e018c20648 - name: - type: string - description: Provisioning owner's human-readable display name. - example: William Wilson - accountRequests: - type: array - description: A list of provisioning instructions to perform on an account-by-account basis. - items: - type: object - required: - - source - - accountOperation - - provisioningResult - - provisioningTarget - properties: - source: - required: - - id - - type - - name - type: object - description: Reference to the source being provisioned against. - properties: - id: - description: ID of the object to which this reference applies - type: string - example: 4e4d982dddff4267ab12f0f1e72b5a6d - type: - type: string - enum: - - SOURCE - example: SOURCE - description: The type of object that is referenced - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: Corporate Active Directory - accountId: - type: string - description: The unique idenfier of the account being provisioned. - example: CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com - accountOperation: - type: string - description: The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. - example: Modify - provisioningResult: - description: The overall result of the provisioning transaction; this could be success, pending, failed, etc. - enum: - - SUCCESS - - PENDING - - FAILED - example: SUCCESS - provisioningTarget: - type: string - description: The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). - example: Corp AD - ticketId: - nullable: true - type: string - description: A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). - example: '72619262' - attributeRequests: - nullable: true - description: A list of attributes as part of the provisioning transaction. - type: array - items: - type: object - required: - - attributeName - - operation - properties: - attributeName: - type: string - description: The name of the attribute being provisioned. - example: memberOf - attributeValue: - nullable: true - type: string - description: The value of the attribute being provisioned. - example: CN=jedi,DC=starwars,DC=com - operation: - enum: - - Add - - Set - - Remove - description: The operation to handle the attribute. - example: Add - ScheduledSearch: - post: - summary: Scheduled Search - operationId: scheduledSearchEvent - description: |- - This event trigger fires after Identity Security Cloud (ISC) generates a report from a saved search. - In ISC, users can subscribe to saved searches to receive an email report generated by the saved search. They can then set a schedule for when those saved searches generate reports, such as daily at 6:00 GMT. The trigger can notify an external HTTP application that ISC has generated a report from a saved search and the report is ready to be processed. - These are some typical use cases for the trigger: - * Perform continous checks for Separation of Duties (SOD) violations, for quality control. - * Respond to upcoming Joiner-Mover-Leaver (JML) scenarios, such as deprovisioning access before an employee's separation date. - - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Scheduled Search](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/scheduled-search). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Saved Search Complete - type: object - required: - - fileName - - ownerEmail - - ownerName - - query - - searchName - - searchResults - - signedS3Url - properties: - fileName: - type: string - description: A name for the report file. - example: Modified.zip - ownerEmail: - type: string - description: The email address of the identity that owns the saved search. - example: test@sailpoint.com - ownerName: - type: string - description: The name of the identity that owns the saved search. - example: Cloud Support - query: - type: string - description: The search query that was used to generate the report. - example: modified:[now-7y/d TO now] - searchName: - type: string - description: The name of the saved search. - example: Modified Activity - searchResults: - type: object - description: A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type. - properties: - Account: - description: A table of accounts that match the search criteria. - nullable: true - type: object - required: - - count - - noun - - preview - properties: - count: - type: string - description: The number of rows in the table. - example: 3 - noun: - type: string - description: The type of object represented in the table. - example: accounts - preview: - description: A sample of the data in the table. - type: array - items: - type: array - items: - type: string - example: Robert.Chase - example: [] - Entitlement: - description: A table of entitlements that match the search criteria. - nullable: true - type: object - required: - - count - - noun - - preview - properties: - count: - type: string - description: The number of rows in the table. - example: 2 - noun: - type: string - description: The type of object represented in the table. - example: entitlements - preview: - description: A sample of the data in the table. - type: array - items: - type: array - items: - type: string - example: Administrator - example: [] - Identity: - description: A table of identities that match the search criteria. - nullable: true - type: object - required: - - count - - noun - - preview - properties: - count: - type: string - description: The number of rows in the table. - example: 2 - noun: - type: string - description: The type of object represented in the table. - example: identities - preview: - description: A sample of the data in the table. - type: array - items: - type: array - items: - type: string - example: Carol Shelby - example: [] - signedS3Url: - type: string - description: The Amazon S3 URL to download the report from. - example: https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc - SourceCreated: - post: - summary: Source Created - operationId: sourceCreatedEvent - description: |- - This event trigger fires when a new source is created in Identity Security Cloud (ISC), by either the [API](https://developer.sailpoint.com/docs/api/v2024/create-source) or the [Admin UI](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source). - These are some typical use cases for the trigger: - * Provide evidence to auditors to show that connector logic and sources are maintained by proper change control processes and aren't vulnerable to outside manipulation. - * Auto-configure new sources with proper owners, using external data sources. - - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-created). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Source Created - type: object - required: - - id - - name - - type - - created - - connector - - actor - properties: - id: - type: string - description: The unique ID of the source. - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Human friendly name of the source. - example: Test source - type: - type: string - description: The connection type. - example: DIRECT_CONNECT - created: - type: string - format: date-time - description: The date and time the source was created. - example: '2021-03-29T22:01:50.474Z' - connector: - type: string - description: The connector type used to connect to the source. - example: active-directory - actor: - required: - - id - - name - - type - type: object - description: Identity who created the source. - properties: - type: - type: string - description: DTO type of identity who created the source. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity who created the source. - example: 2c7180a46faadee4016fb4e018c20648 - name: - type: string - description: Display name of identity who created the source. - example: William Wilson - SourceDeleted: - post: - summary: Source Deleted - operationId: sourceDeletedEvent - description: |- - This event trigger fires when a new source is deleted from Identity Security Cloud (ISC), by either the [API](https://developer.sailpoint.com/docs/api/v2024/delete-source) or the [Admin UI](https://documentation.sailpoint.com/saas/help/sources/index.html#deleting-a-source). - These are some typical use cases for the trigger: - * Provide evidence to auditors to show that connector logic and sources are maintained by proper change control processes and aren't vulnerable to outside manipulation. - * Alert admins when a source is incorrectly deleted. - - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-deleted). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Source Deleted - type: object - required: - - id - - name - - type - - deleted - - connector - - actor - properties: - id: - type: string - description: The unique ID of the source. - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Human friendly name of the source. - example: Test source - type: - type: string - description: The connection type. - example: DIRECT_CONNECT - deleted: - type: string - format: date-time - description: The date and time the source was deleted. - example: '2021-03-29T22:01:50.474Z' - connector: - type: string - description: The connector type used to connect to the source. - example: active-directory - actor: - required: - - id - - name - - type - type: object - description: Identity who deleted the source. - properties: - type: - type: string - description: DTO type of identity who deleted the source. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity who deleted the source. - example: 2c7180a46faadee4016fb4e018c20648 - name: - type: string - description: Display name of identity who deleted the source. - example: William Wilson - SourceUpdated: - post: - summary: Source Updated - operationId: sourceUpdatedEvent - description: |- - This event trigger fires when a new source's configuration is changed in Identity Security Cloud (ISC). - These are some typical use cases for the trigger: - * Provide evidence to auditors to show that connector logic and sources are maintained by proper change control processes and aren't vulnerable to outside manipulation. - * Trigger review for an updated source. - - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-updated). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Source Updated - type: object - required: - - id - - name - - type - - modified - - connector - - actor - properties: - id: - type: string - description: The unique ID of the source. - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: The user friendly name of the source. - example: Corporate Active Directory - type: - type: string - description: The connection type of the source. - example: DIRECT_CONNECT - modified: - type: string - format: date-time - description: The date and time the source was modified. - example: '2021-03-29T22:01:50.474Z' - connector: - type: string - description: The connector type used to connect to the source. - example: active-directory - actor: - required: - - type - - name - type: object - description: Identity who updated the source. - properties: - type: - type: string - description: DTO type of identity who updated the source. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity who updated the source. - example: 2c7180a46faadee4016fb4e018c20648 - name: - type: string - description: Display name of identity who updated the source. - example: William Wilson - VaClusterStatusChange: - post: - summary: VA Cluster Status Change - operationId: vaClusterStatusChangeEvent - description: |- - This event trigger fires when Identity Security Cloud (ISC) runs a health check on a virtual appliance (VA) cluster, and the cluster's health status is different from the previous health check, such as a change from healthy to unhealthy or the opposite. VA cluster health checks run every 30 minutes. Users can use this trigger to monitor all their VA clusters' health status changes. - These are some typical use cases for the trigger: - * Create real-time health dashboards for VA clusters. - * Notify an admin or system to take appropriate actions when a VA cluster's health status changes. - - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/va-cluster-status-change). - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: VA Cluster Status Change Event - type: object - required: - - created - - type - - application - - healthCheckResult - - previousHealthCheckResult - properties: - created: - type: string - format: date-time - description: The date and time the status change occurred. - example: '2020-06-29T22:01:50.474Z' - type: - enum: - - SOURCE - - CLUSTER - description: The type of the object that initiated this event. - example: CLUSTER - application: - type: object - description: Details about the `CLUSTER` or `SOURCE` that initiated this event. - required: - - id - - name - - attributes - properties: - id: - type: string - description: The GUID of the application - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: The name of the application - example: Production VA Cluster - attributes: - type: object - description: Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. - additionalProperties: true - nullable: true - example: null - healthCheckResult: - type: object - description: The results of the most recent health check. - required: - - message - - resultType - - status - properties: - message: - type: string - description: Detailed message of the result of the health check. - example: Test Connection failed with exception. Error message - java.lang Exception - resultType: - type: string - description: The type of the health check result. - example: SOURCE_STATE_ERROR_CLUSTER - status: - enum: - - Succeeded - - Failed - description: The status of the health check. - example: Succeeded - previousHealthCheckResult: - type: object - description: The results of the last health check. - required: - - message - - resultType - - status - properties: - message: - type: string - description: Detailed message of the result of the health check. - example: Test Connection failed with exception. Error message - java.lang Exception - resultType: - type: string - description: The type of the health check result. - example: SOURCE_STATE_ERROR_CLUSTER - status: - enum: - - Succeeded - - Failed - description: The status of the health check. - example: Failed - IdentityDeleted: - post: - summary: Identity Deleted - operationId: identityDeletedEvent - description: |- - This event trigger fires after an identity has been completely deleted from Identity Security Cloud (ISC). ISC only deletes an identity when it meets all these requirements: - * It has no correlated accounts. - * It's not an owner of a role, access profile, application, source, or task result. - * It's not an owner or requester of a work item. - * It's not a protected account or manager. - * It has no assigned capabilities, such as being an assigned certification reviewer. - * It's not involved in any active certification as a target (its access is not being certified). - - These are some typical use cases for the trigger: - * Notify an administrator or system to take the appropriate provisioning actions as part of the leaver workflow. - * Notify a system to trigger another action, such as deactivating an employee's badge upon termination. - - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Identity Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-deleted). - >**Note: This is an early access event trigger. Contact support to enable it on your tenant.** - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - requestBody: - required: true - content: - application/json: - schema: - title: Identity Deleted - type: object - required: - - identity - - attributes - properties: - identity: - required: - - id - - type - - name - type: object - description: Deleted identity. - properties: - type: - type: string - description: Deleted identity's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Deleted identity ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Deleted identity's display name. - example: Michael Michaels - attributes: - type: object - description: The attributes assigned to the identity. Attributes are determined by the identity profile. - additionalProperties: true - example: - firstname: John - SourceAccountCreated: - post: - summary: Source Account Created - operationId: sourceAccountCreatedEvent - description: |- - This event trigger fires after Identity Security Cloud (ISC) detects a new account during an account aggregation and refresh from a source. This trigger cannot determine whether the account creation happened on the source or in ISC. It omits events related to ISC accounts, such as the ISC Admin. - A typical use for this trigger is to watch for new accounts with highly privileged access, such as an account created in Active Directory Domain Admins. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Source Account Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-created). - >**Note: This is an early access event trigger. Contact support to enable it on your tenant.** - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - deprecated: true - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/x-webhooks/NativeChangeAccountCreated/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceAccountCreated.yaml - SourceAccountDeleted: - post: - summary: Source Account Deleted - operationId: sourceAccountDeletedEvent - description: |- - This event trigger fires when Identity Security Cloud (ISC), during an account aggregation operation, detects that an account has been deleted. This trigger cannot determine whether the account deletion happened on the source or in ISC. It omits events related to ISC accounts, such as the ISC Admin. - A typical use for this trigger is to watch for deletions of authoritative accounts, such as an account deleted from Workday. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Source Account Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-deleted). - >**Note: This is an early access event trigger. Contact support to enable it on your tenant.** - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - deprecated: true - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/x-webhooks/NativeChangeAccountDeleted/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceAccountDeleted.yaml - SourceAccountUpdated: - post: - summary: Source Account Updated - operationId: sourceAccountUpdatedEvent - description: |- - This event trigger fires when Identity Security Cloud (ISC), during an account aggregation operation, detects a change to one or more account attributes on a single account. This trigger cannot determine whether the account update happened on the source or in ISC. It omits events related to ISC accounts, such as the ISC Admin. - These actions are considered updated: - * An update to account attributes - * Enabling or disabling an account - * Locking or unlocking an account - * A change to a source account password - - A typical use for this trigger is to watch for updates to accounts that add highly privileged access, such as an account that is granted privileged access on a sensitive source. - This is a `FIRE_AND_FORGET` event trigger. You can have a maximum of 50 subscriptions for this trigger. For more information about this event trigger, refer to [Source Account Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-updated). - >**Note: This is an early access event trigger. Contact support to enable it on your tenant.** - tags: - - Triggers - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - deprecated: true - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/x-webhooks/NativeChangeAccountUpdated/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceAccountUpdated.yaml -paths: - /access-profiles: - get: - operationId: listAccessProfiles - tags: - - Access Profiles - summary: List Access Profiles - description: |- - Get a list of access profiles. - >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. - parameters: - - in: query - name: for-subadmin - schema: - type: string - description: |- - Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. - - If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. - example: 8c190e6787aa4ed9a90bd9d5344523fb - required: false - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 250 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - - in: query - name: offset - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: count - description: |- - If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. - - Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. - - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: true - schema: - type: boolean - default: false - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **owner.id**: *eq, in* - - **requestable**: *eq* - - **source.id**: *eq, in* - - Supported composite operators are *and, or* - - Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. - example: name eq "SailPoint Support" - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created, modified** - example: name,-modified - required: false - - in: query - name: for-segment-ids - schema: - type: string - format: comma-separated - description: |- - Filters access profiles to only those assigned to the segment(s) with the specified IDs. - If segmentation is currently unavailable, specifying this parameter results in an error. - example: 0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d - required: false - - in: query - name: include-unsegmented - schema: - type: boolean - default: true - description: Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - example: false - required: false - responses: - '200': - description: List of access profiles. - content: - application/json: - schema: - type: array - items: - type: object - description: Access Profile - properties: - id: - type: string - description: The ID of the Access Profile - example: 2c91808a7190d06e01719938fcd20792 - readOnly: true - name: - type: string - description: Name of the Access Profile - example: Employee-database-read-write - description: - type: string - nullable: true - description: Information about the Access Profile - example: Collection of entitlements to read/write the employee database - created: - type: string - description: Date the Access Profile was created - format: date-time - example: '2021-03-01T22:32:58.104Z' - readOnly: true - modified: - type: string - description: Date the Access Profile was last modified. - format: date-time - example: '2021-03-02T20:22:28.104Z' - readOnly: true - enabled: - type: boolean - default: true - description: Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. - example: true - owner: - type: object - nullable: false - description: The owner of this object. - properties: - type: - type: string - enum: - - IDENTITY - description: Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. - example: IDENTITY - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. - example: support - source: - type: object - properties: - id: - type: string - description: The ID of the Source with with which the Access Profile is associated - example: 2c91809773dee3610173fdb0b6061ef4 - type: - type: string - enum: - - SOURCE - description: The type of the Source, will always be SOURCE - example: SOURCE - name: - type: string - description: The display name of the associated Source - example: ODS-AD-SOURCE - entitlements: - type: array - nullable: true - description: A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. - items: - type: object - description: Entitlement including a specific set of access. - properties: - type: - type: string - description: Entitlement's DTO type. - enum: - - ENTITLEMENT - example: ENTITLEMENT - id: - type: string - description: Entitlement's ID. - example: 2c91809773dee32014e13e122092014e - name: - type: string - nullable: true - description: Entitlement's display name. - example: CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local - requestable: - type: boolean - default: true - description: Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. - example: true - accessRequestConfig: - type: object - nullable: true - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: true - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: true - nullable: true - default: false - approvalSchemes: - type: array - nullable: true - description: List describing the steps in approving the request - items: - type: object - properties: - approverType: - type: string - enum: - - APP_OWNER - - OWNER - - SOURCE_OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - **APP_OWNER**: The owner of the Application - - **OWNER**: Owner of the associated Access Profile or Role - - **SOURCE_OWNER**: Owner of the Source associated with an Access Profile - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - revocationRequestConfig: - type: object - nullable: true - properties: - approvalSchemes: - type: array - nullable: true - description: List describing the steps in approving the revocation request - items: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/accessRequestConfig/properties/approvalSchemes/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/AccessProfileApprovalScheme.yaml - segments: - type: array - nullable: true - items: - type: string - description: List of IDs of segments, if any, to which this Access Profile is assigned. - example: - - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - - 29cb6c06-1da8-43ea-8be4-b3125f248f2a - provisioningCriteria: - type: object - nullable: true - description: Defines matching criteria for an Account to be provisioned with a specific Access Profile - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - HAS - - AND - - OR - description: Supported operations on ProvisioningCriteria - example: EQUALS - attribute: - type: string - description: Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. - example: email - nullable: true - value: - type: string - nullable: true - description: String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - description: Defines matching criteria for an Account to be provisioned with a specific Access Profile - properties: - operation: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/provisioningCriteria/properties/operation' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaOperation.yaml - attribute: - type: string - description: Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. - example: email - nullable: true - value: - type: string - nullable: true - description: String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - description: Defines matching criteria for an Account to be provisioned with a specific Access Profile - properties: - operation: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/provisioningCriteria/properties/operation' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaOperation.yaml - attribute: - type: string - description: Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. - example: email - nullable: true - value: - type: string - description: String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: string - description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - example: null - nullable: true - nullable: true - description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - example: null - nullable: true - description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - example: null - required: - - owner - - name - - source - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml - '401': - description: Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: Forbidden - Returned if the user you are running as, doesn't have access to this end-point. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: 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. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - security: - - userAuth: - - idn:access-profile:read - - applicationAuth: - - idn:access-profile:read - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#list-access-profiles - source: | - $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) - - # List Access Profiles - - try { - Get-V2025AccessProfiles - - # Below is a request that includes all optional parameters - # Get-V2025AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfiles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#list-access-profiles - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile import AccessProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) # str | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) - try: - # List Access Profiles - - results = AccessProfilesApi(api_client).list_access_profiles() - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) - print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - post: - operationId: createAccessProfile - tags: - - Access Profiles - summary: Create Access Profile - description: |- - Create an access profile. - A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. - The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml - responses: - '201': - description: Access profile created. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:access-profile:manage - - applicationAuth: - - idn:access-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#create-access-profile - source: | - $AccessProfile = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "description" : "Collection of entitlements to read/write the employee database", - "source" : { - "name" : "ODS-AD-SOURCE", - "id" : "2c91809773dee3610173fdb0b6061ef4", - "type" : "SOURCE" - }, - "enabled" : true, - "revocationRequestConfig" : { - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ] - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "accessRequestConfig" : { - "commentsRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "name" : "Employee-database-read-write", - "provisioningCriteria" : { - "children" : [ { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, - "modified" : "2021-03-02T20:22:28.104Z", - "id" : "2c91808a7190d06e01719938fcd20792", - "requestable" : true - } - "@ - - # Create Access Profile - - try { - $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile - New-V2025AccessProfile -AccessProfile $Result - - # Below is a request that includes all optional parameters - # New-V2025AccessProfile -AccessProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#create-access-profile - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile import AccessProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - access_profile = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "description" : "Collection of entitlements to read/write the employee database", - "source" : { - "name" : "ODS-AD-SOURCE", - "id" : "2c91809773dee3610173fdb0b6061ef4", - "type" : "SOURCE" - }, - "enabled" : true, - "revocationRequestConfig" : { - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ] - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "accessRequestConfig" : { - "commentsRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "name" : "Employee-database-read-write", - "provisioningCriteria" : { - "children" : [ { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, - "modified" : "2021-03-02T20:22:28.104Z", - "id" : "2c91808a7190d06e01719938fcd20792", - "requestable" : true - }''' # AccessProfile | - try: - # Create Access Profile - new_access_profile = AccessProfile.from_json(access_profile) - results = AccessProfilesApi(api_client).create_access_profile(access_profile=new_access_profile) - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).create_access_profile(new_access_profile) - print("The response of AccessProfilesApi->create_access_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) - /access-profiles/{id}: - get: - operationId: getAccessProfile - tags: - - Access Profiles - summary: Get an Access Profile - description: This API returns an Access Profile by its ID. - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listAccessProfiles - schema: - type: string - description: ID of the Access Profile - example: 2c9180837ca6693d017ca8d097500149 - responses: - '200': - description: An AccessProfile - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:access-profile:read - - applicationAuth: - - idn:access-profile:read - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#get-access-profile - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile - - # Get an Access Profile - - try { - Get-V2025AccessProfile -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccessProfile -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#get-access-profile - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile import AccessProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile - try: - # Get an Access Profile - - results = AccessProfilesApi(api_client).get_access_profile(id=id) - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).get_access_profile(id) - print("The response of AccessProfilesApi->get_access_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) - patch: - operationId: patchAccessProfile - tags: - - Access Profiles - summary: Patch a specified Access Profile - description: |- - This API updates an existing Access Profile. The following fields are patchable: - - **name** - - **description** - - **enabled** - - **owner** - - **requestable** - - **accessRequestConfig** - - **revokeRequestConfig** - - **segments** - - **entitlements** - - **provisioningCriteria** - - **source** (must be updated with entitlements belonging to new source in the same API call) - - If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example "Replace Source" in the examples dropdown. - - A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. - > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. - - > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. - parameters: - - name: id - in: path - description: ID of the Access Profile to patch - required: true - x-sailpoint-resource-operation-id: listAccessProfiles - schema: - type: string - example: 2c91808a7813090a017814121919ecca - requestBody: - content: - application/json-patch+json: - schema: - type: array - items: - type: object - description: A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - oneOf: - - type: string - example: New description - title: string - - type: boolean - example: true - title: boolean - - type: integer - example: 300 - title: integer - - type: object - title: object - example: - attributes: - name: philip - - type: array - title: array - items: - anyOf: - - type: string - - type: integer - - type: object - example: - - '001' - - '002' - - '003' - description: The value to be used for the operation, required for "add" and "replace" operations - example: New description - examples: - Add Entitlements: - description: Add one or more entitlements to the end of the list - value: - - op: add - path: /entitlements - value: - - id: 2c9180857725c14301772a93bb77242d - type: ENTITLEMENT - name: AD User Group - Insert Entitlement: - description: Add an entitlement at the beginning of the entitlement list - value: - - op: add - path: /entitlements/0 - value: - id: 2c9180857725c14301772a93bb77242d - type: ENTITLEMENT - name: AD User Group - Replace Entitlements: - description: Replace all entitlements with a new list of entitlements - value: - - op: replace - path: /entitlements - value: - - id: 2c9180857725c14301772a93bb77242d - type: ENTITLEMENT - name: AD User Group - Remove Entitlement: - description: Remove the first entitlement in the list - value: - - op: remove - path: /entitlements/0 - Replace Source: - description: Change the source and the entitlements of the access profile - value: - - op: replace - path: /source - value: - id: 2c9180887671ff8c01767b4671fb7d5e - type: SOURCE - name: Employees - - op: replace - path: /entitlements - value: - - id: 2c9180877677453d01767b4b08f63386 - type: ENTITLEMENT - name: DevRel - required: true - responses: - '200': - description: Responds with the Access Profile as updated. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:access-profile:manage - - applicationAuth: - - idn:access-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#patch-access-profile - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Access Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025AccessProfile -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025AccessProfile -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AccessProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#patch-access-profile - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile import AccessProfile - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch - json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] | - try: - # Patch a specified Access Profile - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = AccessProfilesApi(api_client).patch_access_profile(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).patch_access_profile(id, new_json_patch_operation) - print("The response of AccessProfilesApi->patch_access_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) - delete: - operationId: deleteAccessProfile - tags: - - Access Profiles - summary: Delete the specified Access Profile - description: |- - This API deletes an existing Access Profile. - - The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. - - A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - parameters: - - name: id - in: path - description: ID of the Access Profile to delete - required: true - x-sailpoint-resource-operation-id: listAccessProfiles - schema: - type: string - example: 2c91808a7813090a017814121919ecca - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - '400': - description: Returned when an access profile cannot be deleted as it's being used. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: The locale for the message text, a BCP 47 language tag. - example: en-US - nullable: true - localeOrigin: - 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 - text: - 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. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorMessageDto.yaml - examples: - 400.2.1.0 Object in use by another: - description: Returned when an access profile cannot be deleted as it's being used - value: - detailCode: 400.2.1.0 Object in use by another - trackingId: c9c1033c55b84ebc9e93e926dcf8b8b3 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The "testAccessProfile" access profile can't be deleted because it's in use. - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:access-profile:manage - - applicationAuth: - - idn:access-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#delete-access-profile - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete - - # Delete the specified Access Profile - - try { - Remove-V2025AccessProfile -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025AccessProfile -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#delete-access-profile - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete - try: - # Delete the specified Access Profile - - AccessProfilesApi(api_client).delete_access_profile(id=id) - # Below is a request that includes all optional parameters - # AccessProfilesApi(api_client).delete_access_profile(id) - except Exception as e: - print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) - /access-profiles/bulk-delete: - post: - operationId: deleteAccessProfilesInBulk - summary: Delete Access Profile(s) - tags: - - Access Profiles - description: |- - This endpoint initiates a bulk deletion of one or more access profiles. - When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. - This endpoint can only bulk delete up to a limit of 50 access profiles per request. - By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. - A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - accessProfileIds: - description: List of IDs of Access Profiles to be deleted. - type: array - items: - type: string - example: - - 2c9180847812e0b1017817051919ecca - - 2c9180887812e0b201781e129f151816 - bestEffortOnly: - description: If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. - type: boolean - example: true - example: - bestEffortOnly: true - accessProfileIds: - - 2c91808876438bb2017668b91919ecca - - 2c91808876438ba801766e129f151816 - responses: - '200': - description: Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use. - content: - application/json: - schema: - type: object - properties: - taskId: - type: string - description: ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status. - example: 2c9180867817ac4d017817c491119a20 - pending: - type: array - description: List of IDs of Access Profiles which are pending deletion. - items: - type: string - example: - - 2c91808876438bbb017668c21919ecca - - 2c91808876438bb201766e129f151816 - inUse: - type: array - description: List of usages of Access Profiles targeted for deletion. - items: - type: object - properties: - accessProfileId: - type: string - description: ID of the Access Profile that is in use - example: 2c91808876438bbb017668c21919ecca - usedBy: - type: array - description: List of references to objects which are using the indicated Access Profile - items: - type: object - description: Role using the access profile. - properties: - type: - type: string - description: DTO type of role using the access profile. - enum: - - ROLE - example: ROLE - id: - type: string - description: ID of role using the access profile. - example: 2c8180857a9b3da0017aa03418480f9d - name: - type: string - description: Display name of role using the access profile. - example: Manager Role - example: - pending: [] - inUse: - - accessProfileId: 2c91808876438ba801766e129f151816 - usages: - - type: Role - id: 2c9180887643764201766e9f6e121518 - '202': - description: Returned if at least one deletion will be performed. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1bulk-delete/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/AccessProfileBulkDeleteResponse.yaml - example: - taskId: 2c91808a7813090a01781412a1119a20 - pending: - - 2c91808a7813090a017813fe1919ecca - inUse: - - accessProfileId: 2c91808876438ba801766e129f151816 - usages: - - type: Role - id: 2c9180887643764201766e9f6e121518 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:access-profile:manage - - applicationAuth: - - idn:access-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#delete-access-profiles-in-bulk - source: | - $AccessProfileBulkDeleteRequest = @" - { - "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], - "bestEffortOnly" : true - } - "@ - - # Delete Access Profile(s) - - try { - $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest - Remove-V2025AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfilesInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#delete-access-profiles-in-bulk - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest - from sailpoint.v2025.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - access_profile_bulk_delete_request = '''{ - "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], - "bestEffortOnly" : true - }''' # AccessProfileBulkDeleteRequest | - try: - # Delete Access Profile(s) - new_access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest.from_json(access_profile_bulk_delete_request) - results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(access_profile_bulk_delete_request=new_access_profile_bulk_delete_request) - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(new_access_profile_bulk_delete_request) - print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) - /access-profiles/{id}/entitlements: - get: - operationId: getAccessProfileEntitlements - tags: - - Access Profiles - summary: List Access Profile's Entitlements - description: |- - Use this API to get a list of an access profile's entitlements. - A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. - >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. - parameters: - - name: id - in: path - description: ID of the access profile containing the entitlements. - required: true - x-sailpoint-resource-operation-id: listAccessProfiles - schema: - type: string - example: 2c91808a7813090a017814121919ecca - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **attribute**: *eq, sw* - - **value**: *eq, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **owner.id**: *eq, in* - - **source.id**: *eq, in* - - Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. - example: attribute eq "memberOf" - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, attribute, value, created, modified** - example: name,-modified - required: false - responses: - '200': - description: List of entitlements. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The entitlement id - example: 2c91808874ff91550175097daaec161c - name: - type: string - description: The entitlement name - example: LauncherTest2 - attribute: - type: string - description: The entitlement attribute name - example: memberOf - value: - type: string - description: The value of the entitlement - example: CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local - sourceSchemaObjectType: - type: string - description: The object type of the entitlement from the source schema - example: group - description: - type: string - description: The description of the entitlement - example: CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local - nullable: true - privileged: - type: boolean - description: True if the entitlement is privileged - example: true - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - example: true - requestable: - type: boolean - description: True if the entitlement is able to be directly requested - example: true - default: false - owner: - type: object - description: The identity that owns the entitlement - nullable: true - properties: - id: - type: string - description: The identity ID - example: 2c9180827ca885d7017ca8ce28a000eb - type: - type: string - enum: - - IDENTITY - description: The type of object - example: IDENTITY - name: - type: string - description: The display name of the identity - example: john.doe - manuallyUpdatedFields: - type: object - description: A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. - nullable: true - additionalProperties: true - example: - DISPLAY_NAME: true - DESCRIPTION: true - accessModelMetadata: - type: object - description: Additional data to classify the entitlement - properties: - attributes: - type: array - items: - type: object - description: Metadata that describes an access item - properties: - key: - type: string - description: Unique identifier for the metadata type - example: iscCsp - name: - type: string - description: Human readable name of the metadata type - example: CSP - multiselect: - type: boolean - default: false - example: true - description: Allows selecting multiple values - status: - type: string - description: The state of the metadata item - example: active - type: - type: string - description: The type of the metadata item - example: governance - objectTypes: - type: array - description: The types of objects - items: - type: string - example: general - description: - type: string - description: Describes the metadata item - example: Indicates the type of deployment environment of an access item. - values: - type: array - description: The value to assign to the metadata item - items: - type: object - description: An individual value to assign to the metadata item - properties: - value: - type: string - description: The value to assign to the metdata item - example: development - name: - type: string - description: Display name of the value - example: Development - status: - type: string - description: The status of the individual value - example: active - created: - type: string - description: Time when the entitlement was created - format: date-time - example: '2020-10-08T18:33:52.029Z' - modified: - type: string - description: Time when the entitlement was last modified - format: date-time - example: '2020-10-08T18:33:52.029Z' - source: - type: object - properties: - id: - type: string - description: The source ID - example: 2c9180827ca885d7017ca8ce28a000eb - type: - type: string - description: The source type, will always be "SOURCE" - example: SOURCE - name: - type: string - description: The source name - example: ODS-AD-Source - attributes: - type: object - description: A map of free-form key-value pairs from the source system - example: - fieldName: fieldValue - additionalProperties: true - segments: - type: array - items: - type: string - nullable: true - description: List of IDs of segments, if any, to which this Entitlement is assigned. - example: - - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - - 29cb6c06-1da8-43ea-8be4-b3125f248f2a - directPermissions: - type: array - items: - $ref: '#/paths/~1certifications~1%7BcertificationId%7D~1access-review-items~1%7BitemId%7D~1permissions/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PermissionDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:access-profile:read - - applicationAuth: - - idn:access-profile:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#get-access-profile-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Access Profile's Entitlements - - try { - Get-V2025AccessProfileEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfileEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#get-access-profile-entitlements - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121919ecca' # str | ID of the access profile containing the entitlements. # str | ID of the access profile containing the entitlements. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'attribute eq \"memberOf\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - try: - # List Access Profile's Entitlements - - results = AccessProfilesApi(api_client).get_access_profile_entitlements(id=id) - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) - print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - /access-requests: - post: - operationId: createAccessRequest - security: - - userAuth: - - idn:access-request:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - USER - summary: Submit Access Request - tags: - - Access Requests - description: | - Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. - - Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request - has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error - if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. - - It's best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can - be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also - use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting - an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. - These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. - - There are two types of access request: - - __GRANT_ACCESS__ - * Can be requested for multiple identities in a single request. - * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. - * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. - * Roles, access profiles and entitlements can be requested. - * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. - - __REVOKE_ACCESS__ - * Can only be requested for a single identity at a time. - * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. - * Does not support self request. Only manager can request to revoke access for their directly managed employees. - * If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. - * Roles, access profiles, and entitlements can be requested for revocation. - * Revoke requests for entitlements are limited to 1 entitlement per access request currently. - * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. - * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - requestedFor: - description: A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. - type: array - items: - type: string - example: 2c918084660f45d6016617daa9210584 - requestType: - $ref: '#/components/schemas/AccessRequest/properties/requestType' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestType.yaml - requestedItems: - type: array - items: - $ref: '#/components/schemas/AccessRequest/properties/requestedItems/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestItem.yaml - minItems: 1 - maxItems: 25 - clientMetadata: - type: object - additionalProperties: - type: string - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - required: - - requestedFor - - requestedItems - responses: - '202': - description: Access Request Response. - content: - application/json: - schema: - type: object - properties: - newRequests: - description: A list of new access request tracking data mapped to the values requested. - type: array - items: - type: object - properties: - requestedFor: - type: string - description: The identity id in which the access request is for. - example: 2c918084660f45d6016617daa9210584 - requestedItemsDetails: - type: array - description: The details of the item requested. - example: |- - { - "type": "ENTITLEMENT", - "id": "779c6fd7171540bba1184e5946112c28" - } - items: - type: object - properties: - type: - type: string - description: The type of access item requested. - enum: - - ACCESS_PROFILE - - ENTITLEMENT - - ROLE - example: ENTITLEMENT - id: - type: string - description: The id of the access item requested. - example: 779c6fd7171540bba1184e5946112c28 - attributesHash: - type: integer - format: int32 - description: a hash representation of the access requested, useful for longer term tracking client side. - example: -1928438224 - accessRequestIds: - type: array - items: - type: string - description: a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. - example: - - 5d3118c518a44ec7805450d53479ccdb - example: - - requestedFor: 899fd612ecfc4cf3bf48f14d0afdef89 - requestedItemsDetails: - - type: ENTITLEMENT - id: 779c6fd7171540bba1184e5946112c28 - attributesHash: -1928438224 - accessRequestIds: - - 5d3118c518a44ec7805450d53479ccdb - existingRequests: - description: A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. - type: array - items: - $ref: '#/paths/~1access-requests/post/responses/202/content/application~1json/schema/properties/newRequests/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access-requests/AccessRequestTracking.yaml - example: - - requestedFor: 899fd612ecfc4cf3bf48f14d0afdef89 - requestedItemsDetails: - - type: ROLE - id: 779c6fd7171540bbc1184e5946112c28 - attributesHash: 2843118224 - accessRequestIds: - - 5d3118c518a44ec7805450d53479ccdc - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#create-access-request - source: | - $AccessRequest = @" - { - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], - "clientMetadata" : { - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", - "requestedAppName" : "test-app" - }, - "requestType" : "GRANT_ACCESS", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - } ] - } - "@ - - # Submit Access Request - - try { - $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest - New-V2025AccessRequest -AccessRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025AccessRequest -AccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#create-access-request - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request import AccessRequest - from sailpoint.v2025.models.access_request_response import AccessRequestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], - "clientMetadata" : { - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", - "requestedAppName" : "test-app" - }, - "requestType" : "GRANT_ACCESS", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - } ] - }''' # AccessRequest | - try: - # Submit Access Request - new_access_request = AccessRequest.from_json(access_request) - results = AccessRequestsApi(api_client).create_access_request(access_request=new_access_request) - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).create_access_request(new_access_request) - print("The response of AccessRequestsApi->create_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) - /access-requests/cancel: - post: - operationId: cancelAccessRequest - security: - - userAuth: - - idn:access-request:cancel - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Access Requests - summary: Cancel Access Request - description: |- - This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. - In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - requestBody: - required: true - content: - application/json: - schema: - type: object - description: Request body payload for cancel access request endpoint. - required: - - accountActivityId - - comment - properties: - accountActivityId: - type: string - description: This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. - example: 2c9180835d2e5168015d32f890ca1581 - comment: - type: string - description: Reason for cancelling the pending access request. - example: I requested this role by mistake. - example: - accountActivityId: 2c91808568c529c60168cca6f90c1313 - comment: I requested this role by mistake. - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: object - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#cancel-access-request - source: | - $CancelAccessRequest = @" - { - "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I requested this role by mistake." - } - "@ - - # Cancel Access Request - - try { - $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest - Suspend-V2025AccessRequest -CancelAccessRequest $Result - - # Below is a request that includes all optional parameters - # Suspend-V2025AccessRequest -CancelAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025AccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#cancel-access-request - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.cancel_access_request import CancelAccessRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - cancel_access_request = '''{ - "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I requested this role by mistake." - }''' # CancelAccessRequest | - try: - # Cancel Access Request - new_cancel_access_request = CancelAccessRequest.from_json(cancel_access_request) - results = AccessRequestsApi(api_client).cancel_access_request(cancel_access_request=new_cancel_access_request) - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request) - print("The response of AccessRequestsApi->cancel_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) - /access-requests/bulk-cancel: - post: - operationId: cancelAccessRequestInBulk - security: - - userAuth: - - idn:access-request-administration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Access Requests - summary: Bulk Cancel Access Request - description: |- - This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. - Only ORG_ADMIN or users with rights "idn:access-request-administration:write" can cancel the access requests in bulk. - requestBody: - required: true - content: - application/json: - schema: - type: object - description: Request body payload for bulk cancel access request endpoint. - required: - - accessRequestIds - - comment - properties: - accessRequestIds: - type: array - description: List of access requests ids to cancel the pending requests - items: - type: string - example: - - 2c9180835d2e5168015d32f890ca1581 - - 2c9180835d2e5168015d32f890ca1582 - comment: - type: string - description: Reason for cancelling the pending access request. - example: I requested this role by mistake. - example: - accessRequestIds: - - 2c91808568c529c60168cca6f90c1313 - - 2c91808568c529c60168cca6f90c1314 - comment: I requested this role by mistake. - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#cancel-access-request-in-bulk - source: | - $BulkCancelAccessRequest = @" - { - "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], - "comment" : "I requested this role by mistake." - } - "@ - - # Bulk Cancel Access Request - - try { - $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest - Suspend-V2025AccessRequestInBulk -BulkCancelAccessRequest $Result - - # Below is a request that includes all optional parameters - # Suspend-V2025AccessRequestInBulk -BulkCancelAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025AccessRequestInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#cancel-access-request-in-bulk - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.bulk_cancel_access_request import BulkCancelAccessRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - bulk_cancel_access_request = '''{ - "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], - "comment" : "I requested this role by mistake." - }''' # BulkCancelAccessRequest | - try: - # Bulk Cancel Access Request - new_bulk_cancel_access_request = BulkCancelAccessRequest.from_json(bulk_cancel_access_request) - results = AccessRequestsApi(api_client).cancel_access_request_in_bulk(bulk_cancel_access_request=new_bulk_cancel_access_request) - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).cancel_access_request_in_bulk(new_bulk_cancel_access_request) - print("The response of AccessRequestsApi->cancel_access_request_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->cancel_access_request_in_bulk: %s\n" % e) - /access-request-config: - get: - operationId: getAccessRequestConfig - security: - - userAuth: - - idn:access-request-config:read - summary: Get Access Request Configuration - tags: - - Access Requests - description: This endpoint returns the current access-request configuration. - responses: - '200': - description: Access Request Configuration Details. - content: - application/json: - schema: - type: object - properties: - approvalsMustBeExternal: - type: boolean - description: If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. - default: false - example: true - autoApprovalEnabled: - type: boolean - description: If this is true and the requester and reviewer are the same, the request is automatically approved. - default: false - example: true - reauthorizationEnabled: - type: boolean - description: If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. - default: false - example: true - requestOnBehalfOfConfig: - type: object - properties: - allowRequestOnBehalfOfAnyoneByAnyone: - type: boolean - description: If this is true, anyone can request access for anyone. - default: false - example: true - allowRequestOnBehalfOfEmployeeByManager: - type: boolean - description: If this is true, a manager can request access for his or her direct reports. - default: false - example: true - approvalReminderAndEscalationConfig: - type: object - properties: - daysUntilEscalation: - type: integer - description: Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. - format: int32 - example: 0 - nullable: true - daysBetweenReminders: - type: integer - description: Number of days to wait between reminder notifications. - format: int32 - example: 0 - nullable: true - maxReminders: - type: integer - description: Maximum number of reminder notification to send to the reviewer before approval escalation. - format: int32 - minimum: 1 - example: 1 - nullable: true - fallbackApproverRef: - $ref: '#/components/schemas/RequestableObject/properties/ownerRef' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityReferenceWithNameAndEmail.yaml - entitlementRequestConfig: - $ref: '#/paths/~1entitlements~1%7Bid%7D~1entitlement-request-config/get/responses/200/content/application~1json/schema' - description: Entitlement request configuration. - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EntitlementRequestConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#get-access-request-config - source: | - - # Get Access Request Configuration - - try { - Get-V2025AccessRequestConfig - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#get-access-request-config - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_config import AccessRequestConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get Access Request Configuration - - results = AccessRequestsApi(api_client).get_access_request_config() - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).get_access_request_config() - print("The response of AccessRequestsApi->get_access_request_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) - put: - operationId: setAccessRequestConfig - security: - - userAuth: - - idn:access-request-config:update - x-sailpoint-userLevels: - - ORG_ADMIN - summary: Update Access Request Configuration - tags: - - Access Requests - description: This endpoint replaces the current access-request configuration. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1access-request-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestConfig.yaml - responses: - '200': - description: Access Request Configuration Details. - content: - application/json: - schema: - $ref: '#/paths/~1access-request-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#set-access-request-config - source: | - $AccessRequestConfig = @" - { - "requestOnBehalfOfConfig" : { - "allowRequestOnBehalfOfEmployeeByManager" : true, - "allowRequestOnBehalfOfAnyoneByAnyone" : true - }, - "approvalReminderAndEscalationConfig" : { - "fallbackApproverRef" : { - "name" : "Alison Ferguso", - "id" : "5168015d32f890ca15812c9180835d2e", - "type" : "IDENTITY", - "email" : "alison.ferguso@identitysoon.com" - }, - "maxReminders" : 1, - "daysUntilEscalation" : 0, - "daysBetweenReminders" : 0 - }, - "autoApprovalEnabled" : true, - "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - }, - "reauthorizationEnabled" : true, - "approvalsMustBeExternal" : true - } - "@ - - # Update Access Request Configuration - - try { - $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig - Set-V2025AccessRequestConfig -AccessRequestConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025AccessRequestConfig -AccessRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025AccessRequestConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#set-access-request-config - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_config import AccessRequestConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - access_request_config = '''{ - "requestOnBehalfOfConfig" : { - "allowRequestOnBehalfOfEmployeeByManager" : true, - "allowRequestOnBehalfOfAnyoneByAnyone" : true - }, - "approvalReminderAndEscalationConfig" : { - "fallbackApproverRef" : { - "name" : "Alison Ferguso", - "id" : "5168015d32f890ca15812c9180835d2e", - "type" : "IDENTITY", - "email" : "alison.ferguso@identitysoon.com" - }, - "maxReminders" : 1, - "daysUntilEscalation" : 0, - "daysBetweenReminders" : 0 - }, - "autoApprovalEnabled" : true, - "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - }, - "reauthorizationEnabled" : true, - "approvalsMustBeExternal" : true - }''' # AccessRequestConfig | - try: - # Update Access Request Configuration - new_access_request_config = AccessRequestConfig.from_json(access_request_config) - results = AccessRequestsApi(api_client).set_access_request_config(access_request_config=new_access_request_config) - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).set_access_request_config(new_access_request_config) - print("The response of AccessRequestsApi->set_access_request_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) - /access-request-status: - get: - operationId: listAccessRequestStatus - security: - - userAuth: - - idn:access-request-status:read - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Access Requests - summary: Access Request Status - description: |- - Use this API to return a list of access request statuses based on the specified query parameters. - If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. - Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - parameters: - - in: query - name: requested-for - schema: - type: string - example: 2c9180877b2b6ea4017b2c545f971429 - description: Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - required: false - - in: query - name: requested-by - schema: - type: string - example: 2c9180877b2b6ea4017b2c545f971429 - description: Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - required: false - - in: query - name: regarding-identity - schema: - type: string - example: 2c9180877b2b6ea4017b2c545f971429 - description: Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - required: false - - in: query - name: assigned-to - schema: - type: string - example: 2c9180877b2b6ea4017b2c545f971429 - description: Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - required: false - - in: query - name: count - description: If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - required: false - schema: - type: boolean - default: false - example: false - - in: query - name: limit - description: Max number of results to return. - required: false - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - example: 100 - - in: query - name: offset - description: Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - required: false - schema: - type: integer - format: int32 - minimum: 0 - example: 10 - - in: query - name: filters - schema: - type: string - example: accountActivityItemId eq "2c918086771c86df0177401efcdf54c0" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **accessRequestId**: *in* - - **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - - **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** - example: created - required: false - - in: query - name: request-state - schema: - type: string - example: request-state=EXECUTING - description: Filter the results by the state of the request. The only valid value is *EXECUTING*. - required: false - responses: - '200': - description: List of requested item statuses. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of the access request. As of 2025, this is a new property. Older access requests might not have an ID. - example: 2c9180926cbfbddd016cbfc7c3b10010 - nullable: true - name: - type: string - description: Human-readable display name of the item being requested. - example: AccessProfile1 - nullable: true - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - - null - description: Type of requested object. - example: ACCESS_PROFILE - nullable: true - cancelledRequestDetails: - allOf: - - type: object - properties: - comment: - type: string - description: Comment made by the owner when cancelling the associated request. - example: This request must be cancelled. - owner: - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/ownerRef/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/OwnerDto.yaml - modified: - type: string - format: date-time - description: Date comment was added by the owner when cancelling the associated request. - example: '2019-12-20T09:17:12.192Z' - description: Provides additional details for a request that has been cancelled. - - nullable: true - errorMessages: - type: array - nullable: true - items: - type: array - description: List of error messages - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorMessageDto.yaml - example: - locale: en-US - localeOrigin: DEFAULT - text: Error Message - description: List of list of localized error messages, if any, encountered during the approval/provisioning process. - state: - type: string - enum: - - EXECUTING - - REQUEST_COMPLETED - - CANCELLED - - TERMINATED - - PROVISIONING_VERIFICATION_PENDING - - REJECTED - - PROVISIONING_FAILED - - NOT_ALL_ITEMS_PROVISIONED - - ERROR - description: |- - Indicates the state of an access request: - * EXECUTING: The request is executing, which indicates the system is doing some processing. - * REQUEST_COMPLETED: Indicates the request has been completed. - * CANCELLED: The request was cancelled with no user input. - * TERMINATED: The request has been terminated before it was able to complete. - * PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified. - * REJECTED: The request was rejected. - * PROVISIONING_FAILED: The request has failed to complete. - * NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes. - * ERROR: An error occurred during request processing. - example: EXECUTING - approvalDetails: - type: array - items: - type: object - properties: - forwarded: - type: boolean - default: false - description: True if the request for this item was forwarded from one owner to another. - example: false - originalOwner: - type: object - description: Identity of orginal approval owner. - properties: - type: - type: string - description: DTO type of original approval owner's identity. - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of original approval owner's identity. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Display name of original approval owner. - example: Michael Michaels - currentOwner: - allOf: - - $ref: '#/paths/~1access-request-approvals~1completed/get/responses/200/content/application~1json/schema/items/properties/reviewedBy' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemReviewedBy.yaml - - nullable: true - modified: - type: string - format: date-time - description: Time at which item was modified. - example: '2019-08-23T18:52:57.398Z' - nullable: true - status: - type: string - enum: - - PENDING - - APPROVED - - REJECTED - - EXPIRED - - CANCELLED - - ARCHIVED - description: |- - Indicates the state of the request processing for this item: - * PENDING: The request for this item is awaiting processing. - * APPROVED: The request for this item has been approved. - * REJECTED: The request for this item was rejected. - * EXPIRED: The request for this item expired with no action taken. - * CANCELLED: The request for this item was cancelled with no user action. - * ARCHIVED: The request for this item has been archived after completion. - example: PENDING - scheme: - type: string - enum: - - APP_OWNER - - SOURCE_OWNER - - MANAGER - - ROLE_OWNER - - ACCESS_PROFILE_OWNER - - ENTITLEMENT_OWNER - - GOVERNANCE_GROUP - description: Describes the individual or group that is responsible for an approval step. - example: MANAGER - errorMessages: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorMessageDto.yaml - description: If the request failed, includes any error messages that were generated. - nullable: true - comment: - type: string - description: Comment, if any, provided by the approver. - example: I approve this request - nullable: true - removeDate: - type: string - description: The date the role or access profile or entitlement is no longer assigned to the specified identity. - format: date-time - example: '2020-07-11T00:00:00Z' - nullable: true - description: Approval details for each item. - approvalIds: - type: array - items: - type: string - description: List of approval IDs associated with the request. - example: - - 85f0cf482dd44327b593624c07906c21 - - fa57e1bfa36f41ee85e33ee59fcbeac5 - nullable: true - manualWorkItemDetails: - type: array - nullable: true - items: - type: object - properties: - forwarded: - type: boolean - default: false - description: True if the request for this item was forwarded from one owner to another. - example: true - originalOwner: - type: object - nullable: true - description: Identity of original work item owner, if the work item has been forwarded. - properties: - type: - type: string - description: DTO type of original work item owner's identity. - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of original work item owner's identity. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Display name of original work item owner. - example: Michael Michaels - currentOwner: - type: object - description: Identity of current work item owner. - nullable: true - properties: - type: - type: string - description: DTO type of current work item owner's identity. - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of current work item owner's identity. - example: 2c3780a46faadee4016fb4e018c20652 - name: - type: string - description: Display name of current work item owner. - example: Allen Albertson - modified: - type: string - format: date-time - description: Time at which item was modified. - example: '2019-08-23T18:52:57.398Z' - status: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/approvalDetails/items/properties/status' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManualWorkItemState.yaml - forwardHistory: - type: array - nullable: true - items: - $ref: '#/paths/~1access-request-approvals~1pending/get/responses/200/content/application~1json/schema/items/properties/forwardHistory/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalForwardHistory.yaml - description: The history of approval forward action. - description: Manual work items created for provisioning the item. - accountActivityItemId: - type: string - description: Id of associated account activity item. - example: 2c9180926cbfbddd016cbfc7c3b10010 - requestType: - $ref: '#/components/schemas/AccessRequest/properties/requestType' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestType.yaml - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - nullable: true - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - requester: - type: object - description: Access item requester's identity. - properties: - type: - type: string - description: Access item requester's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Access item requester's identity ID. - example: 2c7180a46faadee4016fb4e018c20648 - name: - type: string - description: Access item owner's human-readable display name. - example: William Wilson - requestedFor: - type: object - description: Identity access was requested for. - properties: - type: - type: string - enum: - - IDENTITY - description: Type of the object to which this reference applies - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - requesterComment: - allOf: - - $ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommentDto.yaml - - nullable: true - description: The requester's comment. - sodViolationContext: - allOf: - - description: An object referencing a completed SOD violation check - type: object - nullable: true - properties: - state: - type: string - enum: - - SUCCESS - - ERROR - - null - description: The status of SOD violation check - example: SUCCESS - nullable: true - uuid: - description: The id of the Violation check event - type: string - example: f73d16e9-a038-46c5-b217-1246e15fdbdd - nullable: true - violationCheckResult: - description: The inner object representing the completed SOD Violation check - type: object - properties: - message: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema/properties/messages/items' - description: If the request failed, this includes any error message that was generated. - example: - - locale: en-US - localeOrigin: DEFAULT - text: An error has occurred during the SOD violation check - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorMessageDto.yaml - clientMetadata: - type: object - nullable: true - additionalProperties: - type: string - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - example: - requestedAppName: test-app - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - violationContexts: - type: array - nullable: true - items: - description: The contextual information of the violated criteria - type: object - properties: - policy: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/sodViolationContext/allOf/0/properties/violationCheckResult/properties/violatedPolicies/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicyDto.yaml - conflictingAccessCriteria: - type: object - description: The object which contains the left and right hand side of the entitlements that got violated according to the policy. - properties: - leftCriteria: - type: object - properties: - criteriaList: - type: array - items: - description: Details of the Entitlement criteria - type: object - properties: - existing: - type: boolean - default: false - example: true - description: If the entitlement already belonged to the user or not. - type: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - example: ENTITLEMENT - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml - id: - type: string - description: Entitlement ID - example: 2c918085771e9d3301773b3cb66f6398 - name: - type: string - description: Entitlement name - example: My HR Entitlement - rightCriteria: - type: object - properties: - criteriaList: - type: array - items: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/sodViolationContext/allOf/0/properties/violationCheckResult/properties/violationContexts/items/properties/conflictingAccessCriteria/properties/leftCriteria/properties/criteriaList/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodExemptCriteria.yaml - violatedPolicies: - type: array - nullable: true - description: A list of the SOD policies that were violated. - items: - type: object - description: SOD policy. - properties: - type: - type: string - description: SOD policy DTO type. - enum: - - SOD_POLICY - example: SOD_POLICY - id: - type: string - description: SOD policy ID. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: - type: string - description: SOD policy display name. - example: Business SOD Policy - - nullable: true - description: The details of the SOD violations for the associated approval. - provisioningDetails: - allOf: - - type: object - properties: - orderedSubPhaseReferences: - type: string - description: Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain "manualWorkItemDetails" which indicate that there is further information in that object for this phase. - example: manualWorkItemDetails - description: Provides additional details about provisioning for this request. - - nullable: true - preApprovalTriggerDetails: - allOf: - - type: object - properties: - comment: - type: string - description: Comment left for the pre-approval decision - example: Access is Approved - reviewer: - type: string - description: The reviewer of the pre-approval decision - example: John Doe - decision: - type: string - enum: - - APPROVED - - REJECTED - description: The decision of the pre-approval trigger - example: APPROVED - description: Provides additional details about the pre-approval trigger for this request. - - nullable: true - accessRequestPhases: - type: array - items: - type: object - properties: - started: - type: string - description: The time that this phase started. - format: date-time - example: '2020-07-11T00:00:00Z' - finished: - type: string - description: The time that this phase finished. - format: date-time - example: '2020-07-12T00:00:00Z' - nullable: true - name: - type: string - description: The name of this phase. - example: APPROVAL_PHASE - state: - type: string - enum: - - PENDING - - EXECUTING - - COMPLETED - - CANCELLED - - NOT_EXECUTED - description: The state of this phase. - example: COMPLETED - result: - type: string - enum: - - SUCCESSFUL - - FAILED - - null - description: The state of this phase. - example: SUCCESSFUL - nullable: true - phaseReference: - type: string - description: A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. - example: approvalDetails - nullable: true - description: Provides additional details about this access request phase. - description: A list of Phases that the Access Request has gone through in order, to help determine the status of the request. - nullable: true - description: - type: string - description: Description associated to the requested object. - example: This is the Engineering role that engineers are granted. - nullable: true - removeDate: - type: string - format: date-time - nullable: true - description: When the role access is scheduled for removal. - example: '2019-10-23T00:00:00.000Z' - cancelable: - type: boolean - default: false - description: True if the request can be canceled. - example: true - accessRequestId: - type: string - description: This is the account activity id. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - clientMetadata: - nullable: true - type: object - additionalProperties: - type: string - description: Arbitrary key-value pairs, if any were included in the corresponding access request - example: - key1: value1 - key2: value2 - requestedAccounts: - nullable: true - type: array - items: - type: object - properties: - name: - type: string - description: Display name of the account for the user - example: Glen.067da3248e914 - type: - description: The type of item - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - example: ACCOUNT - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml - accountUuid: - type: string - nullable: true - description: The uuid for the account - example: '{fab7119e-004f-4822-9c33-b8d570d6c6a6}' - accountId: - type: string - nullable: true - description: The native identity for the account - example: CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local - sourceName: - type: string - nullable: false - description: Display name of the source for the account - example: Multi Account AD source name - description: The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#list-access-request-status - source: | - $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) - $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - - # Access Request Status - - try { - Get-V2025AccessRequestStatus - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#list-access-request-status - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.requested_item_status import RequestedItemStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - requested_by = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - regarding_identity = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - assigned_to = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - count = False # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) - limit = 250 # int | Max number of results to return. (optional) (default to 250) # int | Max number of results to return. (optional) (default to 250) - offset = 10 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - filters = 'accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) - request_state = 'request-state=EXECUTING' # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - try: - # Access Request Status - - results = AccessRequestsApi(api_client).list_access_request_status() - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) - print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - /access-request-administration: - get: - operationId: listAdministratorsAccessRequestStatus - security: - - userAuth: - - idn:access-request-administration:read - x-sailpoint-userLevels: - - ORG_ADMIN - - idn:access-request-administration:read - tags: - - Access Requests - summary: Access Request Status for Administrators - description: |- - Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. - Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - parameters: - - in: query - name: requested-for - schema: - type: string - example: 2c9180877b2b6ea4017b2c545f971429 - description: Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - required: false - - in: query - name: requested-by - schema: - type: string - example: 2c9180877b2b6ea4017b2c545f971429 - description: Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - required: false - - in: query - name: regarding-identity - schema: - type: string - example: 2c9180877b2b6ea4017b2c545f971429 - description: Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - required: false - - in: query - name: assigned-to - schema: - type: string - example: 2c9180877b2b6ea4017b2c545f971429 - description: Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - required: false - - in: query - name: count - description: If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - required: false - schema: - type: boolean - default: false - example: false - - in: query - name: limit - description: Max number of results to return. - required: false - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - example: 100 - - in: query - name: offset - description: Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - required: false - schema: - type: integer - format: int32 - minimum: 0 - example: 10 - - in: query - name: filters - schema: - type: string - example: accountActivityItemId eq "2c918086771c86df0177401efcdf54c0" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - - **accessRequestId**: *in* - - **status**: *in, eq, ne* - - **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** - example: created - required: false - - in: query - name: request-state - schema: - type: string - example: request-state=EXECUTING - description: Filter the results by the state of the request. The only valid value is *EXECUTING*. - required: false - responses: - '200': - description: List of requested item statuses. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. - example: 2c9180926cbfbddd016cbfc7c3b10010 - nullable: true - name: - type: string - description: Human-readable display name of the item being requested. - example: AccessProfile1 - nullable: true - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - - null - description: Type of requested object. - example: ACCESS_PROFILE - nullable: true - cancelledRequestDetails: - allOf: - - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/cancelledRequestDetails/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CancelledRequestDetails.yaml - - nullable: true - errorMessages: - type: array - nullable: true - items: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/errorMessages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorMessageDtoList.yaml - description: List of localized error messages, if any, encountered during the approval/provisioning process. - state: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/state' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RequestedItemStatusRequestState.yaml - approvalDetails: - type: array - items: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/approvalDetails/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalStatusDto.yaml - description: Approval details for each item. - manualWorkItemDetails: - type: array - nullable: true - items: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/manualWorkItemDetails/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManualWorkItemDetails.yaml - description: Manual work items created for provisioning the item. - accountActivityItemId: - type: string - description: Id of associated account activity item. - example: 2c9180926cbfbddd016cbfc7c3b10010 - requestType: - $ref: '#/components/schemas/AccessRequest/properties/requestType' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestType.yaml - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - nullable: true - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - requester: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/requester' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemRequester.yaml - requestedFor: - type: object - description: Identity access was requested for. - properties: - type: - type: string - enum: - - IDENTITY - description: Type of the object to which this reference applies - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - requesterComment: - allOf: - - $ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommentDto.yaml - - nullable: true - description: The requester's comment. - sodViolationContext: - allOf: - - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/sodViolationContext/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodViolationContextCheckCompleted.yaml - - nullable: true - description: The details of the SOD violations for the associated approval. - provisioningDetails: - allOf: - - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/provisioningDetails/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningDetails.yaml - - nullable: true - preApprovalTriggerDetails: - allOf: - - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/preApprovalTriggerDetails/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PreApprovalTriggerDetails.yaml - - nullable: true - accessRequestPhases: - type: array - items: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/accessRequestPhases/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestPhases.yaml - description: A list of Phases that the Access Request has gone through in order, to help determine the status of the request. - nullable: true - description: - type: string - description: Description associated to the requested object. - example: This is the Engineering role that engineers are granted. - nullable: true - removeDate: - type: string - format: date-time - nullable: true - description: When the role access is scheduled for removal. - example: '2019-10-23T00:00:00.000Z' - cancelable: - type: boolean - default: false - description: True if the request can be canceled. - example: true - reauthorizationRequired: - type: boolean - default: false - description: True if re-auth is required. - example: true - accessRequestId: - type: string - description: This is the account activity id. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - clientMetadata: - nullable: true - type: object - additionalProperties: - type: string - description: Arbitrary key-value pairs, if any were included in the corresponding access request - example: - key1: value1 - key2: value2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#list-administrators-access-request-status - source: | - $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) - $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - - # Access Request Status for Administrators - - try { - Get-V2025AdministratorsAccessRequestStatus - - # Below is a request that includes all optional parameters - # Get-V2025AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AdministratorsAccessRequestStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#list-administrators-access-request-status - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_admin_item_status import AccessRequestAdminItemStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - requested_by = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - regarding_identity = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - assigned_to = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - count = False # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) - limit = 250 # int | Max number of results to return. (optional) (default to 250) # int | Max number of results to return. (optional) (default to 250) - offset = 10 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - filters = 'accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) - request_state = 'request-state=EXECUTING' # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - try: - # Access Request Status for Administrators - - results = AccessRequestsApi(api_client).list_administrators_access_request_status() - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) - print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) - /access-request-approvals/pending: - get: - operationId: listPendingApprovals - security: - - userAuth: - - idn:access-request-approvals:read - x-sailpoint-userLevels: - - ORG_ADMIN - summary: Pending Access Request Approvals List - tags: - - Access Request Approvals - description: This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. - parameters: - - in: query - name: owner-id - schema: - type: string - description: |- - If present, the value returns only pending approvals for the specified identity. - * ORG_ADMIN users can call this with any identity ID value. - * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. - * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - example: 2c91808568c529c60168cca6f90c1313 - required: false - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **requestedFor.id**: *eq, in* - - **modified**: *gt, lt, ge, le, eq, in* - - **accessRequestId**: *eq, in* - example: id eq "2c91808568c529c60168cca6f90c1313" - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, modified** - example: modified - responses: - '200': - description: List of Pending Approvals. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The approval id. - example: id12345 - accessRequestId: - type: string - description: This is the access request id. - example: 2b838de9db9babcfe646d4f274ad4238 - name: - type: string - description: The name of the approval. - example: aName - created: - type: string - format: date-time - description: When the approval was created. - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: When the approval was modified last time. - example: '2018-07-25T20:22:28.104Z' - requestCreated: - type: string - format: date-time - description: When the access-request was created. - example: '2017-07-11T18:45:35.098Z' - requestType: - $ref: '#/components/schemas/AccessRequest/properties/requestType' - description: If the access-request was for granting or revoking access. - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestType.yaml - requester: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/requester' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemRequester.yaml - requestedFor: - type: object - description: Identity the access item is requested for. - properties: - type: - type: string - description: DTO type of identity the access item is requested for. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity the access item is requested for. - example: 2c4180a46faadee4016fb4e018c20626 - name: - type: string - description: Human-readable display name of identity the access item is requested for. - example: Robert Robinson - owner: - type: object - description: Access item owner's identity. - properties: - type: - type: string - description: Access item owner's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Access item owner's identity ID. - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Access item owner's human-readable display name. - example: Support - requestedObject: - type: object - properties: - id: - type: string - description: Id of the object. - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the object. - example: Applied Research Access - description: - type: string - description: Description of the object. - example: Access to research information, lab results, and schematics - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: Type of the object. - example: ROLE - requesterComment: - $ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema' - description: The requester's comment. - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommentDto.yaml - previousReviewersComments: - type: array - items: - $ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommentDto.yaml - description: The history of the previous reviewers comments. - forwardHistory: - type: array - items: - type: object - properties: - oldApproverName: - type: string - description: Display name of approver from whom the approval was forwarded. - example: Frank Mir - newApproverName: - type: string - description: Display name of approver to whom the approval was forwarded. - example: Al Volta - comment: - type: string - nullable: true - description: Comment made while forwarding. - example: Forwarding from Frank to Al - modified: - type: string - format: date-time - description: Time at which approval was forwarded. - example: '2019-08-23T18:52:57.398Z' - forwarderName: - type: string - nullable: true - description: Display name of forwarder who forwarded the approval. - example: William Wilson - reassignmentType: - type: string - enum: - - MANUAL_REASSIGNMENT - - AUTOMATIC_REASSIGNMENT - - AUTO_ESCALATION - - SELF_REVIEW_DELEGATION - description: |- - The approval reassignment type. - * MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task's owner, from their queue to someone else's. - * AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to that approver's reassignment configuration. The approver's reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time. - * AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to the request's escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html). - * SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval). - example: AUTOMATIC_REASSIGNMENT - description: The history of approval forward action. - commentRequiredWhenRejected: - type: boolean - default: false - description: When true the rejector has to provide comments when rejecting - example: true - actionInProcess: - type: string - enum: - - APPROVED - - REJECTED - - FORWARDED - description: Enum represents action that is being processed on an approval. - example: APPROVED - removeDate: - type: string - description: The date the role or access profile or entitlement is no longer assigned to the specified identity. - format: date-time - example: '2020-07-11T00:00:00Z' - removeDateUpdateRequested: - type: boolean - default: false - description: If true, then the request is to change the remove date or sunset date. - example: true - currentRemoveDate: - type: string - description: The remove date or sunset date that was assigned at the time of the request. - format: date-time - example: '2020-07-11T00:00:00Z' - sodViolationContext: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/sodViolationContext/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodViolationContextCheckCompleted.yaml - clientMetadata: - nullable: true - type: object - additionalProperties: - type: string - description: Arbitrary key-value pairs, if any were included in the corresponding access request item - example: - customKey1: custom value 1 - customKey2: custom value 2 - requestedAccounts: - nullable: true - type: array - items: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/requestedAccounts/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RequestedAccountRef.yaml - description: The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#list-pending-approvals - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Pending Access Request Approvals List - - try { - Get-V2025PendingApprovals - - # Below is a request that includes all optional parameters - # Get-V2025PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingApprovals" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#list-pending-approvals - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.pending_approval import PendingApproval - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '2c91808568c529c60168cca6f90c1313' # str | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) - sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - try: - # Pending Access Request Approvals List - - results = AccessRequestApprovalsApi(api_client).list_pending_approvals() - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) - print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - /access-request-approvals/completed: - get: - operationId: listCompletedApprovals - summary: Completed Access Request Approvals List - tags: - - Access Request Approvals - description: This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - parameters: - - in: query - name: owner-id - required: false - schema: - type: string - description: |- - If present, the value returns only completed approvals for the specified identity. - * ORG_ADMIN users can call this with any identity ID value. - * ORG_ADMIN users can also fetch all the approvals in the org, when - owner-id is not used. - * Non-ORG_ADMIN users can only specify *me* or pass their own - identity ID value. - example: 2c91808568c529c60168cca6f90c1313 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - - **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - - **modified**: *gt, lt, ge, le, eq, in, ne, sw* - example: id eq "2c91808568c529c60168cca6f90c1313" - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, modified** - example: modified - responses: - '200': - description: List of Completed Approvals. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The approval id. - example: id12345 - name: - type: string - description: The name of the approval. - example: aName - created: - type: string - format: date-time - description: When the approval was created. - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: When the approval was modified last time. - example: '2018-07-25T20:22:28.104Z' - requestCreated: - type: string - format: date-time - description: When the access-request was created. - example: '2017-07-11T18:45:35.098Z' - requestType: - $ref: '#/components/schemas/AccessRequest/properties/requestType' - description: If the access-request was for granting or revoking access. - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestType.yaml - requester: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/requester' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemRequester.yaml - requestedFor: - type: object - description: Identity access was requested for. - properties: - type: - type: string - enum: - - IDENTITY - description: Type of the object to which this reference applies - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - reviewedBy: - type: object - description: Identity who reviewed the access item request. - properties: - type: - type: string - description: DTO type of identity who reviewed the access item request. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity who reviewed the access item request. - example: 2c3780a46faadee4016fb4e018c20652 - name: - type: string - description: Human-readable display name of identity who reviewed the access item request. - example: Allen Albertson - owner: - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/ownerRef/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/OwnerDto.yaml - requestedObject: - $ref: '#/paths/~1access-request-approvals~1pending/get/responses/200/content/application~1json/schema/items/properties/requestedObject' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RequestableObjectReference.yaml - requesterComment: - allOf: - - $ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommentDto.yaml - - description: The requester's comment. - reviewerComment: - allOf: - - $ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommentDto.yaml - - description: The approval's reviewer's comment. - nullable: true - previousReviewersComments: - type: array - items: - $ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommentDto.yaml - description: The history of the previous reviewers comments. - forwardHistory: - type: array - items: - $ref: '#/paths/~1access-request-approvals~1pending/get/responses/200/content/application~1json/schema/items/properties/forwardHistory/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalForwardHistory.yaml - description: The history of approval forward action. - commentRequiredWhenRejected: - type: boolean - default: false - description: When true the rejector has to provide comments when rejecting - example: true - state: - type: string - enum: - - APPROVED - - REJECTED - description: Enum represents completed approval object's state. - example: APPROVED - removeDate: - type: string - description: The date the role or access profile or entitlement is no longer assigned to the specified identity. - format: date-time - example: '2020-07-11T00:00:00Z' - nullable: true - removeDateUpdateRequested: - type: boolean - default: false - description: If true, then the request was to change the remove date or sunset date. - example: true - currentRemoveDate: - type: string - description: The remove date or sunset date that was assigned at the time of the request. - format: date-time - example: '2020-07-11T00:00:00Z' - nullable: true - sodViolationContext: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/sodViolationContext/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodViolationContextCheckCompleted.yaml - preApprovalTriggerResult: - nullable: true - type: object - description: If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger's decision to either approve or deny the request. - properties: - comment: - type: string - description: The comment from the trigger - example: This request was autoapproved by our automated ETS subscriber - decision: - $ref: '#/paths/~1access-request-approvals~1completed/get/responses/200/content/application~1json/schema/items/properties/state' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CompletedApprovalState.yaml - reviewer: - type: string - description: The name of the approver - example: Automated AR Approval - date: - type: string - format: date-time - example: '2022-06-07T19:18:40.748Z' - description: The date and time the trigger decided on the request - clientMetadata: - type: object - additionalProperties: - type: string - description: Arbitrary key-value pairs provided during the request. - example: - requestedAppName: test-app - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAccounts: - nullable: true - type: array - items: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/requestedAccounts/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RequestedAccountRef.yaml - description: The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#list-completed-approvals - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Completed Access Request Approvals List - - try { - Get-V2025CompletedApprovals - - # Below is a request that includes all optional parameters - # Get-V2025CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompletedApprovals" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#list-completed-approvals - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.completed_approval import CompletedApproval - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '2c91808568c529c60168cca6f90c1313' # str | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) - sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - try: - # Completed Access Request Approvals List - - results = AccessRequestApprovalsApi(api_client).list_completed_approvals() - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) - print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - /access-request-approvals/{approvalId}/approve: - post: - operationId: approveAccessRequest - security: - - userAuth: - - idn:access-request-approvals:read - x-sailpoint-userLevels: - - ORG_ADMIN - - APPROVAL_OWNER - summary: Approve Access Request Approval - tags: - - Access Request Approvals - description: Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - parameters: - - in: path - name: approvalId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPendingApprovals - description: Approval ID. - example: 2c91808b7294bea301729568c68c002e - requestBody: - description: Reviewer's comment. - required: false - content: - application/json: - schema: - type: object - properties: - comment: - type: string - nullable: true - description: Comment content. - example: This is a comment. - created: - type: string - format: date-time - description: Date and time comment was created. - example: '2017-07-11T18:45:37.098Z' - author: - type: object - readOnly: true - description: Author of the comment - properties: - type: - type: string - enum: - - IDENTITY - example: IDENTITY - description: The type of object - id: - type: string - description: The unique ID of the object - example: 2c9180847e25f377017e2ae8cae4650b - name: - type: string - description: The display name of the object - example: john.doe - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#approve-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $CommentDto = @" - { - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - } - "@ - - # Approve Access Request Approval - - try { - Approve-V2025AccessRequest -ApprovalId $ApprovalId - - # Below is a request that includes all optional parameters - # Approve-V2025AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025AccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#approve-access-request - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.comment_dto import CommentDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - comment_dto = '''{ - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - }''' # CommentDto | Reviewer's comment. (optional) - try: - # Approve Access Request Approval - - results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id=approval_id) - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto) - print("The response of AccessRequestApprovalsApi->approve_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) - /access-request-approvals/{approvalId}/reject: - post: - operationId: rejectAccessRequest - summary: Reject Access Request Approval - tags: - - Access Request Approvals - description: Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - parameters: - - in: path - name: approvalId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPendingApprovals - description: Approval ID. - example: 2c91808b7294bea301729568c68c002e - requestBody: - description: Reviewer's comment. - required: true - content: - application/json: - schema: - $ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommentDto.yaml - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#reject-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $CommentDto = @" - { - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - } - "@ - - # Reject Access Request Approval - - try { - $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Deny-V2025AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - - # Below is a request that includes all optional parameters - # Deny-V2025AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025AccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#reject-access-request - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.comment_dto import CommentDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - comment_dto = '''{ - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - }''' # CommentDto | Reviewer's comment. - try: - # Reject Access Request Approval - new_comment_dto = CommentDto.from_json(comment_dto) - results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id=approval_id, comment_dto=new_comment_dto) - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto) - print("The response of AccessRequestApprovalsApi->reject_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) - /access-request-approvals/{approvalId}/forward: - post: - operationId: forwardAccessRequest - summary: Forward Access Request Approval - tags: - - Access Request Approvals - description: Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - parameters: - - in: path - name: approvalId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPendingApprovals - description: Approval ID. - example: 2c91808b7294bea301729568c68c002e - requestBody: - description: Information about the forwarded approval. - required: true - content: - application/json: - schema: - type: object - required: - - newOwnerId - - comment - properties: - newOwnerId: - type: string - description: The Id of the new owner - example: 2c91808568c529c60168cca6f90c1314 - minLength: 1 - maxLength: 255 - comment: - type: string - description: The comment provided by the forwarder - example: 2c91808568c529c60168cca6f90c1313 - minLength: 1 - maxLength: 255 - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#forward-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $ForwardApprovalDto = @" - { - "newOwnerId" : "2c91808568c529c60168cca6f90c1314", - "comment" : "2c91808568c529c60168cca6f90c1313" - } - "@ - - # Forward Access Request Approval - - try { - $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto - Invoke-V2025ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ForwardAccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#forward-access-request - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.forward_approval_dto import ForwardApprovalDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - forward_approval_dto = '''{ - "newOwnerId" : "2c91808568c529c60168cca6f90c1314", - "comment" : "2c91808568c529c60168cca6f90c1313" - }''' # ForwardApprovalDto | Information about the forwarded approval. - try: - # Forward Access Request Approval - new_forward_approval_dto = ForwardApprovalDto.from_json(forward_approval_dto) - results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id=approval_id, forward_approval_dto=new_forward_approval_dto) - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, new_forward_approval_dto) - print("The response of AccessRequestApprovalsApi->forward_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) - /access-request-approvals/approval-summary: - get: - operationId: getAccessRequestApprovalSummary - security: - - userAuth: - - idn:access-request-approvals-summary:read - summary: Get Access Requests Approvals Number - tags: - - Access Request Approvals - description: Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. - parameters: - - in: query - name: owner-id - schema: - type: string - description: |- - The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. - * ORG_ADMIN users can call this with any identity ID value. - * ORG_ADMIN user can also fetch all the approvals in the org, when - owner-id is not used. - * Non ORG_ADMIN users can only specify *me* or pass their own - identity ID value. - example: 2c91808568c529c60168cca6f90c1313 - required: false - - in: query - name: from-date - schema: - type: string - description: This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - example: from-date=2020-03-19T19:59:11Z - required: false - responses: - '200': - description: Number of pending, approved, rejected access request approvals. - content: - application/json: - schema: - type: object - properties: - pending: - type: integer - description: The number of pending access requests approvals. - format: int32 - example: 0 - approved: - type: integer - description: The number of approved access requests approvals. - format: int32 - example: 0 - rejected: - type: integer - description: The number of rejected access requests approvals. - format: int32 - example: 0 - '400': - description: Client Error - Returned if the query parameter is invalid. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#get-access-request-approval-summary - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) - - # Get Access Requests Approvals Number - - try { - Get-V2025AccessRequestApprovalSummary - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestApprovalSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#get-access-request-approval-summary - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.approval_summary import ApprovalSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '2c91808568c529c60168cca6f90c1313' # str | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - from_date = 'from-date=2020-03-19T19:59:11Z' # str | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # str | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) - try: - # Get Access Requests Approvals Number - - results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary() - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary(owner_id, from_date) - print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) - /access-request-approvals/bulk-approve: - post: - operationId: approveBulkAccessRequest - security: - - userAuth: - - idn:access-request-administration:write - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Access Requests - summary: Bulk Approve Access Request - description: This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights "idn:access-request-administration:write" can approve the access requests in bulk. - requestBody: - required: true - content: - application/json: - schema: - type: object - description: Request body payload for bulk approve access request endpoint. - required: - - approvalIds - - comment - properties: - approvalIds: - type: array - description: List of approval ids to approve the pending requests - items: - type: string - example: - - 2c9180835d2e5168015d32f890ca1581 - - 2c9180835d2e5168015d32f890ca1582 - comment: - type: string - description: Reason for approving the pending access request. - example: I approve these request items - example: - accessRequestIds: - - 2c91808568c529c60168cca6f90c1313 - - 2c91808568c529c60168cca6f90c1314 - comment: I approve these request items - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#approve-bulk-access-request - source: | - $BulkApproveAccessRequest = @" - { - "comment" : "I approve these request items", - "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] - } - "@ - - # Bulk Approve Access Request - - try { - $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest - Approve-V2025BulkAccessRequest -BulkApproveAccessRequest $Result - - # Below is a request that includes all optional parameters - # Approve-V2025BulkAccessRequest -BulkApproveAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025BulkAccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#approve-bulk-access-request - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.bulk_approve_access_request import BulkApproveAccessRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - bulk_approve_access_request = '''{ - "comment" : "I approve these request items", - "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] - }''' # BulkApproveAccessRequest | - try: - # Bulk Approve Access Request - new_bulk_approve_access_request = BulkApproveAccessRequest.from_json(bulk_approve_access_request) - results = AccessRequestsApi(api_client).approve_bulk_access_request(bulk_approve_access_request=new_bulk_approve_access_request) - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).approve_bulk_access_request(new_bulk_approve_access_request) - print("The response of AccessRequestsApi->approve_bulk_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->approve_bulk_access_request: %s\n" % e) - /access-request-approvals/{accessRequestId}/approvers: - get: - operationId: listAccessRequestApprovers - security: - - userAuth: - - idn:access-request-administration:read - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Access Request Approvals - summary: Access Request Approvers - description: | - This API endpoint returns the list of approvers for the given access request id. - parameters: - - in: path - name: accessRequestId - description: Access Request ID. - required: true - x-sailpoint-resource-operation-id: listPendingApprovals - schema: - type: string - example: 2c91808568c529c60168cca6f90c1313 - - in: query - name: limit - description: Max number of results to return. - required: false - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 250 - example: 100 - - in: query - name: offset - description: Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - required: false - schema: - type: integer - format: int32 - minimum: 0 - example: 10 - - in: query - name: count - description: If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - required: false - schema: - type: boolean - default: false - example: false - responses: - '200': - description: List of Approvers. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Approver id. - example: id12345 - email: - type: string - description: Email of the approver. - example: jdoe@sailpoint.com - name: - type: string - description: Name of the approver. - example: John Doe - approvalId: - type: string - description: Id of the approval item. - example: ap12345 - type: - type: string - description: Type of the object returned. In this case, the value for this field will always Identity. - example: Identity - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#list-access-request-approvers - source: | - $AccessRequestId = "2c91808568c529c60168cca6f90c1313" # String | Access Request ID. - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - - # Access Request Approvers - - try { - Get-V2025AccessRequestApprovers -AccessRequestId $AccessRequestId - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestApprovers -AccessRequestId $AccessRequestId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestApprovers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-approvals#list-access-request-approvers - source: | - from sailpoint.v2025.api.access_request_approvals_api import AccessRequestApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_approvers_list_response import AccessRequestApproversListResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - access_request_id = '2c91808568c529c60168cca6f90c1313' # str | Access Request ID. # str | Access Request ID. - limit = 250 # int | Max number of results to return. (optional) (default to 250) # int | Max number of results to return. (optional) (default to 250) - offset = 10 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - count = False # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) - try: - # Access Request Approvers - - results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id=access_request_id) - # Below is a request that includes all optional parameters - # results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count) - print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) - /accounts: - get: - operationId: listAccounts - tags: - - Accounts - summary: Accounts List - description: 'List accounts. ' - security: - - userAuth: - - idn:accounts:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - HELPDESK - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: detailLevel - required: false - schema: - type: string - enum: - - SLIM - - FULL - description: This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - example: FULL - - in: query - name: filters - required: false - schema: - type: string - example: identityId eq "2c9180858082150f0180893dbaf44201" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in, sw* - - **identityId**: *eq, in, sw* - - **name**: *eq, in, sw* - - **nativeIdentity**: *eq, in, sw* - - **hasEntitlements**: *eq* - - **sourceId**: *eq, in, sw* - - **uncorrelated**: *eq* - - **entitlements**: *eq* - - **origin**: *eq, in* - - **manuallyCorrelated**: *eq* - - **identity.name**: *eq, in, sw* - - **identity.correlated**: *eq* - - **identity.identityState**: *eq, in* - - **source.displayableName**: *eq, in* - - **source.authoritative**: *eq* - - **source.connectionType**: *eq, in* - - **recommendation.method**: *eq, in, isnull* - - **created**: *eq, ge, gt, le, lt* - - **modified**: *eq, ge, gt, le, lt* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: id,name - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - responses: - '200': - description: List of account objects. - content: - application/json: - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Account/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - - type: object - required: - - sourceId - - sourceName - - attributes - - authoritative - - disabled - - locked - - nativeIdentity - - systemAccount - - uncorrelated - - manuallyCorrelated - - hasEntitlements - properties: - sourceId: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - description: The unique ID of the source this account belongs to - sourceName: - type: string - nullable: true - example: Employees - description: The display name of the source this account belongs to - identityId: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - description: The unique ID of the identity this account is correlated to - cloudLifecycleState: - type: string - nullable: true - example: active - description: The lifecycle state of the identity this account is correlated to - identityState: - type: string - nullable: true - example: ACTIVE - description: The identity state of the identity this account is correlated to - connectionType: - type: string - nullable: true - example: direct - description: The connection type of the source this account is from - isMachine: - type: boolean - default: false - description: Indicates if the account is of machine type - example: true - recommendation: - allOf: - - $ref: '#/components/schemas/Account/allOf/1/properties/recommendation/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Recommendation.yaml - - nullable: true - description: Indicates that the account is currently classified to be one type but is recommended to be a different one - example: - type: MACHINE - method: DISCOVERY - attributes: - type: object - nullable: true - additionalProperties: true - description: The account attributes that are aggregated - example: - firstName: SailPoint - lastName: Support - displayName: SailPoint Support - authoritative: - type: boolean - description: Indicates if this account is from an authoritative source - example: false - description: - type: string - description: A description of the account - nullable: true - example: null - disabled: - type: boolean - description: Indicates if the account is currently disabled - example: false - locked: - type: boolean - description: Indicates if the account is currently locked - example: false - nativeIdentity: - type: string - description: The unique ID of the account generated by the source system - example: '552775' - systemAccount: - type: boolean - example: false - description: If true, this is a user account within IdentityNow. If false, this is an account from a source system. - uncorrelated: - type: boolean - description: Indicates if this account is not correlated to an identity - example: false - uuid: - type: string - description: The unique ID of the account as determined by the account schema - example: '{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}' - nullable: true - manuallyCorrelated: - type: boolean - description: Indicates if the account has been manually correlated to an identity - example: false - hasEntitlements: - type: boolean - description: Indicates if the account has entitlements - example: true - identity: - description: The identity this account is correlated to - type: object - properties: - id: - type: string - description: The ID of the identity - example: 2c918084660f45d6016617daa9210584 - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - name: - type: string - description: display name of identity - example: John Doe - sourceOwner: - type: object - nullable: true - description: The owner of the source this account belongs to. - properties: - id: - type: string - description: The ID of the identity - example: 2c918084660f45d6016617daa9210584 - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - name: - type: string - description: display name of identity - example: Adam Kennedy - features: - type: string - description: A string list containing the owning source's features - example: ENABLE - nullable: true - origin: - type: string - nullable: true - enum: - - AGGREGATED - - PROVISIONED - - null - description: The origin of the account either aggregated or provisioned - example: AGGREGATED - ownerIdentity: - allOf: - - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml - - description: The identity who owns this account, used only for machine accounts - nullable: true - example: - id: 2c918084660f45d6016617daa9210584 - type: IDENTITY - name: Adam Kennedy - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#list-accounts - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) - - # Accounts List - - try { - Get-V2025Accounts - - # Below is a request that includes all optional parameters - # Get-V2025Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Accounts" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#list-accounts - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account import Account - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - detail_level = 'FULL' # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) - filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) - try: - # Accounts List - - results = AccountsApi(api_client).list_accounts() - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) - print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - post: - operationId: createAccount - tags: - - Accounts - summary: Create Account - description: | - Submit an account creation task - the API then returns the task ID. - - You must include the `sourceId` where the account will be created in the `attributes` object. - - This endpoint creates an account on the source record in your ISC tenant. - This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. - - However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. - The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. - - By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - security: - - userAuth: - - idn:accounts:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - attributes - properties: - attributes: - description: The schema attribute values for the account - type: object - required: - - sourceId - properties: - sourceId: - type: string - description: Target source to create an account - example: 34bfcbe116c9407464af37acbaf7a4dc - additionalProperties: - type: string - example: - sourceId: 34bfcbe116c9407464af37acbaf7a4dc - city: Austin - displayName: John Doe - userName: jdoe - sAMAccountName: jDoe - mail: john.doe@sailpoint.com - responses: - '202': - description: Async task details. - content: - application/json: - schema: - description: Accounts async response containing details on started async process - required: - - id - type: object - properties: - id: - description: id of the task - type: string - example: 2c91808474683da6017468693c260195 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#create-account - source: | - $AccountAttributesCreate = @" - { - "attributes" : { - "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - } - "@ - - # Create Account - - try { - $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate - New-V2025Account -AccountAttributesCreate $Result - - # Below is a request that includes all optional parameters - # New-V2025Account -AccountAttributesCreate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#create-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_attributes_create import AccountAttributesCreate - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_attributes_create = '''{ - "attributes" : { - "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - }''' # AccountAttributesCreate | - try: - # Create Account - new_account_attributes_create = AccountAttributesCreate.from_json(account_attributes_create) - results = AccountsApi(api_client).create_account(account_attributes_create=new_account_attributes_create) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).create_account(new_account_attributes_create) - print("The response of AccountsApi->create_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->create_account: %s\n" % e) - /accounts/{id}: - get: - operationId: getAccount - tags: - - Accounts - summary: Account Details - description: 'Use this API to return the details for a single account by its ID. ' - security: - - userAuth: - - idn:accounts:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - HELPDESK - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listAccounts - description: Account ID. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Account object. - content: - application/json: - schema: - $ref: '#/paths/~1accounts/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Account.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#get-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - - # Account Details - - try { - Get-V2025Account -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Account -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#get-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account import Account - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. - try: - # Account Details - - results = AccountsApi(api_client).get_account(id=id) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).get_account(id) - print("The response of AccountsApi->get_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->get_account: %s\n" % e) - patch: - operationId: updateAccount - tags: - - Accounts - summary: Update Account - description: | - Use this API to update account details. - - This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. - To reassign an account from one identity to another, replace the current `identityId` with a new value. - If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account - for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, - this causes the previous identity to become uncorrelated and can even result in its deletion. - All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. - - >**Note:** The `attributes` field can only be modified for flat file accounts. - security: - - userAuth: - - idn:accounts:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listAccounts - description: Account ID. - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - content: - application/json-patch+json: - schema: - type: array - items: - type: object - examples: - Uncorrelate account: - description: Remove account from Identity - value: - - op: remove - path: /identityId - Reassign account: - description: Move account from one Identity to another Identity - value: - - op: replace - path: /identityId - value: 2c9180857725c14301772a93bb77242d - Add account attribute: - description: Add flat file account's attribute - value: - - op: add - path: /attributes/familyName - value: Smith - Replace account attribute: - description: Replace flat file account's attribute - value: - - op: replace - path: /attributes/familyName - value: Smith - Remove account attribute: - description: Remove flat file account's attribute - value: - - op: remove - path: /attributes/familyName - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#update-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"[{op=remove, path=/identityId}]"@ - - - # Update Account - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025Account -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025Account -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#update-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. - request_body = '''[{op=remove, path=/identityId}]''' # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - try: - # Update Account - new_request_body = RequestBody.from_json(request_body) - results = AccountsApi(api_client).update_account(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).update_account(id, new_request_body) - print("The response of AccountsApi->update_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->update_account: %s\n" % e) - put: - operationId: putAccount - tags: - - Accounts - summary: Update Account - description: | - Use this API to update an account with a PUT request. - - This endpoint submits an account update task and returns the task ID. - - >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - security: - - userAuth: - - idn:accounts:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listAccounts - description: Account ID. - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - attributes - properties: - attributes: - description: The schema attribute values for the account - type: object - additionalProperties: true - example: - city: Austin - displayName: John Doe - userName: jdoe - sAMAccountName: jDoe - mail: john.doe@sailpoint.com - responses: - '202': - description: Async task details. - content: - application/json: - schema: - $ref: '#/paths/~1accounts/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccountsAsyncResult.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#put-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - $AccountAttributes = @" - { - "attributes" : { - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - } - "@ - - # Update Account - - try { - $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes - Send-V2025Account -Id $Id -AccountAttributes $Result - - # Below is a request that includes all optional parameters - # Send-V2025Account -Id $Id -AccountAttributes $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#put-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_attributes import AccountAttributes - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. - account_attributes = '''{ - "attributes" : { - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - }''' # AccountAttributes | - try: - # Update Account - new_account_attributes = AccountAttributes.from_json(account_attributes) - results = AccountsApi(api_client).put_account(id=id, account_attributes=new_account_attributes) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).put_account(id, new_account_attributes) - print("The response of AccountsApi->put_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->put_account: %s\n" % e) - delete: - operationId: deleteAccount - tags: - - Accounts - summary: Delete Account - description: |- - Use this API to delete an account. - This endpoint submits an account delete task and returns the task ID. - This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. - >**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** - security: - - userAuth: - - idn:accounts:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listAccounts - description: Account ID. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - description: Async task details. - content: - application/json: - schema: - $ref: '#/paths/~1accounts/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccountsAsyncResult.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#delete-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - - # Delete Account - - try { - Remove-V2025Account -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Account -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#delete-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. - try: - # Delete Account - - results = AccountsApi(api_client).delete_account(id=id) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).delete_account(id) - print("The response of AccountsApi->delete_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->delete_account: %s\n" % e) - /accounts/{id}/entitlements: - get: - operationId: getAccountEntitlements - tags: - - Accounts - summary: Account Entitlements - description: 'This API returns entitlements of the account. ' - security: - - userAuth: - - idn:accounts:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - HELPDESK - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listAccounts - description: The account id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: An array of account entitlements - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#get-account-entitlements - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Account Entitlements - - try { - Get-V2025AccountEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#get-account-entitlements - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Account Entitlements - - results = AccountsApi(api_client).get_account_entitlements(id=id) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) - print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - /accounts/{id}/reload: - post: - operationId: submitReloadAccount - tags: - - Accounts - summary: Reload Account - description: 'This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. ' - security: - - userAuth: - - idn:accounts-state:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - HELPDESK - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listAccounts - description: The account id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - description: Async task details - content: - application/json: - schema: - $ref: '#/paths/~1accounts/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccountsAsyncResult.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#submit-reload-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - - # Reload Account - - try { - Submit-V2025ReloadAccount -Id $Id - - # Below is a request that includes all optional parameters - # Submit-V2025ReloadAccount -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025ReloadAccount" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#submit-reload-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - try: - # Reload Account - - results = AccountsApi(api_client).submit_reload_account(id=id) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).submit_reload_account(id) - print("The response of AccountsApi->submit_reload_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) - /accounts/{id}/enable: - post: - operationId: enableAccount - tags: - - Accounts - summary: Enable Account - description: 'This API submits a task to enable account and returns the task ID. ' - security: - - userAuth: - - idn:accounts-state:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - HELPDESK - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listAccounts - description: The account id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - description: Request used for account enable/disable - type: object - properties: - externalVerificationId: - description: If set, an external process validates that the user wants to proceed with this request. - type: string - example: 3f9180835d2e5168015d32f890ca1581 - forceProvisioning: - description: If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow. - type: boolean - example: false - responses: - '202': - description: Async task details - content: - application/json: - schema: - $ref: '#/paths/~1accounts/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccountsAsyncResult.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $AccountToggleRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } - "@ - - # Enable Account - - try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Enable-V2025Account -Id $Id -AccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Enable-V2025Account -Id $Id -AccountToggleRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#enable-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_toggle_request import AccountToggleRequest - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - account_toggle_request = '''{ - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - }''' # AccountToggleRequest | - try: - # Enable Account - new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request) - results = AccountsApi(api_client).enable_account(id=id, account_toggle_request=new_account_toggle_request) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).enable_account(id, new_account_toggle_request) - print("The response of AccountsApi->enable_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->enable_account: %s\n" % e) - /accounts/{id}/disable: - post: - operationId: disableAccount - tags: - - Accounts - summary: Disable Account - description: 'This API submits a task to disable the account and returns the task ID. ' - security: - - userAuth: - - idn:accounts-state:manage - x-sailpont-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - HELPDESK - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listAccounts - description: The account id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1accounts~1%7Bid%7D~1enable/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccountToggleRequest.yaml - responses: - '202': - description: Async task details - content: - application/json: - schema: - $ref: '#/paths/~1accounts/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccountsAsyncResult.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $AccountToggleRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } - "@ - - # Disable Account - - try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Disable-V2025Account -Id $Id -AccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Disable-V2025Account -Id $Id -AccountToggleRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#disable-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_toggle_request import AccountToggleRequest - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - account_toggle_request = '''{ - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - }''' # AccountToggleRequest | - try: - # Disable Account - new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request) - results = AccountsApi(api_client).disable_account(id=id, account_toggle_request=new_account_toggle_request) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).disable_account(id, new_account_toggle_request) - print("The response of AccountsApi->disable_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->disable_account: %s\n" % e) - /accounts/{id}/unlock: - post: - operationId: unlockAccount - tags: - - Accounts - summary: Unlock Account - description: |- - This API submits a task to unlock an account and returns the task ID. - To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - security: - - userAuth: - - idn:accounts-state:manage - - idn:accounts-provisioning:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - HELPDESK - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listAccounts - description: The account ID. - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - description: Request used for account unlock - type: object - properties: - externalVerificationId: - description: If set, an external process validates that the user wants to proceed with this request. - type: string - example: 3f9180835d2e5168015d32f890ca1581 - unlockIDNAccount: - description: If set, the IDN account is unlocked after the workflow completes. - type: boolean - example: false - forceProvisioning: - description: If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. - type: boolean - example: false - responses: - '202': - description: Async task details - content: - application/json: - schema: - $ref: '#/paths/~1accounts/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccountsAsyncResult.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#unlock-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. - $AccountUnlockRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", - "unlockIDNAccount" : false - } - "@ - - # Unlock Account - - try { - $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest - Unlock-V2025Account -Id $Id -AccountUnlockRequest $Result - - # Below is a request that includes all optional parameters - # Unlock-V2025Account -Id $Id -AccountUnlockRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2025Account" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#unlock-account - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_unlock_request import AccountUnlockRequest - from sailpoint.v2025.models.accounts_async_result import AccountsAsyncResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. - account_unlock_request = '''{ - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", - "unlockIDNAccount" : false - }''' # AccountUnlockRequest | - try: - # Unlock Account - new_account_unlock_request = AccountUnlockRequest.from_json(account_unlock_request) - results = AccountsApi(api_client).unlock_account(id=id, account_unlock_request=new_account_unlock_request) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).unlock_account(id, new_account_unlock_request) - print("The response of AccountsApi->unlock_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->unlock_account: %s\n" % e) - /account-activities: - get: - operationId: listAccountActivities - tags: - - Account Activities - summary: List Account Activities - description: This gets a collection of account activities that satisfy the given query parameters. - parameters: - - in: query - name: requested-for - schema: - type: string - description: The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - required: false - example: 2c91808568c529c60168cca6f90c1313 - - in: query - name: requested-by - schema: - type: string - description: The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - required: false - example: 2c91808568c529c60168cca6f90c1313 - - in: query - name: regarding-identity - schema: - type: string - description: The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - required: false - example: 2c91808568c529c60168cca6f90c1313 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **type**: *eq, in, ge, le, lt, ne, isnull, sw* - - **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - - **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - example: type eq "Identity Refresh" - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **type, created, modified** - example: created - required: false - responses: - '200': - description: List of account activities - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Id of the account activity - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: The name of the activity - example: 2c9180835d2e5168015d32f890ca1581 - created: - description: When the activity was first created - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - description: When the activity was last modified - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - nullable: true - completed: - description: When the activity was completed - type: string - format: date-time - nullable: true - example: '2018-10-19T13:49:37.385Z' - completionStatus: - $ref: '#/components/schemas/AccountActivity/properties/completionStatus' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CompletionStatus.yaml - type: - nullable: true - type: string - example: appRequest - description: | - The type of action the activity performed. Please see the following list of types. This list may grow over time. - - - CloudAutomated - - IdentityAttributeUpdate - - appRequest - - LifecycleStateChange - - AccountStateUpdate - - AccountAttributeUpdate - - CloudPasswordRequest - - Attribute Synchronization Refresh - - Certification - - Identity Refresh - - Lifecycle Change Refresh - - - [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). - requesterIdentitySummary: - $ref: '#/components/schemas/AccountActivity/properties/requesterIdentitySummary' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentitySummary.yaml - targetIdentitySummary: - $ref: '#/components/schemas/AccountActivity/properties/requesterIdentitySummary' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentitySummary.yaml - errors: - nullable: true - description: A list of error messages, if any, that were encountered. - type: array - items: - type: string - example: - - 'sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.' - warnings: - nullable: true - description: A list of warning messages, if any, that were encountered. - type: array - items: - type: string - example: - - Some warning, another warning - items: - nullable: true - type: array - description: Individual actions performed as part of this account activity - items: - $ref: '#/components/schemas/AccountActivity/properties/items/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccountActivityItem.yaml - executionStatus: - $ref: '#/components/schemas/AccountActivity/properties/executionStatus' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ExecutionStatus.yaml - clientMetadata: - nullable: true - type: object - additionalProperties: - type: string - description: Arbitrary key-value pairs, if any were included in the corresponding access request - example: - customKey1: custom value 1 - customKey2: custom value 2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-activities#list-account-activities - source: | - $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) - - # List Account Activities - - try { - Get-V2025AccountActivities - - # Below is a request that includes all optional parameters - # Get-V2025AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountActivities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-activities#list-account-activities - source: | - from sailpoint.v2025.api.account_activities_api import AccountActivitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_activity import AccountActivity - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = '2c91808568c529c60168cca6f90c1313' # str | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - requested_by = '2c91808568c529c60168cca6f90c1313' # str | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - regarding_identity = '2c91808568c529c60168cca6f90c1313' # str | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'type eq \"Identity Refresh\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) - sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) - try: - # List Account Activities - - results = AccountActivitiesApi(api_client).list_account_activities() - # Below is a request that includes all optional parameters - # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) - print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - /account-activities/{id}: - get: - operationId: getAccountActivity - tags: - - Account Activities - summary: Get an Account Activity - description: This gets a single account activity by its id. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listAccountActivities - description: The account activity id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: An account activity object - content: - application/json: - schema: - $ref: '#/paths/~1account-activities/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccountActivity.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-activities#get-account-activity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id - - # Get an Account Activity - - try { - Get-V2025AccountActivity -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccountActivity -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountActivity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-activities#get-account-activity - source: | - from sailpoint.v2025.api.account_activities_api import AccountActivitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_activity import AccountActivity - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id - try: - # Get an Account Activity - - results = AccountActivitiesApi(api_client).get_account_activity(id=id) - # Below is a request that includes all optional parameters - # results = AccountActivitiesApi(api_client).get_account_activity(id) - print("The response of AccountActivitiesApi->get_account_activity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) - /auth-org/network-config: - get: - operationId: getAuthOrgNetworkConfig - tags: - - Global Tenant Security Settings - summary: Get security network configuration. - description: This API returns the details of an org's network auth configuration. - security: - - userAuth: - - sp:auth-org:read - responses: - '200': - description: Network configuration for the tenant's auth org. - content: - application/json: - schema: - type: object - properties: - range: - type: array - description: The collection of ip ranges. - items: - type: string - example: - - 1.3.7.2 - - 255.255.255.252/30 - nullable: true - geolocation: - type: array - description: The collection of country codes. - items: - type: string - example: - - CA - - FR - - HT - nullable: true - whitelisted: - type: boolean - description: Denotes whether the provided lists are whitelisted or blacklisted for geo location. - default: false - example: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-network-config - source: | - - # Get security network configuration. - - try { - Get-V2025AuthOrgNetworkConfig - - # Below is a request that includes all optional parameters - # Get-V2025AuthOrgNetworkConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#get-auth-org-network-config - source: | - from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.network_configuration import NetworkConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get security network configuration. - - results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config() - # Below is a request that includes all optional parameters - # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config() - print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) - post: - operationId: createAuthOrgNetworkConfig - tags: - - Global Tenant Security Settings - summary: Create security network configuration. - description: 'This API returns the details of an org''s network auth configuration. Requires security scope of: ''sp:auth-org:manage''' - security: - - userAuth: - - sp:auth-org:manage - requestBody: - required: true - description: |- - Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: - 1. Each string element in the range array must be a valid ip address or - ip subnet mask. - 2. Each string element in the geolocation array must be 2 characters, - and they can only be uppercase letters. - content: - application/json: - schema: - $ref: '#/paths/~1auth-org~1network-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/NetworkConfiguration.yaml - responses: - '200': - description: Network configuration for the tenant. - content: - application/json: - schema: - $ref: '#/paths/~1auth-org~1network-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/NetworkConfiguration.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#create-auth-org-network-config - source: | - $NetworkConfiguration = @" - { - "range" : [ "1.3.7.2", "255.255.255.252/30" ], - "whitelisted" : true, - "geolocation" : [ "CA", "FR", "HT" ] - } - "@ - - # Create security network configuration. - - try { - $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration - New-V2025AuthOrgNetworkConfig -NetworkConfiguration $Result - - # Below is a request that includes all optional parameters - # New-V2025AuthOrgNetworkConfig -NetworkConfiguration $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#create-auth-org-network-config - source: | - from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.network_configuration import NetworkConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - network_configuration = '''{ - "range" : [ "1.3.7.2", "255.255.255.252/30" ], - "whitelisted" : true, - "geolocation" : [ "CA", "FR", "HT" ] - }''' # NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - try: - # Create security network configuration. - new_network_configuration = NetworkConfiguration.from_json(network_configuration) - results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(network_configuration=new_network_configuration) - # Below is a request that includes all optional parameters - # results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(new_network_configuration) - print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) - patch: - operationId: patchAuthOrgNetworkConfig - tags: - - Global Tenant Security Settings - summary: Update security network configuration. - description: |- - This API updates an existing network configuration for an org using PATCH - Requires security scope of: 'sp:auth-org:manage' - security: - - userAuth: - - sp:auth-org:manage - requestBody: - required: true - description: |- - A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - Ensures that the patched Network Config conforms to certain logical guidelines, which are: - 1. Each string element in the range array must be a valid ip address or - ip subnet mask. - 2. Each string element in the geolocation array must be 2 characters, - and they can only be uppercase letters. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /whitelisted - value: false, - - op: add - path: /geolocation - value: - - AF - - HN - - ES - responses: - '200': - description: Updated Auth Org network configuration. - content: - application/json: - schema: - $ref: '#/paths/~1auth-org~1network-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/NetworkConfiguration.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-network-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update security network configuration. - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025AuthOrgNetworkConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025AuthOrgNetworkConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#patch-auth-org-network-config - source: | - from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.network_configuration import NetworkConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - json_patch_operation = '''[{op=replace, path=/whitelisted, value=false,}, {op=add, path=/geolocation, value=[AF, HN, ES]}]''' # List[JsonPatchOperation] | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - try: - # Update security network configuration. - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(new_json_patch_operation) - print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) - /auth-users/{id}: - get: - operationId: getAuthUser - tags: - - Auth Users - summary: Auth User Details - description: Return the specified user's authentication system details. - parameters: - - in: path - name: id - description: Identity ID - required: true - x-sailpoint-resource-operation-id: listIdentities - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - security: - - userAuth: - - sp:auth-user:read - responses: - '200': - description: The specified user's authentication system details. - content: - application/json: - schema: - type: object - properties: - tenant: - type: string - description: Tenant name. - example: test-tenant - id: - type: string - description: Identity ID. - example: 2c91808458ae7a4f0158b1bbf8af0628 - uid: - type: string - description: Identity's unique identitifier. - example: will.smith - profile: - type: string - description: ID of the auth profile associated with the auth user. - example: 2c91808458ae7a4f0158b1bbf8af0756 - identificationNumber: - type: string - description: Auth user's employee number. - example: 19-5588452 - nullable: true - email: - type: string - description: Auth user's email. - example: william.smith@example.com - nullable: true - phone: - type: string - description: Auth user's phone number. - example: '5555555555' - nullable: true - workPhone: - type: string - description: Auth user's work phone number. - example: '5555555555' - nullable: true - personalEmail: - type: string - description: Auth user's personal email. - example: william.smith@example.com - nullable: true - firstname: - type: string - description: Auth user's first name. - example: Will - nullable: true - lastname: - type: string - description: Auth user's last name. - example: Smith - nullable: true - displayName: - type: string - description: Auth user's name in displayed format. - example: Will Smith - alias: - type: string - description: Auth user's alias. - example: will.smith - lastPasswordChangeDate: - type: string - format: date-time - description: Date of last password change. - example: '2021-03-08T22:37:33.901Z' - nullable: true - lastLoginTimestamp: - description: Timestamp of the last login (long type value). - type: integer - format: int64 - example: 1656327185832 - currentLoginTimestamp: - description: Timestamp of the current login (long type value). - type: integer - format: int64 - example: 1656327185832 - lastUnlockTimestamp: - type: string - format: date-time - description: The date and time when the user was last unlocked. - example: '2021-03-08T22:37:33.901Z' - nullable: true - capabilities: - description: Array of the auth user's capabilities. - type: array - nullable: true - items: - type: string - enum: - - CERT_ADMIN - - CLOUD_GOV_ADMIN - - CLOUD_GOV_USER - - HELPDESK - - ORG_ADMIN - - REPORT_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SAAS_MANAGEMENT_ADMIN - - SAAS_MANAGEMENT_READER - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - das:ui-administrator - - das:ui-compliance_manager - - das:ui-auditor - - das:ui-data-scope - - sp:aic-dashboard-read - - sp:aic-dashboard-write - - sp:ui-config-hub-admin - - sp:ui-config-hub-backup-admin - - sp:ui-config-hub-read - example: ORG_ADMIN - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-users#get-auth-user - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - - # Auth User Details - - try { - Get-V2025AuthUser -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AuthUser -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthUser" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/auth-users#get-auth-user - source: | - from sailpoint.v2025.api.auth_users_api import AuthUsersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.auth_user import AuthUser - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID - try: - # Auth User Details - - results = AuthUsersApi(api_client).get_auth_user(id=id) - # Below is a request that includes all optional parameters - # results = AuthUsersApi(api_client).get_auth_user(id) - print("The response of AuthUsersApi->get_auth_user:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) - patch: - operationId: patchAuthUser - tags: - - Auth Users - summary: Auth User Update - description: |- - Use a PATCH request to update an existing user in the authentication system. - Use this endpoint to modify these fields: - * `capabilities` - - A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. - security: - - userAuth: - - sp:auth-user:update - parameters: - - in: path - name: id - description: Identity ID - required: true - x-sailpoint-resource-operation-id: listIdentities - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /capabilities - value: - - ORG_ADMIN - responses: - '200': - description: Auth user updated. - content: - application/json: - schema: - $ref: '#/paths/~1auth-users~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AuthUser.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-users#patch-auth-user - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Auth User Update - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025AuthUser -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025AuthUser -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthUser" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/auth-users#patch-auth-user - source: | - from sailpoint.v2025.api.auth_users_api import AuthUsersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.auth_user import AuthUser - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID - json_patch_operation = '''[{op=replace, path=/capabilities, value=[ORG_ADMIN]}]''' # List[JsonPatchOperation] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - try: - # Auth User Update - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = AuthUsersApi(api_client).patch_auth_user(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = AuthUsersApi(api_client).patch_auth_user(id, new_json_patch_operation) - print("The response of AuthUsersApi->patch_auth_user:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) - /brandings: - get: - operationId: getBrandingList - tags: - - Branding - summary: List of branding items - description: This API endpoint returns a list of branding items. - security: - - userAuth: - - idn:branding:read - - applicationAuth: - - idn:branding:read - x-sailpoint-userLevels: - - ORG_ADMIN - responses: - '200': - description: A list of branding items. - content: - application/json: - schema: - type: array - items: - type: object - properties: - name: - type: string - description: name of branding item - example: default - productName: - type: string - description: product name - example: product name - nullable: true - actionButtonColor: - type: string - description: hex value of color for action button - example: 0074D9 - nullable: true - activeLinkColor: - type: string - description: hex value of color for link - example: 1.1e+70 - nullable: true - navigationColor: - type: string - description: hex value of color for navigation bar - example: 1.1e+70 - nullable: true - emailFromAddress: - type: string - description: email from address - example: no-reply@sailpoint.com - nullable: true - standardLogoURL: - type: string - description: url to standard logo - example: '' - nullable: true - loginInformationalMessage: - type: string - description: login information message - example: '' - nullable: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#get-branding-list - source: | - - # List of branding items - - try { - Get-V2025BrandingList - - # Below is a request that includes all optional parameters - # Get-V2025BrandingList - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BrandingList" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/branding#get-branding-list - source: | - from sailpoint.v2025.api.branding_api import BrandingApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.branding_item import BrandingItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List of branding items - - results = BrandingApi(api_client).get_branding_list() - # Below is a request that includes all optional parameters - # results = BrandingApi(api_client).get_branding_list() - print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) - post: - operationId: createBrandingItem - tags: - - Branding - summary: Create a branding item - description: This API endpoint creates a branding item. - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - required: - - name - - productName - properties: - name: - type: string - description: name of branding item - example: custom-branding-item - productName: - type: string - description: product name - example: product name - nullable: true - actionButtonColor: - type: string - description: hex value of color for action button - example: 0074D9 - activeLinkColor: - type: string - description: hex value of color for link - example: 1.1e+70 - navigationColor: - type: string - description: hex value of color for navigation bar - example: 1.1e+70 - emailFromAddress: - type: string - description: email from address - example: no-reply@sailpoint.com - loginInformationalMessage: - type: string - description: login information message - example: '' - fileStandard: - type: string - format: binary - description: png file with logo - example: \x00\x00\x00\x02 - security: - - userAuth: - - idn:branding:manage - - applicationAuth: - - idn:branding:manage - x-sailpoint-userLevels: - - ORG_ADMIN - responses: - '201': - description: Branding item created - content: - application/json: - schema: - $ref: '#/paths/~1brandings/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BrandingItem.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#create-branding-item - source: | - $Name = "MyName" # String | name of branding item - $ProductName = "MyProductName" # String | product name - $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) - $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) - $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) - $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) - $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) - $FileStandard = # System.IO.FileInfo | png file with logo (optional) - - # Create a branding item - - try { - New-V2025BrandingItem -Name $Name -ProductName $ProductName - - # Below is a request that includes all optional parameters - # New-V2025BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025BrandingItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/branding#create-branding-item - source: | - from sailpoint.v2025.api.branding_api import BrandingApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.branding_item import BrandingItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'name_example' # str | name of branding item # str | name of branding item - product_name = 'product_name_example' # str | product name # str | product name - action_button_color = 'action_button_color_example' # str | hex value of color for action button (optional) # str | hex value of color for action button (optional) - active_link_color = 'active_link_color_example' # str | hex value of color for link (optional) # str | hex value of color for link (optional) - navigation_color = 'navigation_color_example' # str | hex value of color for navigation bar (optional) # str | hex value of color for navigation bar (optional) - email_from_address = 'email_from_address_example' # str | email from address (optional) # str | email from address (optional) - login_informational_message = 'login_informational_message_example' # str | login information message (optional) # str | login information message (optional) - file_standard = None # bytearray | png file with logo (optional) # bytearray | png file with logo (optional) - try: - # Create a branding item - - results = BrandingApi(api_client).create_branding_item(name=name, product_name=product_name) - # Below is a request that includes all optional parameters - # results = BrandingApi(api_client).create_branding_item(name, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard) - print("The response of BrandingApi->create_branding_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) - /brandings/{name}: - get: - operationId: getBranding - tags: - - Branding - summary: Get a branding item - description: 'This API endpoint retrieves information for an existing branding item by name. ' - security: - - userAuth: - - idn:branding:read - - applicationAuth: - - idn:branding:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: name - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getBrandingList - description: The name of the branding item to be retrieved - example: default - responses: - '200': - description: A branding item object - content: - application/json: - schema: - $ref: '#/paths/~1brandings/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BrandingItem.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#get-branding - source: | - $Name = "default" # String | The name of the branding item to be retrieved - - # Get a branding item - - try { - Get-V2025Branding -Name $Name - - # Below is a request that includes all optional parameters - # Get-V2025Branding -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Branding" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/branding#get-branding - source: | - from sailpoint.v2025.api.branding_api import BrandingApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.branding_item import BrandingItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'default' # str | The name of the branding item to be retrieved # str | The name of the branding item to be retrieved - try: - # Get a branding item - - results = BrandingApi(api_client).get_branding(name=name) - # Below is a request that includes all optional parameters - # results = BrandingApi(api_client).get_branding(name) - print("The response of BrandingApi->get_branding:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling BrandingApi->get_branding: %s\n" % e) - put: - operationId: setBrandingItem - tags: - - Branding - summary: Update a branding item - description: This API endpoint updates information for an existing branding item. - parameters: - - in: path - name: name - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getBrandingList - description: The name of the branding item to be retrieved - example: default - requestBody: - required: true - content: - multipart/form-data: - schema: - $ref: '#/paths/~1brandings/post/requestBody/content/multipart~1form-data/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BrandingItemCreate.yaml - security: - - userAuth: - - idn:branding:manage - - applicationAuth: - - idn:branding:manage - x-sailpoint-userLevels: - - ORG_ADMIN - responses: - '200': - description: Branding item updated - content: - application/json: - schema: - $ref: '#/paths/~1brandings/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BrandingItem.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#set-branding-item - source: | - $Name = "default" # String | The name of the branding item to be retrieved - $Name2 = "Name_example" # String | name of branding item - $ProductName = "MyProductName" # String | product name - $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) - $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) - $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) - $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) - $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) - $FileStandard = # System.IO.FileInfo | png file with logo (optional) - - # Update a branding item - - try { - Set-V2025BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName - - # Below is a request that includes all optional parameters - # Set-V2025BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025BrandingItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/branding#set-branding-item - source: | - from sailpoint.v2025.api.branding_api import BrandingApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.branding_item import BrandingItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'default' # str | The name of the branding item to be retrieved # str | The name of the branding item to be retrieved - name2 = 'name_example' # str | name of branding item # str | name of branding item - product_name = 'product_name_example' # str | product name # str | product name - action_button_color = 'action_button_color_example' # str | hex value of color for action button (optional) # str | hex value of color for action button (optional) - active_link_color = 'active_link_color_example' # str | hex value of color for link (optional) # str | hex value of color for link (optional) - navigation_color = 'navigation_color_example' # str | hex value of color for navigation bar (optional) # str | hex value of color for navigation bar (optional) - email_from_address = 'email_from_address_example' # str | email from address (optional) # str | email from address (optional) - login_informational_message = 'login_informational_message_example' # str | login information message (optional) # str | login information message (optional) - file_standard = None # bytearray | png file with logo (optional) # bytearray | png file with logo (optional) - try: - # Update a branding item - - results = BrandingApi(api_client).set_branding_item(name=name, name2=name2, product_name=product_name) - # Below is a request that includes all optional parameters - # results = BrandingApi(api_client).set_branding_item(name, name2, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard) - print("The response of BrandingApi->set_branding_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) - delete: - operationId: deleteBranding - tags: - - Branding - summary: Delete a branding item - description: 'This API endpoint delete information for an existing branding item by name. ' - security: - - userAuth: - - idn:branding:manage - - applicationAuth: - - idn:branding:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: name - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getBrandingList - description: The name of the branding item to be deleted - example: default - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#delete-branding - source: | - $Name = "default" # String | The name of the branding item to be deleted - - # Delete a branding item - - try { - Remove-V2025Branding -Name $Name - - # Below is a request that includes all optional parameters - # Remove-V2025Branding -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Branding" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/branding#delete-branding - source: | - from sailpoint.v2025.api.branding_api import BrandingApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'default' # str | The name of the branding item to be deleted # str | The name of the branding item to be deleted - try: - # Delete a branding item - - BrandingApi(api_client).delete_branding(name=name) - # Below is a request that includes all optional parameters - # BrandingApi(api_client).delete_branding(name) - except Exception as e: - print("Exception when calling BrandingApi->delete_branding: %s\n" % e) - /campaigns: - get: - operationId: getActiveCampaigns - tags: - - Certification Campaigns - summary: List Campaigns - description: | - Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - security: - - userAuth: - - idn:campaign:read - - idn:campaign:manage - - idn:campaign-report:read - - idn:campaign-report:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - - REPORT_ADMIN - parameters: - - in: query - name: detail - schema: - type: string - enum: - - SLIM - - FULL - required: false - description: Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - example: FULL - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - required: false - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **status**: *eq, in* - example: name eq "Manager Campaign" - - in: query - name: sorters - schema: - type: string - format: comma-separated - required: false - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created** - example: name - responses: - '200': - description: A list of campaign objects. By default list of SLIM campaigns is returned. - content: - application/json: - schema: - type: array - items: - anyOf: - - type: object - title: Slim Campaign - required: - - name - - description - - type - properties: - id: - type: string - readOnly: true - description: Id of the campaign - example: 2c9079b270a266a60170a2779fcb0007 - nullable: true - name: - 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 - description: - type: string - nullable: true - 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 - deadline: - type: string - nullable: true - 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' - type: - type: string - description: The type of campaign. Could be extended in the future. - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - - ROLE_COMPOSITION - - MACHINE_ACCOUNT - example: MANAGER - emailNotificationEnabled: - type: boolean - description: Enables email notification for this campaign - default: false - example: false - autoRevokeAllowed: - type: boolean - description: Allows auto revoke for this campaign - default: false - example: false - recommendationsEnabled: - 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 - status: - type: string - description: The campaign's current status. - nullable: true - readOnly: true - enum: - - PENDING - - STAGED - - CANCELING - - ACTIVATING - - ACTIVE - - COMPLETING - - COMPLETED - - ERROR - - ARCHIVED - - null - example: ACTIVE - correlatedStatus: - 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 - created: - type: string - nullable: true - readOnly: true - format: date-time - description: Created time of the campaign - example: '2020-03-03T22:15:13.611Z' - totalCertifications: - type: integer - nullable: true - format: int32 - description: The total number of certifications in this campaign. - readOnly: true - example: 100 - completedCertifications: - type: integer - nullable: true - format: int32 - description: The number of completed certifications in this campaign. - readOnly: true - example: 10 - alerts: - type: array - nullable: true - description: A list of errors and warnings that have accumulated. - readOnly: true - items: - type: object - properties: - level: - type: string - enum: - - ERROR - - WARN - - INFO - description: Denotes the level of the message - example: ERROR - localizations: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorMessageDto.yaml - - type: object - title: Campaign - allOf: - - $ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SlimCampaign.yaml - - type: object - properties: - modified: - type: string - readOnly: true - nullable: true - format: date-time - description: Modified time of the campaign - example: '2020-03-03T22:20:12.674Z' - filter: - type: object - nullable: true - description: Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. - properties: - id: - type: string - description: The ID of whatever type of filter is being used. - example: 0fbe863c063c4c88a35fd7f17e8a3df5 - type: - type: string - description: Type of the filter - enum: - - CAMPAIGN_FILTER - - RULE - example: CAMPAIGN_FILTER - name: - type: string - description: Name of the filter - example: Test Filter - sunsetCommentsRequired: - type: boolean - description: Determines if comments on sunset date changes are required. - default: true - example: true - sourceOwnerCampaignInfo: - type: object - nullable: true - description: Must be set only if the campaign type is SOURCE_OWNER. - properties: - sourceIds: - type: array - description: The list of sources to be included in the campaign. - items: - type: string - example: - - 0fbe863c063c4c88a35fd7f17e8a3df5 - searchCampaignInfo: - type: object - nullable: true - description: Must be set only if the campaign type is SEARCH. - properties: - type: - type: string - description: The type of search campaign represented. - enum: - - IDENTITY - - ACCESS - example: ACCESS - description: - 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 - reviewer: - type: object - nullable: true - description: 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. - properties: - type: - type: string - description: The reviewer's DTO type. - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: The reviewer's ID. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - nullable: true - description: The reviewer's name. - example: William Wilson - query: - type: string - nullable: true - 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 - identityIds: - type: array - nullable: true - description: A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. - items: - type: string - maxItems: 1000 - example: - - 0fbe863c063c4c88a35fd7f17e8a3df5 - accessConstraints: - type: array - description: Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - - ACCESS_PROFILE - - ROLE - description: Type of Access - example: ENTITLEMENT - ids: - description: Must be set only if operator is SELECTED. - type: array - items: - type: string - example: - - 2c90ad2a70ace7d50170acf22ca90010 - operator: - 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 - required: - - type - - operator - maxItems: 1000 - required: - - type - roleCompositionCampaignInfo: - type: object - nullable: true - description: Optional configuration options for role composition campaigns. - properties: - reviewerId: - type: string - description: The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the "reviewer" object. - deprecated: true - example: 2c91808568c529c60168cca6f90c1313 - nullable: true - reviewer: - type: object - nullable: true - description: 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. - properties: - type: - type: string - description: The reviewer's DTO type. - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - id: - type: string - description: The reviewer's ID. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: The reviewer's name. - example: William Wilson - roleIds: - 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. - items: - type: string - example: - - 2c90ad2a70ace7d50170acf22ca90010 - remediatorRef: - type: object - description: 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. - properties: - type: - type: string - enum: - - IDENTITY - description: Legal Remediator Type - example: IDENTITY - id: - type: string - description: The ID of the remediator. - example: 2c90ad2a70ace7d50170acf22ca90010 - name: - type: string - description: The name of the remediator. - readOnly: true - example: Role Admin - required: - - type - - id - query: - type: string - nullable: true - 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 - description: - type: string - nullable: true - description: Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. - example: Role Composition Description - required: - - remediatorRef - machineAccountCampaignInfo: - type: object - nullable: true - description: Must be set only if the campaign type is MACHINE_ACCOUNT. - properties: - sourceIds: - type: array - description: The list of sources to be included in the campaign. - items: - type: string - example: - - 0fbe863c063c4c88a35fd7f17e8a3df5 - reviewerType: - type: string - description: The reviewer's type. - enum: - - ACCOUNT_OWNER - example: ACCOUNT_OWNER - sourcesWithOrphanEntitlements: - type: array - nullable: true - description: 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). - readOnly: true - items: - type: object - properties: - id: - type: string - description: Id of the source - example: 2c90ad2a70ace7d50170acf22ca90010 - type: - type: string - enum: - - SOURCE - description: Type - example: SOURCE - name: - type: string - description: Name of the source - example: Source with orphan entitlements - mandatoryCommentRequirement: - 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 - examples: - Slim Campaign: - description: List of Slim Campaigns that would result from not specifying *detail* or specifying SLIM - value: - - id: 2c918086719eec070171a7e3355a360a - name: Manager Review - description: A review of everyone's access by their manager. - deadline: '2020-12-25T06:00:00.123Z' - type: MANAGER - status: ACTIVE - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - created: '2022-08-02T19:00:27.731Z' - totalCertifications: 10 - completedCertifications: 3 - alerts: - - level: ERROR - localizations: - - locale: en - localeOrigin: DEFAULT - text: Composite criterion must have children non-composite criterion must not. - - id: 7e1a731e3fb845cfbe58112ba4673ee4 - name: Search Campaign - description: Search Campaign Info - deadline: '2022-07-26T15:42:44.000Z' - type: SEARCH - status: ACTIVE - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - created: '2022-07-25T15:42:18.276Z' - totalCertifications: 5 - completedCertifications: 3 - alerts: null - - id: 2c918086719eec070171a7e3355a412b - name: AD Source Review - description: A review of our AD source. - deadline: '2020-12-25T06:00:00.123Z' - type: SOURCE_OWNER - status: STAGED - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - correlatedStatus: CORRELATED - created: '2022-07-27T17:04:19.027Z' - totalCertifications: 7 - completedCertifications: 3 - alerts: - - level: WARN - localizations: - - locale: en - localeOrigin: DEFAULT - text: Composite criterion is in wrong format. - - id: 3b2e2e5821e84127b6d693d41c40623b - name: Role Composition Campaign - description: A review done by a role owner. - deadline: '2020-12-25T06:00:00.468Z' - type: ROLE_COMPOSITION - status: ACTIVE - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - created: '2022-08-02T20:29:51.065Z' - totalCertifications: 1 - completedCertifications: 1 - alerts: null - Full Campaign: - description: List of Campaigns that would result from specifying *detail* as FULL - value: - - id: 078696a575e045c68d6722ccdb9f101d - name: Role Composition Campaign - description: A review done by a role owner. - deadline: '2020-12-25T06:00:00.468Z' - type: ROLE_COMPOSITION - status: ERROR - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - modified: '2022-08-02T20:29:51.331Z' - filter: - type: CAMPAIGN_FILTER - id: 0fbe863c063c4c88a35fd7f17e8a3df5 - name: Test Role Composition Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - searchCampaignInfo: null - roleCompositionCampaignInfo: - remediatorRef: - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - reviewerId: null - reviewer: null - roleIds: - - b15d609fc5c8434b865fe552315fda8f - query: null - description: null - sourcesWithOrphanEntitlements: null - mandatoryCommentRequirement: NO_DECISIONS - - id: 1be8fc1103914bf0a4e14e316b6a7b7c - name: Manager Review - description: A review of everyone's access by their manager. - deadline: '2020-12-25T06:00:00.468Z' - type: MANAGER - status: STAGED - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - modified: '2022-08-02T19:00:34.391Z' - filter: - type: CAMPAIGN_FILTER - id: 0fbe863c063c4c88a35fd7f17e8a3df5 - name: Test Manager Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - searchCampaignInfo: null - roleCompositionCampaignInfo: null - sourcesWithOrphanEntitlements: [] - mandatoryCommentRequirement: NO_DECISIONS - - id: 7e1a731e3fb845cfbe58112ba4673ee4 - name: Search Campaign - description: Search Campaign for Identities - deadline: '2022-07-26T15:42:44.000Z' - type: SEARCH - status: ACTIVE - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - modified: '2022-07-25T15:42:53.718Z' - filter: - type: CAMPAIGN_FILTER - id: 0fbe863c063c4c88a35fd7f17e8a3df5 - name: Test Search Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - searchCampaignInfo: - type: IDENTITY - description: Example of Search Campaign - reviewer: - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: null - query: user - identityIds: null - accessConstraints: [] - roleCompositionCampaignInfo: null - sourcesWithOrphanEntitlements: [] - mandatoryCommentRequirement: NO_DECISIONS - - id: ad3cf3dd50394b1bad646de4bc51b999 - name: Source Owner Campaign - description: Example for Source Owner Campaign - deadline: '2022-08-10T17:09:02.000Z' - type: SOURCE_OWNER - status: ACTIVE - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - modified: '2022-07-27T17:09:13.925Z' - filter: - type: CAMPAIGN_FILTER - id: 0fbe863c063c4c88a35fd7f17e8a3df5 - name: Test Source Owner Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: - sourceIds: - - 2c91808781fd5aea01821200dc88318e - searchCampaignInfo: null - roleCompositionCampaignInfo: null - sourcesWithOrphanEntitlements: [] - correlatedStatus: CORRELATED - mandatoryCommentRequirement: NO_DECISIONS - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-active-campaigns - source: | - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) - - # List Campaigns - - try { - Get-V2025ActiveCampaigns - - # Below is a request that includes all optional parameters - # Get-V2025ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ActiveCampaigns" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-active-campaigns - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"Manager Campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) - try: - # List Campaigns - - results = CertificationCampaignsApi(api_client).get_active_campaigns() - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) - print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - post: - operationId: createCampaign - tags: - - Certification Campaigns - summary: Create a campaign - description: | - Use this API to create a certification campaign with the information provided in the request body. - security: - - userAuth: - - idn:campaign:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Campaign.yaml - examples: - Manager: - value: - name: Manager Review - description: A review of everyone's access by their manager. - deadline: '2020-12-25T06:00:00.468Z' - type: MANAGER - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - filter: - type: CAMPAIGN_FILTER - id: 0c46fb26c6b20967a55517ee90d15b93 - mandatoryCommentRequirement: NO_DECISIONS - Search: - value: - name: Search Campaign - description: Search Campaign - deadline: '2020-12-25T06:00:00.468Z' - type: SEARCH - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - filter: - type: CAMPAIGN_FILTER - id: 0c46fb26c6b20967a55517ee90d15b93 - searchCampaignInfo: - type: ACCESS - query: user - mandatoryCommentRequirement: NO_DECISIONS - Source Owner: - value: - name: Source Owner - description: Source Owner Info - deadline: '2020-12-25T06:00:00.468Z' - type: SOURCE_OWNER - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - filter: - type: CAMPAIGN_FILTER - id: 0c46fb26c6b20967a55517ee90d15b93 - sourceOwnerCampaignInfo: - sourceIds: - - 612b31b1a0f04aaf83123bdb80e70db6 - correlatedStatus: CORRELATED - mandatoryCommentRequirement: NO_DECISIONS - Role Composition: - value: - name: Role Composition Campaign - description: A review done by a role owner. - deadline: '2020-12-25T06:00:00.468Z' - type: ROLE_COMPOSITION - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - filter: - type: CAMPAIGN_FILTER - id: 0c46fb26c6b20967a55517ee90d15b93 - roleCompositionCampaignInfo: - remediatorRef: - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - roleIds: - - b15d609fc5c8434b865fe552315fda8f - mandatoryCommentRequirement: NO_DECISIONS - Machine Account: - value: - name: Machine Account Owner Campaign - description: A review done by a Machine Account's owner. - deadline: '2024-12-25T06:00:00.468Z' - type: MACHINE_ACCOUNT - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - filter: - type: CAMPAIGN_FILTER - id: 0c46fb26c6b20967a55517ee90d15b93 - machineAccountCampaignInfo: - sourceIds: - - d988f117b7624a16ab0b64c439d5dbb8 - reviewerType: ACCOUNT_OWNER - responses: - '200': - description: This response indicates that the requested campaign was successfully created, and the API returns its representation. - content: - application/json: - schema: - $ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Campaign.yaml - examples: - Manager: - value: - id: 5594f43b76804a6980ece5fdccf74be7 - name: Manager Review - description: A review of everyone's access by their manager. - deadline: '2020-12-25T06:00:00.468Z' - type: MANAGER - status: PENDING - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - created: '2022-08-02T20:21:18.421Z' - modified: null - filter: - type: CAMPAIGN_FILTER - id: 0fbe863c063c4c88a35fd7f17e8a3df5 - name: Test Manager Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - searchCampaignInfo: null - roleCompositionCampaignInfo: null - machineAccountCampaignInfo: null - alerts: null - totalCertifications: 0 - completedCertifications: 0 - sourcesWithOrphanEntitlements: null - mandatoryCommentRequirement: NO_DECISIONS - Search: - value: - id: ec041831cb2147778b594feb9d8db44a - name: Search Campaign - description: Search Campaign - deadline: '2020-12-25T06:00:00.468Z' - type: SEARCH - status: PENDING - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - created: '2022-08-03T13:54:34.344Z' - modified: null - filter: - type: CAMPAIGN_FILTER - id: 0fbe863c063c4c88a35fd7f17e8a3df5 - name: Test Search Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - searchCampaignInfo: - type: ACCESS - description: user - reviewer: - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: null - query: user - identityIds: null - accessConstraints: [] - roleCompositionCampaignInfo: null - machineAccountCampaignInfo: null - alerts: null - totalCertifications: 0 - completedCertifications: 0 - sourcesWithOrphanEntitlements: null - mandatoryCommentRequirement: NO_DECISIONS - Source Owner: - value: - id: fd7b76ba4ea042de8a9414aa12fc977a - name: Source Owner - description: Source Owner Info - deadline: '2020-12-25T06:00:00.468Z' - type: SOURCE_OWNER - status: PENDING - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - created: '2022-08-03T13:34:19.541Z' - modified: null - filter: - type: CAMPAIGN_FILTER - id: 0fbe863c063c4c88a35fd7f17e8a3df5 - name: Test Source Owner Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - sourceIds: - - 612b31b1a0f04aaf83123bdb80e70db6 - searchCampaignInfo: null - roleCompositionCampaignInfo: null - machineAccountCampaignInfo: null - alerts: null - totalCertifications: 0 - completedCertifications: 0 - sourcesWithOrphanEntitlements: null - correlatedStatus: CORRELATED - mandatoryCommentRequirement: NO_DECISIONS - Role Composition: - value: - id: 3b2e2e5821e84127b6d693d41c40623b - name: Role Composition Campaign - description: A review done by a role owner. - deadline: '2020-12-25T06:00:00.468Z' - type: ROLE_COMPOSITION - status: PENDING - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - created: '2022-08-02T20:30:46.083Z' - modified: null - filter: - type: CAMPAIGN_FILTER - id: 0fbe863c063c4c88a35fd7f17e8a3df5 - name: Test Role Composition Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - searchCampaignInfo: null - roleCompositionCampaignInfo: - remediatorRef: - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - reviewerId: null - reviewer: null - roleIds: - - b15d609fc5c8434b865fe552315fda8f - query: null - description: null - alerts: null - totalCertifications: 0 - completedCertifications: 0 - sourcesWithOrphanEntitlements: null - machineAccountCampaignInfo: null - mandatoryCommentRequirement: NO_DECISIONS - Machine Account Owner: - value: - id: 3e9ff3d6555e4721b74695d5b578e847 - name: Machine Account Owner Campaign - description: A review done by a machine account's owner. - deadline: '2024-05-07T19:43:38.186Z' - type: MACHINE_ACCOUNT - status: PENDING - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - created: '2024-04-23T19:43:38.355Z' - modified: '2024-04-23T19:43:38.355Z' - filter: null - sunsetCommentsRequired: true - mandatoryCommentRequirement: NO_DECISIONS - sourceOwnerCampaignInfo: null - searchCampaignInfo: null - roleCompositionCampaignInfo: null - totalCertifications: 0 - completedCertifications: 0 - alerts: null - correlatedStatus: CORRELATED - sourcesWithOrphanEntitlements: [] - machineAccountCampaignInfo: - sourceIds: - - d988f117b7624a16ab0b64c439d5dbb8 - reviewerType: ACCOUNT_OWNER - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#create-campaign - source: | - $Campaign = @" - { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "reviewerId" : "2c91808568c529c60168cca6f90c1313", - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - } - "@ - - # Create a campaign - - try { - $Result = ConvertFrom-JsonToCampaign -Json $Campaign - New-V2025Campaign -Campaign $Result - - # Below is a request that includes all optional parameters - # New-V2025Campaign -Campaign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Campaign" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#create-campaign - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign import Campaign - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - campaign = '''{ - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "reviewerId" : "2c91808568c529c60168cca6f90c1313", - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - }''' # Campaign | - try: - # Create a campaign - new_campaign = Campaign.from_json(campaign) - results = CertificationCampaignsApi(api_client).create_campaign(campaign=new_campaign) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).create_campaign(new_campaign) - print("The response of CertificationCampaignsApi->create_campaign:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) - /campaigns/{id}: - get: - operationId: getCampaign - tags: - - Certification Campaigns - summary: Get Campaign - description: | - Use this API to get information for an existing certification campaign by the campaign's ID. - security: - - userAuth: - - idn:campaign:read - - idn:campaign:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getActiveCampaigns - description: ID of the campaign to be retrieved. - example: 2c91808571bcfcf80171c23e4b4221fc - - in: query - name: detail - schema: - type: string - enum: - - SLIM - - FULL - required: false - description: Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - example: FULL - responses: - '200': - description: Requested campaign object. - content: - application/json: - schema: - anyOf: - - $ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SlimCampaign.yaml - - $ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Campaign.yaml - examples: - Manager: - value: - id: 2c918086719eec070171a7e3355a360a - name: Manager Review - description: A review of everyone's access by their manager. - deadline: '2020-12-25T06:00:00.123Z' - type: MANAGER - status: ACTIVE - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - Search: - value: - id: 7e1a731e3fb845cfbe58112ba4673ee4 - name: Search Campaign - description: Search Campaign Info - deadline: '2022-07-26T15:42:44.000Z' - type: SEARCH - status: ACTIVE - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - Source Owner: - value: - id: 2c918086719eec070171a7e3355a412b - name: AD Source Review - description: A review of our AD source. - deadline: '2020-12-25T06:00:00.123Z' - type: SOURCE_OWNER - status: STAGED - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - correlatedStatus: CORRELATED - RoleComposition: - value: - id: 3b2e2e5821e84127b6d693d41c40623b - name: Role Composition Campaign - description: A review done by a role owner. - deadline: '2020-12-25T06:00:00.468Z' - type: ROLE_COMPOSITION - status: ACTIVE - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - - # Get Campaign - - try { - Get-V2025Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Campaign -Id $Id -Detail $Detail - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Campaign" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-campaign - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign to be retrieved. # str | ID of the campaign to be retrieved. - detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - try: - # Get Campaign - - results = CertificationCampaignsApi(api_client).get_campaign(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_campaign(id, detail) - print("The response of CertificationCampaignsApi->get_campaign:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) - patch: - operationId: updateCampaign - tags: - - Certification Campaigns - summary: Update a Campaign - description: | - Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - security: - - userAuth: - - idn:campaign:read - - idn:campaign:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getActiveCampaigns - description: ID of the campaign template being modified. - example: 2c91808571bcfcf80171c23e4b4221fc - requestBody: - required: true - description: | - A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - The fields that can be patched differ based on the status of the campaign. - - When the campaign is in the *STAGED* status, you can patch these fields: - * name - * description - * recommendationsEnabled - * deadline - * emailNotificationEnabled - * autoRevokeAllowed - - When the campaign is in the *ACTIVE* status, you can patch these fields: - * deadline - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /name - value: This field has been updated! - - op: copy - from: /name - path: /description - responses: - '200': - description: This response indicates that the PATCH operation succeeded, and the API returns the campaign's new representation. - content: - application/json: - schema: - $ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SlimCampaign.yaml - examples: - Manager: - $ref: '#/paths/~1campaigns~1%7Bid%7D/get/responses/200/content/application~1json/examples/Manager' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/campaign/examples/SlimCampaignManager.yaml - Search: - $ref: '#/paths/~1campaigns~1%7Bid%7D/get/responses/200/content/application~1json/examples/Search' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/campaign/examples/SlimCampaignSearch.yaml - Source Owner: - $ref: '#/paths/~1campaigns~1%7Bid%7D/get/responses/200/content/application~1json/examples/Source%20Owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/campaign/examples/SlimCampaignSourceOwner.yaml - RoleComposition: - $ref: '#/paths/~1campaigns~1%7Bid%7D/get/responses/200/content/application~1json/examples/RoleComposition' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/campaign/examples/SlimCampaignRoleComposition.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#update-campaign - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update a Campaign - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Campaign -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Campaign -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Campaign" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#update-campaign - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.slim_campaign import SlimCampaign - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. - json_patch_operation = '''[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]''' # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - try: - # Update a Campaign - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = CertificationCampaignsApi(api_client).update_campaign(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation) - print("The response of CertificationCampaignsApi->update_campaign:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) - /campaigns/{id}/reassign: - post: - security: - - userAuth: - - idn:campaign:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - operationId: move - tags: - - Certification Campaigns - summary: Reassign Certifications - description: | - This API reassigns the specified certifications from one identity to another. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getActiveCampaigns - description: The certification campaign ID - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - certificationIds: - description: List of certification IDs to reassign - type: array - items: - type: string - minItems: 1 - maxItems: 250 - example: - - af3859464779471211bb8424a563abc1 - - af3859464779471211bb8424a563abc2 - - af3859464779471211bb8424a563abc3 - reassignTo: - type: object - properties: - id: - type: string - description: The identity ID to which the review is being assigned. - example: ef38f94347e94562b5bb8424a56397d8 - type: - type: string - description: The type of the ID provided. - enum: - - IDENTITY - example: IDENTITY - reason: - type: string - description: Comment to explain why the certification was reassigned - example: reassigned for some reason - responses: - '202': - description: The reassign task that has been submitted. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The ID of the certification task. - example: 2c918086719eec070171a7e3355a360a - type: - type: string - description: The type of the certification task. More values may be added in the future. - enum: - - REASSIGN - - ADMIN_REASSIGN - - COMPLETE_CERTIFICATION - - FINISH_CERTIFICATION - - COMPLETE_CAMPAIGN - - ACTIVATE_CAMPAIGN - - CAMPAIGN_CREATE - - CAMPAIGN_DELETE - example: ADMIN_REASSIGN - targetType: - type: string - description: The type of item that is being operated on by this task whose ID is stored in the targetId field. - enum: - - CERTIFICATION - - CAMPAIGN - example: CAMPAIGN - targetId: - type: string - description: The ID of the item being operated on by this task. - example: 2c918086719eec070171a7e3355a834c - status: - type: string - description: The status of the task. - enum: - - QUEUED - - IN_PROGRESS - - SUCCESS - - ERROR - example: QUEUED - errors: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/errorMessages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorMessageDtoList.yaml - reassignmentTrailDTOs: - type: array - items: - type: object - properties: - previousOwner: - type: string - description: The ID of previous owner identity. - example: ef38f94347e94562b5bb8424a56397d8 - newOwner: - type: string - description: The ID of new owner identity. - example: ef38f94347e94562b5bb8424a56397a3 - reassignmentType: - type: string - description: The type of reassignment. - example: AUTOMATIC_REASSIGNMENT - description: Reassignment trails that lead to self certification identity - example: - previousOwner: ef38f94347e94562b5bb8424a56397d8 - newOwner: ef38f94347e94562b5bb8424a56397a3 - reassignmentType: AUTOMATIC_REASSIGNMENT - created: - type: string - description: The date and time on which this task was created. - format: date-time - example: '2020-09-24T18:10:47.693Z' - example: - id: 2c918086719eec070171a7e3355a360a - type: ADMIN_REASSIGN - targetType: CAMPAIGN - targetId: 2c918086719eec070171a7e3355a834c - status: QUEUED - errors: [] - created: '2020-09-24T18:10:47.693Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#move - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID - $AdminReviewReassign = @" - { - "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], - "reason" : "reassigned for some reason", - "reassignTo" : { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "IDENTITY" - } - } - "@ - - # Reassign Certifications - - try { - $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign - Move-V2025 -Id $Id -AdminReviewReassign $Result - - # Below is a request that includes all optional parameters - # Move-V2025 -Id $Id -AdminReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2025" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#move - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.admin_review_reassign import AdminReviewReassign - from sailpoint.v2025.models.certification_task import CertificationTask - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification campaign ID # str | The certification campaign ID - admin_review_reassign = '''{ - "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], - "reason" : "reassigned for some reason", - "reassignTo" : { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "IDENTITY" - } - }''' # AdminReviewReassign | - try: - # Reassign Certifications - new_admin_review_reassign = AdminReviewReassign.from_json(admin_review_reassign) - results = CertificationCampaignsApi(api_client).move(id=id, admin_review_reassign=new_admin_review_reassign) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign) - print("The response of CertificationCampaignsApi->move:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) - /campaigns/{id}/activate: - post: - operationId: startCampaign - tags: - - Certification Campaigns - summary: Activate a Campaign - description: | - Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - security: - - userAuth: - - idn:campaign:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - requestBody: - description: Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - required: false - content: - application/json: - schema: - type: object - properties: - timeZone: - type: string - description: The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. - default: Z - example: '-05:00' - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getActiveCampaigns - description: Campaign ID. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-campaign - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. - $ActivateCampaignOptions = @" - { - "timeZone" : "-05:00" - } - "@ - - # Activate a Campaign - - try { - Start-V2025Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025Campaign -Id $Id -ActivateCampaignOptions $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025Campaign" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#start-campaign - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.activate_campaign_options import ActivateCampaignOptions - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. - activate_campaign_options = '''{ - "timeZone" : "-05:00" - }''' # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) - try: - # Activate a Campaign - - results = CertificationCampaignsApi(api_client).start_campaign(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).start_campaign(id, new_activate_campaign_options) - print("The response of CertificationCampaignsApi->start_campaign:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) - /campaigns/{id}/complete: - post: - operationId: completeCampaign - tags: - - Certification Campaigns - summary: Complete a Campaign - description: | - :::caution - - This endpoint will run successfully for any campaigns that are **past due**. - - This endpoint will return a content error if the campaign is **not past due**. - - ::: - - Use this API to complete a certification campaign. This functionality is provided to admins so that they - can complete a certification even if all items have not been completed. - security: - - userAuth: - - idn:campaign:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - requestBody: - description: Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - required: false - content: - application/json: - schema: - type: object - properties: - autoCompleteAction: - description: Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. - type: string - enum: - - APPROVE - - REVOKE - default: APPROVE - example: REVOKE - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getActiveCampaigns - description: Campaign ID. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#complete-campaign - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. - $CampaignCompleteOptions = @" - { - "autoCompleteAction" : "REVOKE" - } - "@ - - # Complete a Campaign - - try { - Complete-V2025Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Complete-V2025Campaign -Id $Id -CampaignCompleteOptions $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025Campaign" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#complete-campaign - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_complete_options import CampaignCompleteOptions - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. - campaign_complete_options = '''{ - "autoCompleteAction" : "REVOKE" - }''' # CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) - try: - # Complete a Campaign - - results = CertificationCampaignsApi(api_client).complete_campaign(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).complete_campaign(id, new_campaign_complete_options) - print("The response of CertificationCampaignsApi->complete_campaign:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) - /campaigns/delete: - post: - operationId: deleteCampaigns - tags: - - Certification Campaigns - summary: Delete Campaigns - description: | - Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - security: - - userAuth: - - idn:campaign:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - requestBody: - description: IDs of the campaigns to delete. - required: true - content: - application/json: - schema: - type: object - properties: - ids: - description: The ids of the campaigns to delete - type: array - items: - type: string - example: - - 2c9180887335cee10173490db1776c26 - - 2c9180836a712436016a7125a90c0021 - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#delete-campaigns - source: | - $CampaignsDeleteRequest = @" - { - "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] - } - "@ - - # Delete Campaigns - - try { - $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest - Remove-V2025Campaigns -CampaignsDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025Campaigns -CampaignsDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Campaigns" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#delete-campaigns - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaigns_delete_request import CampaignsDeleteRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - campaigns_delete_request = '''{ - "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] - }''' # CampaignsDeleteRequest | IDs of the campaigns to delete. - try: - # Delete Campaigns - new_campaigns_delete_request = CampaignsDeleteRequest.from_json(campaigns_delete_request) - results = CertificationCampaignsApi(api_client).delete_campaigns(campaigns_delete_request=new_campaigns_delete_request) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request) - print("The response of CertificationCampaignsApi->delete_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) - /campaigns/{id}/run-remediation-scan: - post: - operationId: startCampaignRemediationScan - tags: - - Certification Campaigns - summary: Run Campaign Remediation Scan - description: | - Use this API to run a remediation scan task for a certification campaign. - security: - - userAuth: - - idn:campaign-report:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - - REPORT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - example: 2c91808571bcfcf80171c23e4b4221fc - required: true - x-sailpoint-resource-operation-id: getActiveCampaigns - description: ID of the campaign the remediation scan is being run for. - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-campaign-remediation-scan - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. - - # Run Campaign Remediation Scan - - try { - Start-V2025CampaignRemediationScan -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025CampaignRemediationScan -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025CampaignRemediationScan" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#start-campaign-remediation-scan - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign the remediation scan is being run for. # str | ID of the campaign the remediation scan is being run for. - try: - # Run Campaign Remediation Scan - - results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id) - print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) - /campaigns/{id}/reports: - get: - operationId: getCampaignReports - tags: - - Certification Campaigns - summary: Get Campaign Reports - description: | - Use this API to fetch all reports for a certification campaign by campaign ID. - security: - - userAuth: - - idn:campaign-report:read - - idn:campaign-report:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - - REPORT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - example: 2c91808571bcfcf80171c23e4b4221fc - required: true - x-sailpoint-resource-operation-id: getActiveCampaigns - description: ID of the campaign whose reports are being fetched. - responses: - '200': - description: Array of campaign report objects. - content: - application/json: - schema: - type: array - items: - type: object - title: Campaign Report - required: - - reportType - allOf: - - $ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReportResultReference.yaml - - type: object - properties: - reportType: - $ref: '#/paths/~1campaigns~1%7Bid%7D~1run-report~1%7Btype%7D/post/parameters/1/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReportType.yaml - lastRunAt: - type: string - readOnly: true - format: date-time - description: The most recent date and time this report was run - example: - type: REPORT_RESULT - id: 2c91808568c529c60168cca6f90c1313 - name: Campaign Composition Report - status: SUCCESS - reportType: CAMPAIGN_COMPOSITION_REPORT - lastRunAt: '2019-12-19T13:49:37.385Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-reports - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. - - # Get Campaign Reports - - try { - Get-V2025CampaignReports -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CampaignReports -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignReports" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-campaign-reports - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_report import CampaignReport - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign whose reports are being fetched. # str | ID of the campaign whose reports are being fetched. - try: - # Get Campaign Reports - - results = CertificationCampaignsApi(api_client).get_campaign_reports(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) - print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - /campaigns/{id}/run-report/{type}: - post: - operationId: startCampaignReport - tags: - - Certification Campaigns - summary: Run Campaign Report - description: | - Use this API to run a report for a certification campaign. - security: - - userAuth: - - idn:campaign-report:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - - REPORT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - example: 2c91808571bcfcf80171c23e4b4221fc - required: true - x-sailpoint-resource-operation-id: getActiveCampaigns - description: ID of the campaign the report is being run for. - - in: path - name: type - schema: - type: string - description: type of a Report - enum: - - CAMPAIGN_COMPOSITION_REPORT - - CAMPAIGN_REMEDIATION_STATUS_REPORT - - CAMPAIGN_STATUS_REPORT - - CERTIFICATION_SIGNOFF_REPORT - example: CAMPAIGN_COMPOSITION_REPORT - required: true - description: Type of the report to run. - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-campaign-report - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. - $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. - - # Run Campaign Report - - try { - Start-V2025CampaignReport -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Start-V2025CampaignReport -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025CampaignReport" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#start-campaign-report - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_type import ReportType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign the report is being run for. # str | ID of the campaign the report is being run for. - type = sailpoint.v2025.ReportType() # ReportType | Type of the report to run. # ReportType | Type of the report to run. - try: - # Run Campaign Report - - results = CertificationCampaignsApi(api_client).start_campaign_report(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).start_campaign_report(id, type) - print("The response of CertificationCampaignsApi->start_campaign_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) - /campaigns/reports-configuration: - get: - operationId: getCampaignReportsConfig - tags: - - Certification Campaigns - summary: Get Campaign Reports Configuration - description: | - Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - security: - - userAuth: - - idn:campaign:read - - idn:campaign:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - responses: - '200': - description: Campaign report configuration. - content: - application/json: - schema: - type: object - title: Campaign Reports Configuration - properties: - identityAttributeColumns: - type: array - nullable: true - description: list of identity attribute columns - items: - type: string - example: - - firstname - - lastname - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-reports-config - source: | - - # Get Campaign Reports Configuration - - try { - Get-V2025CampaignReportsConfig - - # Below is a request that includes all optional parameters - # Get-V2025CampaignReportsConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignReportsConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-campaign-reports-config - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_reports_config import CampaignReportsConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get Campaign Reports Configuration - - results = CertificationCampaignsApi(api_client).get_campaign_reports_config() - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_campaign_reports_config() - print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) - put: - operationId: setCampaignReportsConfig - tags: - - Certification Campaigns - summary: Set Campaign Reports Configuration - description: | - Use this API to overwrite the configuration for campaign reports. - security: - - userAuth: - - idn:campaign:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - requestBody: - required: true - description: Campaign report configuration. - content: - application/json: - schema: - $ref: '#/paths/~1campaigns~1reports-configuration/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignReportsConfig.yaml - responses: - '200': - description: The persisted campaign report configuration. - content: - application/json: - schema: - $ref: '#/paths/~1campaigns~1reports-configuration/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignReportsConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#set-campaign-reports-config - source: | - $CampaignReportsConfig = @" - { - "identityAttributeColumns" : [ "firstname", "lastname" ] - } - "@ - - # Set Campaign Reports Configuration - - try { - $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig - Set-V2025CampaignReportsConfig -CampaignReportsConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025CampaignReportsConfig -CampaignReportsConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025CampaignReportsConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#set-campaign-reports-config - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_reports_config import CampaignReportsConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - campaign_reports_config = '''{ - "identityAttributeColumns" : [ "firstname", "lastname" ] - }''' # CampaignReportsConfig | Campaign report configuration. - try: - # Set Campaign Reports Configuration - new_campaign_reports_config = CampaignReportsConfig.from_json(campaign_reports_config) - results = CertificationCampaignsApi(api_client).set_campaign_reports_config(campaign_reports_config=new_campaign_reports_config) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config) - print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) - /campaign-filters: - post: - operationId: createCampaignFilter - tags: - - Certification Campaign Filters - summary: Create Campaign Filter - description: Use this API to create a campaign filter based on filter details and criteria. - security: - - userAuth: - - idn:campaign-filter:create - requestBody: - required: true - content: - application/json: - schema: - type: object - description: Campaign Filter Details - properties: - id: - type: string - description: The unique ID of the campaign filter - example: 5ec18cef39020d6fd7a60ad3970aba61 - name: - type: string - description: Campaign filter name. - example: Identity Attribute Campaign Filter - description: - type: string - description: Campaign filter description. - example: Campaign filter to certify data based on an identity attribute's specified property. - owner: - type: string - description: Owner of the filter. This field automatically populates at creation time with the current user. - example: SailPoint Support - nullable: true - mode: - type: string - description: Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. - enum: - - INCLUSION - - EXCLUSION - example: INCLUSION - criteriaList: - type: array - description: List of criteria. - items: - type: object - properties: - type: - type: string - enum: - - COMPOSITE - - ROLE - - IDENTITY - - IDENTITY_ATTRIBUTE - - ENTITLEMENT - - ACCESS_PROFILE - - SOURCE - - ACCOUNT - - AGGREGATED_ENTITLEMENT - - INVALID_CERTIFIABLE_ENTITY - - INVALID_CERTIFIABLE_BUNDLE - description: Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple filters in an AND/OR relationship. - example: IDENTITY_ATTRIBUTE - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - - null - description: Operation on a specific criteria - example: EQUALS - nullable: true - property: - type: string - description: Specified key from the type of criteria. - example: displayName - nullable: true - value: - type: string - description: Value for the specified key from the type of criteria. - example: Allie - nullable: true - negateResult: - type: boolean - description: If true, the filter will negate the result of the criteria. - example: false - default: false - shortCircuit: - type: boolean - description: If true, the filter will short circuit the evaluation of the criteria. - example: false - default: false - recordChildMatches: - type: boolean - description: If true, the filter will record child matches for the criteria. - example: false - default: false - id: - type: string - description: The unique ID of the criteria. - example: 5ec18cef39020d6fd7a60ad3970aba61 - nullable: true - suppressMatchedItems: - type: boolean - description: | - If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. - Such items will not appear in the exclusion report. - example: false - default: false - children: - type: array - description: List of child criteria. - items: - type: object - required: - - type - - property - - value - example: - - type: IDENTITY_ATTRIBUTE - property: displayName - value: support - operation: CONTAINS - negateResult: false - shortCircuit: false - recordChildMatches: false - id: null - suppressMatchedItems: false - children: null - isSystemFilter: - type: boolean - default: false - description: If true, the filter is created by the system. If false, the filter is created by a user. - example: false - required: - - id - - name - - owner - - mode - - isSystemFilter - responses: - '200': - description: Created successfully. - content: - application/json: - schema: - $ref: '#/paths/~1campaign-filters/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignFilterDetails.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#create-campaign-filter - source: | - $CampaignFilterDetails = @" - { - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - } - "@ - - # Create Campaign Filter - - try { - $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - New-V2025CampaignFilter -CampaignFilterDetails $Result - - # Below is a request that includes all optional parameters - # New-V2025CampaignFilter -CampaignFilterDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CampaignFilter" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaign-filters#create-campaign-filter - source: | - from sailpoint.v2025.api.certification_campaign_filters_api import CertificationCampaignFiltersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_filter_details import CampaignFilterDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - campaign_filter_details = '''{ - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - }''' # CampaignFilterDetails | - try: - # Create Campaign Filter - new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details) - results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(campaign_filter_details=new_campaign_filter_details) - # Below is a request that includes all optional parameters - # results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(new_campaign_filter_details) - print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) - get: - operationId: listCampaignFilters - tags: - - Certification Campaign Filters - summary: List Campaign Filters - description: Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - security: - - userAuth: - - idn:campaign-filter-list:read - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - in: query - name: start - description: Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: includeSystemFilters - description: 'If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. ' - required: false - example: true - schema: - type: boolean - default: true - responses: - '200': - description: List of campaign filter objects. - content: - application/json: - schema: - type: object - properties: - items: - type: array - description: List of campaign filters. - items: - $ref: '#/paths/~1campaign-filters/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignFilterDetails.yaml - count: - type: integer - description: Number of filters returned. - example: 2 - example: - items: - - id: 5b8a2ba86393dd174495c4436dd76b25 - name: IdentityAttribute Inclusion Campaign Filter - description: IdentityAttribute Inclusion Campaign Filter - owner: SailPoint Support - mode: INCLUSION - criteriaList: - - type: IDENTITY_ATTRIBUTE - property: displayName - value: '#' - operation: CONTAINS - negateResult: false - shortCircuit: false - recordChildMatches: false - id: null - suppressMatchedItems: false - children: null - isSystemFilter: false - - id: e9f9a1397b842fd5a65842087040d3ac - name: Exclusion Campaign Filter - description: Campaign filter for Exclusion update - owner: SailPoint Support - mode: EXCLUSION - criteriaList: - - type: IDENTITY_ATTRIBUTE - property: displayName - value: '#@' - operation: CONTAINS - negateResult: false - shortCircuit: false - recordChildMatches: false - id: null - suppressMatchedItems: false - children: null - isSystemFilter: false - count: 2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#list-campaign-filters - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) - - # List Campaign Filters - - try { - Get-V2025CampaignFilters - - # Below is a request that includes all optional parameters - # Get-V2025CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignFilters" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaign-filters#list-campaign-filters - source: | - from sailpoint.v2025.api.certification_campaign_filters_api import CertificationCampaignFiltersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_campaign_filters200_response import ListCampaignFilters200Response - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - start = 0 # int | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - include_system_filters = True # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to True) # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to True) - try: - # List Campaign Filters - - results = CertificationCampaignFiltersApi(api_client).list_campaign_filters() - # Below is a request that includes all optional parameters - # results = CertificationCampaignFiltersApi(api_client).list_campaign_filters(limit, start, include_system_filters) - print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) - /campaign-filters/{id}: - get: - operationId: getCampaignFilterById - tags: - - Certification Campaign Filters - summary: Get Campaign Filter by ID - description: Retrieves information for an existing campaign filter using the filter's ID. - security: - - userAuth: - - idn:campaign-filter:read - parameters: - - in: path - name: id - schema: - type: string - example: e9f9a1397b842fd5a65842087040d3ac - required: true - x-sailpoint-resource-operation-id: listCampaignFilters - description: The ID of the campaign filter to be retrieved. - responses: - '200': - description: A campaign filter object. - content: - application/json: - schema: - $ref: '#/paths/~1campaign-filters/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignFilterDetails.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#get-campaign-filter-by-id - source: | - $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. - - # Get Campaign Filter by ID - - try { - Get-V2025CampaignFilterById -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CampaignFilterById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignFilterById" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaign-filters#get-campaign-filter-by-id - source: | - from sailpoint.v2025.api.certification_campaign_filters_api import CertificationCampaignFiltersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_filter_details import CampaignFilterDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter to be retrieved. # str | The ID of the campaign filter to be retrieved. - try: - # Get Campaign Filter by ID - - results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id) - print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) - post: - operationId: updateCampaignFilter - tags: - - Certification Campaign Filters - summary: Updates a Campaign Filter - description: Updates an existing campaign filter using the filter's ID. - security: - - userAuth: - - idn:campaign-filter:update - parameters: - - in: path - name: filterId - schema: - type: string - example: e9f9a1397b842fd5a65842087040d3ac - required: true - x-sailpoint-resource-operation-id: listCampaignFilters - description: The ID of the campaign filter being modified. - requestBody: - required: true - description: A campaign filter details with updated field values. - content: - application/json: - schema: - $ref: '#/paths/~1campaign-filters/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignFilterDetails.yaml - responses: - '200': - description: Created successfully. - content: - application/json: - schema: - $ref: '#/paths/~1campaign-filters/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignFilterDetails.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#update-campaign-filter - source: | - $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. - $CampaignFilterDetails = @" - { - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - } - "@ - - # Updates a Campaign Filter - - try { - $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - Update-V2025CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result - - # Below is a request that includes all optional parameters - # Update-V2025CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CampaignFilter" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaign-filters#update-campaign-filter - source: | - from sailpoint.v2025.api.certification_campaign_filters_api import CertificationCampaignFiltersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_filter_details import CampaignFilterDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - filter_id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter being modified. # str | The ID of the campaign filter being modified. - campaign_filter_details = '''{ - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - }''' # CampaignFilterDetails | A campaign filter details with updated field values. - try: - # Updates a Campaign Filter - new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details) - results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id=filter_id, campaign_filter_details=new_campaign_filter_details) - # Below is a request that includes all optional parameters - # results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id, new_campaign_filter_details) - print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) - /campaign-filters/delete: - post: - operationId: deleteCampaignFilters - tags: - - Certification Campaign Filters - summary: Deletes Campaign Filters - description: Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - security: - - userAuth: - - idn:campaign-filter:delete - requestBody: - description: A json list of IDs of campaign filters to delete. - required: true - content: - application/json: - schema: - type: array - items: - type: string - example: - - 0fbe863c063c4c88a35fd7f17e8a3df5 - - 2efb374d392c4d88a34sv7b11e8a4eq6 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#delete-campaign-filters - source: | - $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. - $RequestBody = @""@ - - - # Deletes Campaign Filters - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2025CampaignFilters -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-V2025CampaignFilters -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CampaignFilters" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaign-filters#delete-campaign-filters - source: | - from sailpoint.v2025.api.certification_campaign_filters_api import CertificationCampaignFiltersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - request_body = '''['request_body_example']''' # List[str] | A json list of IDs of campaign filters to delete. - try: - # Deletes Campaign Filters - new_request_body = RequestBody.from_json(request_body) - CertificationCampaignFiltersApi(api_client).delete_campaign_filters(request_body=new_request_body) - # Below is a request that includes all optional parameters - # CertificationCampaignFiltersApi(api_client).delete_campaign_filters(new_request_body) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e) - /campaign-templates: - post: - operationId: createCampaignTemplate - tags: - - Certification Campaigns - summary: Create a Campaign Template - description: | - Use this API to create a certification campaign template based on campaign. - security: - - userAuth: - - idn:campaign-template:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - requestBody: - required: true - content: - application/json: - schema: - type: object - description: Campaign Template - properties: - id: - type: string - description: Id of the campaign template - example: 2c9079b270a266a60170a277bb960008 - name: - type: string - description: This template's name. Has no bearing on generated campaigns' names. - example: Manager Campaign Template - description: - type: string - description: This template's description. Has no bearing on generated campaigns' descriptions. - example: Template for the annual manager campaign. - created: - type: string - description: Creation date of Campaign Template - readOnly: true - format: date-time - example: '2020-03-05T22:44:00.364Z' - modified: - type: string - nullable: true - description: Modification date of Campaign Template - readOnly: true - format: date-time - example: '2020-03-05T22:52:09.969Z' - scheduled: - type: boolean - readOnly: true - description: Indicates if this campaign template has been scheduled. - example: false - default: false - ownerRef: - type: object - readOnly: true - description: 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. - properties: - id: - type: string - description: Id of the owner - example: 2c918086676d3e0601677611dbde220f - type: - type: string - enum: - - IDENTITY - description: Type of the owner - example: IDENTITY - name: - type: string - description: Name of the owner - example: Mister Manager - email: - type: string - description: Email of the owner - example: mr.manager@example.com - deadlineDuration: - type: string - nullable: true - 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 - campaign: - $ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Campaign.yaml - required: - - name - - description - - created - - modified - - campaign - examples: - Manager: - description: This creates a template that can be used to generate manager campaigns. The campaigns will have a due date that is two weeks after their creation date, and will be named "{current date} Manager Review" (e.g. "2020-03-16 Manager Review"). - value: - name: Manager Review - description: A review of everyone's access by their manager. - deadlineDuration: P2W - campaign: - name: Manager Review - description: Review everyone's access. - type: MANAGER - filter: - type: CAMPAIGN_FILTER - id: e0adaae69852e8fe8b8a3d48e5ce757c - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - mandatoryCommentRequirement: NO_DECISIONS - Search: - description: This creates a template that can be used to generate search access campaigns. The campaigns will cover the "reporter" access item for across all identities. - value: - name: Reporting Access Review - description: A review of everyone's access to the reporting system. - deadlineDuration: P2W - campaign: - name: Search Review - description: Review everyone's access to the reporting system. - type: SEARCH - filter: - type: CAMPAIGN_FILTER - id: e0adaae69852e8fe8b8a3d48e5ce757c - searchCampaignInfo: - type: ACCESS - query: '@access(name: ("reporter"))' - description: Identities with reporting abilities - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - mandatoryCommentRequirement: NO_DECISIONS - Source Owner: - description: This creates a template that can be used to generate source owner campaigns. The campaigns will have a due date that is one month after their creation date, and will review one source. - value: - name: AD Source Review - description: A review of our AD source. - deadlineDuration: P1M - campaign: - name: Source Review - description: Review everyone's access. - type: SOURCE_OWNER - filter: - type: CAMPAIGN_FILTER - id: e0adaae69852e8fe8b8a3d48e5ce757c - sourceOwnerCampaignInfo: - sourceIds: - - 2c918084707deba501709d45ce4e5569 - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - correlatedStatus: CORRELATED - mandatoryCommentRequirement: NO_DECISIONS - RoleComposition: - description: This creates a template that can be used to generate role composition campaigns. The campaigns will have a due date that is two weeks after their creation date, and will be named "{current date} Role Composition Review" (e.g. "2020-03-16 Role Composition Review"). - value: - name: Role Composition Review - description: A review of every role's access items, by the specified reviewer. - deadlineDuration: P2W - campaign: - name: Role Composition Review - description: Review all our roles. - type: ROLE_COMPOSITION - roleCompositionCampaignInfo: - remediatorRef: - type: IDENTITY - id: 2c9180876ab2c053016ab6f65dfd5aaa - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - mandatoryCommentRequirement: NO_DECISIONS - responses: - '200': - description: Created successfully. - content: - application/json: - schema: - $ref: '#/paths/~1campaign-templates/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignTemplate.yaml - examples: - Manager: - value: - id: e7dbec99d49349c8951bd84f58a05120 - name: Manager Review - created: '2022-08-02T19:16:42.632Z' - modified: null - description: A review of everyone's access by their manager. - deadlineDuration: P14D - ownerRef: - email: support@testmail.identitysoon.com - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - scheduled: false - campaign: - created: null - modified: null - filter: - type: CAMPAIGN_FILTER - id: e0adaae69852e8fe8b8a3d48e5ce757c - name: Test Manager Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - searchCampaignInfo: null - roleCompositionCampaignInfo: null - alerts: null - totalCertifications: null - completedCertifications: null - sourcesWithOrphanEntitlements: null - id: null - name: Manager Review - description: Review everyone's access. - deadline: null - type: MANAGER - status: null - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - correlatedStatus: CORRELATED - mandatoryCommentRequirement: NO_DECISIONS - Search: - value: - id: b7e6459eed5247ac8b98a5fed81fe27f - name: Reporting Access Review - created: '2022-07-28T19:19:40.035Z' - modified: null - description: A review of everyone's access to the reporting system. - deadlineDuration: P14D - ownerRef: - email: support@testmail.identitysoon.com - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - scheduled: false - campaign: - created: null - modified: null - filter: - type: CAMPAIGN_FILTER - id: e0adaae69852e8fe8b8a3d48e5ce757c - name: Test Search Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - searchCampaignInfo: - type: ACCESS - description: Identities with reporting abilities - reviewerId: null - reviewer: null - query: '@access(name: ("reporter"))' - identityIds: null - accessConstraints: [] - roleCompositionCampaignInfo: null - alerts: null - totalCertifications: null - completedCertifications: null - sourcesWithOrphanEntitlements: null - id: null - name: Search Campaign Review - description: Review everyone's access to the reporting system. - deadline: null - type: SEARCH - status: null - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - correlatedStatus: CORRELATED - mandatoryCommentRequirement: NO_DECISIONS - Source Owner: - value: - id: b9f41bc69e7a4291b9de0630396d030d - name: AD Source Review - created: '2022-08-02T13:40:36.857Z' - modified: null - description: A review of our AD source. - deadlineDuration: P1M - ownerRef: - email: support@testmail.identitysoon.com - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - scheduled: false - campaign: - created: null - modified: null - filter: - type: CAMPAIGN_FILTER - id: e0adaae69852e8fe8b8a3d48e5ce757c - name: Test Source Owner Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: - sourceIds: - - 2c918084707deba501709d45ce4e5569 - searchCampaignInfo: null - roleCompositionCampaignInfo: null - alerts: null - totalCertifications: null - completedCertifications: null - sourcesWithOrphanEntitlements: null - id: null - name: AD Source Review - description: Review everyone's access. - deadline: null - type: SOURCE_OWNER - status: null - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - correlatedStatus: CORRELATED - mandatoryCommentRequirement: NO_DECISIONS - RoleComposition: - value: - id: b9f41bc69e7a4291b9de0630396d030d - name: Campaign With Admin Role - created: '2022-08-02T13:40:36.857Z' - modified: null - description: Campaign With Admin Role - deadlineDuration: null - ownerRef: - email: support@testmail.identitysoon.com - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - scheduled: false - campaign: - created: null - modified: null - filter: null - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - searchCampaignInfo: null - roleCompositionCampaignInfo: - remediatorRef: - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - reviewerId: null - reviewer: null - roleIds: - - b15d609fc5c8434b865fe552315fda8f - query: null - description: null - alerts: null - totalCertifications: null - completedCertifications: null - sourcesWithOrphanEntitlements: null - id: null - name: Campaign With Admin Role - description: Campaign With Admin Role - deadline: null - type: ROLE_COMPOSITION - status: null - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - correlatedStatus: CORRELATED - mandatoryCommentRequirement: NO_DECISIONS - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#create-campaign-template - source: | - $CampaignTemplate = @" - { - "ownerRef" : { - "name" : "Mister Manager", - "id" : "2c918086676d3e0601677611dbde220f", - "type" : "IDENTITY", - "email" : "mr.manager@example.com" - }, - "deadlineDuration" : "P2W", - "created" : "2020-03-05T22:44:00.364Z", - "scheduled" : false, - "name" : "Manager Campaign Template", - "description" : "Template for the annual manager campaign.", - "modified" : "2020-03-05T22:52:09.969Z", - "campaign" : { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "reviewerId" : "2c91808568c529c60168cca6f90c1313", - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - }, - "id" : "2c9079b270a266a60170a277bb960008" - } - "@ - - # Create a Campaign Template - - try { - $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate - New-V2025CampaignTemplate -CampaignTemplate $Result - - # Below is a request that includes all optional parameters - # New-V2025CampaignTemplate -CampaignTemplate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CampaignTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#create-campaign-template - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_template import CampaignTemplate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - campaign_template = '''{ - "ownerRef" : { - "name" : "Mister Manager", - "id" : "2c918086676d3e0601677611dbde220f", - "type" : "IDENTITY", - "email" : "mr.manager@example.com" - }, - "deadlineDuration" : "P2W", - "created" : "2020-03-05T22:44:00.364Z", - "scheduled" : false, - "name" : "Manager Campaign Template", - "description" : "Template for the annual manager campaign.", - "modified" : "2020-03-05T22:52:09.969Z", - "campaign" : { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "reviewerId" : "2c91808568c529c60168cca6f90c1313", - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - }, - "id" : "2c9079b270a266a60170a277bb960008" - }''' # CampaignTemplate | - try: - # Create a Campaign Template - new_campaign_template = CampaignTemplate.from_json(campaign_template) - results = CertificationCampaignsApi(api_client).create_campaign_template(campaign_template=new_campaign_template) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template) - print("The response of CertificationCampaignsApi->create_campaign_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) - get: - operationId: getCampaignTemplates - tags: - - Certification Campaigns - summary: List Campaign Templates - description: | - Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. - - The API returns all campaign templates matching the query parameters. - security: - - userAuth: - - idn:campaign-template:read - - idn:campaign-template:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created, modified** - example: name - - in: query - name: filters - schema: - type: string - format: comma-separated - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **name**: *eq, ge, gt, in, le, lt, ne, sw* - - **id**: *eq, ge, gt, in, le, lt, ne, sw* - example: name eq "manager template" - responses: - '200': - description: List of campaign template objects. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1campaign-templates/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignTemplate.yaml - example: - - id: e7dbec99d49349c8951bd84f58a05120 - name: Manager Review - created: '2022-08-02T19:16:42.632Z' - modified: null - description: A review of everyone's access by their manager. - deadlineDuration: P14D - ownerRef: - email: support@testmail.identitysoon.com - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - scheduled: false - campaign: - created: null - modified: null - filter: - type: CAMPAIGN_FILTER - id: e0adaae69852e8fe8b8a3d48e5ce757c - name: Test Manager Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - searchCampaignInfo: null - roleCompositionCampaignInfo: null - alerts: null - totalCertifications: null - completedCertifications: null - sourcesWithOrphanEntitlements: null - id: null - name: Manager Review - description: Review everyone's access. - deadline: null - type: MANAGER - status: null - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - mandatoryCommentRequirement: NO_DECISIONS - - id: b7e6459eed5247ac8b98a5fed81fe27f - name: Reporting Access Review - created: '2022-07-28T19:19:40.035Z' - modified: null - description: A review of everyone's access to the reporting system. - deadlineDuration: P14D - ownerRef: - email: support@testmail.identitysoon.com - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - scheduled: false - campaign: - created: null - modified: null - filter: - type: CAMPAIGN_FILTER - id: e0adaae69852e8fe8b8a3d48e5ce757c - name: Test Search Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - searchCampaignInfo: - type: ACCESS - description: Identities with reporting abilities - reviewerId: null - reviewer: null - query: '@access(name: ("reporter"))' - identityIds: null - accessConstraints: [] - roleCompositionCampaignInfo: null - alerts: null - totalCertifications: null - completedCertifications: null - sourcesWithOrphanEntitlements: null - id: null - name: Search Campaign - description: Review everyone's access to the reporting system. - deadline: null - type: SEARCH - status: null - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - mandatoryCommentRequirement: NO_DECISIONS - - id: b9f41bc69e7a4291b9de0630396d030d - name: Campaign With Admin Role - created: '2022-08-02T13:40:36.857Z' - modified: null - description: Campaign With Admin Role - deadlineDuration: null - ownerRef: - email: support@testmail.identitysoon.com - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - scheduled: false - campaign: - created: null - modified: null - filter: null - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: null - searchCampaignInfo: null - roleCompositionCampaignInfo: - remediatorRef: - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - reviewerId: null - reviewer: null - roleIds: - - b15d609fc5c8434b865fe552315fda8f - query: null - description: null - alerts: null - totalCertifications: null - completedCertifications: null - sourcesWithOrphanEntitlements: null - id: null - name: Campaign With Admin Role - description: Campaign With Admin Role - deadline: null - type: ROLE_COMPOSITION - status: null - emailNotificationEnabled: false - autoRevokeAllowed: false - recommendationsEnabled: false - mandatoryCommentRequirement: NO_DECISIONS - - id: b9f41bc69e7a4291b9de0630396d030d - name: AD Source Review - created: '2022-08-02T13:40:36.857Z' - modified: null - description: A review of our AD source. - deadlineDuration: P1M - ownerRef: - email: support@testmail.identitysoon.com - type: IDENTITY - id: 7ec252acbd4245548bc25df22348cb75 - name: SailPoint Support - scheduled: false - campaign: - created: null - modified: null - filter: - type: CAMPAIGN_FILTER - id: e0adaae69852e8fe8b8a3d48e5ce757c - name: Test Source Owner Filter - sunsetCommentsRequired: true - sourceOwnerCampaignInfo: - sourceIds: - - 2c918084707deba501709d45ce4e5569 - searchCampaignInfo: null - roleCompositionCampaignInfo: null - alerts: null - totalCertifications: null - completedCertifications: null - sourcesWithOrphanEntitlements: null - id: null - name: AD Source Review - description: Review everyone's access. - deadline: null - type: SOURCE_OWNER - status: null - emailNotificationEnabled: true - autoRevokeAllowed: false - recommendationsEnabled: false - correlatedStatus: CORRELATED - mandatoryCommentRequirement: NO_DECISIONS - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-templates - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) - - # List Campaign Templates - - try { - Get-V2025CampaignTemplates - - # Below is a request that includes all optional parameters - # Get-V2025CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignTemplates" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-campaign-templates - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_template import CampaignTemplate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - filters = 'name eq \"manager template\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) - try: - # List Campaign Templates - - results = CertificationCampaignsApi(api_client).get_campaign_templates() - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) - print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - /campaign-templates/{id}: - patch: - operationId: patchCampaignTemplate - tags: - - Certification Campaigns - summary: Update a Campaign Template - description: | - Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - security: - - userAuth: - - idn:campaign-template:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getCampaignTemplates - description: ID of the campaign template being modified. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - description: | - A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * name - * description - * deadlineDuration - * campaign (all fields that are allowed during create) - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /description - value: Updated description! - - op: replace - path: /campaign/filter/id - value: ff80818155fe8c080155fe8d925b0316 - responses: - '200': - description: This response indicates that the PATCH operation succeeded, and the API returns the template's new representation. - content: - application/json: - schema: - $ref: '#/paths/~1campaign-templates/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignTemplate.yaml - examples: - Manager: - $ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/Manager' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/campaign/examples/CampaignTemplateManager.yaml - Search: - $ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/Search' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/campaign/examples/CampaignTemplateSearch.yaml - Source Owner: - $ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/Source%20Owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/campaign/examples/CampaignTemplateSourceOwner.yaml - RoleComposition: - $ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/RoleComposition' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/campaign/examples/CampaignTemplateRoleComposition.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#patch-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update a Campaign Template - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025CampaignTemplate -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025CampaignTemplate -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CampaignTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#patch-campaign-template - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_template import CampaignTemplate - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}]''' # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - try: - # Update a Campaign Template - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = CertificationCampaignsApi(api_client).patch_campaign_template(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation) - print("The response of CertificationCampaignsApi->patch_campaign_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) - get: - operationId: getCampaignTemplate - tags: - - Certification Campaigns - summary: Get a Campaign Template - description: | - Use this API to fetch a certification campaign template by ID. - security: - - userAuth: - - idn:campaign-template:read - - idn:campaign-template:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getCampaignTemplates - description: Requested campaign template's ID. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: Data for the campaign matching the given ID. - content: - application/json: - schema: - $ref: '#/paths/~1campaign-templates/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignTemplate.yaml - examples: - Manager: - $ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/Manager' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/campaign/examples/CampaignTemplateManager.yaml - Search: - $ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/Search' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/campaign/examples/CampaignTemplateSearch.yaml - Source Owner: - $ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/Source%20Owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/campaign/examples/CampaignTemplateSourceOwner.yaml - RoleComposition: - $ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/RoleComposition' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/campaign/examples/CampaignTemplateRoleComposition.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. - - # Get a Campaign Template - - try { - Get-V2025CampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-campaign-template - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_template import CampaignTemplate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID. - try: - # Get a Campaign Template - - results = CertificationCampaignsApi(api_client).get_campaign_template(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_campaign_template(id) - print("The response of CertificationCampaignsApi->get_campaign_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) - delete: - operationId: deleteCampaignTemplate - tags: - - Certification Campaigns - summary: Delete a Campaign Template - description: | - Use this API to delete a certification campaign template by ID. - security: - - userAuth: - - idn:campaign-template:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getCampaignTemplates - description: ID of the campaign template being deleted. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#delete-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. - - # Delete a Campaign Template - - try { - Remove-V2025CampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025CampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CampaignTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#delete-campaign-template - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted. - try: - # Delete a Campaign Template - - CertificationCampaignsApi(api_client).delete_campaign_template(id=id) - # Below is a request that includes all optional parameters - # CertificationCampaignsApi(api_client).delete_campaign_template(id) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) - /campaign-templates/{id}/schedule: - get: - operationId: getCampaignTemplateSchedule - tags: - - Certification Campaigns - summary: Get Campaign Template Schedule - description: | - Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getCampaignTemplates - description: ID of the campaign template whose schedule is being fetched. - example: 04bedce387bd47b2ae1f86eb0bb36dee - responses: - '200': - description: Current schedule for the campaign template. See the [Set Campaign Template Schedule endpoint documentation](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule) for more examples. - content: - application/json: - schema: - type: object - properties: - type: - type: string - description: Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. - enum: - - WEEKLY - - MONTHLY - - ANNUALLY - - CALENDAR - example: WEEKLY - months: - type: object - nullable: true - description: | - Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: - - On February and March: - * type LIST - * values "2", "3" - - Every 3 months, starting in January (quarterly): - * type LIST - * values "1" - * interval 3 - - Every two months between July and December: - * type RANGE - * values "7", "12" - * interval 2 - properties: - type: - type: string - description: Enum type to specify months value - enum: - - LIST - - RANGE - example: LIST - values: - type: array - description: Values of the months based on the enum type mentioned above - items: - type: string - example: - - '1' - interval: - type: integer - example: 2 - format: int64 - description: Interval between the cert generations - required: - - type - - values - days: - type: object - description: | - Specifies which day(s) a schedule is active for. This is required for all schedule types. - The "values" field holds different data depending on the type of schedule: - * WEEKLY: days of the week (1-7) - * MONTHLY: days of the month (1-31, L, L-1...) - * ANNUALLY: if the "months" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year ("--12-31") - * CALENDAR: ISO-8601 dates ("2020-12-31") - - Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided - with ISO-8601 dates without year. - - Examples: - - On Sundays: - * type LIST - * values "1" - - The second to last day of the month: - * type LIST - * values "L-1" - - From the 20th to the last day of the month: - * type RANGE - * values "20", "L" - - Every March 2nd: - * type LIST - * values "--03-02" - - On March 2nd, 2021: - * type: LIST - * values "2021-03-02" - properties: - type: - type: string - description: Enum type to specify days value - enum: - - LIST - - RANGE - example: LIST - values: - type: array - description: Values of the days based on the enum type mentioned above - items: - type: string - example: - - '1' - interval: - type: integer - example: 2 - format: int64 - description: Interval between the cert generations - nullable: true - required: - - type - - values - hours: - type: object - description: | - Specifies which hour(s) a schedule is active for. Examples: - - Every three hours starting from 8AM, inclusive: - * type LIST - * values "8" - * interval 3 - - During business hours: - * type RANGE - * values "9", "5" - - At 5AM, noon, and 5PM: - * type LIST - * values "5", "12", "17" - properties: - type: - type: string - description: Enum type to specify hours value - enum: - - LIST - - RANGE - example: LIST - values: - type: array - description: Values of the days based on the enum type mentioned above - items: - type: string - example: - - '1' - interval: - type: integer - format: int64 - example: 2 - description: Interval between the cert generations - nullable: true - required: - - type - - values - expiration: - type: string - format: date-time - description: Specifies the time after which this schedule will no longer occur. - example: '2022-09-19 13:55:26' - nullable: true - timeZoneId: - type: string - description: The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to "CST", the schedule will run at 1AM CST. - example: CST - required: - - type - - hours - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. - - # Get Campaign Template Schedule - - try { - Get-V2025CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CampaignTemplateSchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#get-campaign-template-schedule - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.schedule import Schedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template whose schedule is being fetched. # str | ID of the campaign template whose schedule is being fetched. - try: - # Get Campaign Template Schedule - - results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id) - print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) - put: - operationId: setCampaignTemplateSchedule - tags: - - Certification Campaigns - summary: Set Campaign Template Schedule - description: | - Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getCampaignTemplates - description: ID of the campaign template being scheduled. - example: 04bedce387bd47b2ae1f86eb0bb36dee - requestBody: - content: - application/json: - schema: - $ref: '#/paths/~1campaign-templates~1%7Bid%7D~1schedule/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schedule.yaml - examples: - Monthly: - description: Runs on the 15th and last day of the month, at 5PM. - value: - type: MONTHLY - hours: - type: LIST - values: - - '17' - days: - type: LIST - values: - - '15' - Once a year: - description: Runs every January 1st at midnight. - value: - type: ANNUALLY - hours: - type: LIST - values: - - '0' - days: - type: LIST - values: - - '--01-01' - Quarterly: - description: Runs once a quarter (every 3 months) on the first of the month at 1AM. - value: - type: ANNUALLY - hours: - type: LIST - values: - - '1' - days: - type: LIST - values: - - '1' - months: - type: LIST - values: - - '1' - interval: 3 - Yearly on Specific Days: - description: Runs on March 12 and December 5 at 1AM, every year. - value: - type: ANNUALLY - hours: - type: LIST - values: - - '1' - days: - type: LIST - values: - - '--03-12' - - '--12-05' - On a Specific Date: - description: Runs at 1AM on February 18th, 2020 - value: - type: CALENDAR - hours: - type: LIST - values: - - '1' - days: - type: LIST - values: - - '2020-02-18' - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#set-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. - $Schedule = @" - { - "hours" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "months" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "timeZoneId" : "CST", - "days" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "expiration" : "2000-01-23T04:56:07.000+00:00", - "type" : "WEEKLY" - } - "@ - - # Set Campaign Template Schedule - - try { - Set-V2025CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Set-V2025CampaignTemplateSchedule -Id $Id -Schedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#set-campaign-template-schedule - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.schedule import Schedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template being scheduled. # str | ID of the campaign template being scheduled. - schedule = '''{ - "hours" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "months" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "timeZoneId" : "CST", - "days" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "expiration" : "2000-01-23T04:56:07.000+00:00", - "type" : "WEEKLY" - }''' # Schedule | (optional) - try: - # Set Campaign Template Schedule - - CertificationCampaignsApi(api_client).set_campaign_template_schedule(id=id) - # Below is a request that includes all optional parameters - # CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, new_schedule) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) - delete: - operationId: deleteCampaignTemplateSchedule - tags: - - Certification Campaigns - summary: Delete Campaign Template Schedule - description: | - Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getCampaignTemplates - description: ID of the campaign template whose schedule is being deleted. - example: 04bedce387bd47b2ae1f86eb0bb36dee - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#delete-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. - - # Delete Campaign Template Schedule - - try { - Remove-V2025CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025CampaignTemplateSchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#delete-campaign-template-schedule - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template whose schedule is being deleted. # str | ID of the campaign template whose schedule is being deleted. - try: - # Delete Campaign Template Schedule - - CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id=id) - # Below is a request that includes all optional parameters - # CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) - /campaign-templates/{id}/generate: - post: - operationId: startGenerateCampaignTemplate - tags: - - Certification Campaigns - summary: Generate a Campaign from Template - security: - - userAuth: - - idn:campaign-template:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - description: | - Use this API to generate a new certification campaign from a campaign template. - - The campaign object contained in the template has special formatting applied to its name and description - fields that determine the generated campaign's name/description. Placeholders in those fields are - formatted with the current date and time upon generation. - - Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For - example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a - campaign called "Campaign for 2020" (assuming the year at generation time is 2020). - - Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getCampaignTemplates - description: ID of the campaign template to use for generation. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: This response indicates that a campaign was successfully generated from this template, and the API returns a reference to the new campaign. - content: - application/json: - schema: - $ref: '#/components/schemas/Certification/properties/campaign' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignReference.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-generate-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. - - # Generate a Campaign from Template - - try { - Start-V2025GenerateCampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025GenerateCampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025GenerateCampaignTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-campaigns#start-generate-campaign-template - source: | - from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.campaign_reference import CampaignReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template to use for generation. # str | ID of the campaign template to use for generation. - try: - # Generate a Campaign from Template - - results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id=id) - # Below is a request that includes all optional parameters - # results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id) - print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) - /certifications: - get: - operationId: listIdentityCertifications - tags: - - Certifications - summary: List Identity Campaign Certifications - description: Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - parameters: - - in: query - name: reviewer-identity - schema: - type: string - example: me - description: Reviewer's identity. *me* indicates the current user. - required: false - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - example: id eq "ef38f94347e94562b5bb8424a56397d8" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **campaign.id**: *eq, in* - - **phase**: *eq* - - **completed**: *eq* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: name,due - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, due, signed** - responses: - '200': - description: List of identity campaign certifications. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - example: 2c9180835d2e5168015d32f890ca1581 - type: string - description: id of the certification - name: - example: Source Owner Access Review for Employees [source] - type: string - description: name of the certification - campaign: - $ref: '#/components/schemas/Certification/properties/campaign' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CampaignReference.yaml - completed: - type: boolean - description: Have all decisions been made? - example: true - identitiesCompleted: - type: integer - description: The number of identities for whom all decisions have been made and are complete. - example: 5 - format: int32 - identitiesTotal: - type: integer - description: The total number of identities in the Certification, both complete and incomplete. - example: 10 - format: int32 - created: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: created date - modified: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: modified date - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made. - example: 20 - format: int32 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions. - example: 40 - format: int32 - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - nullable: true - signed: - type: string - format: date-time - nullable: true - description: The date the reviewer signed off on the Certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - $ref: '#/components/schemas/Certification/properties/reviewer' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Reviewer.yaml - reassignment: - $ref: '#/components/schemas/Certification/properties/reassignment' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Reassignment.yaml - hasErrors: - description: Identifies if the certification has an error - type: boolean - example: false - errorMessage: - description: Description of the certification error - nullable: true - type: string - example: The certification has an error - phase: - $ref: '#/components/schemas/Certification/properties/phase' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertificationPhase.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#list-identity-certifications - source: | - $ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) - $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) - - # List Identity Campaign Certifications - - try { - Get-V2025IdentityCertifications - - # Below is a request that includes all optional parameters - # Get-V2025IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityCertifications" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#list-identity-certifications - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_certification_dto import IdentityCertificationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - reviewer_identity = 'me' # str | Reviewer's identity. *me* indicates the current user. (optional) # str | Reviewer's identity. *me* indicates the current user. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) - sorters = 'name,due' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) - try: - # List Identity Campaign Certifications - - results = CertificationsApi(api_client).list_identity_certifications() - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) - print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) - /certifications/{id}: - get: - operationId: getIdentityCertification - tags: - - Certifications - summary: Identity Certification by ID - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - description: This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityCertifications - description: The certification id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: An identity campaign certification object - content: - application/json: - schema: - $ref: '#/paths/~1certifications/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityCertificationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-identity-certification - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id - - # Identity Certification by ID - - try { - Get-V2025IdentityCertification -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityCertification -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityCertification" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#get-identity-certification - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_certification_dto import IdentityCertificationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id - try: - # Identity Certification by ID - - results = CertificationsApi(api_client).get_identity_certification(id=id) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).get_identity_certification(id) - print("The response of CertificationsApi->get_identity_certification:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e) - /certifications/{id}/access-review-items: - get: - operationId: listIdentityAccessReviewItems - tags: - - Certifications - summary: List of Access Review Items - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - description: This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityCertifications - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - required: false - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **type**: *eq* - - **access.type**: *eq* - - **completed**: *eq, ne* - - **identitySummary.id**: *eq, in* - - **identitySummary.name**: *eq, sw* - - **access.id**: *eq, in* - - **access.name**: *eq, sw* - - **entitlement.sourceName**: *eq, sw* - - **accessProfile.sourceName**: *eq, sw* - example: id eq "ef38f94347e94562b5bb8424a56397d8" - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: access.name,-accessProfile.sourceName - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - - in: query - name: entitlements - required: false - schema: - type: string - example: identityEntitlement - description: |- - Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. - - An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - - in: query - name: access-profiles - required: false - schema: - type: string - example: accessProfile1 - description: |- - Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. - - An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - - in: query - name: roles - required: false - schema: - type: string - example: userRole - description: |- - Filter results to view access review items that pertain to any of the specified comma-separated role IDs. - - An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - responses: - '200': - description: A list of access review items - content: - application/json: - schema: - type: array - items: - type: object - properties: - accessSummary: - $ref: '#/paths/~1certifications~1%7Bid%7D~1access-summaries~1%7Btype%7D/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessSummary.yaml - identitySummary: - $ref: '#/paths/~1certifications~1%7Bid%7D~1identity-summaries/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertificationIdentitySummary.yaml - id: - type: string - description: The review item's id - example: ef38f94347e94562b5bb8424a56397d8 - completed: - type: boolean - description: Whether the review item is complete - example: false - newAccess: - type: boolean - description: Indicates whether the review item is for new access to a source - example: false - decision: - type: string - description: The decision to approve or revoke the review item - enum: - - APPROVE - - REVOKE - example: APPROVE - comments: - nullable: true - type: string - description: Comments for this review item - example: This user still needs access to this source - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#list-identity-access-review-items - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) - $Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) - $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) - $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) - - # List of Access Review Items - - try { - Get-V2025IdentityAccessReviewItems -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessReviewItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#list-identity-access-review-items - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_review_item import AccessReviewItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name,-accessProfile.sourceName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) - entitlements = 'identityEntitlement' # str | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) - access_profiles = 'accessProfile1' # str | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) - roles = 'userRole' # str | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) - try: - # List of Access Review Items - - results = CertificationsApi(api_client).list_identity_access_review_items(id=id) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) - print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) - /certifications/{id}/decide: - post: - operationId: makeIdentityDecision - tags: - - Certifications - summary: Decide on a Certification Item - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - description: The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityCertifications - description: The ID of the identity campaign certification on which to make decisions - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: A non-empty array of decisions to be made. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The id of the review decision - example: ef38f94347e94562b5bb8424a56397d8 - decision: - $ref: '#/paths/~1certifications~1%7Bid%7D~1access-review-items/get/responses/200/content/application~1json/schema/items/properties/decision' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertificationDecision.yaml - proposedEndDate: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - description: The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions. - bulk: - type: boolean - description: Indicates whether decision should be marked as part of a larger bulk decision - example: true - recommendation: - type: object - properties: - recommendation: - type: string - description: The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. - example: null - nullable: true - reasons: - type: array - items: - type: string - description: A list of reasons for the recommendation. - example: - - Reason 1 - - Reason 2 - timestamp: - type: string - format: date-time - description: The time at which the recommendation was recorded. - example: '2020-06-01T13:49:37.385Z' - comments: - type: string - description: Comments recorded when the decision was made - example: This user no longer needs access to this source - required: - - id - - decision - - bulk - minItems: 1 - maxItems: 250 - example: - - id: ef38f94347e94562b5bb8424a56396b5 - decision: APPROVE - bulk: true - comments: This user still needs access to this source. - - id: ef38f94347e94562b5bb8424a56397d8 - decision: APPROVE - bulk: true - comments: This user still needs access to this source too. - responses: - '200': - description: An identity campaign certification object - content: - application/json: - schema: - $ref: '#/paths/~1certifications/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityCertificationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#make-identity-decision - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions - $ReviewDecision = @"{ - "comments" : "This user no longer needs access to this source", - "decision" : "APPROVE", - "proposedEndDate" : "2017-07-11T18:45:37.098Z", - "recommendation" : { - "reasons" : [ "Reason 1", "Reason 2" ], - "recommendation" : "recommendation", - "timestamp" : "2020-06-01T13:49:37.385Z" - }, - "id" : "ef38f94347e94562b5bb8424a56397d8", - "bulk" : true - }"@ - - - # Decide on a Certification Item - - try { - $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision - Select-V2025IdentityDecision -Id $Id -ReviewDecision $Result - - # Below is a request that includes all optional parameters - # Select-V2025IdentityDecision -Id $Id -ReviewDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2025IdentityDecision" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#make-identity-decision - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_certification_dto import IdentityCertificationDto - from sailpoint.v2025.models.review_decision import ReviewDecision - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the identity campaign certification on which to make decisions # str | The ID of the identity campaign certification on which to make decisions - review_decision = '''[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}]''' # List[ReviewDecision] | A non-empty array of decisions to be made. - try: - # Decide on a Certification Item - new_review_decision = ReviewDecision.from_json(review_decision) - results = CertificationsApi(api_client).make_identity_decision(id=id, review_decision=new_review_decision) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).make_identity_decision(id, new_review_decision) - print("The response of CertificationsApi->make_identity_decision:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) - /certifications/{id}/reassign: - post: - operationId: reassignIdentityCertifications - tags: - - Certifications - summary: Reassign Identities or Items - description: This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityCertifications - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - reassign: - type: array - items: - $ref: '#/components/schemas/AccessReviewReassignment/properties/reassign/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReassignReference.yaml - reassignTo: - type: string - description: The ID of the identity to which the certification is reassigned - example: ef38f94347e94562b5bb8424a56397d8 - reason: - type: string - description: The reason comment for why the reassign was made - example: reassigned for some reason - required: - - reassign - - reassignTo - - reason - responses: - '200': - description: An identity campaign certification details after completing the reassignment. - content: - application/json: - schema: - $ref: '#/paths/~1certifications/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityCertificationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#reassign-identity-certifications - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $ReviewReassign = @" - { - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - } - "@ - - # Reassign Identities or Items - - try { - $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Invoke-V2025ReassignIdentityCertifications -Id $Id -ReviewReassign $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025ReassignIdentityCertifications -Id $Id -ReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ReassignIdentityCertifications" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#reassign-identity-certifications - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_certification_dto import IdentityCertificationDto - from sailpoint.v2025.models.review_reassign import ReviewReassign - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - review_reassign = '''{ - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - }''' # ReviewReassign | - try: - # Reassign Identities or Items - new_review_reassign = ReviewReassign.from_json(review_reassign) - results = CertificationsApi(api_client).reassign_identity_certifications(id=id, review_reassign=new_review_reassign) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).reassign_identity_certifications(id, new_review_reassign) - print("The response of CertificationsApi->reassign_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) - /certifications/{id}/sign-off: - post: - operationId: signOffIdentityCertification - tags: - - Certifications - summary: Finalize Identity Certification Decisions - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - description: This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityCertifications - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: An identity campaign certification object - content: - application/json: - schema: - $ref: '#/paths/~1certifications/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityCertificationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#sign-off-identity-certification - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - - # Finalize Identity Certification Decisions - - try { - Invoke-V2025SignOffIdentityCertification -Id $Id - - # Below is a request that includes all optional parameters - # Invoke-V2025SignOffIdentityCertification -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025SignOffIdentityCertification" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#sign-off-identity-certification - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_certification_dto import IdentityCertificationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - try: - # Finalize Identity Certification Decisions - - results = CertificationsApi(api_client).sign_off_identity_certification(id=id) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).sign_off_identity_certification(id) - print("The response of CertificationsApi->sign_off_identity_certification:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e) - /certifications/{id}/decision-summary: - get: - operationId: getIdentityDecisionSummary - tags: - - Certification Summaries - summary: Summary of Certification Decisions - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - description: This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityCertifications - description: The certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: query - name: filters - required: false - schema: - type: string - example: identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **identitySummary.id**: *eq, in* - responses: - '200': - description: Summary of the decisions made - content: - application/json: - schema: - type: object - properties: - entitlementDecisionsMade: - type: integer - description: Number of entitlement decisions that have been made - example: 3 - format: int32 - accessProfileDecisionsMade: - type: integer - description: Number of access profile decisions that have been made - example: 5 - format: int32 - roleDecisionsMade: - type: integer - description: Number of role decisions that have been made - example: 2 - format: int32 - accountDecisionsMade: - type: integer - description: Number of account decisions that have been made - example: 4 - format: int32 - entitlementDecisionsTotal: - type: integer - description: The total number of entitlement decisions on the certification, both complete and incomplete - example: 6 - format: int32 - accessProfileDecisionsTotal: - type: integer - description: The total number of access profile decisions on the certification, both complete and incomplete - example: 10 - format: int32 - roleDecisionsTotal: - type: integer - description: The total number of role decisions on the certification, both complete and incomplete - example: 4 - format: int32 - accountDecisionsTotal: - type: integer - description: The total number of account decisions on the certification, both complete and incomplete - example: 8 - format: int32 - entitlementsApproved: - type: integer - description: The number of entitlement decisions that have been made which were approved - example: 2 - format: int32 - entitlementsRevoked: - type: integer - description: The number of entitlement decisions that have been made which were revoked - example: 1 - format: int32 - accessProfilesApproved: - type: integer - description: The number of access profile decisions that have been made which were approved - example: 3 - format: int32 - accessProfilesRevoked: - type: integer - description: The number of access profile decisions that have been made which were revoked - example: 2 - format: int32 - rolesApproved: - type: integer - description: The number of role decisions that have been made which were approved - example: 2 - format: int32 - rolesRevoked: - type: integer - description: The number of role decisions that have been made which were revoked - example: 0 - format: int32 - accountsApproved: - type: integer - description: The number of account decisions that have been made which were approved - example: 1 - format: int32 - accountsRevoked: - type: integer - description: The number of account decisions that have been made which were revoked - example: 3 - format: int32 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2025IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) - /certifications/{id}/identity-summaries: - get: - operationId: getIdentitySummaries - tags: - - Certification Summaries - summary: Identity Summaries for Campaign Certification - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - description: This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityCertifications - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - example: id eq "ef38f94347e94562b5bb8424a56397d8" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **completed**: *eq, ne* - - **name**: *eq, sw* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: name - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - responses: - '200': - description: List of identity summaries - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of the identity summary - example: 2c91808772a504f50172a9540e501ba7 - name: - type: string - description: Name of the linked identity - example: Alison Ferguso - identityId: - type: string - description: The ID of the identity being certified - example: 2c9180857182306001719937377a33de - completed: - type: boolean - description: Indicates whether the review items for the linked identity's certification have been completed - example: true - example: - - id: 2c91808772a504f50172a9540e501ba7 - name: Aaron Grey - identityId: 2c9180857182306001719937379633e4 - completed: false - - id: 2c91808772a504f50172a9540e501ba8 - name: Aglae Wilson - identityId: 2c9180857182306001719937377a33de - completed: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2025IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummaries" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) - /certifications/{id}/access-summaries/{type}: - get: - operationId: getIdentityAccessSummaries - tags: - - Certification Summaries - summary: Access Summaries - description: This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - security: - - userAuth: - - idn:certification:read - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityCertifications - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: type - schema: - type: string - enum: - - ROLE - - ACCESS_PROFILE - - ENTITLEMENT - required: true - description: The type of access review item to retrieve summaries for - example: ACCESS_PROFILE - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - example: access.id eq "ef38f94347e94562b5bb8424a56397d8" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **completed**: *eq, ne* - - **access.id**: *eq, in* - - **access.name**: *eq, sw* - - **entitlement.sourceName**: *eq, sw* - - **accessProfile.sourceName**: *eq, sw* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: access.name - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **access.name** - responses: - '200': - description: List of access summaries - content: - application/json: - schema: - type: array - items: - type: object - description: An object holding the access that is being reviewed - properties: - access: - type: object - properties: - type: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml - id: - type: string - description: The ID of the item being certified - example: 2c9180867160846801719932c5153fb7 - name: - type: string - description: The name of the item being certified - example: Entitlement for Company Database - entitlement: - type: object - nullable: true - properties: - id: - type: string - description: The id for the entitlement - example: 2c918085718230600171993742c63558 - name: - type: string - description: The name of the entitlement - example: CN=entitlement.bbb7c650 - description: - nullable: true - type: string - description: Information about the entitlement - example: Gives read/write access to the company database - privileged: - type: boolean - example: false - default: false - description: Indicates if the entitlement is a privileged entitlement - owner: - $ref: '#/components/schemas/RequestableObject/properties/ownerRef' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityReferenceWithNameAndEmail.yaml - attributeName: - type: string - description: The name of the attribute on the source - example: memberOf - attributeValue: - type: string - description: The value of the attribute on the source - example: CN=entitlement.bbb7c650 - sourceSchemaObjectType: - type: string - description: The schema object type on the source used to represent the entitlement and its attributes - example: groups - sourceName: - type: string - description: The name of the source for which this entitlement belongs - example: ODS-AD-Source - sourceType: - type: string - description: The type of the source for which the entitlement belongs - example: Active Directory - Direct - sourceId: - type: string - description: The ID of the source for which the entitlement belongs - example: 78ca6be511cb41fbb86dba2fcca7780c - hasPermissions: - type: boolean - default: false - description: Indicates if the entitlement has permissions - example: false - isPermission: - type: boolean - default: false - description: Indicates if the entitlement is a representation of an account permission - example: false - revocable: - type: boolean - default: false - description: Indicates whether the entitlement can be revoked - example: true - cloudGoverned: - type: boolean - default: false - description: True if the entitlement is cloud governed - example: false - containsDataAccess: - type: boolean - description: True if the entitlement has DAS data - default: false - example: true - dataAccess: - type: object - description: DAS data for the entitlement - nullable: true - properties: - policies: - type: array - description: List of classification policies that apply to resources the entitlement \ groups has access to - items: - type: object - properties: - value: - type: string - description: Value of the policy - example: GDPR-20 - categories: - type: array - description: List of classification categories that apply to resources the entitlement \ groups has access to - items: - type: object - properties: - value: - type: string - description: Value of the category - example: email-7 - matchCount: - type: integer - description: Number of matched for each category - example: 10 - impactScore: - type: object - properties: - value: - type: string - description: Impact Score for this data - example: Medium - account: - type: object - nullable: true - description: Information about the status of the entitlement - properties: - nativeIdentity: - type: string - description: The native identity for this account - example: CN=Alison Ferguso - disabled: - type: boolean - default: false - example: false - description: Indicates whether this account is currently disabled - locked: - type: boolean - default: false - example: false - description: Indicates whether this account is currently locked - type: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml - id: - nullable: true - type: string - description: The id associated with the account - example: 2c9180857182305e0171993737eb29e6 - name: - nullable: true - type: string - description: The account name - example: Alison Ferguso - created: - nullable: true - type: string - format: date-time - description: When the account was created - example: '2020-04-20T20:11:05.067Z' - modified: - nullable: true - type: string - format: date-time - description: When the account was last modified - example: '2020-05-20T18:57:16.987Z' - activityInsights: - type: object - description: Insights into account activity - properties: - accountID: - type: string - description: UUID of the account - example: c4ddd5421d8549f0abd309162cafd3b1 - usageDays: - type: integer - format: int32 - minimum: 0 - maximum: 90 - description: The number of days of activity - example: 45 - usageDaysState: - type: string - enum: - - COMPLETE - - UNKNOWN - description: Status indicating if the activity is complete or unknown - example: COMPLETE - description: - nullable: true - type: string - description: Information about the account - example: Account for Read/write to the company database - governanceGroupId: - nullable: true - type: string - description: The id associated with the machine Account Governance Group - example: 2c9180857182305e0171993737eb29e6 - owner: - type: object - nullable: true - description: Information about the machine account owner - properties: - id: - nullable: true - type: string - description: The id associated with the machine account owner - example: 2c9180857182305e0171993737eb29e8 - type: - type: string - enum: - - IDENTITY - description: An enumeration of the types of Owner supported within the IdentityNow infrastructure. - example: IDENTITY - displayName: - nullable: true - type: string - description: The machine account owner's display name - example: Alison Ferguson - accessProfile: - type: object - properties: - id: - type: string - description: The id of the Access Profile - example: 2c91808a7190d06e01719938fcd20792 - name: - type: string - description: Name of the Access Profile - example: Employee-database-read-write - description: - type: string - description: Information about the Access Profile - example: Collection of entitlements to read/write the employee database - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - example: false - cloudGoverned: - type: boolean - description: True if the entitlement is cloud governed - example: false - endDate: - nullable: true - type: string - format: date-time - description: The date at which a user's access expires - example: '2021-12-25T00:00:00.000Z' - owner: - $ref: '#/components/schemas/RequestableObject/properties/ownerRef' - description: Owner of the Access Profile - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityReferenceWithNameAndEmail.yaml - entitlements: - type: array - description: A list of entitlements associated with this Access Profile - items: - $ref: '#/paths/~1certifications~1%7Bid%7D~1access-summaries~1%7Btype%7D/get/responses/200/content/application~1json/schema/items/properties/entitlement' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/reviews/ReviewableEntitlement.yaml - created: - type: string - description: Date the Access Profile was created. - format: date-time - example: '2021-01-01T22:32:58.104Z' - modified: - type: string - description: Date the Access Profile was last modified. - format: date-time - example: '2021-02-01T22:32:58.104Z' - role: - type: object - nullable: true - properties: - id: - type: string - description: The id for the Role - example: 2c91808a7190d06e0171993907fd0794 - name: - type: string - description: The name of the Role - example: Accounting-Employees - description: - type: string - description: Information about the Role - example: Role for members of the accounting department with the necessary Access Profiles - privileged: - type: boolean - description: Indicates if the entitlement is a privileged entitlement - example: false - owner: - $ref: '#/components/schemas/RequestableObject/properties/ownerRef' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityReferenceWithNameAndEmail.yaml - revocable: - type: boolean - description: Indicates whether the Role can be revoked or requested - example: false - endDate: - type: string - format: date-time - description: The date when a user's access expires. - example: '2021-12-25T00:00:00.000Z' - accessProfiles: - type: array - description: The list of Access Profiles associated with this Role - items: - $ref: '#/paths/~1certifications~1%7Bid%7D~1access-summaries~1%7Btype%7D/get/responses/200/content/application~1json/schema/items/properties/accessProfile' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/reviews/ReviewableAccessProfile.yaml - entitlements: - type: array - description: The list of entitlements associated with this Role - items: - $ref: '#/paths/~1certifications~1%7Bid%7D~1access-summaries~1%7Btype%7D/get/responses/200/content/application~1json/schema/items/properties/entitlement' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/reviews/ReviewableEntitlement.yaml - example: - - access: - type: ENTITLEMENT - id: 2c9180857182305e01719937429e2bad - name: CN=Engineering - entitlement: - id: 2c9180857182305e01719937429e2bad - name: CN=Engineering - description: Access to the engineering database - privileged: false - owner: - email: brandon.gray@acme-solar.com - type: IDENTITY - id: 2c9180867160846801719932c5153fb7 - name: Brandon Gray - attributeName: memberOf - attributeValue: CN=Engineering - sourceName: ODS-AD-Source - hasPermissions: true - revocable: true - containsDataAccess: true - dataAccess: - policies: - - value: GDPR-1 - - value: GDPR-2 - categories: - - value: email-7 - matchCount: 74 - - value: email-9 - matchCount: 30 - impactScore: - value: Medium - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2025IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) - /certifications/{id}/identity-summaries/{identitySummaryId}: - get: - operationId: getIdentitySummary - tags: - - Certification Summaries - summary: Summary for Identity - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - description: This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityCertifications - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: identitySummaryId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getIdentitySummaries - description: The identity summary ID - example: 2c91808772a504f50172a9540e501ba8 - responses: - '200': - description: An identity summary - content: - application/json: - schema: - $ref: '#/paths/~1certifications~1%7Bid%7D~1identity-summaries/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertificationIdentitySummary.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - /certifications/{certificationId}/access-review-items/{itemId}/permissions: - get: - operationId: getIdentityCertificationItemPermissions - tags: - - Certifications - summary: Permissions for Entitlement Certification Item - description: This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. - security: - - userAuth: - - idn:certification:read - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **target**: *eq, sw* - - **rights**: *ca* - - Supported composite operators: *and, or* - - All field values (second filter operands) are case-insensitive for this API. - - Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. - - For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` - - The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - example: target eq "SYS.OBJAUTH2" - - in: path - name: certificationId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityCertifications - description: The certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: itemId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityAccessReviewItems - description: The certification item ID - example: 2c91808671bcbab40171bd945d961227 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - responses: - '200': - description: A list of permissions associated with the given itemId - content: - application/json: - schema: - type: array - items: - type: object - description: Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. - properties: - rights: - type: array - description: All the rights (e.g. actions) that this permission allows on the target - readOnly: true - items: - type: string - example: SELECT - target: - type: string - description: The target the permission would grants rights on. - readOnly: true - example: SYS.GV_$TRANSACTION - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-identity-certification-item-permissions - source: | - $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID - $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Permissions for Entitlement Certification Item - - try { - Get-V2025IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId - - # Below is a request that includes all optional parameters - # Get-V2025IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityCertificationItemPermissions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#get-identity-certification-item-permissions - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.permission_dto import PermissionDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - certification_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - item_id = '2c91808671bcbab40171bd945d961227' # str | The certification item ID # str | The certification item ID - filters = 'target eq \"SYS.OBJAUTH2\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Permissions for Entitlement Certification Item - - results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id=certification_id, item_id=item_id) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) - print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - /certifications/{id}/reviewers: - get: - operationId: listCertificationReviewers - tags: - - Certifications - summary: List of Reviewers for certification - description: This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - security: - - userAuth: - - idn:certification:read - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityCertifications - description: The certification ID - example: ef38f94347e94562b5bb8424a56397d8 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **email**: *eq, sw* - example: name eq "Bob" - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, email** - example: name - responses: - '200': - description: A list of reviewers - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/RequestableObject/properties/ownerRef' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityReferenceWithNameAndEmail.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#list-certification-reviewers - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) - - # List of Reviewers for certification - - try { - Get-V2025CertificationReviewers -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CertificationReviewers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#list-certification-reviewers - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"Bob\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) - try: - # List of Reviewers for certification - - results = CertificationsApi(api_client).list_certification_reviewers(id=id) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) - print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - /certifications/{id}/reassign-async: - post: - operationId: submitReassignCertsAsync - tags: - - Certifications - summary: Reassign Certifications Asynchronously - description: | - This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another - reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the - reassignment is complete. - - Reviewers for this certification can also call this API. - security: - - userAuth: - - idn:campaign:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentityCertifications - description: The identity campaign certification ID - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1certifications~1%7Bid%7D~1reassign/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReviewReassign.yaml - responses: - '200': - description: A certification task object for the reassignment which can be queried for status. - content: - application/json: - schema: - $ref: '#/paths/~1campaigns~1%7Bid%7D~1reassign/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertificationTask.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#submit-reassign-certs-async - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $ReviewReassign = @" - { - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - } - "@ - - # Reassign Certifications Asynchronously - - try { - $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Submit-V2025ReassignCertsAsync -Id $Id -ReviewReassign $Result - - # Below is a request that includes all optional parameters - # Submit-V2025ReassignCertsAsync -Id $Id -ReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025ReassignCertsAsync" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#submit-reassign-certs-async - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_task import CertificationTask - from sailpoint.v2025.models.review_reassign import ReviewReassign - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - review_reassign = '''{ - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - }''' # ReviewReassign | - try: - # Reassign Certifications Asynchronously - new_review_reassign = ReviewReassign.from_json(review_reassign) - results = CertificationsApi(api_client).submit_reassign_certs_async(id=id, review_reassign=new_review_reassign) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign) - print("The response of CertificationsApi->submit_reassign_certs_async:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) - /certification-tasks/{id}: - get: - operationId: getCertificationTask - tags: - - Certifications - summary: Certification Task by ID - description: This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - security: - - userAuth: - - idn:certification:read - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPendingCertificationTasks - description: The task ID - example: 63b32151-26c0-42f4-9299-8898dc1c9daa - responses: - '200': - description: A certification task - content: - application/json: - schema: - $ref: '#/paths/~1campaigns~1%7Bid%7D~1reassign/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertificationTask.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-certification-task - source: | - $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID - - # Certification Task by ID - - try { - Get-V2025CertificationTask -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CertificationTask -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CertificationTask" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#get-certification-task - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_task import CertificationTask - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '63b32151-26c0-42f4-9299-8898dc1c9daa' # str | The task ID # str | The task ID - try: - # Certification Task by ID - - results = CertificationsApi(api_client).get_certification_task(id=id) - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).get_certification_task(id) - print("The response of CertificationsApi->get_certification_task:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) - /certification-tasks: - get: - operationId: getPendingCertificationTasks - tags: - - Certifications - summary: List of Pending Certification Tasks - description: This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - security: - - userAuth: - - idn:certification:read - parameters: - - in: query - name: reviewer-identity - schema: - type: string - example: Ada.1de82e55078344 - description: The ID of reviewer identity. *me* indicates the current user. - required: false - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - example: type eq "ADMIN_REASSIGN" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **targetId**: *eq, in* - - **type**: *eq, in* - responses: - '200': - description: A list of pending certification tasks - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1campaigns~1%7Bid%7D~1reassign/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertificationTask.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-pending-certification-tasks - source: | - $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) - - # List of Pending Certification Tasks - - try { - Get-V2025PendingCertificationTasks - - # Below is a request that includes all optional parameters - # Get-V2025PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingCertificationTasks" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certifications#get-pending-certification-tasks - source: | - from sailpoint.v2025.api.certifications_api import CertificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_task import CertificationTask - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - reviewer_identity = 'Ada.1de82e55078344' # str | The ID of reviewer identity. *me* indicates the current user. (optional) # str | The ID of reviewer identity. *me* indicates the current user. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'type eq \"ADMIN_REASSIGN\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) - try: - # List of Pending Certification Tasks - - results = CertificationsApi(api_client).get_pending_certification_tasks() - # Below is a request that includes all optional parameters - # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) - print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) - /connector-customizers: - get: - tags: - - Connector Customizers - operationId: listConnectorCustomizers - summary: List All Connector Customizers - description: List all connector customizers. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - responses: - '200': - description: List all connector customizers. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - readOnly: true - description: Connector customizer ID. - example: b07dc46a-1498-4de8-bfbb-259a68e70c8a - name: - type: string - description: Connector customizer name. - example: connector-customizer-name - imageVersion: - type: integer - format: int64 - description: Connector customizer image version. - example: 1 - imageID: - type: string - description: Connector customizer image id. - example: 2c91808568c529c60168cca6f90c1324 - tenantID: - type: string - description: Connector customizer tenant id. - example: 2c91808568c529c60168cca6f90c1324 - created: - type: string - description: Date-time when the connector customizer was created - format: date-time - example: 2009-11-10 23:00:00 +0000 UTC - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:connector:read - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#list-connector-customizers - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List All Connector Customizers - - try { - Get-V2025ConnectorCustomizers - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorCustomizers -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorCustomizers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-customizers#list-connector-customizers - source: | - from sailpoint.v2025.api.connector_customizers_api import ConnectorCustomizersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_customizers_response import ConnectorCustomizersResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List All Connector Customizers - - results = ConnectorCustomizersApi(api_client).list_connector_customizers() - # Below is a request that includes all optional parameters - # results = ConnectorCustomizersApi(api_client).list_connector_customizers(offset, limit) - print("The response of ConnectorCustomizersApi->list_connector_customizers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorCustomizersApi->list_connector_customizers: %s\n" % e) - post: - tags: - - Connector Customizers - operationId: createConnectorCustomizer - summary: Create Connector Customizer - description: Create a connector customizer. - requestBody: - required: true - description: Connector customizer to create. - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: Connector customizer name. - example: My Custom Connector - responses: - '201': - description: Created connector customizer. - content: - application/json: - schema: - description: ConnectorCustomizerResponse - type: object - properties: - id: - type: string - description: the ID of connector customizer. - example: b07dc46a-1498-4de8-bfbb-259a68e70c8a - name: - type: string - description: name of the connector customizer. - example: connector-customizer-name - tenantID: - type: string - description: Connector customizer tenant id. - example: 2c91808568c529c60168cca6f90c1324 - created: - type: string - description: Date-time when the connector customizer was created. - format: date-time - example: 2009-11-10 23:00:00 +0000 UTC - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:connector:create - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#create-connector-customizer - source: | - $ConnectorCustomizerCreateRequest = @" - { - "name" : "My Custom Connector" - } - "@ - - # Create Connector Customizer - - try { - $Result = ConvertFrom-JsonToConnectorCustomizerCreateRequest -Json $ConnectorCustomizerCreateRequest - New-V2025ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ConnectorCustomizer" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-customizers#create-connector-customizer - source: | - from sailpoint.v2025.api.connector_customizers_api import ConnectorCustomizersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_customizer_create_request import ConnectorCustomizerCreateRequest - from sailpoint.v2025.models.connector_customizer_create_response import ConnectorCustomizerCreateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - connector_customizer_create_request = '''{ - "name" : "My Custom Connector" - }''' # ConnectorCustomizerCreateRequest | Connector customizer to create. - try: - # Create Connector Customizer - new_connector_customizer_create_request = ConnectorCustomizerCreateRequest.from_json(connector_customizer_create_request) - results = ConnectorCustomizersApi(api_client).create_connector_customizer(connector_customizer_create_request=new_connector_customizer_create_request) - # Below is a request that includes all optional parameters - # results = ConnectorCustomizersApi(api_client).create_connector_customizer(new_connector_customizer_create_request) - print("The response of ConnectorCustomizersApi->create_connector_customizer:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorCustomizersApi->create_connector_customizer: %s\n" % e) - /connector-customizers/{id}: - get: - tags: - - Connector Customizers - summary: Get connector customizer - operationId: getConnectorCustomizer - description: Gets connector customizer by ID. - parameters: - - name: id - in: path - description: ID of the connector customizer to get. - required: true - schema: - type: string - example: b07dc46a-1498-4de8-bfbb-259a68e70c8a - x-sailpoint-resource-operation-id: listConnectorCustomizers - responses: - '200': - description: Connector customizer with the given ID. - content: - application/json: - schema: - $ref: '#/paths/~1connector-customizers/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ConnectorCustomizersResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:connector:read - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#get-connector-customizer - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to get. - - # Get connector customizer - - try { - Get-V2025ConnectorCustomizer -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorCustomizer -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorCustomizer" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-customizers#get-connector-customizer - source: | - from sailpoint.v2025.api.connector_customizers_api import ConnectorCustomizersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_customizers_response import ConnectorCustomizersResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to get. # str | ID of the connector customizer to get. - try: - # Get connector customizer - - results = ConnectorCustomizersApi(api_client).get_connector_customizer(id=id) - # Below is a request that includes all optional parameters - # results = ConnectorCustomizersApi(api_client).get_connector_customizer(id) - print("The response of ConnectorCustomizersApi->get_connector_customizer:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorCustomizersApi->get_connector_customizer: %s\n" % e) - put: - tags: - - Connector Customizers - summary: Update Connector Customizer - description: 'Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`.' - operationId: putConnectorCustomizer - parameters: - - name: id - in: path - description: ID of the connector customizer to update. - required: true - schema: - type: string - example: b07dc46a-1498-4de8-bfbb-259a68e70c8a - x-sailpoint-resource-operation-id: listConnectorCustomizers - requestBody: - description: Connector rule with updated data. - content: - application/json: - schema: - description: ConnectorCustomizerUpdateRequest - type: object - allOf: - - $ref: '#/paths/~1connector-customizers/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ConnectorCustomizerCreateRequest.yaml - responses: - '200': - description: Updated connector customizer. - content: - application/json: - schema: - description: ConnectorCustomizerUpdateResponse - allOf: - - type: object - properties: - imageVersion: - type: integer - format: int64 - description: Connector customizer image version. - example: 1 - imageID: - type: string - description: Connector customizer image id. - example: 2c91808568c529c60168cca6f90c1324 - - $ref: '#/paths/~1connector-customizers/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ConnectorCustomizerCreateResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:connector:update - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#put-connector-customizer - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to update. - $ConnectorCustomizerUpdateRequest = @" - { - "name" : "My Custom Connector" - } - "@ - - # Update Connector Customizer - - try { - Send-V2025ConnectorCustomizer -Id $Id - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorCustomizer -Id $Id -ConnectorCustomizerUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorCustomizer" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-customizers#put-connector-customizer - source: | - from sailpoint.v2025.api.connector_customizers_api import ConnectorCustomizersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_customizer_update_request import ConnectorCustomizerUpdateRequest - from sailpoint.v2025.models.connector_customizer_update_response import ConnectorCustomizerUpdateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to update. # str | ID of the connector customizer to update. - connector_customizer_update_request = '''{ - "name" : "My Custom Connector" - }''' # ConnectorCustomizerUpdateRequest | Connector rule with updated data. (optional) - try: - # Update Connector Customizer - - results = ConnectorCustomizersApi(api_client).put_connector_customizer(id=id) - # Below is a request that includes all optional parameters - # results = ConnectorCustomizersApi(api_client).put_connector_customizer(id, new_connector_customizer_update_request) - print("The response of ConnectorCustomizersApi->put_connector_customizer:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorCustomizersApi->put_connector_customizer: %s\n" % e) - delete: - tags: - - Connector Customizers - summary: Delete Connector Customizer - description: Delete the connector customizer for the given ID. - operationId: deleteConnectorCustomizer - parameters: - - name: id - in: path - description: ID of the connector customizer to delete. - required: true - schema: - type: string - example: b07dc46a-1498-4de8-bfbb-259a68e70c8a - x-sailpoint-resource-operation-id: listConnectorCustomizers - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:connector:delete - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#delete-connector-customizer - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete. - - # Delete Connector Customizer - - try { - Remove-V2025ConnectorCustomizer -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ConnectorCustomizer -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ConnectorCustomizer" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-customizers#delete-connector-customizer - source: | - from sailpoint.v2025.api.connector_customizers_api import ConnectorCustomizersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to delete. # str | ID of the connector customizer to delete. - try: - # Delete Connector Customizer - - ConnectorCustomizersApi(api_client).delete_connector_customizer(id=id) - # Below is a request that includes all optional parameters - # ConnectorCustomizersApi(api_client).delete_connector_customizer(id) - except Exception as e: - print("Exception when calling ConnectorCustomizersApi->delete_connector_customizer: %s\n" % e) - /connector-customizers/{id}/versions: - post: - operationId: createConnectorCustomizerVersion - security: - - userAuth: - - sp:connector:update - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Connector Customizers - summary: Creates a connector customizer version - description: Creates a new version for the customizer. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The id of the connector customizer. - example: b07dc46a-1498-4de8-bfbb-259a68e70c8a - x-sailpoint-resource-operation-id: listConnectorCustomizers - responses: - '200': - description: The created connector customizer version object. - content: - application/json: - schema: - description: ConnectorCustomizerVersionCreateResponse - type: object - nullable: true - properties: - customizerID: - type: string - description: ID of connector customizer. - example: b07dc46a-1498-4de8-bfbb-259a68e70c8a - imageID: - type: string - description: ImageID of the connector customizer. - example: 2c91808568c529c60168cca6f90c1324 - version: - type: integer - format: int64 - description: Image version of the connector customizer. - example: 1 - created: - type: string - description: Date-time when the connector customizer version was created. - format: date-time - example: '2022-02-08T14:50:03.827Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#create-connector-customizer-version - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | The id of the connector customizer. - - # Creates a connector customizer version - - try { - New-V2025ConnectorCustomizerVersion -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025ConnectorCustomizerVersion -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ConnectorCustomizerVersion" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-customizers#create-connector-customizer-version - source: | - from sailpoint.v2025.api.connector_customizers_api import ConnectorCustomizersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_customizer_version_create_response import ConnectorCustomizerVersionCreateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | The id of the connector customizer. # str | The id of the connector customizer. - try: - # Creates a connector customizer version - - results = ConnectorCustomizersApi(api_client).create_connector_customizer_version(id=id) - # Below is a request that includes all optional parameters - # results = ConnectorCustomizersApi(api_client).create_connector_customizer_version(id) - print("The response of ConnectorCustomizersApi->create_connector_customizer_version:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorCustomizersApi->create_connector_customizer_version: %s\n" % e) - /configuration-hub/object-mappings/{sourceOrg}: - get: - operationId: getObjectMappings - security: - - userAuth: - - sp:config-object-mapping:read - - sp:config-object-mapping:manage - tags: - - Configuration Hub - summary: Gets list of object mappings - description: |- - This gets a list of existing object mappings between current org and source org. - Source org should be "default" when getting object mappings that are not associated to any particular org. - The request will need the following security scope: - - sp:config-object-mapping:read - parameters: - - in: path - name: sourceOrg - schema: - type: string - required: true - description: The name of the source org. - example: source-org - responses: - '200': - description: List of existing object mappings between current org and source org. - content: - application/json: - schema: - type: array - items: - type: object - title: Object Mapping Response - properties: - objectMappingId: - type: string - description: Id of the object mapping - example: 3d6e0144-963f-4bd6-8d8d-d77b4e507ce4 - objectType: - type: string - description: Type of the object the mapping value applies to - example: IDENTITY - enum: - - ACCESS_PROFILE - - ACCESS_REQUEST_CONFIG - - ATTR_SYNC_SOURCE_CONFIG - - AUTH_ORG - - CAMPAIGN_FILTER - - ENTITLEMENT - - FORM_DEFINITION - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - LIFECYCLE_STATE - - NOTIFICATION_TEMPLATE - - PASSWORD_POLICY - - PASSWORD_SYNC_GROUP - - PUBLIC_IDENTITIES_CONFIG - - ROLE - - RULE - - SEGMENT - - SERVICE_DESK_INTEGRATION - - SOD_POLICY - - SOURCE - - TAG - - TRANSFORM - - TRIGGER_SUBSCRIPTION - - WORKFLOW - jsonPath: - type: string - description: JSONPath expression denoting the path within the object where the mapping value should be applied - example: $.name - sourceValue: - type: string - description: Original value at the jsonPath location within the object - example: My Governance Group Name - targetValue: - type: string - description: Value to be assigned at the jsonPath location within the object - example: My New Governance Group Name - enabled: - type: boolean - description: Whether or not this object mapping is enabled - default: false - example: false - created: - type: string - description: Object mapping creation timestamp - example: '2024-03-19T23:18:53.732Z' - modified: - type: string - description: Object mapping latest update timestamp - example: '2024-03-19T23:18:53.732Z' - example: - - objectMappingId: 3d6e0144-963f-4bd6-8d8d-d77b4e507ce4 - objectType: GOVERNANCE_GROUP - jsonPath: $.description - sourceValue: Sample Governance Group - targetValue: Sample Governance Group - Updated - enabled: true - created: '2024-03-19T23:18:53.732Z' - modified: '2024-03-19T23:18:53.732Z' - - objectMappingId: e1d5cb80-65e2-4f92-ae2e-9588f61cc4cd - objectType: IDENTITY - jsonPath: $.name - sourceValue: SailPoint Support - targetValue: john.doe - enabled: false - created: '2024-03-19T23:18:06.238Z' - modified: '2024-03-19T23:18:06.238Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#get-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - - # Gets list of object mappings - - try { - Get-V2025ObjectMappings -SourceOrg $SourceOrg - - # Below is a request that includes all optional parameters - # Get-V2025ObjectMappings -SourceOrg $SourceOrg - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ObjectMappings" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#get-object-mappings - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.object_mapping_response import ObjectMappingResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - try: - # Gets list of object mappings - - results = ConfigurationHubApi(api_client).get_object_mappings(source_org=source_org) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) - print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) - post: - operationId: createObjectMapping - security: - - userAuth: - - sp:config-object-mapping:manage - tags: - - Configuration Hub - summary: Creates an object mapping - description: |- - This creates an object mapping between current org and source org. - Source org should be "default" when creating an object mapping that is not to be associated to any particular org. - The request will need the following security scope: - - sp:config-object-mapping:manage - parameters: - - in: path - name: sourceOrg - schema: - type: string - required: true - description: The name of the source org. - example: source-org - requestBody: - description: The object mapping request body. - required: true - content: - application/json: - schema: - type: object - title: Object Mapping Request - required: - - objectType - - jsonPath - - sourceValue - - targetValue - properties: - objectType: - type: string - description: Type of the object the mapping value applies to, must be one from enum - example: IDENTITY - enum: - - ACCESS_PROFILE - - ACCESS_REQUEST_CONFIG - - ATTR_SYNC_SOURCE_CONFIG - - AUTH_ORG - - CAMPAIGN_FILTER - - ENTITLEMENT - - FORM_DEFINITION - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - LIFECYCLE_STATE - - NOTIFICATION_TEMPLATE - - PASSWORD_POLICY - - PASSWORD_SYNC_GROUP - - PUBLIC_IDENTITIES_CONFIG - - ROLE - - RULE - - SEGMENT - - SERVICE_DESK_INTEGRATION - - SOD_POLICY - - SOURCE - - TAG - - TRANSFORM - - TRIGGER_SUBSCRIPTION - - WORKFLOW - jsonPath: - type: string - description: JSONPath expression denoting the path within the object where the mapping value should be applied - example: $.name - sourceValue: - type: string - description: Original value at the jsonPath location within the object - example: My Governance Group Name - targetValue: - type: string - description: Value to be assigned at the jsonPath location within the object - example: My New Governance Group Name - enabled: - type: boolean - description: Whether or not this object mapping is enabled - default: false - example: false - example: - objectType: GOVERNANCE_GROUP - jsonPath: $.description - sourceValue: Sample Governance Group - targetValue: Sample Governance Group - Updated - enabled: true - responses: - '200': - description: The created object mapping between current org and source org. - content: - application/json: - schema: - $ref: '#/paths/~1configuration-hub~1object-mappings~1%7BsourceOrg%7D/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/configuration-hub/ObjectMappingResponse.yaml - example: - objectMappingId: 3d6e0144-963f-4bd6-8d8d-d77b4e507ce4 - objectType: GOVERNANCE_GROUP - jsonPath: $.description - sourceValue: Sample Governance Group - targetValue: Sample Governance Group - Updated - enabled: true - created: '2024-03-19T23:18:53.732Z' - modified: '2024-03-19T23:18:53.732Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-object-mapping - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingRequest = @" - { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - } - "@ - - # Creates an object mapping - - try { - $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest - New-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ObjectMapping" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#create-object-mapping - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.object_mapping_request import ObjectMappingRequest - from sailpoint.v2025.models.object_mapping_response import ObjectMappingResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_request = '''{ - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - }''' # ObjectMappingRequest | The object mapping request body. - try: - # Creates an object mapping - new_object_mapping_request = ObjectMappingRequest.from_json(object_mapping_request) - results = ConfigurationHubApi(api_client).create_object_mapping(source_org=source_org, object_mapping_request=new_object_mapping_request) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request) - print("The response of ConfigurationHubApi->create_object_mapping:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) - /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}: - delete: - operationId: deleteObjectMapping - security: - - userAuth: - - sp:config-object-mapping:manage - tags: - - Configuration Hub - summary: Deletes an object mapping - description: |- - This deletes an existing object mapping. - Source org should be "default" when deleting an object mapping that is not associated to any particular org. - The request will need the following security scope: - - sp:config-object-mapping:manage - parameters: - - in: path - name: sourceOrg - schema: - type: string - required: true - description: The name of the source org. - example: source-org - - in: path - name: objectMappingId - schema: - type: string - required: true - description: The id of the object mapping to be deleted. - example: 3d6e0144-963f-4bd6-8d8d-d77b4e507ce4 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-object-mapping - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. - - # Deletes an object mapping - - try { - Remove-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId - - # Below is a request that includes all optional parameters - # Remove-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ObjectMapping" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#delete-object-mapping - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_id = '3d6e0144-963f-4bd6-8d8d-d77b4e507ce4' # str | The id of the object mapping to be deleted. # str | The id of the object mapping to be deleted. - try: - # Deletes an object mapping - - ConfigurationHubApi(api_client).delete_object_mapping(source_org=source_org, object_mapping_id=object_mapping_id) - # Below is a request that includes all optional parameters - # ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id) - except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_object_mapping: %s\n" % e) - /configuration-hub/object-mappings/{sourceOrg}/bulk-create: - post: - operationId: createObjectMappings - security: - - userAuth: - - sp:config-object-mapping:manage - tags: - - Configuration Hub - summary: Bulk creates object mappings - description: |- - This creates a set of object mappings (Max 25) between current org and source org. - Source org should be "default" when creating object mappings that are not to be associated to any particular org. - The request will need the following security scope: - - sp:config-object-mapping:manage - parameters: - - in: path - name: sourceOrg - schema: - type: string - required: true - description: The name of the source org. - example: source-org - requestBody: - description: The bulk create object mapping request body. - required: true - content: - application/json: - schema: - type: object - title: Bulk Create Object Mapping Request - required: - - newObjectsMappings - properties: - newObjectsMappings: - type: array - items: - $ref: '#/paths/~1configuration-hub~1object-mappings~1%7BsourceOrg%7D/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/configuration-hub/ObjectMappingRequest.yaml - example: - newObjectsMappings: - - objectType: SOURCE - jsonPath: $.name - sourceValue: Original SOURCE Name - targetValue: New SOURCE Name - enabled: true - - objectType: IDENTITY - jsonPath: $.name - sourceValue: Original IDENTITY Name - targetValue: 'New IDENTITY Name ' - enabled: true - responses: - '200': - description: The created object mapping between current org and source org. - content: - application/json: - schema: - type: object - title: Bulk Create Object Mapping Response - properties: - addedObjects: - type: array - items: - $ref: '#/paths/~1configuration-hub~1object-mappings~1%7BsourceOrg%7D/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/configuration-hub/ObjectMappingResponse.yaml - example: - addedObjects: - - objectMappingId: 603b1a61-d03d-4ed1-864f-a508fbd1995d - objectType: SOURCE - jsonPath: $.name - sourceValue: Original SOURCE Name - targetValue: New SOURCE Name - enabled: true - created: '2024-03-25T15:50:41.314Z' - modified: '2024-03-25T15:50:41.299Z' - - objectMappingId: 00bece34-f50d-4227-8878-76f620b5a971 - objectType: IDENTITY - jsonPath: $.name - sourceValue: Original IDENTITY Name - targetValue: 'New IDENTITY Name ' - enabled: true - created: '2024-03-25T15:50:41.316Z' - modified: '2024-03-25T15:50:41.316Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingBulkCreateRequest = @" - { - "newObjectsMappings" : [ { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - }, { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - } ] - } - "@ - - # Bulk creates object mappings - - try { - $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest - New-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ObjectMappings" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#create-object-mappings - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.object_mapping_bulk_create_request import ObjectMappingBulkCreateRequest - from sailpoint.v2025.models.object_mapping_bulk_create_response import ObjectMappingBulkCreateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_bulk_create_request = '''{ - "newObjectsMappings" : [ { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - }, { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - } ] - }''' # ObjectMappingBulkCreateRequest | The bulk create object mapping request body. - try: - # Bulk creates object mappings - new_object_mapping_bulk_create_request = ObjectMappingBulkCreateRequest.from_json(object_mapping_bulk_create_request) - results = ConfigurationHubApi(api_client).create_object_mappings(source_org=source_org, object_mapping_bulk_create_request=new_object_mapping_bulk_create_request) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).create_object_mappings(source_org, new_object_mapping_bulk_create_request) - print("The response of ConfigurationHubApi->create_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) - /configuration-hub/object-mappings/{sourceOrg}/bulk-patch: - post: - operationId: updateObjectMappings - security: - - userAuth: - - sp:config-object-mapping:manage - tags: - - Configuration Hub - summary: Bulk updates object mappings - description: |- - This updates a set of object mappings, only enabled and targetValue fields can be updated. - Source org should be "default" when updating object mappings that are not associated to any particular org. - The request will need the following security scope: - - sp:config-object-mapping:manage - parameters: - - in: path - name: sourceOrg - schema: - type: string - required: true - description: The name of the source org. - example: source-org - requestBody: - description: The object mapping request body. - required: true - content: - application/json: - schema: - type: object - title: Bulk Update Object Mapping Request - required: - - patches - properties: - patches: - description: Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. - type: object - additionalProperties: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - 603b1a61-d03d-4ed1-864f-a508fbd1995d: - - op: replace - path: /enabled - value: true - 00bece34-f50d-4227-8878-76f620b5a971: - - op: replace - path: /targetValue - value: New Target Value - example: - patches: - 603b1a61-d03d-4ed1-864f-a508fbd1995d: - - op: replace - path: /enabled - value: true - 00bece34-f50d-4227-8878-76f620b5a971: - - op: replace - path: /targetValue - value: New Target Value - responses: - '200': - description: The updated object mappings. - content: - application/json: - schema: - type: object - title: Bulk Update Object Mapping Response - properties: - patchedObjects: - type: array - items: - $ref: '#/paths/~1configuration-hub~1object-mappings~1%7BsourceOrg%7D/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/configuration-hub/ObjectMappingResponse.yaml - example: - patchedObjects: - - objectMappingId: 603b1a61-d03d-4ed1-864f-a508fbd1995d - objectType: SOURCE - jsonPath: $.name - sourceValue: Original SOURCE Name - targetValue: New SOURCE Name - enabled: true - created: '2024-03-25T15:50:41.314Z' - modified: '2024-03-25T15:50:41.299Z' - - objectMappingId: 00bece34-f50d-4227-8878-76f620b5a971 - objectType: IDENTITY - jsonPath: $.name - sourceValue: Original IDENTITY Name - targetValue: 'New IDENTITY Name ' - enabled: true - created: '2024-03-25T15:50:41.316Z' - modified: '2024-03-25T15:50:41.316Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#update-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingBulkPatchRequest = @" - { - "patches" : { - "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : true - } ], - "00bece34-f50d-4227-8878-76f620b5a971" : [ { - "op" : "replace", - "path" : "/targetValue", - "value" : "New Target Value" - } ] - } - } - "@ - - # Bulk updates object mappings - - try { - $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest - Update-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ObjectMappings" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#update-object-mappings - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest - from sailpoint.v2025.models.object_mapping_bulk_patch_response import ObjectMappingBulkPatchResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_bulk_patch_request = '''{ - "patches" : { - "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : true - } ], - "00bece34-f50d-4227-8878-76f620b5a971" : [ { - "op" : "replace", - "path" : "/targetValue", - "value" : "New Target Value" - } ] - } - }''' # ObjectMappingBulkPatchRequest | The object mapping request body. - try: - # Bulk updates object mappings - new_object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest.from_json(object_mapping_bulk_patch_request) - results = ConfigurationHubApi(api_client).update_object_mappings(source_org=source_org, object_mapping_bulk_patch_request=new_object_mapping_bulk_patch_request) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).update_object_mappings(source_org, new_object_mapping_bulk_patch_request) - print("The response of ConfigurationHubApi->update_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) - /configuration-hub/scheduled-actions: - get: - operationId: listScheduledActions - security: - - userAuth: - - sp:config-scheduled-action:read - - sp:config-scheduled-action:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Configuration Hub - summary: List Scheduled Actions - description: This API gets a list of existing scheduled actions for the current tenant. - responses: - '200': - description: List of existing scheduled actions. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Unique identifier for this scheduled action. - example: 3469b87d-48ca-439a-868f-2160001da8c1 - created: - type: string - format: date-time - description: The time when this scheduled action was created. - example: '2021-05-11T22:23:16.000Z' - jobType: - type: string - description: Type of the scheduled job. - enum: - - BACKUP - - CREATE_DRAFT - - CONFIG_DEPLOY_DRAFT - example: BACKUP - content: - type: object - description: Content details for the scheduled action. - properties: - name: - type: string - description: Name of the scheduled action (maximum 50 characters). - maxLength: 50 - example: Daily Backup - backupOptions: - type: object - description: Options for BACKUP type jobs. Optional, applicable for BACKUP jobs only. - properties: - includeTypes: - type: array - description: Object types that are to be included in the backup. - items: - type: string - example: - - ROLE - - IDENTITY_PROFILE - objectOptions: - type: object - description: Map of objectType string to the options to be passed to the target service for that objectType. - additionalProperties: - type: object - properties: - includedNames: - type: array - description: Set of names to be included. - items: - type: string - example: - - Admin Role - - User Role - example: - SOURCE: - includedNames: - - Source1 - - Source2 - ROLE: - includedNames: - - Admin Role - - User Role - sourceBackupId: - type: string - description: ID of the source backup. Required for CREATE_DRAFT jobs only. - example: 5678b87d-48ca-439a-868f-2160001da8c2 - sourceTenant: - type: string - description: Source tenant identifier. Required for CREATE_DRAFT jobs only. - example: tenant-name - draftId: - type: string - description: ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only. - example: 9012b87d-48ca-439a-868f-2160001da8c3 - startTime: - type: string - format: date-time - description: The time when this scheduled action should start. - example: '2021-05-12T10:00:00.000Z' - cronString: - type: string - description: Cron expression defining the schedule for this action. - example: 0 0 12 * * ? - timeZoneId: - type: string - description: Time zone ID for interpreting the cron expression. - example: America/Chicago - example: - - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - created: '2024-08-16T14:16:58.389Z' - jobType: BACKUP - content: - name: Backup Name - backupOptions: - includeTypes: - - SOURCE - - IDENTITY - objectOptions: [] - startTime: '2024-08-16T14:16:58.389Z' - cronString: 0 0 * * * - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-scheduled-actions - source: | - - # List Scheduled Actions - - try { - Get-V2025ScheduledActions - - # Below is a request that includes all optional parameters - # Get-V2025ScheduledActions - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ScheduledActions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#list-scheduled-actions - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.scheduled_action_response import ScheduledActionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Scheduled Actions - - results = ConfigurationHubApi(api_client).list_scheduled_actions() - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).list_scheduled_actions() - print("The response of ConfigurationHubApi->list_scheduled_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->list_scheduled_actions: %s\n" % e) - post: - operationId: createScheduledAction - security: - - userAuth: - - sp:config-scheduled-action:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Configuration Hub - summary: Create Scheduled Action - description: This API creates a new scheduled action for the current tenant. - requestBody: - description: The scheduled action creation request body. - required: true - content: - application/json: - schema: - type: object - required: - - jobType - - content - properties: - jobType: - type: string - description: Type of the scheduled job. - enum: - - BACKUP - - CREATE_DRAFT - - CONFIG_DEPLOY_DRAFT - example: BACKUP - startTime: - type: string - format: date-time - description: The time when this scheduled action should start. Optional. - example: '2024-08-16T14:16:58.389Z' - cronString: - type: string - description: Cron expression defining the schedule for this action. Optional for repeated events. - example: 0 0 12 * * ? - timeZoneId: - type: string - description: Time zone ID for interpreting the cron expression. Optional, will default to current time zone. - example: America/Chicago - content: - type: object - required: - - name - properties: - name: - type: string - description: Name of the scheduled action (maximum 50 characters). - maxLength: 50 - example: Daily Backup - backupOptions: - type: object - description: Options for BACKUP type jobs. Required for BACKUP jobs. - properties: - includeTypes: - type: array - description: Object types that are to be included in the backup. - items: - type: string - example: - - ROLE - - IDENTITY_PROFILE - objectOptions: - type: object - description: Map of objectType string to the options to be passed to the target service for that objectType. - additionalProperties: - type: object - properties: - includedNames: - type: array - description: Set of names to be included. - items: - type: string - example: - - Admin Role - - User Role - example: - SOURCE: - includedNames: - - Source1 - - Source2 - ROLE: - includedNames: - - Admin Role - - User Role - sourceBackupId: - type: string - description: ID of the source backup. Required for CREATE_DRAFT jobs. - example: 5678b87d-48ca-439a-868f-2160001da8c2 - sourceTenant: - type: string - description: Source tenant identifier. Required for CREATE_DRAFT jobs. - example: tenant-name - draftId: - type: string - description: ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs. - example: 9012b87d-48ca-439a-868f-2160001da8c3 - example: - jobType: BACKUP - startTime: '2024-08-16T14:16:58.389Z' - cronString: 0 0 12 * * ? - timeZoneId: America/Chicago - content: - name: Daily Backup - backupOptions: - includeTypes: - - SOURCE - - IDENTITY - objectOptions: - SOURCE: - includedNames: - - Source1 - - Source2 - responses: - '200': - description: The created scheduled action. - content: - application/json: - schema: - $ref: '#/paths/~1configuration-hub~1scheduled-actions/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionResponse.yaml - example: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - created: '2024-08-16T14:16:58.389Z' - jobType: BACKUP - content: - name: Daily Backup - backupOptions: - includeTypes: - - SOURCE - - IDENTITY - objectOptions: - SOURCE: - includedNames: - - Source1 - - Source2 - startTime: '2024-08-16T14:16:58.389Z' - cronString: 0 0 12 * * ? - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-scheduled-action - source: | - $ScheduledActionPayload = @" - { - "cronString" : "0 0 12 * * ?", - "timeZoneId" : "America/Chicago", - "startTime" : "2024-08-16T14:16:58.389Z", - "jobType" : "BACKUP", - "content" : { - "sourceTenant" : "tenant-name", - "draftId" : "9012b87d-48ca-439a-868f-2160001da8c3", - "name" : "Daily Backup", - "backupOptions" : { - "includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ], - "objectOptions" : { - "SOURCE" : { - "includedNames" : [ "Source1", "Source2" ] - }, - "ROLE" : { - "includedNames" : [ "Admin Role", "User Role" ] - } - } - }, - "sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2" - } - } - "@ - - # Create Scheduled Action - - try { - $Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload - New-V2025ScheduledAction -ScheduledActionPayload $Result - - # Below is a request that includes all optional parameters - # New-V2025ScheduledAction -ScheduledActionPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ScheduledAction" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#create-scheduled-action - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.scheduled_action_payload import ScheduledActionPayload - from sailpoint.v2025.models.scheduled_action_response import ScheduledActionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - scheduled_action_payload = '''{ - "cronString" : "0 0 12 * * ?", - "timeZoneId" : "America/Chicago", - "startTime" : "2024-08-16T14:16:58.389Z", - "jobType" : "BACKUP", - "content" : { - "sourceTenant" : "tenant-name", - "draftId" : "9012b87d-48ca-439a-868f-2160001da8c3", - "name" : "Daily Backup", - "backupOptions" : { - "includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ], - "objectOptions" : { - "SOURCE" : { - "includedNames" : [ "Source1", "Source2" ] - }, - "ROLE" : { - "includedNames" : [ "Admin Role", "User Role" ] - } - } - }, - "sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2" - } - }''' # ScheduledActionPayload | The scheduled action creation request body. - try: - # Create Scheduled Action - new_scheduled_action_payload = ScheduledActionPayload.from_json(scheduled_action_payload) - results = ConfigurationHubApi(api_client).create_scheduled_action(scheduled_action_payload=new_scheduled_action_payload) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).create_scheduled_action(new_scheduled_action_payload) - print("The response of ConfigurationHubApi->create_scheduled_action:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_scheduled_action: %s\n" % e) - /configuration-hub/scheduled-actions/{id}: - patch: - operationId: updateScheduledAction - security: - - userAuth: - - sp:config-scheduled-action:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Configuration Hub - summary: Update Scheduled Action - description: This API updates an existing scheduled action using JSON Patch format. - parameters: - - in: path - name: scheduledActionId - schema: - type: string - required: true - description: The ID of the scheduled action. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - x-sailpoint-resource-operation-id: listScheduledActions - requestBody: - description: The JSON Patch document containing the changes to apply to the scheduled action. - required: true - content: - application/json-patch+json: - schema: - type: object - description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - properties: - operations: - description: Operations to be applied - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /content/name - value: Updated Backup Name - - op: replace - path: /cronString - value: 0 0 9 * * ? - responses: - '200': - description: The updated scheduled action. - content: - application/json: - schema: - $ref: '#/paths/~1configuration-hub~1scheduled-actions/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionResponse.yaml - example: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - created: '2024-08-16T14:16:58.389Z' - jobType: BACKUP - content: - name: Updated Backup Name - backupOptions: - includeTypes: - - SOURCE - - IDENTITY - objectOptions: - SOURCE: - includedNames: - - Source1 - - Source2 - startTime: '2024-08-16T14:16:58.389Z' - cronString: 0 0 9 * * ? - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#update-scheduled-action - source: | - $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update Scheduled Action - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ScheduledAction" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#update-scheduled-action - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.scheduled_action_response import ScheduledActionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - scheduled_action_id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the scheduled action. # str | The ID of the scheduled action. - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSON Patch document containing the changes to apply to the scheduled action. - try: - # Update Scheduled Action - new_json_patch = JsonPatch.from_json(json_patch) - results = ConfigurationHubApi(api_client).update_scheduled_action(scheduled_action_id=scheduled_action_id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).update_scheduled_action(scheduled_action_id, new_json_patch) - print("The response of ConfigurationHubApi->update_scheduled_action:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->update_scheduled_action: %s\n" % e) - delete: - operationId: deleteScheduledAction - security: - - userAuth: - - sp:config-scheduled-action:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Configuration Hub - summary: Delete Scheduled Action - description: This API deletes an existing scheduled action. - parameters: - - in: path - name: scheduledActionId - schema: - type: string - required: true - description: The ID of the scheduled action. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - x-sailpoint-resource-operation-id: listScheduledActions - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-scheduled-action - source: | - $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. - - # Delete Scheduled Action - - try { - Remove-V2025ScheduledAction -ScheduledActionId $ScheduledActionId - - # Below is a request that includes all optional parameters - # Remove-V2025ScheduledAction -ScheduledActionId $ScheduledActionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ScheduledAction" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#delete-scheduled-action - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - scheduled_action_id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the scheduled action. # str | The ID of the scheduled action. - try: - # Delete Scheduled Action - - ConfigurationHubApi(api_client).delete_scheduled_action(scheduled_action_id=scheduled_action_id) - # Below is a request that includes all optional parameters - # ConfigurationHubApi(api_client).delete_scheduled_action(scheduled_action_id) - except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_scheduled_action: %s\n" % e) - /configuration-hub/backups/uploads: - get: - operationId: listUploadedConfigurations - security: - - userAuth: - - sp:config-backup:read - - sp:config-backup:manage - tags: - - Configuration Hub - summary: List Uploaded Configurations - description: This API gets a list of existing uploaded configurations for the current tenant. - parameters: - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **status**: *eq* - example: status eq "COMPLETE" - required: false - responses: - '200': - description: List of existing uploaded configurations. - content: - application/json: - schema: - type: array - items: - type: object - properties: - jobId: - type: string - description: Unique id assigned to this backup. - example: 3469b87d-48ca-439a-868f-2160001da8c1 - status: - type: string - description: Status of the backup. - enum: - - NOT_STARTED - - IN_PROGRESS - - COMPLETE - - CANCELLED - - FAILED - example: COMPLETE - type: - type: string - description: Type of the job, will always be BACKUP for this type of job. - enum: - - BACKUP - example: BACKUP - tenant: - type: string - description: The name of the tenant performing the upload - example: tenant-name - requesterName: - type: string - description: The name of the requester. - example: Requester Name - fileExists: - type: boolean - default: true - description: Whether or not a file was created and stored for this backup. - example: true - created: - type: string - format: date-time - description: The time the job was started. - example: '2021-05-11T22:23:16.000Z' - modified: - type: string - format: date-time - description: The time of the last update to the job. - example: '2021-05-11T22:23:16.000Z' - completed: - type: string - format: date-time - description: The time the job was completed. - example: '2021-05-11T22:23:16.000Z' - name: - type: string - description: The name assigned to the upload file in the request body. - example: Backup Name - userCanDelete: - type: boolean - default: true - description: Whether this backup can be deleted by a regular user. - example: false - isPartial: - type: boolean - default: false - description: Whether this backup contains all supported object types or only some of them. - example: false - backupType: - type: string - description: |- - Denotes how this backup was created. - - MANUAL - The backup was created by a user. - - AUTOMATED - The backup was created by devops. - - AUTOMATED_DRAFT - The backup was created during a draft process. - - UPLOADED - The backup was created by uploading an existing configuration file. - enum: - - UPLOADED - - AUTOMATED - - MANUAL - example: MANUAL - options: - type: object - nullable: true - description: Backup options control what will be included in the backup. - properties: - includeTypes: - type: array - description: Object type names to be included in a Configuration Hub backup command. - items: - type: string - enum: - - ACCESS_PROFILE - - ACCESS_REQUEST_CONFIG - - ATTR_SYNC_SOURCE_CONFIG - - AUTH_ORG - - CAMPAIGN_FILTER - - FORM_DEFINITION - - GOVERNANCE_GROUP - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - LIFECYCLE_STATE - - NOTIFICATION_TEMPLATE - - PASSWORD_POLICY - - PASSWORD_SYNC_GROUP - - PUBLIC_IDENTITIES_CONFIG - - ROLE - - RULE - - SEGMENT - - SERVICE_DESK_INTEGRATION - - SOD_POLICY - - SOURCE - - TAG - - TRANSFORM - - TRIGGER_SUBSCRIPTION - - WORKFLOW - example: TRIGGER_SUBSCRIPTION - objectOptions: - description: Additional options targeting specific objects related to each item in the includeTypes field. - type: object - additionalProperties: - type: object - properties: - includedNames: - description: Object names to be included in a backup. - type: array - items: - type: string - example: Test Object name - example: - TRIGGER_SUBSCRIPTION: - includedNames: - - Trigger Subscription name - hydrationStatus: - type: string - description: Whether the object details of this backup are ready. - enum: - - HYDRATED - - NOT_HYDRATED - example: NOT_HYDRATED - totalObjectCount: - type: integer - format: int64 - description: Number of objects contained in this backup. - example: 10 - cloudStorageStatus: - type: string - description: Whether this backup has been transferred to a customer storage location. - enum: - - SYNCED - - NOT_SYNCED - - SYNC_FAILED - example: SYNCED - example: - - jobId: 281d421c-0643-4004-9fe5-29a95d2f73df - status: COMPLETE - type: BACKUP - tenant: someTenant - requesterName: support - fileExists: true - created: '2024-03-07T21:11:00.375Z' - modified: '2024-03-07T21:11:25.046Z' - completed: '2024-03-07T21:11:00.66Z' - name: test1 - userCanDelete: false - isPartial: false - backupType: UPLOADED - hydrationStatus: HYDRATED - totalObjectCount: 64 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-uploaded-configurations - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - - # List Uploaded Configurations - - try { - Get-V2025UploadedConfigurations - - # Below is a request that includes all optional parameters - # Get-V2025UploadedConfigurations -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UploadedConfigurations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#list-uploaded-configurations - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.backup_response import BackupResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - filters = 'status eq \"COMPLETE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - try: - # List Uploaded Configurations - - results = ConfigurationHubApi(api_client).list_uploaded_configurations() - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) - print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) - post: - operationId: createUploadedConfiguration - security: - - userAuth: - - sp:config-backup:manage - tags: - - Configuration Hub - summary: Upload a Configuration - description: |- - This API uploads a JSON configuration file into a tenant. - - Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. - - Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects. - requestBody: - description: | - The body will consist of "data" which should contain the json file and name wish should be the name you want to assign to the uploaded file" - - __Example__ - - data: "uploaded.json", - name: "A_NEW_UPLOADED_BACKUP" - - __Sample Upload File__ - - { - "version": 1, - "tenant": "a-sample-tenant", - "objects": - [ - { - "version": 1, - "self": - { - "id": "0a59c7196d2917f8aa6d29686e6600fb", - "type": "SOURCE", - "name": "Extended Form" - }, - "object": - { - "id": "0a59c7196d2917f8aa6d29686e6600fb", - "name": "Extended Form", - "type": "DelimitedFile", - "connectorClass": "sailpoint.connector.DelimitedFileConnector", - "connectorScriptName": "delimited-file-angularsc", - "description": "Migrated app - Extended Form (original ID: 0a59c7196d2917f8aa6d29686e6600fb)", - "deleteThreshold": 10, - "provisionAsCsv": false, - "owner": - { - "type": "IDENTITY", - "id": "0a59c7196d2917f8816d29685fed00c3", - "name": "slpt.services" - }, - "connectorAttributes": - { - "beforemoveAccount": "Do Nothing", - "beforemoverAccount": "Do Nothing", - "busApp": "false", - "file": "Empty", - "filetransport": "local", - "filterEmptyRecords": "true", - "group.filetransport": "local", - "group.filterEmptyRecords": "true", - "group.partitionMode": "auto", - "hasHeader": "true", - "indexColumn": "ID", - "isCaseInsensitiveMerge": "false", - "isSortedByIndexColumn": "false", - "loaProcess": "Do Nothing", - "ltdProcess": "Do Nothing", - "mergeRows": "false", - "moverProcess": "Do Nothing", - "moverRevocation": "Do Nothing", - "nativeChangeDetectionAttributeScope": "entitlements", - "nativeChangeDetectionEnabled": "false", - "nativeChangeProcess": "Do Nothing", - "parseType": "delimited", - "partitionMode": "auto", - "policyType": "Do Nothing", - "rehireProcess": "Do Nothing", - "reverseleaverProcess": "Do Nothing", - "rtwloaProcess": "Do Nothing", - "rtwltdProcess": "Do Nothing", - "stopIfLineHasWrongColumnLength": "false", - "templateApplication": "DelimitedFile Template", - "terminationProcess": "Do Nothing" - }, - "schemas": - [], - "provisioningPolicies": - [], - "features": - [ - "DIRECT_PERMISSIONS", - "NO_RANDOM_ACCESS", - "DISCOVER_SCHEMA" - ] - } - } - ] - } - required: true - content: - multipart/form-data: - schema: - type: object - properties: - data: - type: string - format: binary - description: JSON file containing the objects to be imported. - name: - type: string - description: Name that will be assigned to the uploaded configuration file. - required: - - data - - name - responses: - '202': - description: Upload job accepted and queued for processing. - content: - application/json: - schema: - $ref: '#/paths/~1configuration-hub~1backups~1uploads/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/configuration-hub/BackupResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-uploaded-configuration - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. - - # Upload a Configuration - - try { - New-V2025UploadedConfiguration -Data $Data -Name $Name - - # Below is a request that includes all optional parameters - # New-V2025UploadedConfiguration -Data $Data -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025UploadedConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#create-uploaded-configuration - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.backup_response import BackupResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - name = 'name_example' # str | Name that will be assigned to the uploaded configuration file. # str | Name that will be assigned to the uploaded configuration file. - try: - # Upload a Configuration - - results = ConfigurationHubApi(api_client).create_uploaded_configuration(data=data, name=name) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).create_uploaded_configuration(data, name) - print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) - /configuration-hub/backups/uploads/{id}: - get: - operationId: getUploadedConfiguration - security: - - userAuth: - - sp:config-backup:read - - sp:config-backup:manage - tags: - - Configuration Hub - summary: Get an Uploaded Configuration - description: This API gets an existing uploaded configuration for the current tenant. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The id of the uploaded configuration. - example: 3d0fe04b-57df-4a46-a83b-8f04b0f9d10b - responses: - '200': - description: Gets an uploaded configuration details. - content: - application/json: - schema: - $ref: '#/paths/~1configuration-hub~1backups~1uploads/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/configuration-hub/BackupResponse.yaml - example: - jobId: 2ea830f3-2b14-4772-8a20-3d006742e419 - status: COMPLETE - type: BACKUP - tenant: someTenant - requesterName: support - fileExists: true - created: '2024-02-20T22:08:31.064Z' - modified: '2024-02-20T22:13:15.662Z' - completed: '2024-02-20T22:08:31.689Z' - name: something new - userCanDelete: false - isPartial: false - backupType: UPLOADED - hydrationStatus: HYDRATED - totalObjectCount: 2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#get-uploaded-configuration - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - - # Get an Uploaded Configuration - - try { - Get-V2025UploadedConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025UploadedConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UploadedConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#get-uploaded-configuration - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.backup_response import BackupResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration. - try: - # Get an Uploaded Configuration - - results = ConfigurationHubApi(api_client).get_uploaded_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).get_uploaded_configuration(id) - print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) - delete: - operationId: deleteUploadedConfiguration - security: - - userAuth: - - sp:config-backup:manage - tags: - - Configuration Hub - summary: Delete an Uploaded Configuration - description: |- - This API deletes an uploaded configuration based on Id. - - On success, this endpoint will return an empty response. - - The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The id of the uploaded configuration. - example: 3d0fe04b-57df-4a46-a83b-8f04b0f9d10b - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-uploaded-configuration - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - - # Delete an Uploaded Configuration - - try { - Remove-V2025UploadedConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025UploadedConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025UploadedConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#delete-uploaded-configuration - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration. - try: - # Delete an Uploaded Configuration - - ConfigurationHubApi(api_client).delete_uploaded_configuration(id=id) - # Below is a request that includes all optional parameters - # ConfigurationHubApi(api_client).delete_uploaded_configuration(id) - except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) - /configuration-hub/backups: - get: - operationId: listBackups - security: - - userAuth: - - sp:config-backup:read - - sp:config-backup:manage - tags: - - Configuration Hub - summary: List Backups - description: This API gets a list of existing backups for the current tenant. - parameters: - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **status**: *eq* - example: status eq "COMPLETE" - required: false - responses: - '200': - description: List of existing backups. - content: - application/json: - schema: - type: array - items: - type: object - properties: - jobId: - type: string - description: Unique id assigned to this backup. - example: 3469b87d-48ca-439a-868f-2160001da8c1 - status: - type: string - description: Status of the backup. - enum: - - NOT_STARTED - - IN_PROGRESS - - COMPLETE - - CANCELLED - - FAILED - example: COMPLETE - type: - type: string - description: Type of the job, will always be BACKUP for this type of job. - enum: - - BACKUP - example: BACKUP - tenant: - type: string - description: The name of the tenant performing the upload - example: tenant-name - requesterName: - type: string - description: The name of the requester. - example: Requester Name - fileExists: - type: boolean - default: true - description: Whether or not a file was created and stored for this backup. - example: true - created: - type: string - format: date-time - description: The time the job was started. - example: '2021-05-11T22:23:16.000Z' - modified: - type: string - format: date-time - description: The time of the last update to the job. - example: '2021-05-11T22:23:16.000Z' - completed: - type: string - format: date-time - description: The time the job was completed. - example: '2021-05-11T22:23:16.000Z' - name: - type: string - description: The name assigned to the upload file in the request body. - example: Backup Name - userCanDelete: - type: boolean - default: true - description: Whether this backup can be deleted by a regular user. - example: false - isPartial: - type: boolean - default: false - description: Whether this backup contains all supported object types or only some of them. - example: false - backupType: - type: string - description: |- - Denotes how this backup was created. - - MANUAL - The backup was created by a user. - - AUTOMATED - The backup was created by devops. - - AUTOMATED_DRAFT - The backup was created during a draft process. - - UPLOADED - The backup was created by uploading an existing configuration file. - enum: - - UPLOADED - - AUTOMATED - - MANUAL - example: MANUAL - options: - type: object - nullable: true - description: Backup options control what will be included in the backup. - properties: - includeTypes: - type: array - description: Object type names to be included in a Configuration Hub backup command. - items: - type: string - enum: - - ACCESS_PROFILE - - ACCESS_REQUEST_CONFIG - - ATTR_SYNC_SOURCE_CONFIG - - AUTH_ORG - - CAMPAIGN_FILTER - - FORM_DEFINITION - - GOVERNANCE_GROUP - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - LIFECYCLE_STATE - - NOTIFICATION_TEMPLATE - - PASSWORD_POLICY - - PASSWORD_SYNC_GROUP - - PUBLIC_IDENTITIES_CONFIG - - ROLE - - RULE - - SEGMENT - - SERVICE_DESK_INTEGRATION - - SOD_POLICY - - SOURCE - - TAG - - TRANSFORM - - TRIGGER_SUBSCRIPTION - - WORKFLOW - example: TRIGGER_SUBSCRIPTION - objectOptions: - description: Additional options targeting specific objects related to each item in the includeTypes field. - type: object - additionalProperties: - type: object - properties: - includedNames: - description: Object names to be included in a backup. - type: array - items: - type: string - example: Test Object name - example: - TRIGGER_SUBSCRIPTION: - includedNames: - - Trigger Subscription name - hydrationStatus: - type: string - description: Whether the object details of this backup are ready. - enum: - - HYDRATED - - NOT_HYDRATED - example: NOT_HYDRATED - totalObjectCount: - type: integer - format: int64 - description: Number of objects contained in this backup. - example: 10 - cloudStorageStatus: - type: string - description: Whether this backup has been transferred to a customer storage location. - enum: - - SYNCED - - NOT_SYNCED - - SYNC_FAILED - example: SYNCED - example: - - jobId: 09491993-9cb6-49a7-8d37-8bef54d33502 - status: COMPLETE - type: BACKUP - tenant: tenant-name - requesterName: Requester Name - fileExists: true - created: '2024-02-19T19:54:15.373Z' - modified: '2024-02-19T20:39:00.341Z' - completed: '2024-02-19T19:54:15.605Z' - name: Backup name - userCanDelete: false - isPartial: true - backupType: MANUAL - options: - includeTypes: - - SOURCE - objectOptions: - SOURCE: - includedNames: - - Source Name - hydrationStatus: HYDRATED - totalObjectCount: 2 - cloudStorageStatus: SYNCED - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-backups - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - - # List Backups - - try { - Get-V2025Backups - - # Below is a request that includes all optional parameters - # Get-V2025Backups -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Backups" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#list-backups - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.backup_response1 import BackupResponse1 - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - filters = 'status eq \"COMPLETE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - try: - # List Backups - - results = ConfigurationHubApi(api_client).list_backups() - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).list_backups(filters) - print("The response of ConfigurationHubApi->list_backups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) - /configuration-hub/backups/{id}: - delete: - operationId: deleteBackup - security: - - userAuth: - - sp:config-backup:manage - tags: - - Configuration Hub - summary: Delete a Backup - description: |- - This API deletes an existing backup for the current tenant. - - On success, this endpoint will return an empty response. - - The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The id of the backup to delete. - example: 07659d7d-2cce-47c0-9e49-185787ee565a - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-backup - source: | - $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. - - # Delete a Backup - - try { - Remove-V2025Backup -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Backup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Backup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#delete-backup - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the backup to delete. # str | The id of the backup to delete. - try: - # Delete a Backup - - ConfigurationHubApi(api_client).delete_backup(id=id) - # Below is a request that includes all optional parameters - # ConfigurationHubApi(api_client).delete_backup(id) - except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_backup: %s\n" % e) - /configuration-hub/drafts: - get: - operationId: listDrafts - security: - - userAuth: - - sp:config-draft:read - - sp:config-draft:manage - tags: - - Configuration Hub - summary: List Drafts - description: This API gets a list of existing drafts for the current tenant. - parameters: - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **status**: *eq* - - **approvalStatus**: *eq* - example: status eq "COMPLETE" - required: false - responses: - '200': - description: List of existing drafts. - content: - application/json: - schema: - type: array - items: - type: object - properties: - jobId: - type: string - description: Unique id assigned to this job. - example: 07659d7d-2cce-47c0-9e49-185787ee565a - status: - type: string - description: Status of the job. - enum: - - NOT_STARTED - - IN_PROGRESS - - COMPLETE - - CANCELLED - - FAILED - example: COMPLETE - type: - type: string - description: Type of the job, will always be CREATE_DRAFT for this type of job. - enum: - - CREATE_DRAFT - example: CREATE_DRAFT - message: - type: string - description: Message providing information about the outcome of the draft process. - example: Draft creation message - requesterName: - type: string - description: The name of user that that initiated the draft process. - example: requester.name - fileExists: - type: boolean - default: true - description: Whether or not a file was generated for this draft. - example: true - created: - type: string - format: date-time - description: The time the job was started. - example: '2021-05-11T22:23:16Z' - modified: - type: string - format: date-time - description: The time of the last update to the job. - example: '2021-05-11T22:23:16Z' - completed: - type: string - format: date-time - description: The time the job was completed. - example: '2021-05-11T22:23:16Z' - name: - type: string - description: Name of the draft. - example: Draft name - sourceTenant: - type: string - description: Tenant owner of the backup from which the draft was generated. - example: source-tenant - sourceBackupId: - type: string - description: Id of the backup from which the draft was generated. - example: 549bf881-1ac4-4a64-9acf-6014e8a3a887 - sourceBackupName: - type: string - description: Name of the backup from which the draft was generated. - example: Source backup name - mode: - type: string - description: |- - Denotes the origin of the source backup from which the draft was generated. - - RESTORE - Same tenant. - - PROMOTE - Different tenant. - - UPLOAD - Uploaded configuration. - enum: - - RESTORE - - PROMOTE - - UPLOAD - example: RESTORE - approvalStatus: - type: string - description: Approval status of the draft used to determine whether or not the draft can be deployed. - enum: - - DEFAULT - - PENDING_APPROVAL - - APPROVED - - DENIED - example: APPROVED - approvalComment: - type: array - description: List of comments that have been exchanged between an approval requester and an approver. - items: - type: object - title: Approval Comment - required: - - comment - - timestamp - - user - - id - - changedToStatus - properties: - comment: - type: string - description: Comment provided either by the approval requester or the approver. - example: Approval comment - timestamp: - type: string - format: date-time - description: The time when this comment was provided. - example: '2021-05-11T22:23:16Z' - user: - type: string - description: Name of the user that provided this comment. - example: user.name - id: - type: string - description: Id of the user that provided this comment. - example: 549bf881-1ac4-4a64-9acf-6014e8a3a887 - changedToStatus: - type: string - description: Status transition of the draft. - enum: - - PENDING_APPROVAL - - APPROVED - - REJECTED - example: PENDING_APPROVAL - example: - - jobId: 07659d7d-2cce-47c0-9e49-185787ee565a - status: COMPLETE - type: CREATE_DRAFT - message: Draft creation message - requesterName: Requester Name - fileExists: true - created: '2024-08-16T14:16:58.389Z' - completed: '2024-08-16T14:17:12.355Z' - name: Draft Name - sourceTenant: source-tenant - sourceBackupId: 9393e1f5-bed6-4fa8-80fb-6f86b19bd3d6 - sourceBackupName: Source Backup Name - mode: RESTORE - approvalStatus: DEFAULT - approvalComment: - - comment: Approval comment - timestamp: '2024-08-26T19:32:46.384137Z' - user: User name - id: User id - changedToStatus: PENDING_FOR_APPROVAL - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-drafts - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) - - # List Drafts - - try { - Get-V2025Drafts - - # Below is a request that includes all optional parameters - # Get-V2025Drafts -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Drafts" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#list-drafts - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.draft_response import DraftResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - filters = 'status eq \"COMPLETE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) - try: - # List Drafts - - results = ConfigurationHubApi(api_client).list_drafts() - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).list_drafts(filters) - print("The response of ConfigurationHubApi->list_drafts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) - /configuration-hub/drafts/{id}: - delete: - operationId: deleteDraft - security: - - userAuth: - - sp:config-draft:manage - tags: - - Configuration Hub - summary: Delete a draft - description: |- - This API deletes an existing draft for the current tenant. - - On success, this endpoint will return an empty response. - - The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The id of the draft to delete. - example: 07659d7d-2cce-47c0-9e49-185787ee565a - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-draft - source: | - $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to delete. - - # Delete a draft - - try { - Remove-V2025Draft -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Draft -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Draft" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#delete-draft - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the draft to delete. # str | The id of the draft to delete. - try: - # Delete a draft - - ConfigurationHubApi(api_client).delete_draft(id=id) - # Below is a request that includes all optional parameters - # ConfigurationHubApi(api_client).delete_draft(id) - except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_draft: %s\n" % e) - /configuration-hub/deploys: - get: - operationId: listDeploys - security: - - userAuth: - - sp:config-deploy:read - - sp:config-deploy:manage - tags: - - Configuration Hub - summary: List Deploys - description: This API gets a list of deploys for the current tenant. - responses: - '200': - description: List of existing deploys. - content: - application/json: - schema: - type: object - properties: - items: - type: array - description: list of deployments - items: - type: object - properties: - jobId: - type: string - description: Unique id assigned to this job. - example: 07659d7d-2cce-47c0-9e49-185787ee565a - status: - type: string - description: Status of the job. - enum: - - NOT_STARTED - - IN_PROGRESS - - COMPLETE - - CANCELLED - - FAILED - example: COMPLETE - type: - type: string - description: Type of the job, will always be CONFIG_DEPLOY_DRAFT for this type of job. - enum: - - CONFIG_DEPLOY_DRAFT - example: CONFIG_DEPLOY_DRAFT - message: - type: string - description: Message providing information about the outcome of the deploy process. - example: Deploy creation message - requesterName: - type: string - description: The name of the user that initiated the deploy process. - example: requester.name - fileExists: - type: boolean - default: true - description: Whether or not a results file was created and stored for this deploy. - example: true - created: - type: string - format: date-time - description: The time the job was started. - example: '2021-05-11T22:23:16.000Z' - modified: - type: string - format: date-time - description: The time of the last update to the job. - example: '2021-05-11T22:23:16.000Z' - completed: - type: string - format: date-time - description: The time the job was completed. - example: '2021-05-11T22:23:16.000Z' - draftId: - type: string - description: The id of the draft that was used for this deploy. - example: 07659d7d-2cce-47c0-9e49-185787ee565a - draftName: - type: string - description: The name of the draft that was used for this deploy. - example: Draft Name - cloudStorageStatus: - type: string - description: Whether this deploy results file has been transferred to a customer storage location. - enum: - - SYNCED - - NOT_SYNCED - - SYNC_FAILED - example: SYNCED - example: - items: - - jobId: 3d0fe04b-57df-4a46-a83b-8f04b0f9d10b - status: COMPLETE - type: CONFIG_DEPLOY_DRAFT - message: Deploy outcome message - requesterName: requester.name - fileExists: true - created: '2023-08-29T01:54:37.069Z' - modified: '2024-07-15T16:53:45.925Z' - completed: '2023-08-29T01:54:41.924Z' - draftId: 925e34e3-fa7c-4e7a-9b9a-cf3b8b4b1068 - draftName: Source draft name - cloudStorageStatus: SYNCED - - jobId: bdbcaae6-5e2a-4ebd-9eb3-37b09ec7eea4 - status: FAILED - type: CONFIG_DEPLOY_DRAFT - message: Deploy outcome message - requesterName: requester.name - fileExists: true - created: '2023-07-20T18:38:00.812Z' - modified: '2024-07-15T16:53:59.778Z' - completed: '2023-07-20T18:38:01.783Z' - draftId: e04da89d-941f-41e8-83ab-dd185ef5e646 - draftName: Source draft name - cloudStorageStatus: NOT_SYNCED - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-deploys - source: | - - # List Deploys - - try { - Get-V2025Deploys - - # Below is a request that includes all optional parameters - # Get-V2025Deploys - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Deploys" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#list-deploys - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_deploys200_response import ListDeploys200Response - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Deploys - - results = ConfigurationHubApi(api_client).list_deploys() - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).list_deploys() - print("The response of ConfigurationHubApi->list_deploys:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->list_deploys: %s\n" % e) - post: - operationId: createDeploy - security: - - userAuth: - - sp:config-deploy:manage - tags: - - Configuration Hub - summary: Create a Deploy - description: This API performs a deploy based on an existing daft. - requestBody: - description: The deploy request body. - required: true - content: - application/json: - schema: - type: object - title: Deploy Request - required: - - draftId - properties: - draftId: - type: string - description: The id of the draft to be used by this deploy. - example: 3d0fe04b-57df-4a46-a83b-8f04b0f9d10b - example: - draftId: c9a38d8c-5edf-4182-9d39-f6581d3ebd05 - responses: - '202': - description: Deploy job accepted and queued for processing. - content: - application/json: - schema: - $ref: '#/paths/~1configuration-hub~1deploys/get/responses/200/content/application~1json/schema/properties/items/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/configuration-hub/DeployResponse.yaml - example: - jobId: ce928190-b50a-4e9a-9854-b56959be8bb1 - status: NOT_STARTED - type: CONFIG_DEPLOY_DRAFT - requesterName: support - fileExists: false - created: '2024-09-19T19:28:58.503Z' - modified: '2024-09-19T19:28:58.509Z' - draftId: ebee8250-841f-41de-b74f-288b81137d12 - draftName: Draft for 46207915-854f-4894-8723-782fdcc677d6 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-deploy - source: | - $DeployRequest = @" - { - "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" - } - "@ - - # Create a Deploy - - try { - $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest - New-V2025Deploy -DeployRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Deploy -DeployRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Deploy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#create-deploy - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.deploy_request import DeployRequest - from sailpoint.v2025.models.deploy_response import DeployResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - deploy_request = '''{ - "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" - }''' # DeployRequest | The deploy request body. - try: - # Create a Deploy - new_deploy_request = DeployRequest.from_json(deploy_request) - results = ConfigurationHubApi(api_client).create_deploy(deploy_request=new_deploy_request) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).create_deploy(new_deploy_request) - print("The response of ConfigurationHubApi->create_deploy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_deploy: %s\n" % e) - /configuration-hub/deploys/{id}: - get: - operationId: getDeploy - security: - - userAuth: - - sp:config-deploy:read - - sp:config-deploy:manage - tags: - - Configuration Hub - summary: Get a Deploy - description: This API gets an existing deploy for the current tenant. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The id of the deploy. - example: 3d0fe04b-57df-4a46-a83b-8f04b0f9d10b - responses: - '200': - description: Gets the details of a deploy. - content: - application/json: - schema: - $ref: '#/paths/~1configuration-hub~1deploys/get/responses/200/content/application~1json/schema/properties/items/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/configuration-hub/DeployResponse.yaml - example: - jobId: 3d0fe04b-57df-4a46-a83b-8f04b0f9d10b - status: COMPLETE - type: CONFIG_DEPLOY_DRAFT - message: Deploy outcome message - requesterName: requester.name - fileExists: true - created: '2023-08-29T01:54:37.069Z' - modified: '2024-07-15T16:53:45.925Z' - completed: '2023-08-29T01:54:41.924Z' - draftId: 925e34e3-fa7c-4e7a-9b9a-cf3b8b4b1068 - draftName: Source draft name - cloudStorageStatus: SYNCED - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#get-deploy - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. - - # Get a Deploy - - try { - Get-V2025Deploy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Deploy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Deploy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/configuration-hub#get-deploy - source: | - from sailpoint.v2025.api.configuration_hub_api import ConfigurationHubApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.deploy_response import DeployResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the deploy. # str | The id of the deploy. - try: - # Get a Deploy - - results = ConfigurationHubApi(api_client).get_deploy(id=id) - # Below is a request that includes all optional parameters - # results = ConfigurationHubApi(api_client).get_deploy(id) - print("The response of ConfigurationHubApi->get_deploy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConfigurationHubApi->get_deploy: %s\n" % e) - /connectors/{scriptName}: - get: - tags: - - Connectors - operationId: getConnector - summary: Get Connector by Script Name - description: 'Fetches a connector that using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - - in: query - name: locale - required: false - schema: - type: string - enum: - - de - - 'no' - - fi - - sv - - ru - - pt - - ko - - zh-TW - - en - - it - - fr - - zh-CN - - hu - - es - - cs - - ja - - pl - - da - - nl - example: de - description: The locale to apply to the config. If no viable locale is given, it will default to "en" - responses: - '200': - description: A Connector Dto object - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The connector name - example: name - type: - type: string - description: The connector type - example: ServiceNow - className: - type: string - description: The connector class name - example: class name - scriptName: - type: string - description: The connector script name - example: servicenow - applicationXml: - type: string - description: The connector application xml - example: | - - - - correlationConfigXml: - type: string - description: The connector correlation config xml - example: "\n\n\n\n\n\n\t\n\t\t\n\t\t\n\t\t\n\t\n\n" - sourceConfigXml: - type: string - description: The connector source config xml - example: |- -

- - - - - - - - sourceConfig: - type: string - nullable: true - description: The connector source config - example: |- -
- - - - - - -
- sourceConfigFrom: - type: string - nullable: true - description: The connector source config origin - example: sp-connect - s3Location: - type: string - description: storage path key for this connector - example: custom-connector/scriptname - uploadedFiles: - type: array - description: The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. - nullable: true - items: - type: string - example: - - pod/org/connectorFiles/testconnector/test1.jar - fileUpload: - type: boolean - description: true if the source is file upload - example: true - default: false - directConnect: - type: boolean - description: true if the source is a direct connect source - example: true - default: false - translationProperties: - type: object - description: A map containing translation attributes by loacale key - additionalProperties: true - example: - de: |- - # Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved. - # DO NOT EDIT. This file is generated by "sailpointTranslate" command. - menuLabel_ConnectionSettings=Verbindungseinstellungen - menuLabel_AggregationSettings=Aggregationseinstellungen - sectionLabel_AuthenticationSettings=Verbindungseinstellungen - sectionLabel_AggregationSettings=Aggregationseinstellungen - sectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.

Geben Sie bei Zeit\u00fcberschreitung bei Verbindung die maximal erlaubte Zeitdauer (in Minuten) f\u00fcr die Verbindung von IdentityNow mit der Quelle ein.

Geben Sie die Host-URL der Delinea-SCIM-Serverquelle ein.

Geben Sie den API-Token der Quelle zur Authentifizierung ein. - sectionInfo_AggregationSettings=Geben Sie die Einstellungen f\u00fcr Ihre Aggregation an.

Geben Sie in das Feld Seitengr\u00f6\u00dfe die Anzahl an Kontoeintr\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\u00dfe Datens\u00e4tze durchlaufen werden.
\n
Geben Sie im Kontofilter die Bedingungen f\u00fcr den Kontofilter an. Beispiel: userName sw "S"

Geben Sie im Gruppenfilter die Gruppenfilterbedingungen an. Beispiel: displayName sw "S". - placeHolder_accAggregation=userName sw "S" - placeHolder_grpAggregation=displayName sw "S" - placeHolder_host=https://{Delinea_SCIM_Server_host}/v2 - docLinkLabel_AuthenticationSettings=Mehr \u00fcber Verbindungseinstellungen - docLinkLabel_Filters=Mehr \u00fcber Konto- und Gruppenfilter - HostURL=Host-URL - ConnectionTimeout=Zeit\u00fcberschreitung bei Verbindung - API_TOKEN=API-Token - JSONPathMapping=JSON-Path-Attribut-Mapping - FilterConditionForAccounts=Kontofilter - FilterConditionForGroups=Gruppenfilter - Page_Size=Seitengr\u00f6\u00dfe - SchemaAttribute=Schema-Attribut - JSONpath=JSON-Pfad - ShortDesc=Das Integrationsmodul IdentityNow f\u00fcr Delinea Secret Server On-Premise bietet die M\u00f6glichkeit einer tiefen Governance f\u00fcr Konten und Gruppen. Es unterst\u00fctzt au\u00dferdem das End-to-End-Lebenszyklus-Management. - connectorMetadata: - type: object - description: A map containing metadata pertinent to the UI to be used - additionalProperties: true - example: - supportedUI: EXTJS - platform: ccg - shortDesc: connector description - status: - type: string - enum: - - DEPRECATED - - DEVELOPMENT - - DEMO - - RELEASED - description: The connector status - example: RELEASED - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:read - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector by Script Name - - try { - Get-V2025Connector -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025Connector -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Connector" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#get-connector - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_detail import ConnectorDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) - try: - # Get Connector by Script Name - - results = ConnectorsApi(api_client).get_connector(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).get_connector(script_name, locale) - print("The response of ConnectorsApi->get_connector:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) - delete: - tags: - - Connectors - operationId: deleteCustomConnector - summary: Delete Connector by Script Name - description: Delete a custom connector that using its script name. - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#delete-custom-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Delete Connector by Script Name - - try { - Remove-V2025CustomConnector -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Remove-V2025CustomConnector -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CustomConnector" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#delete-custom-connector - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - try: - # Delete Connector by Script Name - - ConnectorsApi(api_client).delete_custom_connector(script_name=script_name) - # Below is a request that includes all optional parameters - # ConnectorsApi(api_client).delete_custom_connector(script_name) - except Exception as e: - print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e) - patch: - tags: - - Connectors - operationId: updateConnector - summary: Update Connector by Script Name - description: | - This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - - The following fields are patchable: - - - * connectorMetadata - - * applicationXml - - * correlationConfigXml - - * sourceConfigXml - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - requestBody: - required: true - description: | - A list of connector detail update operations - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - responses: - '200': - description: A updated Connector Dto object - content: - application/json: - schema: - $ref: '#/paths/~1connectors~1%7BscriptName%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ConnectorDetail.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#update-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Connector by Script Name - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Connector -ScriptName $ScriptName -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Connector -ScriptName $ScriptName -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Connector" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#update-connector - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_detail import ConnectorDetail - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of connector detail update operations - try: - # Update Connector by Script Name - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ConnectorsApi(api_client).update_connector(script_name=script_name, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).update_connector(script_name, new_json_patch_operation) - print("The response of ConnectorsApi->update_connector:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) - /connectors: - get: - tags: - - Connectors - operationId: getConnectorList - summary: Get Connector List - description: Fetches list of connectors that have 'RELEASED' status using filtering and pagination. - parameters: - - in: query - name: filters - required: false - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **name**: *sw, co* - - **type**: *sw, co, eq* - - **directConnect**: *eq* - - **category**: *eq* - - **features**: *ca* - - **labels**: *ca* - example: directConnect eq "true" - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: locale - required: false - schema: - type: string - enum: - - de - - 'no' - - fi - - sv - - ru - - pt - - ko - - zh-TW - - en - - it - - fr - - zh-CN - - hu - - es - - cs - - ja - - pl - - da - - nl - example: de - description: The locale to apply to the config. If no viable locale is given, it will default to "en" - responses: - '200': - description: A Connector Dto object - content: - application/json: - schema: - type: array - items: - title: custom connector response object - type: object - properties: - name: - type: string - description: The connector name - example: name - type: - type: string - description: The connector type - example: ServiceNow - scriptName: - type: string - description: The connector script name - example: servicenow - className: - type: string - nullable: true - description: The connector class name. - example: sailpoint.connector.OpenConnectorAdapter - features: - type: array - description: The list of features supported by the connector - nullable: true - items: - type: string - example: - - PROVISIONING - - SYNC_PROVISIONING - - SEARCH - - UNSTRUCTURED_TARGETS - directConnect: - type: boolean - description: true if the source is a direct connect source - example: true - default: false - connectorMetadata: - type: object - additionalProperties: true - description: A map containing metadata pertinent to the connector - example: - supportedUI: ANGULAR - platform: ccg - shortDesc: connector description - status: - type: string - enum: - - DEPRECATED - - DEVELOPMENT - - DEMO - - RELEASED - description: The connector status - example: RELEASED - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:read - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-list - source: | - $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector List - - try { - Get-V2025ConnectorList - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorList" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#get-connector-list - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.v3_connector_dto import V3ConnectorDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - filters = 'directConnect eq \"true\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) - try: - # Get Connector List - - results = ConnectorsApi(api_client).get_connector_list() - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) - print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - post: - tags: - - Connectors - operationId: createCustomConnector - summary: Create Custom Connector - description: 'Create custom connector. ' - requestBody: - required: true - content: - application/json: - schema: - title: custom connector create request - type: object - required: - - name - - className - properties: - name: - type: string - description: The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints - example: custom connector - type: - type: string - description: The connector type. If not specified will be defaulted to 'custom '+name - example: custom connector type - className: - type: string - description: The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter - example: sailpoint.connector.OpenConnectorAdapter - directConnect: - type: boolean - description: true if the source is a direct connect source - default: true - example: true - status: - type: string - enum: - - DEVELOPMENT - - DEMO - - RELEASED - description: The connector status - example: RELEASED - responses: - '200': - description: A Connector Dto object - content: - application/json: - schema: - $ref: '#/paths/~1connectors/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/V3ConnectorDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#create-custom-connector - source: | - $V3CreateConnectorDto = @" - { - "name" : "custom connector", - "directConnect" : true, - "className" : "sailpoint.connector.OpenConnectorAdapter", - "type" : "custom connector type", - "status" : "RELEASED" - } - "@ - - # Create Custom Connector - - try { - $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto - New-V2025CustomConnector -V3CreateConnectorDto $Result - - # Below is a request that includes all optional parameters - # New-V2025CustomConnector -V3CreateConnectorDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CustomConnector" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#create-custom-connector - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.v3_connector_dto import V3ConnectorDto - from sailpoint.v2025.models.v3_create_connector_dto import V3CreateConnectorDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - v3_create_connector_dto = '''{ - "name" : "custom connector", - "directConnect" : true, - "className" : "sailpoint.connector.OpenConnectorAdapter", - "type" : "custom connector type", - "status" : "RELEASED" - }''' # V3CreateConnectorDto | - try: - # Create Custom Connector - new_v3_create_connector_dto = V3CreateConnectorDto.from_json(v3_create_connector_dto) - results = ConnectorsApi(api_client).create_custom_connector(v3_create_connector_dto=new_v3_create_connector_dto) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto) - print("The response of ConnectorsApi->create_custom_connector:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) - /connectors/{scriptName}/source-config: - get: - tags: - - Connectors - operationId: getConnectorSourceConfig - summary: Get Connector Source Configuration - description: 'Fetches a connector''s source config using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - responses: - '200': - description: The connector's source template - content: - application/xml: - schema: - type: string - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:read - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-source-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Get Connector Source Configuration - - try { - Get-V2025ConnectorSourceConfig -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorSourceConfig -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorSourceConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#get-connector-source-config - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - try: - # Get Connector Source Configuration - - results = ConnectorsApi(api_client).get_connector_source_config(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).get_connector_source_config(script_name) - print("The response of ConnectorsApi->get_connector_source_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) - put: - tags: - - Connectors - operationId: putConnectorSourceConfig - summary: Update Connector Source Configuration - description: 'Update a connector''s source config using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - required: - - file - properties: - file: - type: string - description: connector source config xml file - format: binary - responses: - '200': - description: The connector's update detail - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: The detailed message for an update. Typically the relevent error message when status is error. - example: unsupported xsd version, please ensure latest xsd version http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd is used for source config - scriptName: - type: string - description: The connector script name - example: servicenow - updatedFiles: - type: array - description: The list of updated files supported by the connector - nullable: true - items: - type: string - example: - - pod/org/connectorFiles/testconnector/test1.jar - status: - type: string - enum: - - ERROR - - UPDATED - - UNCHANGED - - SKIPPED - description: The connector update status - example: ERROR - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-source-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector source config xml file - - # Update Connector Source Configuration - - try { - Send-V2025ConnectorSourceConfig -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorSourceConfig -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorSourceConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#put-connector-source-config - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.update_detail import UpdateDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - file = None # bytearray | connector source config xml file # bytearray | connector source config xml file - try: - # Update Connector Source Configuration - - results = ConnectorsApi(api_client).put_connector_source_config(script_name=script_name, file=file) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).put_connector_source_config(script_name, file) - print("The response of ConnectorsApi->put_connector_source_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) - /connectors/{scriptName}/translations/{locale}: - get: - tags: - - Connectors - operationId: getConnectorTranslations - summary: Get Connector Translations - description: 'Fetches a connector''s translations using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - - name: locale - in: path - required: true - schema: - type: string - enum: - - de - - 'no' - - fi - - sv - - ru - - pt - - ko - - zh-TW - - en - - it - - fr - - zh-CN - - hu - - es - - cs - - ja - - pl - - da - - nl - example: de - description: The locale to apply to the config. If no viable locale is given, it will default to "en" - responses: - '200': - description: The connector's translations - content: - text/plain: - schema: - type: string - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:read - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-translations - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - - # Get Connector Translations - - try { - Get-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorTranslations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#get-connector-translations - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" - try: - # Get Connector Translations - - results = ConnectorsApi(api_client).get_connector_translations(script_name=script_name, locale=locale) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).get_connector_translations(script_name, locale) - print("The response of ConnectorsApi->get_connector_translations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) - put: - tags: - - Connectors - operationId: putConnectorTranslations - summary: Update Connector Translations - description: 'Update a connector''s translations using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - - name: locale - in: path - required: true - schema: - type: string - enum: - - de - - 'no' - - fi - - sv - - ru - - pt - - ko - - zh-TW - - en - - it - - fr - - zh-CN - - hu - - es - - cs - - ja - - pl - - da - - nl - example: de - description: The locale to apply to the config. If no viable locale is given, it will default to "en" - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - responses: - '200': - description: The connector's update detail - content: - application/json: - schema: - $ref: '#/paths/~1connectors~1%7BscriptName%7D~1source-config/put/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UpdateDetail.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-translations - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - - # Update Connector Translations - - try { - Send-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorTranslations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#put-connector-translations - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.update_detail import UpdateDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" - try: - # Update Connector Translations - - results = ConnectorsApi(api_client).put_connector_translations(script_name=script_name, locale=locale) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).put_connector_translations(script_name, locale) - print("The response of ConnectorsApi->put_connector_translations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) - /connectors/{scriptName}/source-template: - get: - tags: - - Connectors - operationId: getConnectorSourceTemplate - summary: Get Connector Source Template - description: 'Fetches a connector''s source template using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - responses: - '200': - description: The connector's source template - content: - application/xml: - schema: - type: string - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:read - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-source-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Get Connector Source Template - - try { - Get-V2025ConnectorSourceTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorSourceTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorSourceTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#get-connector-source-template - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - try: - # Get Connector Source Template - - results = ConnectorsApi(api_client).get_connector_source_template(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).get_connector_source_template(script_name) - print("The response of ConnectorsApi->get_connector_source_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) - put: - tags: - - Connectors - operationId: putConnectorSourceTemplate - summary: Update Connector Source Template - description: 'Update a connector''s source template using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - required: - - file - properties: - file: - type: string - description: connector source template xml file - format: binary - responses: - '200': - description: The connector's update detail - content: - application/json: - schema: - $ref: '#/paths/~1connectors~1%7BscriptName%7D~1source-config/put/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UpdateDetail.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-source-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector source template xml file - - # Update Connector Source Template - - try { - Send-V2025ConnectorSourceTemplate -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorSourceTemplate -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorSourceTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#put-connector-source-template - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.update_detail import UpdateDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - file = None # bytearray | connector source template xml file # bytearray | connector source template xml file - try: - # Update Connector Source Template - - results = ConnectorsApi(api_client).put_connector_source_template(script_name=script_name, file=file) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).put_connector_source_template(script_name, file) - print("The response of ConnectorsApi->put_connector_source_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) - /connectors/{scriptName}/correlation-config: - get: - tags: - - Connectors - operationId: getConnectorCorrelationConfig - summary: Get Connector Correlation Configuration - description: 'Fetches a connector''s correlation config using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - responses: - '200': - description: The connector's correlation config - content: - application/xml: - schema: - type: string - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:read - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-correlation-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - - # Get Connector Correlation Configuration - - try { - Get-V2025ConnectorCorrelationConfig -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorCorrelationConfig -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorCorrelationConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#get-connector-correlation-config - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - try: - # Get Connector Correlation Configuration - - results = ConnectorsApi(api_client).get_connector_correlation_config(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).get_connector_correlation_config(script_name) - print("The response of ConnectorsApi->get_connector_correlation_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_correlation_config: %s\n" % e) - put: - tags: - - Connectors - operationId: putConnectorCorrelationConfig - summary: Update Connector Correlation Configuration - description: 'Update a connector''s correlation config using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - required: - - file - properties: - file: - type: string - description: connector correlation config xml file - format: binary - responses: - '200': - description: The connector's update detail - content: - application/json: - schema: - $ref: '#/paths/~1connectors~1%7BscriptName%7D~1source-config/put/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UpdateDetail.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-correlation-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector correlation config xml file - - # Update Connector Correlation Configuration - - try { - Send-V2025ConnectorCorrelationConfig -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorCorrelationConfig -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorCorrelationConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connectors#put-connector-correlation-config - source: | - from sailpoint.v2025.api.connectors_api import ConnectorsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.update_detail import UpdateDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - file = None # bytearray | connector correlation config xml file # bytearray | connector correlation config xml file - try: - # Update Connector Correlation Configuration - - results = ConnectorsApi(api_client).put_connector_correlation_config(script_name=script_name, file=file) - # Below is a request that includes all optional parameters - # results = ConnectorsApi(api_client).put_connector_correlation_config(script_name, file) - print("The response of ConnectorsApi->put_connector_correlation_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_correlation_config: %s\n" % e) - /connector-rules: - get: - tags: - - Connector Rule Management - operationId: getConnectorRuleList - summary: List Connector Rules - description: List existing connector rules. - responses: - '200': - description: List of connector rules. - content: - application/json: - schema: - type: array - items: - description: ConnectorRuleResponse - allOf: - - $ref: '#/paths/~1connector-rules/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ConnectorRuleCreateRequest.yaml - - type: object - nullable: true - required: - - id - - created - properties: - id: - type: string - description: the ID of the rule - example: 8113d48c0b914f17b4c6072d4dcb9dfe - created: - type: string - description: an ISO 8601 UTC timestamp when this rule was created - example: 021-07-22T15:59:23Z - modified: - type: string - nullable: true - description: an ISO 8601 UTC timestamp when this rule was last modified - example: 021-07-22T15:59:23Z - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:rule-management-connector:read - - idn:rule-management-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: query - name: limit - description: |- - Note that for this API the maximum value for limit is 50. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 50 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 50 - default: 50 - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#get-connector-rule-list - source: | - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Connector Rules - - try { - Get-V2025ConnectorRuleList - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorRuleList -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorRuleList" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-rule-management#get-connector-rule-list - source: | - from sailpoint.v2025.api.connector_rule_management_api import ConnectorRuleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_rule_response import ConnectorRuleResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Connector Rules - - results = ConnectorRuleManagementApi(api_client).get_connector_rule_list() - # Below is a request that includes all optional parameters - # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(limit, offset, count) - print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) - post: - tags: - - Connector Rule Management - operationId: createConnectorRule - summary: Create Connector Rule - description: Create a connector rule from the available types. - requestBody: - required: true - description: Connector rule to create. - content: - application/json: - schema: - description: ConnectorRuleCreateRequest - type: object - required: - - name - - type - - sourceCode - properties: - name: - type: string - description: the name of the rule - example: WebServiceBeforeOperationRule - minLength: 1 - maxLength: 128 - description: - type: string - nullable: true - description: a description of the rule's purpose - example: This rule does that - type: - type: string - enum: - - BuildMap - - ConnectorAfterCreate - - ConnectorAfterDelete - - ConnectorAfterModify - - ConnectorBeforeCreate - - ConnectorBeforeDelete - - ConnectorBeforeModify - - JDBCBuildMap - - JDBCOperationProvisioning - - JDBCProvision - - PeopleSoftHRMSBuildMap - - PeopleSoftHRMSOperationProvisioning - - PeopleSoftHRMSProvision - - RACFPermissionCustomization - - ResourceObjectCustomization - - SAPBuildMap - - SapHrManagerRule - - SapHrOperationProvisioning - - SapHrProvision - - SuccessFactorsOperationProvisioning - - WebServiceAfterOperationRule - - WebServiceBeforeOperationRule - - ResourceObjectCustomization - description: the type of rule - example: BuildMap - signature: - description: The rule's function signature. Describes the rule's input arguments and output (if any) - type: object - required: - - input - properties: - input: - type: array - items: - type: object - nullable: true - properties: - name: - type: string - description: the name of the argument - example: firstName - description: - type: string - nullable: true - description: the description of the argument - example: the first name of the identity - type: - type: string - nullable: true - description: the programmatic type of the argument - example: String - required: - - name - output: - $ref: '#/paths/~1connector-rules/post/requestBody/content/application~1json/schema/properties/signature/properties/input/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Argument.yaml - sourceCode: - $ref: '#/paths/~1connector-rules~1validate/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SourceCode.yaml - attributes: - type: object - nullable: true - description: a map of string to objects - example: {} - responses: - '201': - description: Created connector rule. - content: - application/json: - schema: - $ref: '#/paths/~1connector-rules/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ConnectorRuleResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:rule-management-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#create-connector-rule - source: | - $ConnectorRuleCreateRequest = @" - { - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "type" : "BuildMap" - } - "@ - - # Create Connector Rule - - try { - $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest - New-V2025ConnectorRule -ConnectorRuleCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ConnectorRule -ConnectorRuleCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-rule-management#create-connector-rule - source: | - from sailpoint.v2025.api.connector_rule_management_api import ConnectorRuleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_rule_create_request import ConnectorRuleCreateRequest - from sailpoint.v2025.models.connector_rule_response import ConnectorRuleResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - connector_rule_create_request = '''{ - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "type" : "BuildMap" - }''' # ConnectorRuleCreateRequest | Connector rule to create. - try: - # Create Connector Rule - new_connector_rule_create_request = ConnectorRuleCreateRequest.from_json(connector_rule_create_request) - results = ConnectorRuleManagementApi(api_client).create_connector_rule(connector_rule_create_request=new_connector_rule_create_request) - # Below is a request that includes all optional parameters - # results = ConnectorRuleManagementApi(api_client).create_connector_rule(new_connector_rule_create_request) - print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) - /connector-rules/{id}: - get: - tags: - - Connector Rule Management - summary: Get Connector Rule - operationId: getConnectorRule - description: Get a connector rule by ID. - parameters: - - name: id - in: path - description: ID of the connector rule to get. - required: true - x-sailpoint-resource-operation-id: getConnectorRuleList - style: simple - explode: false - schema: - type: string - example: 8c190e6787aa4ed9a90bd9d5344523fb - responses: - '200': - description: Connector rule with the given ID. - content: - application/json: - schema: - $ref: '#/paths/~1connector-rules/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ConnectorRuleResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:rule-management-connector:read - - idn:rule-management-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#get-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. - - # Get Connector Rule - - try { - Get-V2025ConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorRule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-rule-management#get-connector-rule - source: | - from sailpoint.v2025.api.connector_rule_management_api import ConnectorRuleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_rule_response import ConnectorRuleResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to get. # str | ID of the connector rule to get. - try: - # Get Connector Rule - - results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id) - # Below is a request that includes all optional parameters - # results = ConnectorRuleManagementApi(api_client).get_connector_rule(id) - print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) - put: - tags: - - Connector Rule Management - summary: Update Connector Rule - description: 'Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type`' - operationId: putConnectorRule - parameters: - - name: id - in: path - description: ID of the connector rule to update. - required: true - x-sailpoint-resource-operation-id: getConnectorRuleList - style: simple - explode: false - schema: - type: string - example: 8c190e6787aa4ed9a90bd9d5344523fb - requestBody: - description: Connector rule with updated data. - content: - application/json: - schema: - description: ConnectorRuleUpdateRequest - allOf: - - type: object - required: - - id - properties: - id: - type: string - description: the ID of the rule to update - example: 8113d48c0b914f17b4c6072d4dcb9dfe - - $ref: '#/paths/~1connector-rules/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ConnectorRuleCreateRequest.yaml - responses: - '200': - description: Updated connector rule. - content: - application/json: - schema: - $ref: '#/paths/~1connector-rules/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ConnectorRuleResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:rule-management-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#put-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update. - $ConnectorRuleUpdateRequest = @" - { - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", - "type" : "BuildMap" - } - "@ - - # Update Connector Rule - - try { - Send-V2025ConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorRule -Id $Id -ConnectorRuleUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-rule-management#put-connector-rule - source: | - from sailpoint.v2025.api.connector_rule_management_api import ConnectorRuleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_rule_response import ConnectorRuleResponse - from sailpoint.v2025.models.connector_rule_update_request import ConnectorRuleUpdateRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update. # str | ID of the connector rule to update. - connector_rule_update_request = '''{ - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", - "type" : "BuildMap" - }''' # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional) - try: - # Update Connector Rule - - results = ConnectorRuleManagementApi(api_client).put_connector_rule(id=id) - # Below is a request that includes all optional parameters - # results = ConnectorRuleManagementApi(api_client).put_connector_rule(id, new_connector_rule_update_request) - print("The response of ConnectorRuleManagementApi->put_connector_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->put_connector_rule: %s\n" % e) - delete: - tags: - - Connector Rule Management - summary: Delete Connector Rule - description: Delete the connector rule for the given ID. - operationId: deleteConnectorRule - parameters: - - name: id - in: path - description: ID of the connector rule to delete. - required: true - x-sailpoint-resource-operation-id: getConnectorRuleList - style: simple - explode: false - schema: - type: string - example: 8c190e6787aa4ed9a90bd9d5344523fb - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:rule-management-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#delete-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. - - # Delete Connector Rule - - try { - Remove-V2025ConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ConnectorRule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-rule-management#delete-connector-rule - source: | - from sailpoint.v2025.api.connector_rule_management_api import ConnectorRuleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete. # str | ID of the connector rule to delete. - try: - # Delete Connector Rule - - ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id) - # Below is a request that includes all optional parameters - # ConnectorRuleManagementApi(api_client).delete_connector_rule(id) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) - /connector-rules/validate: - post: - tags: - - Connector Rule Management - operationId: testConnectorRule - summary: Validate Connector Rule - description: Detect issues within the connector rule's code to fix and list them. - requestBody: - required: true - description: Code to validate. - content: - application/json: - schema: - description: SourceCode - type: object - required: - - version - - script - properties: - version: - type: string - description: the version of the code - example: '1.0' - script: - type: string - description: The code - example: return "Mr. " + firstName; - responses: - '200': - description: Status of the code's eligibility as a connector rule. - content: - application/json: - schema: - description: ConnectorRuleValidationResponse - type: object - required: - - state - - details - properties: - state: - type: string - enum: - - OK - - ERROR - example: ERROR - details: - type: array - items: - description: CodeErrorDetail - type: object - required: - - line - - column - - message - properties: - line: - type: integer - description: The line number where the issue occurred - example: 2 - column: - type: integer - description: the column number where the issue occurred - example: 5 - messsage: - type: string - description: a description of the issue in the code - example: Remove reference to .decrypt( - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:rule-management-connector:read - - idn:rule-management-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#test-connector-rule - source: | - $SourceCode = @" - { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - } - "@ - - # Validate Connector Rule - - try { - $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode - Test-V2025ConnectorRule -SourceCode $Result - - # Below is a request that includes all optional parameters - # Test-V2025ConnectorRule -SourceCode $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/connector-rule-management#test-connector-rule - source: | - from sailpoint.v2025.api.connector_rule_management_api import ConnectorRuleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_rule_validation_response import ConnectorRuleValidationResponse - from sailpoint.v2025.models.source_code import SourceCode - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_code = '''{ - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }''' # SourceCode | Code to validate. - try: - # Validate Connector Rule - new_source_code = SourceCode.from_json(source_code) - results = ConnectorRuleManagementApi(api_client).test_connector_rule(source_code=new_source_code) - # Below is a request that includes all optional parameters - # results = ConnectorRuleManagementApi(api_client).test_connector_rule(new_source_code) - print("The response of ConnectorRuleManagementApi->test_connector_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->test_connector_rule: %s\n" % e) - /data-segments/membership/{identityId}: - get: - operationId: getDataSegmentIdentityMembership - security: - - userAuth: - - idn:data-segments:read - - applicationAuth: - - idn:data-segments:read - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Data Segmentation - summary: Get SegmentMembership by Identity ID - description: This API returns the segment membership specified by the given identity ID. - parameters: - - in: path - name: identityId - schema: - type: string - required: true - description: The identity ID to retrieve the segments they are in. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Segment Memberships for specified identity - content: - application/json: - schema: - items: - type: object - description: Contains the segments and types that an identity is associated with - properties: - segments: - type: array - items: - type: string - description: The segment's ID. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - description: List of segment ids that the identity is associated with. - allAccessScopes: - type: array - items: - type: string - enum: - - ENTITLEMENT - - CERTIFICATION - - IDENTITY - - ENTITLEMENTREQUEST - description: An enumeration of the types of scope choices - example: ALL - description: They type of scopes that are assigned to the identity. - refreshBy: - type: string - format: date-time - description: Date time string that lets you know when the membership data is going to be refreshed. - example: '2020-01-01T00:00:00.000000Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#get-data-segment-identity-membership - source: | - $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get SegmentMembership by Identity ID - - try { - Get-V2025DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegmentIdentityMembership" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#get-data-segment-identity-membership - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get SegmentMembership by Identity ID - - results = DataSegmentationApi(api_client).get_data_segment_identity_membership(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = DataSegmentationApi(api_client).get_data_segment_identity_membership(identity_id, x_sail_point_experimental) - print("The response of DataSegmentationApi->get_data_segment_identity_membership:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DataSegmentationApi->get_data_segment_identity_membership: %s\n" % e) - /data-segments/user-enabled/{identityId}: - get: - operationId: getDataSegmentationEnabledForUser - security: - - userAuth: - - idn:data-segments:read - - applicationAuth: - - idn:data-segments:read - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Data Segmentation - summary: Is Segmentation enabled by Identity - description: This API returns whether or not segmentation is enabled for the identity. - parameters: - - in: path - name: identityId - schema: - type: string - required: true - description: The identity ID to retrieve if segmentation is enabled for the identity. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Returns if segmentation is enabled for a specified User - content: - application/json: - schema: - type: boolean - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#get-data-segmentation-enabled-for-user - source: | - $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Is Segmentation enabled by Identity - - try { - Get-V2025DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegmentationEnabledForUser" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#get-data-segmentation-enabled-for-user - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Is Segmentation enabled by Identity - - results = DataSegmentationApi(api_client).get_data_segmentation_enabled_for_user(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = DataSegmentationApi(api_client).get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental) - print("The response of DataSegmentationApi->get_data_segmentation_enabled_for_user:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DataSegmentationApi->get_data_segmentation_enabled_for_user: %s\n" % e) - /data-segments/{segmentId}: - get: - operationId: getDataSegment - security: - - userAuth: - - idn:data-segments:read - - applicationAuth: - - idn:data-segments:read - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Data Segmentation - summary: Get Segment by ID - description: This API returns the segment specified by the given ID. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The segment ID to retrieve. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Segment - content: - application/json: - schema: - type: object - properties: - id: - $ref: '#/paths/~1data-segments~1membership~1%7BidentityId%7D/get/responses/200/content/application~1json/schema/items/properties/segments/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/data-segment/SegmentId.yaml - name: - type: string - description: The segment's business name. - example: segment-xyz - created: - type: string - format: date-time - description: The time when the segment is created. - example: '2020-01-01T00:00:00.000000Z' - modified: - type: string - format: date-time - description: The time when the segment is modified. - example: '2020-01-01T00:00:00.000000Z' - description: - type: string - description: The segment's optional description. - example: This segment represents xyz - scopes: - type: array - items: - type: object - description: This defines what access the segment is giving - properties: - scope: - $ref: '#/paths/~1data-segments~1membership~1%7BidentityId%7D/get/responses/200/content/application~1json/schema/items/properties/allAccessScopes/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/data-segment/ScopeType.yaml - visibility: - type: string - enum: - - ALL - - FILTER - - SELECTION - - UNSEGMENTED - description: An enumeration of the types of scope visibility choices - example: ALL - scopeFilter: - $ref: '#/paths/~1data-segments~1%7BsegmentId%7D/get/responses/200/content/application~1json/schema/properties/memberFilter' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/VisibilityCriteria.yaml - scopeSelection: - $ref: '#/paths/~1data-segments~1%7BsegmentId%7D/get/responses/200/content/application~1json/schema/properties/memberSelection' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/data-segment/Selection.yaml - nullable: false - description: List of Scopes that are assigned to the segment - example: - - scope: ENTITLEMENT - visibility: SELECTION - scopeFilter: null - scopeSelection: - - type: ENTITLEMENT - id: 34d73f611449463ea4fdcf02cda0c397 - memberSelection: - type: array - items: - type: object - properties: - type: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - description: DTO type - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - nullable: false - description: List of Identities that are assigned to the segment - example: - - type: IDENTITY - id: 29cb6c061da843ea8be4b3125f248f2a - - type: IDENTITY - id: f7b1b8a35fed4fd4ad2982014e137e19 - memberFilter: - type: object - properties: - expression: - type: object - properties: - operator: - type: string - description: Operator for the expression - enum: - - AND - - EQUALS - example: EQUALS - attribute: - type: string - description: Name for the attribute - example: location - nullable: true - value: - type: object - nullable: true - properties: - type: - type: string - description: The type of attribute value - example: STRING - value: - type: string - description: The attribute value - example: Austin - children: - type: array - nullable: true - description: List of expressions - items: - type: object - properties: - operator: - type: string - description: Operator for the expression - enum: - - AND - - EQUALS - example: EQUALS - attribute: - type: string - description: Name for the attribute - example: location - nullable: true - value: - $ref: '#/paths/~1data-segments~1%7BsegmentId%7D/get/responses/200/content/application~1json/schema/properties/memberFilter/properties/expression/properties/value' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Value.yaml - children: - type: string - nullable: true - description: There cannot be anymore nested children. This will always be null. - example: null - example: [] - membership: - type: string - enum: - - ALL - - FILTER - - SELECTION - description: An enumeration of the types of membership choices - example: ALL - enabled: - type: boolean - description: This boolean indicates whether the segment is currently active. Inactive segments have no effect. - default: false - example: true - published: - type: boolean - description: This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified to until published - default: false - example: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#get-data-segment - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Segment by ID - - try { - Get-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#get-data-segment - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.data_segment import DataSegment - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Segment by ID - - results = DataSegmentationApi(api_client).get_data_segment(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = DataSegmentationApi(api_client).get_data_segment(id, x_sail_point_experimental) - print("The response of DataSegmentationApi->get_data_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DataSegmentationApi->get_data_segment: %s\n" % e) - post: - operationId: publishDataSegment - security: - - userAuth: - - idn:data-segments:write - - applicationAuth: - - idn:data-segments:write - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Data Segmentation - summary: Publish segment by ID - description: This will publish the segment so that it starts applying the segmentation to the desired users if enabled - parameters: - - in: query - name: publishAll - schema: - type: boolean - default: true - required: false - description: This flag decides whether you want to publish all unpublished or a list of specific segment ids - example: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - description: A list of segment ids that you wish to publish - content: - application/json: - schema: - type: array - items: - type: string - responses: - '200': - description: Segments published - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#publish-data-segment - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish to publish - $RequestBody = @""@ - - $PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true) - - # Publish segment by ID - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Publish-V2025DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Publish-V2025DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -PublishAll $PublishAll - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2025DataSegment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#publish-data-segment - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''['request_body_example']''' # List[str] | A list of segment ids that you wish to publish - publish_all = True # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) - try: - # Publish segment by ID - new_request_body = RequestBody.from_json(request_body) - DataSegmentationApi(api_client).publish_data_segment(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # DataSegmentationApi(api_client).publish_data_segment(x_sail_point_experimental, new_request_body, publish_all) - except Exception as e: - print("Exception when calling DataSegmentationApi->publish_data_segment: %s\n" % e) - patch: - operationId: patchDataSegment - security: - - userAuth: - - idn:data-segments:write - - applicationAuth: - - idn:data-segments:write - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Data Segmentation - summary: Update Segment - description: Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The segment ID to modify. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - description: | - A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * name - * description - * membership - * memberFilter - * memberSelection - * scopes - * enabled - content: - application/json-patch+json: - schema: - type: array - items: - type: object - examples: - Set Visibility Criteria: - description: Set the member filter - value: - - op: replace - path: /memberFilter - value: - expression: - operator: AND - children: - - operator: EQUALS - attribute: location - value: - type: STRING - value: Philadelphia - - operator: EQUALS - attribute: department - value: - type: STRING - value: HR - responses: - '200': - description: Indicates the PATCH operation succeeded, and returns the segment's new representation. - content: - application/json: - schema: - $ref: '#/paths/~1data-segments~1%7BsegmentId%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/data-segment/Data-Segment.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#patch-data-segment - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to modify. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - $RequestBody = @"[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025DataSegment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#patch-data-segment - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.data_segment import DataSegment - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - try: - # Update Segment - new_request_body = RequestBody.from_json(request_body) - results = DataSegmentationApi(api_client).patch_data_segment(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = DataSegmentationApi(api_client).patch_data_segment(id, x_sail_point_experimental, new_request_body) - print("The response of DataSegmentationApi->patch_data_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DataSegmentationApi->patch_data_segment: %s\n" % e) - delete: - operationId: deleteDataSegment - security: - - userAuth: - - idn:data-segments:write - - applicationAuth: - - idn:data-segments:write - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Data Segmentation - summary: Delete Segment by ID - description: This API deletes the segment specified by the given ID. - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The segment ID to delete. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - - in: query - name: published - schema: - type: boolean - default: false - required: false - description: This determines which version of the segment to delete - example: false - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '204': - description: No content. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#delete-data-segment - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false) - - # Delete Segment by ID - - try { - Remove-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -Published $Published - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025DataSegment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#delete-data-segment - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - published = False # bool | This determines which version of the segment to delete (optional) (default to False) # bool | This determines which version of the segment to delete (optional) (default to False) - try: - # Delete Segment by ID - - DataSegmentationApi(api_client).delete_data_segment(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # DataSegmentationApi(api_client).delete_data_segment(id, x_sail_point_experimental, published) - except Exception as e: - print("Exception when calling DataSegmentationApi->delete_data_segment: %s\n" % e) - /data-segments: - get: - operationId: listDataSegments - security: - - userAuth: - - idn:data-segments:read - - applicationAuth: - - idn:data-segments:read - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Data Segmentation - summary: Get Segments - description: This API returns the segment specified by the given ID. - parameters: - - in: query - name: enabled - required: false - description: This boolean indicates whether the segment is currently active. Inactive segments have no effect. - schema: - type: boolean - default: true - example: true - - in: query - name: unique - required: false - description: This returns only one record if set to true and that would be the published record if exists. - schema: - type: boolean - default: false - example: false - - in: query - name: published - required: false - description: This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published - schema: - type: boolean - default: true - example: true - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - example: name eq "" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in, sw* - - **name**: *eq, in, sw* - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of all segments - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1data-segments~1%7BsegmentId%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/data-segment/Data-Segment.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#list-data-segments - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Enabled = $true # Boolean | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to $true) - $Unique = $false # Boolean | This returns only one record if set to true and that would be the published record if exists. (optional) (default to $false) - $Published = $true # Boolean | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to $true) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq """ # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) - - # Get Segments - - try { - Get-V2025DataSegments -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DataSegments -XSailPointExperimental $XSailPointExperimental -Enabled $Enabled -Unique $Unique -Published $Published -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegments" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#list-data-segments - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.data_segment import DataSegment - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - enabled = True # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) - unique = False # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) - published = True # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to True) # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to True) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) - try: - # Get Segments - - results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) - print("The response of DataSegmentationApi->list_data_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) - post: - operationId: createDataSegment - security: - - userAuth: - - idn:data-segments:write - - applicationAuth: - - idn:data-segments:write - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Data Segmentation - summary: Create Segment - description: |- - This API creates a segment. - >**Note:** Segment definitions may take time to propagate to all identities. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1data-segments~1%7BsegmentId%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/data-segment/Data-Segment.yaml - responses: - '201': - description: Segment created - content: - application/json: - schema: - $ref: '#/paths/~1data-segments~1%7BsegmentId%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/data-segment/Data-Segment.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#create-data-segment - source: | - $DataSegment = @" - - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment - New-V2025DataSegment -DataSegment $Result - - # Below is a request that includes all optional parameters - # New-V2025DataSegment -DataSegment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DataSegment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/data-segmentation#create-data-segment - source: | - from sailpoint.v2025.api.data_segmentation_api import DataSegmentationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.data_segment import DataSegment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data_segment = '''sailpoint.v2025.DataSegment()''' # DataSegment | - try: - # Create Segment - new_data_segment = DataSegment.from_json(data_segment) - results = DataSegmentationApi(api_client).create_data_segment(data_segment=new_data_segment) - # Below is a request that includes all optional parameters - # results = DataSegmentationApi(api_client).create_data_segment(new_data_segment) - print("The response of DataSegmentationApi->create_data_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DataSegmentationApi->create_data_segment: %s\n" % e) - /identities/{identity-id}/set-lifecycle-state: - post: - operationId: setLifecycleState - tags: - - Lifecycle States - summary: Set Lifecycle State - description: Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. - security: - - userAuth: - - idn:identity-lifecycle-state:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: identity-id - description: ID of the identity to update. - required: true - x-sailpoint-resource-operation-id: listIdentities - example: 2c9180857893f1290178944561990364 - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - lifecycleStateId: - type: string - description: ID of the lifecycle state to set. - example: 2c9180877a86e408017a8c19fefe046c - responses: - '200': - description: The request was successfully accepted into the system. - content: - application/json: - schema: - type: object - properties: - accountActivityId: - type: string - example: 2c9180837ab5b716017ab7c6c9ef1e20 - description: ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#set-lifecycle-state - source: | - $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. - $SetLifecycleStateRequest = @" - - "@ - - # Set Lifecycle State - - try { - $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest - Set-V2025LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result - - # Below is a request that includes all optional parameters - # Set-V2025LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025LifecycleState" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/lifecycle-states#set-lifecycle-state - source: | - from sailpoint.v2025.api.lifecycle_states_api import LifecycleStatesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.set_lifecycle_state200_response import SetLifecycleState200Response - from sailpoint.v2025.models.set_lifecycle_state_request import SetLifecycleStateRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_id = '2c9180857893f1290178944561990364' # str | ID of the identity to update. # str | ID of the identity to update. - set_lifecycle_state_request = '''sailpoint.v2025.SetLifecycleStateRequest()''' # SetLifecycleStateRequest | - try: - # Set Lifecycle State - new_set_lifecycle_state_request = SetLifecycleStateRequest.from_json(set_lifecycle_state_request) - results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id=identity_id, set_lifecycle_state_request=new_set_lifecycle_state_request) - # Below is a request that includes all optional parameters - # results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id, new_set_lifecycle_state_request) - print("The response of LifecycleStatesApi->set_lifecycle_state:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) - /identity-profiles/{identity-profile-id}/lifecycle-states: - get: - operationId: getLifecycleStates - tags: - - Lifecycle States - summary: Lists LifecycleStates - description: 'Use this endpoint to list all lifecycle states by their associated identity profiles. ' - security: - - userAuth: - - idn:identity-profile-lifecycle-state:read - - applicationAuth: - - idn:identity-profile-lifecycle-state:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: identity-profile-id - description: Identity profile ID. - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: created,modified - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, modified** - responses: - '200': - description: List of LifecycleState objects. - content: - application/json: - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Account/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - - type: object - required: - - technicalName - properties: - enabled: - type: boolean - default: false - example: true - description: Indicates whether the lifecycle state is enabled or disabled. - technicalName: - type: string - example: Technical Name - description: The lifecycle state's technical name. This is for internal use. - description: - type: string - nullable: true - example: Lifecycle description - description: Lifecycle state's description. - identityCount: - type: integer - format: int32 - example: 42 - readOnly: true - description: Number of identities that have the lifecycle state. - emailNotificationOption: - type: object - description: This is used for representing email configuration for a lifecycle state - properties: - notifyManagers: - type: boolean - default: false - example: true - description: If true, then the manager is notified of the lifecycle state change. - notifyAllAdmins: - type: boolean - default: false - example: true - description: If true, then all the admins are notified of the lifecycle state change. - notifySpecificUsers: - type: boolean - default: false - example: true - description: If true, then the users specified in "emailAddressList" below are notified of lifecycle state change. - emailAddressList: - type: array - example: - - test@test.com - - test2@test.com - items: - type: string - description: List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change. - accountActions: - type: array - items: - type: object - description: Object for specifying Actions to be performed on a specified list of sources' account. - properties: - action: - example: ENABLE - type: string - description: Describes if action will be enabled or disabled - enum: - - ENABLE - - DISABLE - sourceIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. - accessProfileIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique access-profile IDs that are associated with the lifecycle state. - identityState: - type: string - nullable: true - example: null - description: The lifecycle state's associated identity state. This field is generally 'null'. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#get-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Lists LifecycleStates - - try { - Get-V2025LifecycleStates -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-V2025LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LifecycleStates" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/lifecycle-states#get-lifecycle-states - source: | - from sailpoint.v2025.api.lifecycle_states_api import LifecycleStatesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.lifecycle_state import LifecycleState - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - try: - # Lists LifecycleStates - - results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id=identity_profile_id) - # Below is a request that includes all optional parameters - # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) - print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) - post: - operationId: createLifecycleState - tags: - - Lifecycle States - summary: Create Lifecycle State - description: Use this endpoint to create a lifecycle state. - security: - - userAuth: - - idn:identity-profile-lifecycle-state:manage - - applicationAuth: - - idn:identity-profile-lifecycle-state:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: identity-profile-id - description: Identity profile ID. - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - requestBody: - description: Lifecycle state to be created. - required: true - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles~1%7Bidentity-profile-id%7D~1lifecycle-states/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/LifecycleState.yaml - responses: - '201': - description: Created LifecycleState object. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles~1%7Bidentity-profile-id%7D~1lifecycle-states/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/LifecycleState.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#create-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleState = @" - { - "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], - "emailNotificationOption" : { - "notifyManagers" : true, - "notifySpecificUsers" : true, - "emailAddressList" : [ "test@test.com", "test2@test.com" ], - "notifyAllAdmins" : true - }, - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Lifecycle description", - "accountActions" : [ { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - }, { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } ], - "id" : "id12345", - "identityCount" : 42, - "technicalName" : "Technical Name", - "identityState" : "identityState", - "enabled" : true - } - "@ - - # Create Lifecycle State - - try { - $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState - New-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result - - # Below is a request that includes all optional parameters - # New-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025LifecycleState" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/lifecycle-states#create-lifecycle-state - source: | - from sailpoint.v2025.api.lifecycle_states_api import LifecycleStatesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.lifecycle_state import LifecycleState - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - lifecycle_state = '''{ - "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], - "emailNotificationOption" : { - "notifyManagers" : true, - "notifySpecificUsers" : true, - "emailAddressList" : [ "test@test.com", "test2@test.com" ], - "notifyAllAdmins" : true - }, - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Lifecycle description", - "accountActions" : [ { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - }, { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } ], - "id" : "id12345", - "identityCount" : 42, - "technicalName" : "Technical Name", - "identityState" : "identityState", - "enabled" : true - }''' # LifecycleState | Lifecycle state to be created. - try: - # Create Lifecycle State - new_lifecycle_state = LifecycleState.from_json(lifecycle_state) - results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state=new_lifecycle_state) - # Below is a request that includes all optional parameters - # results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, new_lifecycle_state) - print("The response of LifecycleStatesApi->create_lifecycle_state:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) - /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}: - get: - operationId: getLifecycleState - tags: - - Lifecycle States - summary: Get Lifecycle State - description: 'Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. ' - security: - - userAuth: - - idn:identity-profile-lifecycle-state:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: identity-profile-id - description: Identity profile ID. - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - - in: path - name: lifecycle-state-id - description: Lifecycle state ID. - required: true - x-sailpoint-resource-operation-id: getLifecycleStates - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: The requested LifecycleState was successfully retrieved. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles~1%7Bidentity-profile-id%7D~1lifecycle-states/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/LifecycleState.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#get-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - - # Get Lifecycle State - - try { - Get-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Get-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LifecycleState" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/lifecycle-states#get-lifecycle-state - source: | - from sailpoint.v2025.api.lifecycle_states_api import LifecycleStatesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.lifecycle_state import LifecycleState - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID. - try: - # Get Lifecycle State - - results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id) - # Below is a request that includes all optional parameters - # results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id, lifecycle_state_id) - print("The response of LifecycleStatesApi->get_lifecycle_state:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) - patch: - operationId: updateLifecycleStates - tags: - - Lifecycle States - summary: Update Lifecycle State - description: Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - security: - - userAuth: - - idn:identity-profile-lifecycle-state:manage - - applicationAuth: - - idn:identity-profile-lifecycle-state:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: identity-profile-id - description: Identity profile ID. - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - - in: path - name: lifecycle-state-id - description: Lifecycle state ID. - required: true - x-sailpoint-resource-operation-id: getLifecycleStates - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields can be updated: - * enabled - * description - * accountActions - * accessProfileIds - * emailNotificationOption - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /description - value: Updated description! - - op: replace - path: /accessProfileIds - value: - - 2c918087742bab150174407a80f3125e - - 2c918087742bab150174407a80f3124f - - op: replace - path: /accountActions - value: - - action: ENABLE - sourceIds: - - 2c9180846a2f82fb016a481c1b1560c5 - - 2c9180846a2f82fb016a481c1b1560cc - - action: DISABLE - sourceIds: - - 2c91808869a0c9980169a207258513fb - - op: replace - path: /emailNotificationOption - value: - notifyManagers: true - notifyAllAdmins: false - notifySpecificUsers: false - emailAddressList: [] - responses: - '200': - description: The LifecycleState was successfully updated. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles~1%7Bidentity-profile-id%7D~1lifecycle-states/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/LifecycleState.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#update-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Lifecycle State - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025LifecycleStates" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/lifecycle-states#update-lifecycle-states - source: | - from sailpoint.v2025.api.lifecycle_states_api import LifecycleStatesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.lifecycle_state import LifecycleState - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID. - json_patch_operation = '''[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/accessProfileIds, value=[2c918087742bab150174407a80f3125e, 2c918087742bab150174407a80f3124f]}, {op=replace, path=/accountActions, value=[{action=ENABLE, sourceIds=[2c9180846a2f82fb016a481c1b1560c5, 2c9180846a2f82fb016a481c1b1560cc]}, {action=DISABLE, sourceIds=[2c91808869a0c9980169a207258513fb]}]}, {op=replace, path=/emailNotificationOption, value={notifyManagers=true, notifyAllAdmins=false, notifySpecificUsers=false, emailAddressList=[]}}]''' # List[JsonPatchOperation] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - try: - # Update Lifecycle State - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id, lifecycle_state_id, new_json_patch_operation) - print("The response of LifecycleStatesApi->update_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) - delete: - operationId: deleteLifecycleState - tags: - - Lifecycle States - summary: Delete Lifecycle State - description: 'Use this endpoint to delete the lifecycle state by its ID. ' - security: - - userAuth: - - idn:identity-profile-lifecycle-state:manage - - applicationAuth: - - idn:identity-profile-lifecycle-state:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: identity-profile-id - description: Identity profile ID. - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - - in: path - name: lifecycle-state-id - description: Lifecycle state ID. - required: true - x-sailpoint-resource-operation-id: getLifecycleStates - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - description: The request was successfully accepted into the system. - content: - application/json: - schema: - type: object - description: Deleted lifecycle state. - properties: - type: - type: string - description: Deleted lifecycle state's DTO type. - enum: - - LIFECYCLE_STATE - example: LIFECYCLE_STATE - id: - type: string - description: Deleted lifecycle state ID. - example: 12345 - name: - type: string - description: Deleted lifecycle state's display name. - example: Contractor Lifecycle - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#delete-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - - # Delete Lifecycle State - - try { - Remove-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Remove-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025LifecycleState" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/lifecycle-states#delete-lifecycle-state - source: | - from sailpoint.v2025.api.lifecycle_states_api import LifecycleStatesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.lifecyclestate_deleted import LifecyclestateDeleted - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID. - try: - # Delete Lifecycle State - - results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id) - # Below is a request that includes all optional parameters - # results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id, lifecycle_state_id) - print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e) - /identity-profiles: - get: - operationId: listIdentityProfiles - tags: - - Identity Profiles - summary: List Identity Profiles - description: Get a list of identity profiles, based on the specified query parameters. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - example: id eq "ef38f94347e94562b5bb8424a56397d8" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, ne, ge, gt, in, le, sw* - - **name**: *eq, ne, ge, gt, in, le, sw* - - **priority**: *eq, ne* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: id,name - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** - responses: - '200': - description: List of identity profiles. - content: - application/json: - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Account/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - - type: object - required: - - authoritativeSource - properties: - description: - type: string - description: Identity profile's description. - example: My custom flat file profile - nullable: true - owner: - type: object - description: Identity profile's owner. - nullable: true - properties: - type: - type: string - enum: - - IDENTITY - description: Owner's object type. - example: IDENTITY - id: - type: string - description: Owner's ID. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Owner's name. - example: William Wilson - priority: - type: integer - format: int64 - description: Identity profile's priority. - example: 10 - authoritativeSource: - type: object - properties: - type: - type: string - enum: - - SOURCE - description: Authoritative source's object type. - example: SOURCE - id: - type: string - description: Authoritative source's ID. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Authoritative source's name. - example: HR Active Directory - identityRefreshRequired: - type: boolean - default: false - description: Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. - example: true - identityCount: - type: integer - description: Number of identities belonging to the identity profile. - format: int32 - example: 8 - identityAttributeConfig: - $ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityAttributeConfig' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityAttributeConfig.yaml - identityExceptionReportReference: - $ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityExceptionReportReference' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityExceptionReportReference.yaml - hasTimeBasedAttr: - description: Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. - type: boolean - default: false - example: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:read - - applicationAuth: - - idn:identity-profile:read - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#list-identity-profiles - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - - # List Identity Profiles - - try { - Get-V2025IdentityProfiles - - # Below is a request that includes all optional parameters - # Get-V2025IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityProfiles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#list-identity-profiles - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_profile import IdentityProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - try: - # List Identity Profiles - - results = IdentityProfilesApi(api_client).list_identity_profiles() - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) - print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - post: - operationId: createIdentityProfile - summary: Create Identity Profile - description: 'Creates an identity profile. ' - tags: - - Identity Profiles - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityProfile.yaml - responses: - '201': - description: Created identity profile. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#create-identity-profile - source: | - $IdentityProfile = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - "@ - - # Create Identity Profile - - try { - $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-V2025IdentityProfile -IdentityProfile $Result - - # Below is a request that includes all optional parameters - # New-V2025IdentityProfile -IdentityProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#create-identity-profile - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_profile import IdentityProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - }''' # IdentityProfile | - try: - # Create Identity Profile - new_identity_profile = IdentityProfile.from_json(identity_profile) - results = IdentityProfilesApi(api_client).create_identity_profile(identity_profile=new_identity_profile) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile) - print("The response of IdentityProfilesApi->create_identity_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) - /identity-profiles/bulk-delete: - post: - operationId: deleteIdentityProfiles - tags: - - Identity Profiles - summary: Delete Identity Profiles - description: |- - This deletes multiple Identity Profiles via a list of supplied IDs. - - On success, this endpoint will return a reference to the bulk delete task result. - - The following rights are required to access this endpoint: idn:identity-profile:delete - requestBody: - description: Identity Profile bulk delete request body. - required: true - content: - application/json: - schema: - description: List of Identity Profile IDs to delete. - type: array - items: - type: string - example: - - 2c9180867b2a34e0017b3078d60b0699 - - 2c9180867b2a34e0017b3078d60b0698 - responses: - '202': - description: Accepted - Returns a TaskResult object referencing the bulk delete job created. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: Task identifier - example: ff8081814d977c21014da056804a0af3 - name: - type: string - description: Task name - example: Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d - description: - type: string - description: Task description - example: Generic task for terminating data in the overlay, used by the TerminationService. - launcher: - type: string - description: User or process who launched the task - example: support - completed: - type: string - format: date-time - description: Date time of completion - example: Mon Aug 21 14:57:39 CDT 2023 - launched: - type: string - format: date-time - description: Date time when the task was launched - example: Mon Aug 21 14:55:39 CDT 2023 - completionStatus: - type: string - enum: - - Success - - Warning - - Error - - Terminated - - TempError - description: Task result status - example: Success - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:delete - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#delete-identity-profiles - source: | - $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. - $RequestBody = @""@ - - - # Delete Identity Profiles - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2025IdentityProfiles -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-V2025IdentityProfiles -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityProfiles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#delete-identity-profiles - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_result_simplified import TaskResultSimplified - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - request_body = '''['request_body_example']''' # List[str] | Identity Profile bulk delete request body. - try: - # Delete Identity Profiles - new_request_body = RequestBody.from_json(request_body) - results = IdentityProfilesApi(api_client).delete_identity_profiles(request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).delete_identity_profiles(new_request_body) - print("The response of IdentityProfilesApi->delete_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) - /identity-profiles/export: - get: - operationId: exportIdentityProfiles - tags: - - Identity Profiles - summary: Export Identity Profiles - description: This exports existing identity profiles in the format specified by the sp-config service. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - example: id eq "ef38f94347e94562b5bb8424a56397d8" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, ne* - - **name**: *eq, ne* - - **priority**: *eq, ne* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: id,name - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, priority** - responses: - '200': - description: List of export objects with identity profiles. - content: - application/json: - schema: - type: array - items: - type: object - description: Identity profile exported object. - properties: - version: - type: integer - example: 1 - description: Version or object from the target service. - format: int32 - self: - type: object - description: Self block for exported object. - properties: - type: - type: string - description: Exported object's DTO type. - enum: - - ACCESS_PROFILE - - ACCESS_REQUEST_CONFIG - - ATTR_SYNC_SOURCE_CONFIG - - AUTH_ORG - - CAMPAIGN_FILTER - - FORM_DEFINITION - - GOVERNANCE_GROUP - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - LIFECYCLE_STATE - - NOTIFICATION_TEMPLATE - - PASSWORD_POLICY - - PASSWORD_SYNC_GROUP - - PUBLIC_IDENTITIES_CONFIG - - ROLE - - RULE - - SEGMENT - - SERVICE_DESK_INTEGRATION - - SOD_POLICY - - SOURCE - - TAG - - TRANSFORM - - TRIGGER_SUBSCRIPTION - - WORKFLOW - example: SOURCE - id: - type: string - description: Exported object's ID. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Exported object's display name. - example: HR Active Directory - object: - $ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#export-identity-profiles - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) - - # Export Identity Profiles - - try { - Export-V2025IdentityProfiles - - # Below is a request that includes all optional parameters - # Export-V2025IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025IdentityProfiles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#export-identity-profiles - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_profile_exported_object import IdentityProfileExportedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) - try: - # Export Identity Profiles - - results = IdentityProfilesApi(api_client).export_identity_profiles() - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) - print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - /identity-profiles/import: - post: - operationId: importIdentityProfiles - summary: Import Identity Profiles - description: This imports previously exported identity profiles. - tags: - - Identity Profiles - requestBody: - description: Previously exported Identity Profiles. - required: true - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1identity-profiles~1export/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityProfileExportedObject.yaml - responses: - '200': - description: The result of importing Identity Profiles. - content: - application/json: - schema: - type: object - title: Import Object Response Body - description: Response model for import of a single object. - properties: - infos: - description: Informational messages returned from the target service on import. - type: array - items: - type: object - title: Config Import/Export Message - description: Message model for Config Import/Export. - properties: - key: - type: string - description: Message key. - example: UNKNOWN_REFERENCE_RESOLVER - text: - type: string - description: Message text. - example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]' - details: - type: object - description: Message details if any, in key:value pairs. - additionalProperties: true - example: - details: message details - required: - - key - - text - - details - warnings: - description: Warning messages returned from the target service on import. - type: array - items: - $ref: '#/paths/~1identity-profiles~1import/post/responses/200/content/application~1json/schema/properties/infos/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SpConfigMessage.yaml - errors: - description: Error messages returned from the target service on import. - type: array - items: - $ref: '#/paths/~1identity-profiles~1import/post/responses/200/content/application~1json/schema/properties/infos/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SpConfigMessage.yaml - importedObjects: - description: References to objects that were created or updated by the import. - type: array - items: - type: object - description: Object created or updated by import. - properties: - type: - type: string - description: DTO type of object created or updated by import. - enum: - - CONNECTOR_RULE - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - RULE - - SOURCE - - TRANSFORM - - TRIGGER_SUBSCRIPTION - example: SOURCE - id: - type: string - description: ID of object created or updated by import. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Display name of object created or updated by import. - example: HR Active Directory - required: - - infos - - warnings - - errors - - importedObjects - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#import-identity-profiles - source: | - - - - - - $IdentityProfileExportedObject = @"{ - "self" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "version" : 1, - "object" : { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - }"@ - - - # Import Identity Profiles - - try { - $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-V2025IdentityProfiles -IdentityProfileExportedObject $Result - - # Below is a request that includes all optional parameters - # Import-V2025IdentityProfiles -IdentityProfileExportedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025IdentityProfiles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#import-identity-profiles - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_profile_exported_object import IdentityProfileExportedObject - from sailpoint.v2025.models.object_import_result import ObjectImportResult - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_exported_object = '''[sailpoint.v2025.IdentityProfileExportedObject()]''' # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. - try: - # Import Identity Profiles - new_identity_profile_exported_object = IdentityProfileExportedObject.from_json(identity_profile_exported_object) - results = IdentityProfilesApi(api_client).import_identity_profiles(identity_profile_exported_object=new_identity_profile_exported_object) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).import_identity_profiles(new_identity_profile_exported_object) - print("The response of IdentityProfilesApi->import_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) - /identity-profiles/{identity-profile-id}: - get: - operationId: getIdentityProfile - tags: - - Identity Profiles - summary: Get Identity Profile - description: Get a single identity profile by ID. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - description: Identity profile ID. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - responses: - '200': - description: Identity profile object. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:read - - applicationAuth: - - idn:identity-profile:read - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#get-identity-profile - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - - # Get Identity Profile - - try { - Get-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#get-identity-profile - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_profile import IdentityProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - try: - # Get Identity Profile - - results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id=identity_profile_id) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id) - print("The response of IdentityProfilesApi->get_identity_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) - delete: - operationId: deleteIdentityProfile - tags: - - Identity Profiles - summary: Delete Identity Profile - description: |- - Delete an identity profile by ID. - On success, this endpoint will return a reference to the bulk delete task result. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - description: Identity profile ID. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - description: Accepted - Returns a TaskResult object referencing the bulk delete job created. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles~1bulk-delete/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskResultSimplified.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:delete - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#delete-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - - # Delete Identity Profile - - try { - Remove-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Remove-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#delete-identity-profile - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_result_simplified import TaskResultSimplified - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. - try: - # Delete Identity Profile - - results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id=identity_profile_id) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id) - print("The response of IdentityProfilesApi->delete_identity_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) - patch: - operationId: updateIdentityProfile - tags: - - Identity Profiles - summary: Update Identity Profile - description: |- - Update a specified identity profile with this PATCH request. - - You cannot update these fields: - * id - * created - * modified - * identityCount - * identityRefreshRequired - * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - description: Identity profile ID. - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - examples: - add-attribute-transform: - summary: Add an attribute transform - value: - - op: add - path: /identityAttributeConfig/attributeTransforms/0 - value: - identityAttributeName: location - transformDefinition: - type: accountAttribute - attributes: - sourceName: Employees - attributeName: location - sourceId: 2c91808878b7d63b0178c66ffcdc4ce4 - responses: - '200': - description: Updated identity profile. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#update-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Identity Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#update-identity-profile - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_profile import IdentityProfile - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. - json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]''' # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - try: - # Update Identity Profile - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id=identity_profile_id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, new_json_patch_operation) - print("The response of IdentityProfilesApi->update_identity_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) - /identity-profiles/{identity-profile-id}/default-identity-attribute-config: - get: - operationId: getDefaultIdentityAttributeConfig - tags: - - Identity Profiles - summary: Get default Identity Attribute Config - description: This returns the default identity attribute config. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - description: The Identity Profile ID. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - responses: - '200': - description: An Identity Attribute Config object. - content: - application/json: - schema: - $ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityAttributeConfig' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityAttributeConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#get-default-identity-attribute-config - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. - - # Get default Identity Attribute Config - - try { - Get-V2025DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-V2025DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultIdentityAttributeConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#get-default-identity-attribute-config - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_attribute_config import IdentityAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID. - try: - # Get default Identity Attribute Config - - results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id=identity_profile_id) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id) - print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) - /identity-profiles/{identity-profile-id}/process-identities: - post: - operationId: syncIdentityProfile - tags: - - Identity Profiles - summary: Process identities under profile - description: |- - Process identities under the profile - This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. - This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. - This operation will perform the following activities on all identities under the identity profile. - 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. - externalDocs: - description: Learn more about manually processing identities here - url: https://documentation.sailpoint.com/saas/help/setup/identity_processing.html - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - description: The Identity Profile ID to be processed - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:refresh - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#sync-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed - - # Process identities under profile - - try { - Sync-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Sync-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#sync-identity-profile - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID to be processed # str | The Identity Profile ID to be processed - try: - # Process identities under profile - - results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id=identity_profile_id) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id) - print("The response of IdentityProfilesApi->sync_identity_profile:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) - /managed-clients: - get: - tags: - - Managed Clients - summary: Get Managed Clients - description: List managed clients. - operationId: getManagedClients - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq* - - **name**: *eq* - - **clientId**: *eq* - - **clusterId**: *eq* - required: false - example: name eq "client name" - responses: - '200': - description: Response with a list of managed clients, based on the specified query parameters. - content: - application/json: - schema: - type: array - items: - description: Managed Client - type: object - required: - - clientId - - clusterId - - description - - type - properties: - id: - description: ManagedClient ID - readOnly: true - nullable: true - type: string - example: 2c9180878eaf4204018eb019c3570003 - alertKey: - description: ManagedClient alert key - readOnly: true - nullable: true - type: string - example: CLIENT_STATUS_NOT_CONFIGURED - apiGatewayBaseUrl: - nullable: true - type: string - cookbook: - nullable: true - type: string - ccId: - description: Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) - nullable: true - type: integer - format: int64 - example: 2248 - clientId: - description: The client ID used in API management - type: string - example: 00be54a2-bb6d-402f-9159-beb2d5319347 - clusterId: - description: Cluster ID that the ManagedClient is linked to - type: string - example: e1ff7bb24c934240bbf55e1aa39e41c5 - description: - description: ManagedClient description - type: string - default: '' - example: A short description of the ManagedClient - ipAddress: - description: The public IP address of the ManagedClient - readOnly: true - nullable: true - type: string - example: 123.456.78.90 - lastSeen: - description: When the ManagedClient was last seen by the server - readOnly: true - nullable: true - type: string - format: date-time - example: '2020-01-01T00:00:00.000000Z' - name: - description: ManagedClient name - nullable: true - type: string - default: VA-$clientId - example: aName - sinceLastSeen: - description: Milliseconds since the ManagedClient has polled the server - readOnly: true - nullable: true - type: string - example: 15000 - status: - description: Status of the ManagedClient - readOnly: true - nullable: true - type: string - enum: - - NORMAL - - UNDEFINED - - NOT_CONFIGURED - - CONFIGURING - - WARNING - - ERROR - - FAILED - - null - example: NORMAL - type: - description: Type of the ManagedClient (VA, CCG) - type: string - example: VA - clusterType: - description: Cluster Type of the ManagedClient - readOnly: true - nullable: true - type: string - enum: - - null - - idn - - iai - - spConnectCluster - - sqsCluster - - das-rc - - das-pc - - das-dc - example: idn - vaDownloadUrl: - description: ManagedClient VA download URL - readOnly: true - nullable: true - type: string - example: aUrl - vaVersion: - description: Version that the ManagedClient's VA is running - readOnly: true - nullable: true - type: string - example: va-megapod-useast1-610-1621372012 - secret: - description: Client's apiKey - nullable: true - type: string - example: ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381 - createdAt: - description: The date/time this ManagedClient was created - example: '2023-08-04T20:48:01.865Z' - nullable: true - type: string - format: date-time - updatedAt: - description: The date/time this ManagedClient was last updated - example: '2023-08-04T20:48:01.865Z' - nullable: true - type: string - format: date-time - provisionStatus: - description: The provisioning status of the ManagedClient - readOnly: true - nullable: true - type: string - enum: - - null - - PROVISIONED - - DRAFT - example: PROVISIONED - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:remote-client:read - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-clients - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - - # Get Managed Clients - - try { - Get-V2025ManagedClients - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClients" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clients#get-managed-clients - source: | - from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - try: - # Get Managed Clients - - results = ManagedClientsApi(api_client).get_managed_clients() - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) - print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) - post: - tags: - - Managed Clients - summary: Create Managed Client - description: |- - Create a new managed client. - The API returns a result that includes the managed client ID. - operationId: createManagedClient - requestBody: - required: true - content: - application/json: - schema: - description: Managed Client Request - type: object - required: - - clusterId - properties: - clusterId: - description: Cluster ID that the ManagedClient is linked to - type: string - example: aClusterId - description: - description: description for the ManagedClient to create - type: string - nullable: true - example: A short description of the ManagedClient - name: - description: name for the ManagedClient to create - type: string - nullable: true - example: aName - type: - description: Type of the ManagedClient (VA, CCG) to create - type: string - nullable: true - example: VA - responses: - '200': - description: Created managed client. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clients/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedClient.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#create-managed-client - source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ - - # Create Managed Client - - try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-V2025ManagedClient -ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedClient -ManagedClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clients#create-managed-client - source: | - from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_client import ManagedClient - from sailpoint.v2025.models.managed_client_request import ManagedClientRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_client_request = '''{ - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - }''' # ManagedClientRequest | - try: - # Create Managed Client - new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) - results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) - print("The response of ManagedClientsApi->create_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) - /managed-clients/{id}: - get: - tags: - - Managed Clients - summary: Get Managed Client - description: 'Get managed client by ID. ' - operationId: getManagedClient - parameters: - - name: id - in: path - description: Managed client ID. - required: true - x-sailpoint-resource-operation-id: getManagedClients - example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7 - schema: - type: string - responses: - '200': - description: Managed client response. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clients/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedClient.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:remote-client:read - - idn:remote-client:manage - - idn:managed-client-status:read - - idn:managed-client-status:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Get Managed Client - - try { - Get-V2025ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clients#get-managed-client - source: | - from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Get Managed Client - - results = ManagedClientsApi(api_client).get_managed_client(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client(id) - print("The response of ManagedClientsApi->get_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) - patch: - tags: - - Managed Clients - summary: Update Managed Client - description: Update an existing managed client. - operationId: updateManagedClient - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getManagedClients - description: Managed client ID. - example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7 - requestBody: - required: true - description: JSONPatch payload used to update the object. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - responses: - '200': - description: Updated managed client. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clients/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedClient.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#update-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025ManagedClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clients#update-managed-client - source: | - from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Client - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) - print("The response of ManagedClientsApi->update_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) - delete: - operationId: deleteManagedClient - tags: - - Managed Clients - summary: Delete Managed Client - description: Delete an existing managed client. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getManagedClients - description: Managed client ID. - example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#delete-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Delete Managed Client - - try { - Remove-V2025ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clients#delete-managed-client - source: | - from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Delete Managed Client - - ManagedClientsApi(api_client).delete_managed_client(id=id) - # Below is a request that includes all optional parameters - # ManagedClientsApi(api_client).delete_managed_client(id) - except Exception as e: - print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) - /managed-clients/{id}/status: - get: - tags: - - Managed Clients - summary: Get Managed Client Status - description: Get a managed client's status, using its ID. - operationId: getManagedClientStatus - parameters: - - name: id - in: path - description: Managed client ID to get status for. - required: true - x-sailpoint-resource-operation-id: getManagedClients - schema: - type: string - example: aClientId - - name: type - in: query - description: Managed client type to get status for. - required: true - schema: - description: Managed Client type - type: string - example: CCG - nullable: true - enum: - - CCG - - VA - - INTERNAL - - IIQ_HARVESTER - - null - responses: - '200': - description: Response with the managed client status, with the given ID and type. - content: - application/json: - schema: - description: Managed Client Status - type: object - required: - - body - - status - - type - - timestamp - properties: - body: - description: ManagedClientStatus body information - type: object - example: - alertKey: '' - id: '5678' - clusterId: '1234' - ccg_etag: ccg_etag123xyz456 - ccg_pin: NONE - cookbook_etag: 20210420125956-20210511144538 - hostname: megapod-useast1-secret-hostname.sailpoint.com - internal_ip: 127.0.0.1 - lastSeen: '1620843964604' - sinceSeen: '14708' - sinceSeenMillis: '14708' - localDev: false - stacktrace: '' - state: null - status: NORMAL - uuid: null - product: idn - va_version: null - platform_version: '2' - os_version: 2345.3.1 - os_type: flatcar - hypervisor: unknown - status: - type: string - description: Status of a Managed Client - enum: - - NORMAL - - UNDEFINED - - NOT_CONFIGURED - - CONFIGURING - - WARNING - - ERROR - - FAILED - example: NORMAL - type: - description: type of the Managed Client - $ref: '#/paths/~1managed-clients~1%7Bid%7D~1status/get/parameters/1/schema' - example: CCG - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedClientType.yaml - timestamp: - description: timestamp on the Client Status update - type: string - format: date-time - example: '2020-01-01T00:00:00.000000Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:managed-client-status:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. - - # Get Managed Client Status - - try { - Get-V2025ManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClientStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_client_status import ManagedClientStatus - from sailpoint.v2025.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. - type = sailpoint.v2025.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. - try: - # Get Managed Client Status - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) - /managed-clusters: - get: - tags: - - Managed Clusters - summary: Get Managed Clusters - description: List current organization's managed clusters, based on request context. - operationId: getManagedClusters - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **operational**: *eq* - required: false - example: operational eq "operation" - responses: - '200': - description: Response with a list of managed clusters. - content: - application/json: - schema: - type: array - items: - description: Managed Cluster - type: object - required: - - id - - clientType - - ccgVersion - properties: - id: - description: ManagedCluster ID - type: string - example: e1ff7bb24c934240bbf55e1aa39e41c5 - name: - description: ManagedCluster name - type: string - example: Managed Cluster Name - pod: - description: ManagedCluster pod - type: string - example: megapod-useast1 - org: - description: ManagedCluster org - type: string - example: denali - type: - type: string - description: The Type of Cluster - example: idn - enum: - - idn - - iai - configuration: - description: ManagedProcess configuration map - type: object - additionalProperties: - type: string - nullable: true - example: - clusterExternalId: e1ff7bb24c934240bbf55e1aa39e41c5 - clusterType: sqsCluster - gmtOffset: '-5' - keyPair: - description: Managed Cluster key pair for Cluster - type: object - properties: - publicKey: - nullable: true - description: ManagedCluster publicKey - type: string - example: '-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----' - publicKeyThumbprint: - nullable: true - description: ManagedCluster publicKeyThumbprint - type: string - example: 6CMlaJIV44-xJxcB3CJBjDUUn54 - publicKeyCertificate: - nullable: true - description: ManagedCluster publicKeyCertificate - type: string - example: '-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----' - attributes: - description: Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster] - type: object - properties: - queue: - description: Managed Cluster key pair for Cluster - type: object - properties: - name: - description: ManagedCluster queue name - type: string - example: megapod-useast1-denali-lwt-cluster-1533 - region: - description: ManagedCluster queue aws region - type: string - example: us-east-1 - keystore: - nullable: true - description: ManagedCluster keystore for spConnectCluster type - type: string - example: /u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW - description: - description: ManagedCluster description - type: string - default: q - example: A short description of the managed cluster. - redis: - description: Managed Cluster Redis Configuration - type: object - properties: - redisHost: - description: ManagedCluster redisHost - type: string - example: megapod-useast1-shared-redis.cloud.sailpoint.com - redisPort: - description: ManagedCluster redisPort - type: integer - format: int32 - example: 6379 - clientType: - description: type of client for the ManagedCluster - $ref: '#/paths/~1managed-clients~1%7Bid%7D~1status/get/parameters/1/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedClientType.yaml - ccgVersion: - description: CCG version used by the ManagedCluster - type: string - example: v01 - pinnedConfig: - description: boolean flag indiacting whether or not the cluster configuration is pinned - type: boolean - default: false - example: false - logConfiguration: - description: client log configuration for the cluster - example: '{ "rootLevel": "WARN", "logLevels": { "foobar": "WARN" } }' - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ClientLogConfiguration.yaml - operational: - description: Whether or not the cluster is operational or not - type: boolean - default: false - example: false - status: - description: Cluster status - type: string - enum: - - CONFIGURING - - FAILED - - NO_CLIENTS - - NORMAL - - WARNING - example: NORMAL - publicKeyCertificate: - nullable: true - description: Public key certificate - type: string - example: '-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----' - publicKeyThumbprint: - nullable: true - description: Public key thumbprint - type: string - example: obc6pLiulGbtZ - publicKey: - nullable: true - description: Public key - type: string - example: '-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----' - alertKey: - description: Key describing any immediate cluster alerts - type: string - example: LIMITED_RESOURCES - clientIds: - type: array - description: List of clients in a cluster - items: - type: string - example: - - '1244' - - '1245' - serviceCount: - description: Number of services bound to a cluster - type: integer - format: int32 - default: 0 - example: 6 - ccId: - description: CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished - type: string - default: '0' - example: '1533' - createdAt: - description: The date/time this cluster was created - example: '2023-08-04T20:48:01.865Z' - nullable: true - type: string - format: date-time - updatedAt: - description: The date/time this cluster was last updated - example: '2023-08-04T20:48:01.865Z' - nullable: true - type: string - format: date-time - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:remote-client:read - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-V2025ManagedClusters - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusters" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Get Managed Clusters - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - post: - tags: - - Managed Clusters - summary: Create Create Managed Cluster - description: |- - Create a new Managed Cluster. - The API returns a result that includes the managed cluster ID. - operationId: createManagedCluster - requestBody: - required: true - content: - application/json: - schema: - description: Request to create Managed Cluster - type: object - required: - - name - properties: - name: - description: ManagedCluster name - type: string - nullable: false - example: Managed Cluster Name - type: - $ref: '#/paths/~1managed-clusters/get/responses/200/content/application~1json/schema/items/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedClusterTypes.yaml - configuration: - description: ManagedProcess configuration map - type: object - additionalProperties: - type: string - example: - clusterExternalId: externalId - ccgVersion: 77.0.0 - description: - description: ManagedCluster description - type: string - nullable: true - example: A short description of the managed cluster. - responses: - '200': - description: Created managed cluster. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clusters/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedCluster.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-V2025ManagedCluster -ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedCluster -ManagedClusterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedCluster" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#create-managed-cluster - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster import ManagedCluster - from sailpoint.v2025.models.managed_cluster_request import ManagedClusterRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_request = '''{ - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - }''' # ManagedClusterRequest | - try: - # Create Create Managed Cluster - new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) - results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) - print("The response of ManagedClustersApi->create_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) - /managed-clusters/{id}: - get: - tags: - - Managed Clusters - summary: Get Managed Cluster - description: Get a managed cluster by ID. - operationId: getManagedCluster - parameters: - - name: id - in: path - description: Managed cluster ID. - required: true - x-sailpoint-resource-operation-id: getManagedClusters - example: 2c9180897de347a2017de8859e8c5039 - style: simple - explode: false - schema: - type: string - responses: - '200': - description: Response with managed cluster for the given ID. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clusters/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedCluster.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:remote-client:read - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-V2025ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedCluster" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - try: - # Get Managed Cluster - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) - patch: - tags: - - Managed Clusters - summary: Update Managed Cluster - description: Update an existing managed cluster. - operationId: updateManagedCluster - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getManagedClusters - description: Managed cluster ID. - example: 2c9180897de347a2017de8859e8c5039 - requestBody: - required: true - description: JSONPatch payload used to update the object. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - responses: - '200': - description: Updated managed cluster. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clusters/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedCluster.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025ManagedCluster -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedCluster -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedCluster" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#update-managed-cluster - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Cluster - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) - print("The response of ManagedClustersApi->update_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - delete: - operationId: deleteManagedCluster - tags: - - Managed Clusters - summary: Delete Managed Cluster - description: Delete an existing managed cluster. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getManagedClusters - description: Managed cluster ID. - example: 2c9180897de347a2017de8859e8c5039 - - in: query - name: removeClients - schema: - type: boolean - default: false - required: false - description: Flag to determine the need to delete a cluster with clients. - example: false - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-V2025ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedCluster" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#delete-managed-cluster - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) - try: - # Delete Managed Cluster - - ManagedClustersApi(api_client).delete_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) - except Exception as e: - print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) - /managed-clusters/{id}/log-config: - get: - tags: - - Managed Clusters - summary: Get Managed Cluster Log Configuration - description: Get a managed cluster's log configuration. - operationId: getClientLogConfiguration - parameters: - - name: id - in: path - description: ID of managed cluster to get log configuration for. - required: true - x-sailpoint-resource-operation-id: getManagedClusters - schema: - type: string - format: uuid - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - responses: - '200': - description: Log configuration of managed cluster for given cluster ID. - content: - application/json: - schema: - description: Client Runtime Logging Configuration - nullable: true - type: object - required: - - rootLevel - properties: - clientId: - description: Log configuration's client ID - type: string - example: 3a38a51992e8445ab51a549c0a70ee66 - durationMinutes: - description: Duration in minutes for log configuration to remain in effect before resetting to defaults. - type: integer - format: int32 - example: 120 - default: 240 - minimum: 5 - maximum: 1440 - expiration: - description: Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. - example: '2024-11-06T01:31:08.013164Z' - type: string - format: date-time - rootLevel: - description: Standard Log4j log level - type: string - example: INFO - enum: - - 'OFF' - - FATAL - - ERROR - - WARN - - INFO - - DEBUG - - TRACE - logLevels: - description: Mapping of identifiers to Standard Log Level values - type: object - example: INFO - additionalProperties: - default: INFO - example: TRACE - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/rootLevel' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/StandardLevel.yaml - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:remote-client:read - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-V2025ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ClientLogConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. - try: - # Get Managed Cluster Log Configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) - put: - tags: - - Managed Clusters - summary: Update Managed Cluster Log Configuration - description: Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - operationId: putClientLogConfiguration - parameters: - - name: id - in: path - description: ID of the managed cluster to update the log configuration for. - required: true - x-sailpoint-resource-operation-id: getManagedClusters - schema: - type: string - format: uuid - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - requestBody: - description: Client log configuration for the given managed cluster. - content: - application/json: - schema: - oneOf: - - description: Client Runtime Logging Configuration - title: Set Duration Minutes - nullable: true - type: object - required: - - rootLevel - properties: - clientId: - description: Log configuration's client ID - type: string - example: 3a38a51992e8445ab51a549c0a70ee66 - durationMinutes: - description: Duration in minutes for log configuration to remain in effect before resetting to defaults. - type: integer - format: int32 - example: 120 - default: 240 - minimum: 5 - maximum: 1440 - rootLevel: - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/rootLevel' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/StandardLevel.yaml - logLevels: - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/logLevels' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/LogLevelSpec.yaml - - description: Client Runtime Logging Configuration - title: Set Expiration Date - nullable: true - type: object - required: - - rootLevel - properties: - clientId: - description: Log configuration's client ID - type: string - example: 3a38a51992e8445ab51a549c0a70ee66 - expiration: - description: Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. - example: '2024-11-06T01:31:08.013164Z' - type: string - format: date-time - rootLevel: - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/rootLevel' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/StandardLevel.yaml - logLevels: - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/logLevels' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/LogLevelSpec.yaml - examples: - Duration Minutes: - summary: Duration Minutes - value: - clientId: 3a38a51992e8445ab51a549c0a70ee66 - durationMinutes: 120 - rootLevel: INFO - logLevels: - sailpoint.connector.ADLDAPConnector: TRACE - sailpoint.connector.JDBCConnector: DEBUG - Expiration: - summary: Expiration - value: - clientId: 3a38a51992e8445ab51a549c0a70ee66 - expiration: '2024-11-06T01:31:08.013164Z' - rootLevel: INFO - logLevels: - sailpoint.connector.ADLDAPConnector: TRACE - sailpoint.connector.JDBCConnector: DEBUG - required: true - responses: - '200': - description: Response with updated client log configuration for the given managed cluster. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ClientLogConfiguration.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-V2025ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2025ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ClientLogConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.client_log_configuration import ClientLogConfiguration - from sailpoint.v2025.models.put_client_log_configuration_request import PutClientLogConfigurationRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. - put_client_log_configuration_request = '''sailpoint.v2025.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. - try: - # Update Managed Cluster Log Configuration - new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - /managed-clusters/{id}/manualUpgrade: - post: - tags: - - Managed Clusters - summary: Trigger Manual Upgrade for Managed Cluster - description: |- - Trigger Manual Upgrade for Managed Cluster. - AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - operationId: update - parameters: - - name: id - in: path - description: ID of managed cluster to trigger manual upgrade. - required: true - x-sailpoint-resource-operation-id: getManagedClusters - schema: - type: string - format: uuid - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - responses: - '200': - description: Manual upgrade of managed cluster for given cluster ID. - content: - application/json: - schema: - description: Manual Upgrade Job Response - nullable: false - type: object - properties: - jobs: - description: List of job objects for the upgrade request. - type: array - items: - type: object - required: - - uuid - - cookbook - - state - - type - - targetId - - managedProcessConfiguration - properties: - uuid: - description: Unique identifier for the upgrade job. - type: string - example: 4732440c-dacb-45b2-b2f8-ee2fa1327a07 - cookbook: - description: Identifier for the cookbook used in the upgrade job. - type: string - example: 4732440c-dacb-45b2-b2f8-ee2fa1327a07 - state: - description: Current state of the upgrade job. - type: string - example: PENDING - type: - description: The type of upgrade job (e.g., VA_UPGRADE). - type: string - example: VA_UPGRADE - targetId: - description: Unique identifier of the target for the upgrade job. - type: string - example: 9fe8f1cc-2fd2-4675-a8cf-af4b43488ca2 - managedProcessConfiguration: - description: Configuration of the managed processes involved in the upgrade. - type: object - properties: - charon: - description: Configuration details for the 'charon' process. - type: object - required: - - version - - path - - description - - restartNeeded - properties: - version: - description: Version of the 'charon' process. - type: string - example: '3047' - path: - description: Path to the 'charon' process. - type: string - example: sailpoint/charon - description: - description: A brief description of the 'charon' process. - type: string - example: version of charon used by the va - restartNeeded: - description: Indicates whether the process needs to be restarted. - type: boolean - example: true - ccg: - description: Configuration details for the 'ccg' process. - type: object - required: - - version - - path - - description - - restartNeeded - - dependencies - properties: - version: - description: Version of the 'ccg' process. - type: string - example: 1798_1054_241.0.0 - path: - description: Path to the 'ccg' process. - type: string - example: sailpoint/ccg - description: - description: A brief description of the 'ccg' process. - type: string - example: CCG Deployment through ops-cli - restartNeeded: - description: Indicates whether the process needs to be restarted. - type: boolean - example: true - dependencies: - description: A map of dependencies for the 'ccg' process. - type: object - additionalProperties: - type: string - example: - IQService: 743/IQService-743.zip - connector-bundle-jdbc: 432/connector-bundle-jdbc-432.zip - connector-bundle-misc: 437/connector-bundle-misc-437.zip - connector-bundle-unix: 242/connector-bundle-unix-242.zip - connector-common-config: 208/connector-common-config-208.zip - connector-bundle-filebased: 222/connector-bundle-filebased-222.zip - connector-bundle-imprivata: 3/connector-bundle-imprivata-3.zip - connector-bundle-mainframe: 211/connector-bundle-mainframe-211.zip - connector-bundle-directories: 681/connector-bundle-directories-681.zip - connector-bundle-sap-on-prem: 196/connector-bundle-sap-on-prem-196.zip - connector-bundle-webservices: 1535/connector-bundle-webservices-1535.zip - connector-bundle-sap-cloud-app: 175/connector-bundle-sap-cloud-app-175.zip - connector-bundle-healthcare-epic: 302/connector-bundle-healthcare-epic-302.zip - connector-bundle-hrms-oraclefusionhcm: 166/connector-bundle-hrms-oraclefusionhcm-166.zip - connector-bundle-collaboration-connectors: 246/connector-bundle-collaboration-connectors-246.zip - otel_agent: - description: Configuration details for the 'otel_agent' process. - type: object - required: - - version - - path - - description - - restartNeeded - properties: - version: - description: Version of the 'otel_agent' process. - type: string - example: '3003' - path: - description: Path to the 'otel_agent' process. - type: string - example: sailpoint/otel_agent - description: - description: A brief description of the 'otel_agent' process. - type: string - example: version of otel_agent used by the va - restartNeeded: - description: Indicates whether the process needs to be restarted. - type: boolean - example: true - relay: - description: Configuration details for the 'relay' process. - type: object - required: - - version - - path - - description - - restartNeeded - properties: - version: - description: Version of the 'relay' process. - type: string - example: '3000' - path: - description: Path to the 'relay' process. - type: string - example: sailpoint/relay - description: - description: A brief description of the 'relay' process. - type: string - example: version of relay used by the va - restartNeeded: - description: Indicates whether the process needs to be restarted. - type: boolean - example: true - toolbox: - description: Configuration details for the 'toolbox' process. - type: object - required: - - version - - path - - description - - restartNeeded - properties: - version: - description: Version of the 'toolbox' process. - type: string - example: '3004' - path: - description: Path to the 'toolbox' process. - type: string - example: sailpoint/toolbox - description: - description: A brief description of the 'toolbox' process. - type: string - example: version of toolbox used by the va - restartNeeded: - description: Indicates whether the process needs to be restarted. - type: boolean - example: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:managed-cluster-upgrade:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#update - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. - - # Trigger Manual Upgrade for Managed Cluster - - try { - Update-V2025 -Id $Id - - # Below is a request that includes all optional parameters - # Update-V2025 -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-clusters#update - source: | - from sailpoint.v2025.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.cluster_manual_upgrade import ClusterManualUpgrade - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to trigger manual upgrade. # str | ID of managed cluster to trigger manual upgrade. - try: - # Trigger Manual Upgrade for Managed Cluster - - results = ManagedClustersApi(api_client).update(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).update(id) - print("The response of ManagedClustersApi->update:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->update: %s\n" % e) - /managed-cluster-types: - get: - tags: - - Managed Cluster Types - summary: List Managed Cluster Types - description: Get a list of Managed Cluster Types. - operationId: getManagedClusterTypes - parameters: - - name: type - in: query - required: false - description: Type descriptor - schema: - type: string - example: IDN - - name: pod - in: query - required: false - description: Pinned pod (or default) - schema: - type: string - example: megapod-useast1 - - name: org - in: query - required: false - description: Pinned org (or default) - schema: - type: string - example: denali-xyz - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - responses: - '200': - description: Responds with a list of ManagedClusterType based on the query params provided - content: - application/json: - schema: - type: array - items: - description: Managed Cluster Type for Cluster upgrade configuration information - type: object - required: - - type - - pod - - org - properties: - id: - description: ManagedClusterType ID - readOnly: true - type: string - example: aClusterTypeId - type: - description: ManagedClusterType type name - type: string - example: idn - pod: - description: ManagedClusterType pod - type: string - example: megapod-useast1 - org: - description: ManagedClusterType org - type: string - example: denali-cjh - managedProcessIds: - type: array - description: List of processes for the cluster type - items: - type: string - example: - - someId - - someId2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:managed-cluster-types:read - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - $Type = "IDN" # String | Type descriptor (optional) - $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) - $Org = "denali-xyz" # String | Pinned org (or default) (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Managed Cluster Types - - try { - Get-V2025ManagedClusterTypes - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterTypes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) - post: - tags: - - Managed Cluster Types - summary: Create new Managed Cluster Type - description: |- - Create a new Managed Cluster Type. - - The API returns a result that includes the Managed Cluster Type ID - operationId: createManagedClusterType - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1managed-cluster-types/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedClusterType.yaml - responses: - '200': - description: The created ManagedClusterType - content: - application/json: - schema: - $ref: '#/paths/~1managed-cluster-types/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedClusterType.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - dn:managed-cluster-types:create - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - $ManagedClusterType = @" - { - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - } - "@ - - # Create new Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType - New-V2025ManagedClusterType -ManagedClusterType $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedClusterType -ManagedClusterType $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) - /managed-cluster-types/{id}: - get: - tags: - - Managed Cluster Types - summary: Get a Managed Cluster Type - description: Get a Managed Cluster Type. - operationId: getManagedClusterType - parameters: - - name: id - in: path - description: The Managed Cluster Type ID - required: true - x-sailpoint-resource-operation-id: getManagedClusterTypes - schema: - type: string - example: aClusterTypeId - responses: - '200': - description: Responds with a ManagedClusterType - content: - application/json: - schema: - $ref: '#/paths/~1managed-cluster-types/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedClusterType.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:managed-cluster-types:read - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Get a Managed Cluster Type - - try { - Get-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) - patch: - tags: - - Managed Cluster Types - summary: Update a Managed Cluster Type - description: Update an existing Managed Cluster Type. - operationId: updateManagedClusterType - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getManagedClusterTypes - description: The Managed Cluster Type ID - example: aClusterTypeId - requestBody: - required: true - description: The JSONPatch payload used to update the schema. - content: - application/json-patch+json: - schema: - $ref: '#/paths/~1configuration-hub~1scheduled-actions~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatch.yaml - responses: - '200': - description: The updated ManagedClusterType - content: - application/json: - schema: - $ref: '#/paths/~1managed-cluster-types/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagedClusterType.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:managed-cluster-types:update - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update a Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) - delete: - operationId: deleteManagedClusterType - tags: - - Managed Cluster Types - summary: Delete a Managed Cluster Type - description: Delete an existing Managed Cluster Type. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getManagedClusterTypes - description: The Managed Cluster Type ID - example: aClusterTypeId - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:managed-cluster-types:delete - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Delete a Managed Cluster Type - - try { - Remove-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) - /mfa/okta-verify/config: - get: - operationId: getMFAOktaConfig - tags: - - MFA Configuration - summary: Configuration of Okta MFA method - description: This API returns the configuration of an Okta MFA method. - security: - - userAuth: - - idn:mfa-configuration:read - - idn:mfa-configuration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - responses: - '200': - description: The configuration of an Okta MFA method. - content: - application/json: - schema: - type: object - properties: - mfaMethod: - type: string - nullable: true - description: Mfa method name - example: okta-verify - enabled: - type: boolean - description: If MFA method is enabled. - default: false - example: true - host: - type: string - nullable: true - description: The server host name or IP address of the MFA provider. - example: example.com - accessKey: - type: string - nullable: true - description: The secret key for authenticating requests to the MFA provider. - example: qw123Y3QlA5UqocYpdU3rEkzrK2D497y - identityAttribute: - type: string - nullable: true - description: Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - example: email - example: - mfaMethod: okta-verify - enabled: true - host: www.example.com - accessKey: d******Y - identityAttribute: email - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-V2025MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) - put: - operationId: setMFAOktaConfig - tags: - - MFA Configuration - summary: Set Okta MFA configuration - description: This API sets the configuration of an Okta MFA method. - security: - - userAuth: - - idn:mfa-configuration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1mfa~1okta-verify~1config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MfaOktaConfig.yaml - example: - mfaMethod: okta-verify - enabled: true - host: www.example.com - accessKey: dk778Y3QlA5UqocYpdU3rEkzrK2D497y - identityAttribute: email - responses: - '200': - description: MFA configuration of an Okta MFA method. - content: - application/json: - schema: - $ref: '#/paths/~1mfa~1okta-verify~1config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MfaOktaConfig.yaml - example: - mfaMethod: okta-verify - enabled: true - host: www.example.com - accessKey: d******Y - identityAttribute: email - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2025MFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) - /mfa/duo-web/config: - get: - operationId: getMFADuoConfig - tags: - - MFA Configuration - summary: Configuration of Duo MFA method - description: This API returns the configuration of an Duo MFA method. - security: - - userAuth: - - idn:mfa-configuration:read - - idn:mfa-configuration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - responses: - '200': - description: The configuration of an Duo MFA method. - content: - application/json: - schema: - type: object - properties: - mfaMethod: - type: string - nullable: true - description: Mfa method name - example: duo-web - enabled: - type: boolean - description: If MFA method is enabled. - default: false - example: true - host: - type: string - nullable: true - description: The server host name or IP address of the MFA provider. - example: example.com - accessKey: - type: string - nullable: true - description: The secret key for authenticating requests to the MFA provider. - example: qw123Y3QlA5UqocYpdU3rEkzrK2D497y - identityAttribute: - type: string - nullable: true - description: Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - example: email - configProperties: - description: A map with additional config properties for the given MFA method - duo-web. - type: object - nullable: true - additionalProperties: true - example: - skey: qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x - ikey: Q123WE45R6TY7890ZXCV - example: - mfaMethod: duo-web - enabled: true - host: www.example.com - accessKey: d******Y - identityAttribute: email - configProperties: - skey: 6******B - ikey: Q123WE45R6TY7890ZXCV - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-V2025MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) - put: - operationId: setMFADuoConfig - tags: - - MFA Configuration - summary: Set Duo MFA configuration - description: This API sets the configuration of an Duo MFA method. - security: - - userAuth: - - idn:mfa-configuration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1mfa~1duo-web~1config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MfaDuoConfig.yaml - example: - mfaMethod: duo-web - enabled: true - host: www.example.com - accessKey: qw123Y3QlA5UqocYpdU3rEkzrK2D497y - identityAttribute: email - configProperties: - skey: 12q3WERlcUHWJmiMqyCXI3uOF7EaDJTbdeOp6E2B - ikey: Q123WE45R6TY7890ZXCV - responses: - '200': - description: MFA configuration of an Duo MFA method. - content: - application/json: - schema: - $ref: '#/paths/~1mfa~1duo-web~1config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MfaDuoConfig.yaml - example: - mfaMethod: duo-web - enabled: true - host: www.example.com - accessKey: q******y - identityAttribute: email - configProperties: - skey: 1******B - ikey: Q123WE45R6TY7890ZXCV - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2025MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) - /mfa/kba/config: - get: - operationId: getMFAKbaConfig - tags: - - MFA Configuration - summary: Configuration of KBA MFA method - description: This API returns the KBA configuration for MFA. - parameters: - - in: query - name: allLanguages - required: false - schema: - type: boolean - description: |- - Indicator whether the question text should be returned in all configured languages - * If true, the question text is returned in all languages that it is configured in. - * If false, the question text is returned in the user locale if available, else for the default locale. - * If not passed, it behaves the same way as passing this parameter as false - example: allLanguages=true - security: - - userAuth: - - idn:mfa-kba:read - x-sailpoint-userLevels: - - ORG_ADMIN - - USER - responses: - '200': - description: The configuration for KBA MFA method. - content: - application/json: - schema: - type: array - items: - description: KBA Configuration - type: object - properties: - id: - type: string - nullable: false - description: KBA Question Id - example: 143cfd3b-c23f-426b-ae5f-d3db06fa5919 - text: - type: string - nullable: false - description: KBA Question description - example: '[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]' - hasAnswer: - type: boolean - nullable: false - description: Denotes whether the KBA question has an answer configured for any user in the tenant - example: true - numAnswers: - type: integer - format: int32 - nullable: false - description: Denotes the number of KBA configurations for this question - example: 5 - required: - - id - - text - - hasAnswer - - numAnswers - example: - - id: 143cfd3b-c23f-426b-ae5f-d3db06fa5919 - text: MFA new question -1 ? - hasAnswer: false - numAnswers: 0 - - id: '173421' - text: What is your alphanumeric PIN? - hasAnswer: false - numAnswers: 3 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-V2025MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAKbaConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - /mfa/kba/config/answers: - post: - operationId: setMFAKBAConfig - tags: - - MFA Configuration - summary: Set MFA KBA configuration - description: 'This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. ' - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - nullable: false - description: Question Id - example: c54fee53-2d63-4fc5-9259-3e93b9994135 - answer: - type: string - nullable: false - description: An answer for the KBA question - example: Your answer - required: - - id - - answer - example: - - id: '173423' - answer: 822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34 - - id: c54fee53-2d63-4fc5-9259-3e93b9994135 - answer: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08 - security: - - userAuth: - - idn:mfa-kba:authenticate - x-sailpoint-userLevels: - - USER - responses: - '200': - description: The new KBA configuration for the user. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - nullable: false - description: Question Id - example: c54fee53-2d63-4fc5-9259-3e93b9994135 - question: - type: string - nullable: false - description: Question description - example: '[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]' - hasAnswer: - type: boolean - nullable: false - description: Denotes whether the KBA question has an answer configured for the current user - example: true - required: - - id - - question - - hasAnswer - example: - - id: 143cfd3b-c23f-426b-ae5f-d3db06fa5919 - question: '[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]' - hasAnswer: false - - id: '173421' - question: '[{"text":"What is your alphanumeric PIN?","locale":""}]' - hasAnswer: true - - id: c54fee53-2d63-4fc5-9259-3e93b9994135 - question: '[{"text":"Nouvelle question MFA - 2 ?","locale":"fr"},{"text":"MFA new question - 2 ?","locale":""}]' - hasAnswer: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAKBAConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - /mfa/{method}/test: - get: - operationId: testMFAConfig - tags: - - MFA Configuration - summary: MFA method's test configuration - description: This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - security: - - userAuth: - - idn:mfa-configuration:read - - idn:mfa-configuration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: method - schema: - type: string - example: okta-verify - nullable: false - enum: - - okta-verify - - duo-web - required: true - description: The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - responses: - '200': - description: The result of configuration test for the MFA provider. - content: - application/json: - schema: - description: Response model for configuration test of a given MFA method - type: object - properties: - state: - type: string - enum: - - SUCCESS - - FAILED - description: The configuration test result. - example: SUCCESS - readOnly: true - error: - type: string - example: MFA Method is disabled. - description: The error message to indicate the failure of configuration test. - readOnly: true - example: - state: SUCCESS - error: null - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-V2025MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-V2025MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025MFAConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - /multihosts: - post: - tags: - - Multi-Host Integration - summary: Create Multi-Host Integration - description: |- - This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. - - A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - operationId: createMultiHostIntegration - requestBody: - description: The specifics of the Multi-Host Integration to create - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: Multi-Host Integration's human-readable name. - example: My Multi-Host Integration - description: - type: string - description: Multi-Host Integration's human-readable description. - example: This is the Multi-Host Integration. - owner: - description: Reference to identity object who owns the source. - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Owner identity's ID. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Owner identity's human-readable display name. - example: MyName - cluster: - description: Reference to the source's associated cluster. - type: object - nullable: true - required: - - name - - id - - type - properties: - type: - description: Type of object being referenced. - type: string - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: Cluster ID. - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Cluster's human-readable display name. - example: Corporate Cluster - connector: - type: string - description: Connector script name. - example: multihost-microsoft-sql-server - connectorAttributes: - type: object - additionalProperties: true - description: Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. - example: - maxSourcesPerAggGroup: 10 - maxAllowedSources: 300 - managementWorkgroup: - description: Reference to management workgroup for the source. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - GOVERNANCE_GROUP - example: GOVERNANCE_GROUP - id: - type: string - description: Management workgroup ID. - example: 2c91808568c529c60168cca6f90c2222 - name: - type: string - description: Management workgroup's human-readable display name. - example: My Management Workgroup - created: - type: string - description: Date-time when the source was created - format: date-time - example: '2022-02-08T14:50:03.827Z' - modified: - type: string - description: Date-time when the source was last modified. - format: date-time - example: '2024-01-23T18:08:50.897Z' - required: - - name - - owner - - connector - - description - required: true - responses: - '201': - description: OK. Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: object - properties: - id: - type: string - readOnly: true - description: Multi-Host Integration ID. - example: 2c91808568c529c60168cca6f90c1324 - name: - type: string - description: Multi-Host Integration's human-readable name. - example: My Multi-Host Integration - description: - type: string - description: Multi-Host Integration's human-readable description. - example: This is a Multi-Host Integration. - owner: - description: Reference to identity object who owns the source. - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Owner identity's ID. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Owner identity's human-readable display name. - example: MyName - cluster: - description: Reference to the source's associated cluster. - type: object - nullable: true - required: - - name - - id - - type - properties: - type: - description: Type of object being referenced. - type: string - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: Cluster ID. - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Cluster's human-readable display name. - example: Corporate Cluster - accountCorrelationConfig: - description: Reference to account correlation config object. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - example: ACCOUNT_CORRELATION_CONFIG - id: - type: string - description: Account correlation config ID. - example: 2c9180855d191c59015d28583727245a - name: - type: string - description: Account correlation config's human-readable display name. - example: Directory [source-62867] Account Correlation - accountCorrelationRule: - description: Reference to a rule that can do COMPLEX correlation. Only use this rule when you can't use accountCorrelationConfig. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - RULE - example: RULE - id: - type: string - description: Rule ID. - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Rule's human-readable display name. - example: Example Rule - managerCorrelationMapping: - allOf: - - $ref: '#/components/schemas/Source/properties/managerCorrelationMapping/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagerCorrelationMapping.yaml - - nullable: true - description: | - Filter object used during manager correlation to match incoming manager values to an existing manager's - account/identity. - managerCorrelationRule: - description: Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn't sufficient. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - RULE - example: RULE - id: - type: string - description: Rule ID. - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Rule's human-readable display name. - example: Example Rule - beforeProvisioningRule: - description: Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - RULE - example: RULE - id: - type: string - description: Rule ID. - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Rule's human-readable display name. - example: Example Rule - schemas: - type: array - items: - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: Schema ID. - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Schema's human-readable display name. - example: MySchema - description: List of references to schema objects. - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - nullable: true - items: - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - PASSWORD_POLICY - example: PASSWORD_POLICY - id: - type: string - description: Policy ID. - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Policy's human-readable display name. - example: My Password Policy - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb057777 - name: Vendor Password Policy - features: - $ref: '#/components/schemas/Source/properties/features' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SourceFeature.yaml - type: - type: string - description: Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - example: Multi-Host - Microsoft SQL Server - connector: - type: string - description: Connector script name. - example: multihost-microsoft-sql-server - connectorClass: - type: string - description: Fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.OpenConnectorAdapter - connectorAttributes: - type: object - additionalProperties: - type: string - description: Connector specific configuration. This configuration will differ for Multi-Host Integration type. - properties: - maxAllowedSources: - type: integer - format: int32 - description: Maximum sources allowed count of a Multi-Host Integration - example: 250 - lastSourceUploadCount: - type: integer - format: int32 - description: Last upload sources count of a Multi-Host Integration - example: 40 - connectorFileUploadHistory: - type: object - properties: - connectorFileNameUploadedDate: - description: File name of the connector JAR - type: string - example: '2024-08-29T10:20:38.896479Z' - multihost_status: - type: string - enum: - - ready - - processing - - fileUploadInProgress - - sourceCreationInProgress - - aggregationGroupingInProgress - - aggregationScheduleInProgress - - deleteInProgress - - deleteFailed - description: Multi-Host integration status. - example: ready - showAccountSchema: - description: Show account schema - type: boolean - example: true - default: true - showEntitlementSchema: - description: Show entitlement schema - type: boolean - example: true - default: true - multiHostAttributes: - type: object - description: Attributes of Multi-Host Integration - properties: - password: - description: Password. - type: string - example: Password - connector_files: - type: string - description: Connector file. - example: mssql-jdbc-8.4.1.jre8.jar - authType: - type: string - description: Authentication type. - example: SQLAuthentication - user: - type: string - description: Username. - example: My Username - example: - multiHostAttributes: - password: Password - user: Username - connector_files: mssql-jdbc-8.4.1.jre8.jar - authType: SQLAuthentication - connectorFileUploadHistory: - connectorFileNameUploadedDate: '2024-08-29T10:20:38.896479Z' - maxAllowedSources: 30 - lastSourceUploadCount: 50 - showEntitlementSchema: true - showAccountSchema: true - multihost_status: ready - deleteThreshold: - type: integer - format: int32 - minimum: 0 - maximum: 100 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When this is true, it indicates that the source is referenced by an identity profile. - default: false - example: false - managementWorkgroup: - description: Reference to management workgroup for the source. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - GOVERNANCE_GROUP - example: GOVERNANCE_GROUP - id: - type: string - description: Management workgroup ID. - example: 2c91808568c529c60168cca6f90c2222 - name: - type: string - description: Management workgroup's human-readable display name. - example: My Management Workgroup - healthy: - type: boolean - description: When this is true, it indicates that the source is healthy. - default: false - example: true - status: - type: string - enum: - - SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT - - SOURCE_STATE_ERROR_CLUSTER - - SOURCE_STATE_ERROR_SOURCE - - SOURCE_STATE_ERROR_VA - - SOURCE_STATE_FAILURE_CLUSTER - - SOURCE_STATE_FAILURE_SOURCE - - SOURCE_STATE_HEALTHY - - SOURCE_STATE_UNCHECKED_CLUSTER - - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES - - SOURCE_STATE_UNCHECKED_SOURCE - - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS - description: Status identifier that gives specific information about why a source is or isn't healthy. - example: SOURCE_STATE_HEALTHY - since: - type: string - format: date-time - description: Timestamp that shows when a source health check was last performed. - example: '2021-09-28T15:48:29.380Z' - connectorId: - type: string - description: Connector ID - example: multihost-microsoft-sql-server - connectorName: - type: string - description: Name of the connector that was chosen during source creation. - example: Multi-Host Microsoft SQL Server - connectionType: - type: string - enum: - - direct - - file - description: Type of connection (direct or file). - example: direct - connectorImplementationId: - type: string - description: Connector implementation ID. - example: multihost-microsoft-sql-server - created: - type: string - description: Date-time when the source was created - format: date-time - example: '2022-02-08T14:50:03.827Z' - modified: - type: string - description: Date-time when the source was last modified. - format: date-time - example: '2024-01-23T18:08:50.897Z' - credentialProviderEnabled: - type: boolean - description: If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - default: false - example: false - category: - type: string - nullable: true - default: null - description: Source category (e.g. null, CredentialProvider). - example: CredentialProvider - accountsFile: - description: Reference to accounts file for the source. - type: object - nullable: true - properties: - name: - description: Name of the accounts file. - type: string - example: My Accounts File - key: - type: string - description: The accounts file key. - example: 2c91808568c529c60168cca6f90c2222 - uploadTime: - type: string - description: Date-time when the file was uploaded - format: date-time - example: '2022-02-08T14:50:03.827Z' - expiry: - type: string - description: Date-time when the accounts file expired. - format: date-time - example: '2022-02-08T14:50:03.827Z' - expired: - type: boolean - default: false - description: If this is true, it indicates that the accounts file has expired. - example: false - required: - - name - - owner - - connector - - description - - id - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:create - - idn:sources:create - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#create-multi-host-integration - source: | - $MultiHostIntegrationsCreate = @" - { - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "connector" : "multihost-microsoft-sql-server", - "connectorAttributes" : { - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "created" : "2022-02-08T14:50:03.827Z", - "name" : "My Multi-Host Integration", - "description" : "This is the Multi-Host Integration.", - "modified" : "2024-01-23T18:08:50.897Z" - } - "@ - - # Create Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate - New-V2025MultiHostIntegration -MultiHostIntegrationsCreate $Result - - # Below is a request that includes all optional parameters - # New-V2025MultiHostIntegration -MultiHostIntegrationsCreate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025MultiHostIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#create-multi-host-integration - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integrations import MultiHostIntegrations - from sailpoint.v2025.models.multi_host_integrations_create import MultiHostIntegrationsCreate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_host_integrations_create = '''{ - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "connector" : "multihost-microsoft-sql-server", - "connectorAttributes" : { - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "created" : "2022-02-08T14:50:03.827Z", - "name" : "My Multi-Host Integration", - "description" : "This is the Multi-Host Integration.", - "modified" : "2024-01-23T18:08:50.897Z" - }''' # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create - try: - # Create Multi-Host Integration - new_multi_host_integrations_create = MultiHostIntegrationsCreate.from_json(multi_host_integrations_create) - results = MultiHostIntegrationApi(api_client).create_multi_host_integration(multi_host_integrations_create=new_multi_host_integrations_create) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).create_multi_host_integration(new_multi_host_integrations_create) - print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->create_multi_host_integration: %s\n" % e) - get: - tags: - - Multi-Host Integration - summary: List All Existing Multi-Host Integrations - description: |- - Get a list of Multi-Host Integrations. - - A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - operationId: getMultiHostIntegrationsList - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - name: sorters - in: query - required: false - style: form - explode: true - schema: - type: string - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - example: name - - name: filters - in: query - required: false - style: form - explode: true - schema: - type: string - format: comma-separated - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **type**: *in* - - **forSubAdminId**: *in* - example: id eq 2c91808b6ef1d43e016efba0ce470904 - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: for-subadmin - in: query - schema: - type: string - description: |- - If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. - - The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. - - A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - example: 5168015d32f890ca15812c9180835d2e - responses: - '200': - description: OK. Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1multihosts/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MultiHostIntegrations.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:read - - idn:sources:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multi-host-integrations-list - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - - # List All Existing Multi-Host Integrations - - try { - Get-V2025MultiHostIntegrationsList - - # Below is a request that includes all optional parameters - # Get-V2025MultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultiHostIntegrationsList" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-multi-host-integrations-list - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integrations import MultiHostIntegrations - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - try: - # List All Existing Multi-Host Integrations - - results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list() - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) - print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) - /multihosts/types: - get: - tags: - - Multi-Host Integration - summary: List Multi-Host Integration Types - description: |- - This API endpoint returns the current list of supported Multi-Host Integration types. - - A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - operationId: getMultihostIntegrationTypes - responses: - '200': - description: OK. Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: array - items: - description: This represents a Multi-Host Integration template type. - required: - - type - - scriptName - type: object - properties: - name: - description: This is the name of the type. - example: aName - type: string - type: - description: This is the type value for the type. - example: aType - type: string - scriptName: - description: This is the scriptName attribute value for the type. - example: aScriptName - type: string - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:read - - idn:sources:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multihost-integration-types - source: | - - # List Multi-Host Integration Types - - try { - Get-V2025MultihostIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-V2025MultihostIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultihostIntegrationTypes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-multihost-integration-types - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integration_template_type import MultiHostIntegrationTemplateType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Multi-Host Integration Types - - results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() - print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) - /multihosts/{multihostId}: - post: - tags: - - Multi-Host Integration - summary: Create Sources Within Multi-Host Integration - description: |- - This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. - - A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - operationId: createSourcesWithinMultiHost - parameters: - - name: multihostId - in: path - description: ID of the Multi-Host Integration. - required: true - x-sailpoint-resource-operation-id: getMultiHostIntegrations - style: simple - explode: false - schema: - type: string - example: 2c91808568c529c60168cca6f90c1326 - requestBody: - description: The specifics of the sources to create within Multi-Host Integration. - content: - application/json: - schema: - type: array - items: - description: This represents sources to be created of same type. - required: - - name - type: object - properties: - name: - type: string - description: Source's human-readable name. - example: My Source - description: - type: string - description: Source's human-readable description. - example: This is the corporate directory. - connectorAttributes: - type: object - additionalProperties: true - description: Connector specific configuration. This configuration will differ from type to type. - example: - authType: SQLAuthentication - url: jdbc:sqlserver://178.18.41.118:1433 - user: username - driverClass: com.microsoft.sqlserver.jdbc.SQLServerDriver - maxSourcesPerAggGroup: 10 - maxAllowedSources: 300 - required: true - responses: - '200': - description: OK. Returned if the request was successfully accepted into the system. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:create - - idn:sources:create - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#create-sources-within-multi-host - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - $MultiHostIntegrationsCreateSources = @"{ - "connectorAttributes" : { - "authType" : "SQLAuthentication", - "url" : "jdbc:sqlserver://178.18.41.118:1433", - "user" : "username", - "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "name" : "My Source", - "description" : "This is the corporate directory." - }"@ - - - # Create Sources Within Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources - New-V2025SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result - - # Below is a request that includes all optional parameters - # New-V2025SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourcesWithinMultiHost" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#create-sources-within-multi-host - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integrations_create_sources import MultiHostIntegrationsCreateSources - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. - multi_host_integrations_create_sources = '''[sailpoint.v2025.MultiHostIntegrationsCreateSources()]''' # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. - try: - # Create Sources Within Multi-Host Integration - new_multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources.from_json(multi_host_integrations_create_sources) - MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id=multihost_id, multi_host_integrations_create_sources=new_multi_host_integrations_create_sources) - # Below is a request that includes all optional parameters - # MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id, new_multi_host_integrations_create_sources) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->create_sources_within_multi_host: %s\n" % e) - get: - tags: - - Multi-Host Integration - summary: Get Multi-Host Integration By ID - description: |- - Get an existing Multi-Host Integration. - - A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - operationId: getMultiHostIntegrations - parameters: - - name: multihostId - in: path - description: ID of the Multi-Host Integration. - required: true - x-sailpoint-resource-operation-id: getMultiHostIntegrations - style: simple - explode: false - schema: - type: string - example: 2c91808568c529c60168cca6f90c1326 - responses: - '200': - description: OK. Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - $ref: '#/paths/~1multihosts/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MultiHostIntegrations.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:read - - idn:sources:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multi-host-integrations - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - - # Get Multi-Host Integration By ID - - try { - Get-V2025MultiHostIntegrations -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-V2025MultiHostIntegrations -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultiHostIntegrations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-multi-host-integrations - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integrations import MultiHostIntegrations - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. - try: - # Get Multi-Host Integration By ID - - results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id=multihost_id) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id) - print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations: %s\n" % e) - delete: - tags: - - Multi-Host Integration - summary: Delete Multi-Host Integration - description: |- - Delete an existing Multi-Host Integration by ID. - - A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - operationId: deleteMultiHost - parameters: - - name: multihostId - in: path - description: ID of Multi-Host Integration to delete. - required: true - x-sailpoint-resource-operation-id: getMultiHostIntegrations - style: simple - explode: false - schema: - type: string - example: 2c91808568c529c60168cca6f90c1326 - responses: - '200': - description: OK. Returned if the request was successfully accepted into the system. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:delete - - idn:sources:delete - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#delete-multi-host - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. - - # Delete Multi-Host Integration - - try { - Remove-V2025MultiHost -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Remove-V2025MultiHost -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MultiHost" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#delete-multi-host - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of Multi-Host Integration to delete. # str | ID of Multi-Host Integration to delete. - try: - # Delete Multi-Host Integration - - MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id=multihost_id) - # Below is a request that includes all optional parameters - # MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->delete_multi_host: %s\n" % e) - patch: - operationId: updateMultiHostSources - tags: - - Multi-Host Integration - summary: Update Multi-Host Integration - description: |- - Update existing sources within Multi-Host Integration. - - A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - parameters: - - name: multihostId - in: path - description: ID of the Multi-Host Integration to update. - required: true - x-sailpoint-resource-operation-id: getMultiHostIntegrations - style: simple - explode: false - schema: - type: string - example: anId - requestBody: - required: true - description: | - This endpoint allows you to update a Multi-Host Integration. - content: - application/json-patch+json: - schema: - type: array - description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). - items: - type: object - description: A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - replace - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - oneOf: - - type: string - example: New description - title: string - - type: boolean - example: true - title: boolean - - type: integer - example: 300 - title: integer - - type: object - title: object - example: - attributes: - name: philip - - type: array - title: array - items: - anyOf: - - type: string - - type: integer - - type: object - example: - - '001' - - '002' - - '003' - description: The value to be used for the operation, required for "add" and "replace" operations - example: New description - example: - - op: add - path: /description - value: MDK Multi-Host Integration 222 description - responses: - '200': - description: OK. Returned if the request was successfully accepted into the system. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:update - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#update-multi-host-sources - source: | - $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. - $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ - - - # Update Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner - Update-V2025MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MultiHostSources" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#update-multi-host-sources - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.update_multi_host_sources_request_inner import UpdateMultiHostSourcesRequestInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = 'anId' # str | ID of the Multi-Host Integration to update. # str | ID of the Multi-Host Integration to update. - update_multi_host_sources_request_inner = '''[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]''' # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. - try: - # Update Multi-Host Integration - new_update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner.from_json(update_multi_host_sources_request_inner) - MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id=multihost_id, update_multi_host_sources_request_inner=new_update_multi_host_sources_request_inner) - # Below is a request that includes all optional parameters - # MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id, new_update_multi_host_sources_request_inner) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->update_multi_host_sources: %s\n" % e) - /multihosts/{multihostId}/sources/testConnection: - post: - tags: - - Multi-Host Integration - summary: Test Configuration For Multi-Host Integration - description: |- - This endpoint performs a more detailed validation of the Multi-Host Integration's configuration. - - A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - operationId: testConnectionMultiHostSources - parameters: - - name: multihostId - in: path - description: ID of the Multi-Host Integration - required: true - x-sailpoint-resource-operation-id: getMultiHostIntegrations - style: simple - explode: false - schema: - type: string - example: 2c91808568c529c60168cca6f90c1324 - responses: - '200': - description: OK. Returned if the request was successfully accepted into the system. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:read - - idn:sources:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#test-connection-multi-host-sources - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration - - # Test Configuration For Multi-Host Integration - - try { - Test-V2025ConnectionMultiHostSources -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Test-V2025ConnectionMultiHostSources -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ConnectionMultiHostSources" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#test-connection-multi-host-sources - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = '2c91808568c529c60168cca6f90c1324' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration - try: - # Test Configuration For Multi-Host Integration - - MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id=multihost_id) - # Below is a request that includes all optional parameters - # MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->test_connection_multi_host_sources: %s\n" % e) - /multihosts/{multihostId}/sources/{sourceId}/testConnection: - get: - tags: - - Multi-Host Integration - summary: Test Configuration For Multi-Host Integration's Single Source - description: |- - This endpoint performs a more detailed validation of the source's configuration. - - A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - operationId: testSourceConnectionMultihost - parameters: - - name: multihostId - in: path - description: ID of the Multi-Host Integration - required: true - x-sailpoint-resource-operation-id: getMultiHostIntegrations - style: simple - explode: false - schema: - type: string - example: 2c91808568c529c60168cca6f90c1326 - - name: sourceId - in: path - description: ID of the source within the Multi-Host Integration - required: true - x-sailpoint-resource-operation-id: getSourcesWithinMultiHost - style: simple - explode: false - schema: - type: string - example: 2c91808568c529f60168cca6f90c1324 - responses: - '200': - description: OK. Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: object - properties: - success: - type: boolean - description: Source's test connection status. - example: true - message: - type: string - description: Source's test connection message. - example: Tes. - timing: - type: integer - description: Source's test connection timing. - example: 30437 - resultType: - enum: - - SOURCE_STATE_ERROR_CLUSTER - - SOURCE_STATE_ERROR_SOURCE - - SOURCE_STATE_ERROR_VA - - SOURCE_STATE_FAILURE_CLUSTER - - SOURCE_STATE_FAILURE_SOURCE - - SOURCE_STATE_HEALTHY - - SOURCE_STATE_UNCHECKED_CLUSTER - - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES - - SOURCE_STATE_UNCHECKED_SOURCE - - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS - - SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT - description: Source's human-readable result type. - example: SOURCE_STATE_HEALTHY - testConnectionDetails: - type: string - description: Source's human-readable test connection details. - example: null - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:read - - idn:sources:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#test-source-connection-multihost - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration - $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration - - # Test Configuration For Multi-Host Integration's Single Source - - try { - Test-V2025SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-V2025SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConnectionMultihost" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#test-source-connection-multihost - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_source_connection_multihost200_response import TestSourceConnectionMultihost200Response - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration - source_id = '2c91808568c529f60168cca6f90c1324' # str | ID of the source within the Multi-Host Integration # str | ID of the source within the Multi-Host Integration - try: - # Test Configuration For Multi-Host Integration's Single Source - - results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id=multihost_id, source_id=source_id) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id, source_id) - print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->test_source_connection_multihost: %s\n" % e) - /multihosts/{multihostId}/sources: - get: - tags: - - Multi-Host Integration - summary: List Sources Within Multi-Host Integration - description: |- - Get a list of sources within Multi-Host Integration ID. - - A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - operationId: getSourcesWithinMultiHost - parameters: - - name: multihostId - in: path - description: ID of the Multi-Host Integration to update - required: true - x-sailpoint-resource-operation-id: getMultiHostIntegrations - style: simple - explode: false - schema: - type: string - example: aMultiHostId - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - name: sorters - in: query - required: false - style: form - explode: true - schema: - type: string - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - example: name - - name: filters - in: query - required: false - style: form - explode: true - schema: - type: string - format: comma-separated - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *in* - example: id eq 2c91808b6ef1d43e016efba0ce470904 - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - responses: - '200': - description: OK. Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - readOnly: true - description: Source ID. - example: 2c91808568c529c60168cca6f90c1324 - name: - type: string - description: Source's human-readable name. - example: My Source - description: - type: string - description: Source's human-readable description. - example: This is the Source. - owner: - description: Reference to identity object who owns the source. - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Owner identity's ID. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Owner identity's human-readable display name. - example: MyName - cluster: - description: Reference to the source's associated cluster. - type: object - nullable: true - required: - - name - - id - - type - properties: - type: - description: Type of object being referenced. - type: string - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: Cluster ID. - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Cluster's human-readable display name. - example: Corporate Cluster - accountCorrelationConfig: - description: Reference to account correlation config object. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - example: ACCOUNT_CORRELATION_CONFIG - id: - type: string - description: Account correlation config ID. - example: 2c9180855d191c59015d28583727245a - name: - type: string - description: Account correlation config's human-readable display name. - example: Directory [source-62867] Account Correlation - accountCorrelationRule: - description: Reference to a rule that can do COMPLEX correlation. Only use this rule when you can't use accountCorrelationConfig. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - RULE - example: RULE - id: - type: string - description: Rule ID. - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Rule's human-readable display name. - example: Example Rule - managerCorrelationMapping: - $ref: '#/components/schemas/Source/properties/managerCorrelationMapping/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagerCorrelationMapping.yaml - managerCorrelationRule: - description: Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn't sufficient. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - RULE - example: RULE - id: - type: string - description: Rule ID. - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Rule's human-readable display name. - example: Example Rule - beforeProvisioningRule: - description: 'Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. ' - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - RULE - example: RULE - id: - type: string - description: Rule ID. - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Rule's human-readable display name. - example: Example Rule - schemas: - type: array - items: - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: Schema ID. - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Schema's human-readable display name. - example: MySchema - description: List of references to schema objects. - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - nullable: true - items: - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - PASSWORD_POLICY - example: PASSWORD_POLICY - id: - type: string - description: Policy ID. - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Policy's human-readable display name. - example: My Password Policy - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb057777 - name: Vendor Password Policy - features: - type: array - 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 - - ARM_SECURITY_EXTRACT - - ARM_UTILIZATION_EXTRACT - - ARM_CHANGELOG_EXTRACT - - USES_UUID - - APPLICATION_DISCOVERY - example: AUTHENTICATE - description: |- - Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * 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. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * 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. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * 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. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * 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. - * 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. - * 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. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. - * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. - * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM - * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM - * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - type: - type: string - description: 'Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. ' - example: Multi-Host - Microsoft SQL Server - connector: - type: string - description: Connector script name. - example: multihost-microsoft-sql-server - connectorClass: - type: string - description: Fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.OpenConnectorAdapter - connectorAttributes: - type: object - additionalProperties: true - description: Connector specific configuration. This configuration will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - minimum: 0 - maximum: 100 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When this is true, it indicates that the source is referenced by an identity profile. - default: false - example: false - managementWorkgroup: - description: Reference to management workgroup for the source. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - GOVERNANCE_GROUP - example: GOVERNANCE_GROUP - id: - type: string - description: Management workgroup ID. - example: 2c91808568c529c60168cca6f90c2222 - name: - type: string - description: Management workgroup's human-readable display name. - example: My Management Workgroup - healthy: - type: boolean - description: When this is true, it indicates that the source is healthy. - default: false - example: true - status: - type: string - enum: - - SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT - - SOURCE_STATE_ERROR_CLUSTER - - SOURCE_STATE_ERROR_SOURCE - - SOURCE_STATE_ERROR_VA - - SOURCE_STATE_FAILURE_CLUSTER - - SOURCE_STATE_FAILURE_SOURCE - - SOURCE_STATE_HEALTHY - - SOURCE_STATE_UNCHECKED_CLUSTER - - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES - - SOURCE_STATE_UNCHECKED_SOURCE - - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS - description: 'Status identifier that gives specific information about why a source is or isn''t healthy. ' - example: SOURCE_STATE_HEALTHY - since: - type: string - format: date-time - description: Timestamp that shows when a source health check was last performed. - example: '2021-09-28T15:48:29.380Z' - connectorId: - type: string - description: Connector ID - example: multihost-microsoft-sql-server - connectorName: - type: string - description: Name of the connector that was chosen during source creation. - example: Multi-Host Microsoft SQL Server - connectionType: - type: string - description: Type of connection (direct or file). - example: file - connectorImplementationId: - type: string - description: Connector implementation ID. - example: multihost-microsoft-sql-server - created: - type: string - description: Date-time when the source was created - format: date-time - example: '2022-02-08T14:50:03.827Z' - modified: - type: string - description: Date-time when the source was last modified. - format: date-time - example: '2024-01-23T18:08:50.897Z' - credentialProviderEnabled: - type: boolean - description: If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - default: false - example: false - category: - type: string - nullable: true - default: null - description: Source category (e.g. null, CredentialProvider). - example: CredentialProvider - required: - - name - - owner - - connector - - id - - connectorName - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:read - - idn:sources:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-sources-within-multi-host - source: | - $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Sources Within Multi-Host Integration - - try { - Get-V2025SourcesWithinMultiHost -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-V2025SourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourcesWithinMultiHost" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-sources-within-multi-host - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_sources import MultiHostSources - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Sources Within Multi-Host Integration - - results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id=multihost_id) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) - print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) - /multihosts/{multiHostId}/sources/errors: - get: - tags: - - Multi-Host Integration - summary: List Multi-Host Source Creation Errors - description: |- - Get a list of sources creation errors within Multi-Host Integration ID. - - A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - operationId: getMultiHostSourceCreationErrors - parameters: - - name: multiHostId - in: path - description: ID of the Multi-Host Integration - required: true - x-sailpoint-resource-operation-id: getMultiHostIntegrations - style: simple - explode: false - schema: - type: string - example: 004091cb79b04636b88662afa50a4440 - responses: - '200': - description: OK. Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: array - items: - type: object - properties: - multihostId: - type: string - readOnly: true - description: Multi-Host Integration ID. - example: 2c91808568c529c60168cca6f90c1324 - source_name: - type: string - description: Source's human-readable name. - example: My Source - source_error: - type: string - description: Source's human-readable description. - example: Source with internal name "My Source [source]" already exists. - created: - type: string - description: Date-time when the source was created - format: date-time - example: '2022-02-08T14:50:03.827Z' - modified: - type: string - description: Date-time when the source was last modified. - format: date-time - example: '2024-01-23T18:08:50.897Z' - operation: - type: string - nullable: true - default: null - description: operation category (e.g. DELETE). - example: DELETE - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:read - - idn:sources:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multi-host-source-creation-errors - source: | - $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration - - # List Multi-Host Source Creation Errors - - try { - Get-V2025MultiHostSourceCreationErrors -MultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-V2025MultiHostSourceCreationErrors -MultiHostId $MultiHostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultiHostSourceCreationErrors" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-multi-host-source-creation-errors - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_creation_errors import SourceCreationErrors - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_host_id = '004091cb79b04636b88662afa50a4440' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration - try: - # List Multi-Host Source Creation Errors - - results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id=multi_host_id) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) - print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) - /multihosts/{multihostId}/acctAggregationGroups: - get: - tags: - - Multi-Host Integration - summary: List Account-Aggregation-Groups by Multi-Host ID - description: |- - This API will return array of account aggregation groups within provided Multi-Host Integration ID. - A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - operationId: getAcctAggregationGroups - parameters: - - name: multihostId - in: path - description: ID of the Multi-Host Integration to update - required: true - x-sailpoint-resource-operation-id: getMultiHostIntegrations - style: simple - explode: false - schema: - type: string - example: aMultiHostId - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - responses: - '200': - description: OK. Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - description: Multi-Host Integration's aggregation schedule specification. - required: - - multihostId - - aggregation_grp_id - - aggregation_grp_name - - aggregation_cron_schedule - - enableSchedule - - source_id_list - properties: - multihostId: - description: Multi-Host Integration ID. The ID must be unique - type: string - example: 004091cb79b04636b88662afa50a4456 - aggregation_grp_id: - description: Multi-Host Integration aggregation group ID - type: string - example: 004091cb79b04636b88662afa50a4448 - aggregation_grp_name: - description: Multi-Host Integration name - type: string - example: Multi-Host Integration aggregation group name - aggregation_cron_schedule: - description: Cron expression to schedule aggregation - type: string - example: 0 0 0 * * ? - enableSchedule: - description: |- - Boolean value for Multi-Host Integration aggregation schedule. - - This specifies if scheduled aggregation is enabled or disabled. - type: boolean - default: false - example: false - source_id_list: - description: Source IDs of the Multi-Host Integration - type: array - items: - type: string - example: - - 004091cb79b04636b88662afa50a4440 - - 00af6d0d562a49b591c47be908740542 - created: - description: Created date of Multi-Host Integration aggregation schedule - type: string - format: date-time - example: '2024-01-23T18:08:50.897Z' - modified: - description: Modified date of Multi-Host Integration aggregation schedule - type: string - format: date-time - example: '2024-01-23T18:08:50.897Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:update - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-acct-aggregation-groups - source: | - $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Account-Aggregation-Groups by Multi-Host ID - - try { - Get-V2025AcctAggregationGroups -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-V2025AcctAggregationGroups -MultihostId $MultihostId -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AcctAggregationGroups" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-acct-aggregation-groups - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List Account-Aggregation-Groups by Multi-Host ID - - results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id=multihost_id) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id, offset, limit) - print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) - /multihosts/{multiHostId}/entitlementAggregationGroups: - get: - tags: - - Multi-Host Integration - summary: List Entitlement-Aggregation-Groups by Integration ID - description: |- - This API will return array of aggregation groups within provided Multi-Host Integration ID. - - A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - operationId: getEntitlementAggregationGroups - parameters: - - name: multiHostId - in: path - description: ID of the Multi-Host Integration to update - required: true - x-sailpoint-resource-operation-id: getMultiHostIntegrations - style: simple - explode: false - schema: - type: string - example: aMultiHostId - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - responses: - '200': - description: OK. Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1multihosts~1%7BmultihostId%7D~1acctAggregationGroups/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MultiHostIntegrationsAggScheduleUpdate.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:multihosts:update - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-entitlement-aggregation-groups - source: | - $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Entitlement-Aggregation-Groups by Integration ID - - try { - Get-V2025EntitlementAggregationGroups -MultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementAggregationGroups -MultiHostId $MultiHostId -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementAggregationGroups" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/multi-host-integration#get-entitlement-aggregation-groups - source: | - from sailpoint.v2025.api.multi_host_integration_api import MultiHostIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_host_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List Entitlement-Aggregation-Groups by Integration ID - - results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id=multi_host_id) - # Below is a request that includes all optional parameters - # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id, offset, limit) - print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) - /non-employee-records: - post: - operationId: createNonEmployeeRecord - tags: - - Non-Employee Lifecycle Management - summary: Create Non-Employee Record - description: |- - This request will create a non-employee record. - Requires role context of `idn:nesr:create` - requestBody: - description: Non-Employee record creation request body. - required: true - content: - application/json: - schema: - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5125555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Additional attributes for a non-employee. Up to 10 custom attributes can be added. - example: - description: Auditing - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - required: - - accountName - - firstName - - lastName - - email - - phone - - manager - - sourceId - - startDate - - endDate - responses: - '200': - description: Created non-employee record. - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee record id. - example: ef38f94347e94562b5bb8424a56397d8 - accountName: - type: string - description: Requested identity account name. - example: Abby.Smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5125555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Additional attributes for a non-employee. Up to 10 custom attributes can be added. - example: - description: Auditing - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2019-08-23T18:52:59.162Z' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2020-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-record - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2025NonEmployeeRecord -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2025NonEmployeeRecord -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#create-non-employee-record - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_record import NonEmployeeRecord - from sailpoint.v2025.models.non_employee_request_body import NonEmployeeRequestBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - non_employee_request_body = '''{ - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - }''' # NonEmployeeRequestBody | Non-Employee record creation request body. - try: - # Create Non-Employee Record - new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) - results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(non_employee_request_body=new_non_employee_request_body) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) - get: - operationId: listNonEmployeeRecords - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: List Non-Employee Records - description: |- - This gets a list of non-employee records. There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. - 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: accountName,sourceId - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - - in: query - name: filters - required: false - schema: - type: string - example: sourceId eq "2c91808568c529c60168cca6f90c1313" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **sourceId**: *eq* - responses: - '200': - description: Non-Employee record objects - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1non-employee-records/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeRecord.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-records - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - - # List Non-Employee Records - - try { - Get-V2025NonEmployeeRecords - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRecords" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#list-non-employee-records - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_record import NonEmployeeRecord - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'accountName,sourceId' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) - filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - try: - # List Non-Employee Records - - results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records() - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - /non-employee-records/{id}: - get: - operationId: getNonEmployeeRecord - tags: - - Non-Employee Lifecycle Management - summary: Get a Non-Employee Record - description: |- - This gets a non-employee record. - Requires role context of `idn:nesr:read` - parameters: - - in: path - name: id - description: Non-Employee record id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRecords - example: ef38f94347e94562b5bb8424a56397d8 - schema: - type: string - responses: - '200': - description: Non-Employee record object - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-records/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeRecord.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - - # Get a Non-Employee Record - - try { - Get-V2025NonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-record - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_record import NonEmployeeRecord - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) - try: - # Get a Non-Employee Record - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id=id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) - put: - operationId: updateNonEmployeeRecord - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Update Non-Employee Record - description: |- - This request will update a non-employee record. There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:update`, in which case they - update all available fields. - 2. The user is owner of the source, in this case they can only update the - end date. - parameters: - - in: path - name: id - description: Non-employee record id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRecords - schema: - type: string - requestBody: - description: Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - required: true - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-records/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeRequestBody.yaml - responses: - '200': - description: An updated non-employee record. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-records/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeRecord.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#update-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Update Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-V2025NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#update-non-employee-record - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_record import NonEmployeeRecord - from sailpoint.v2025.models.non_employee_request_body import NonEmployeeRequestBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) - non_employee_request_body = '''{ - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - }''' # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - try: - # Update Non-Employee Record - new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) - results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id=id, non_employee_request_body=new_non_employee_request_body) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body) - print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) - patch: - operationId: patchNonEmployeeRecord - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Patch Non-Employee Record - description: |- - This request will patch a non-employee record. There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:update`, in which case they - update all available fields. - 2. The user is owner of the source, in this case they can only update the - end date. - parameters: - - in: path - name: id - description: Non-employee record id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRecords - schema: - type: string - requestBody: - description: A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - required: true - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /endDate - value: '2019-08-23T18:40:35.772Z' - responses: - '200': - description: A patched non-employee record. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-records/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeRecord.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#patch-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Non-Employee Record - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025NonEmployeeRecord -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025NonEmployeeRecord -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#patch-non-employee-record - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.non_employee_record import NonEmployeeRecord - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) - json_patch_operation = '''[{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}]''' # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - try: - # Patch Non-Employee Record - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) - delete: - operationId: deleteNonEmployeeRecord - tags: - - Non-Employee Lifecycle Management - summary: Delete Non-Employee Record - description: |- - This request will delete a non-employee record. - Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: id - description: Non-Employee record id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRecords - schema: - type: string - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - - # Delete Non-Employee Record - - try { - Remove-V2025NonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#delete-non-employee-record - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) - try: - # Delete Non-Employee Record - - NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id=id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) - /non-employee-records/bulk-delete: - post: - operationId: deleteNonEmployeeRecordsInBulk - tags: - - Non-Employee Lifecycle Management - summary: Delete Multiple Non-Employee Records - description: This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - requestBody: - description: Non-Employee bulk delete request body. - required: true - content: - application/json: - schema: - type: object - properties: - ids: - description: List of non-employee ids. - type: array - items: - type: string - format: uuid - example: - - 2b838de9-db9b-abcf-e646-d4f274ad4238 - - 2d838de9-db9b-abcf-e646-d4f274ad4238 - required: - - ids - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk - source: | - $DeleteNonEmployeeRecordsInBulkRequest = @" - - "@ - - # Delete Multiple Non-Employee Records - - try { - $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest - Remove-V2025NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.delete_non_employee_records_in_bulk_request import DeleteNonEmployeeRecordsInBulkRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - delete_non_employee_records_in_bulk_request = '''sailpoint.v2025.DeleteNonEmployeeRecordsInBulkRequest()''' # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. - try: - # Delete Multiple Non-Employee Records - new_delete_non_employee_records_in_bulk_request = DeleteNonEmployeeRecordsInBulkRequest.from_json(delete_non_employee_records_in_bulk_request) - NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(delete_non_employee_records_in_bulk_request=new_delete_non_employee_records_in_bulk_request) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(new_delete_non_employee_records_in_bulk_request) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_records_in_bulk: %s\n" % e) - /non-employee-requests: - post: - operationId: createNonEmployeeRequest - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Create Non-Employee Request - description: This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - requestBody: - description: Non-Employee creation request body - required: true - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-records/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeRequestBody.yaml - responses: - '200': - description: Non-Employee request creation object - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5125555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - nonEmployeeSource: - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeSourceLite.yaml - data: - type: object - additionalProperties: - type: string - description: Additional attributes for a non-employee. Up to 10 custom attributes can be added. - example: - description: Auditing - approvalItems: - description: List of approval item for the request - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/approvers/items' - description: Reference to the associated Identity - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeIdentityReferenceWithId.yaml - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/1/properties/approvalStatus' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/ApprovalStatus.yaml - approvalOrder: - type: number - description: Approval order - example: 1 - format: float - comment: - type: string - description: comment of approver - example: I approve - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - comment: - type: string - description: Comment of requester - example: approved - completionDate: - type: string - format: date-time - description: When the request was completely approved. - example: '2020-03-24T11:11:41.139-05:00' - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2020-03-24T11:11:41.139-05:00' - created: - type: string - format: date-time - description: When the request was created. - example: '2020-03-24T11:11:41.139-05:00' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml - examples: - 400.1 Bad Request Content: - description: Response for bad request content - value: - detailCode: 400.1 Bad Request Content - trackingId: e7eab60924f64aa284175b9fa3309599 - messages: - - locale: en - localeOrigin: REQUEST - text: firstName is required; accountName is required; - 400.1.409 Reference conflict: - description: Response for reference conflict - value: - detailCode: 400.1.409 Reference conflict - trackingId: e7eab60924f64aa284175b9fa3309599 - messages: - - locale: en - localeOrigin: REQUEST - text: Unable to create Non-Employee because the accountName "existed" is already being used. - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-request - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2025NonEmployeeRequest -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2025NonEmployeeRequest -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#create-non-employee-request - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_request import NonEmployeeRequest - from sailpoint.v2025.models.non_employee_request_body import NonEmployeeRequestBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - non_employee_request_body = '''{ - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - }''' # NonEmployeeRequestBody | Non-Employee creation request body - try: - # Create Non-Employee Request - new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) - results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(non_employee_request_body=new_non_employee_request_body) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) - get: - operationId: listNonEmployeeRequests - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: List Non-Employee Requests - description: |- - This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. - 2. The current user is an account manager, in which case "me" should be - provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: requested-for - required: true - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - description: The identity for whom the request was made. *me* indicates the current user. - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: created,approvalStatus - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - - in: query - name: filters - required: false - schema: - type: string - example: sourceId eq "2c91808568c529c60168cca6f90c1313" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **sourceId**: *eq* - responses: - '200': - description: List of non-employee request objects. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeRequest.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-requests - source: | - $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - - # List Non-Employee Requests - - try { - Get-V2025NonEmployeeRequests -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRequests" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#list-non-employee-requests - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_request import NonEmployeeRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = 'e136567de87e4d029e60b3c3c55db56d' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'created,approvalStatus' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) - filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - try: - # List Non-Employee Requests - - results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for=requested_for) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - /non-employee-requests/{id}: - get: - operationId: getNonEmployeeRequest - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get a Non-Employee Request - description: |- - This gets a non-employee request. - There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:read`, in this case the user - can get the non-employee request for any user. - 2. The user must be the owner of the non-employee request. - parameters: - - in: path - name: id - description: Non-Employee request id (UUID) - example: ac110005-7156-1150-8171-5b292e3e0084 - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRequests - schema: - type: string - responses: - '200': - description: Non-Employee request object. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeRequest.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-request - source: | - $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) - - # Get a Non-Employee Request - - try { - Get-V2025NonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-request - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_request import NonEmployeeRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) - try: - # Get a Non-Employee Request - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id=id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) - delete: - operationId: deleteNonEmployeeRequest - tags: - - Non-Employee Lifecycle Management - summary: Delete Non-Employee Request - description: |- - This request will delete a non-employee request. - Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: id - description: Non-Employee request id in the UUID format - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRequests - schema: - type: string - format: uuid - example: ac110005-7156-1150-8171-5b292e3e0084 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-request - source: | - $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format - - # Delete Non-Employee Request - - try { - Remove-V2025NonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#delete-non-employee-request - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format - try: - # Delete Non-Employee Request - - NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id=id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) - /non-employee-requests/summary/{requested-for}: - get: - operationId: getNonEmployeeRequestSummary - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get Summary of Non-Employee Requests - description: |- - This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. - 2. The current user is an account manager, in which case "me" should be - provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - parameters: - - in: path - name: requested-for - description: The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use "me" instead to indicate the current user. - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRecords - schema: - type: string - format: uuid (if user is Org Admin) - example: 2c91808280430dfb0180431a59440460 - responses: - '200': - description: Non-Employee request summary object. - content: - application/json: - schema: - type: object - properties: - approved: - type: integer - description: The number of approved non-employee requests on all sources that *requested-for* user manages. - example: 2 - format: int32 - rejected: - type: integer - description: The number of rejected non-employee requests on all sources that *requested-for* user manages. - example: 2 - format: int32 - pending: - type: integer - description: The number of pending non-employee requests on all sources that *requested-for* user manages. - example: 2 - format: int32 - nonEmployeeCount: - type: integer - description: The number of non-employee records on all sources that *requested-for* user manages. - example: 2 - format: int32 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-request-summary - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Requests - - try { - Get-V2025NonEmployeeRequestSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRequestSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRequestSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-request-summary - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_request_summary import NonEmployeeRequestSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = '2c91808280430dfb0180431a59440460' # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - try: - # Get Summary of Non-Employee Requests - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for=requested_for) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) - /non-employee-sources: - post: - operationId: createNonEmployeeSource - security: - - userAuth: - - idn:nelm:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Non-Employee Lifecycle Management - summary: Create Non-Employee Source - description: 'Create a non-employee source. ' - requestBody: - description: Non-Employee source creation request body. - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: Name of non-employee source. - example: Retail - description: - type: string - description: Description of non-employee source. - example: Source description - owner: - type: object - properties: - id: - type: string - format: UUID - description: Identity id. - example: 2c91808570313110017040b06f344ec9 - required: - - id - managementWorkgroup: - type: string - description: The ID for the management workgroup that contains source sub-admins - example: '123299' - approvers: - description: List of approvers. - type: array - items: - $ref: '#/paths/~1non-employee-sources/post/requestBody/content/application~1json/schema/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeIdnUserRequest.yaml - maxItems: 3 - accountManagers: - description: List of account managers. - type: array - items: - $ref: '#/paths/~1non-employee-sources/post/requestBody/content/application~1json/schema/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeIdnUserRequest.yaml - maxItems: 10 - required: - - owner - - name - - description - responses: - '200': - description: Created non-employee source. - content: - application/json: - schema: - allOf: - - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeSource.yaml - - type: object - properties: - cloudExternalId: - type: string - description: Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. - example: '99999' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-source - source: | - $NonEmployeeSourceRequestBody = @" - { - "owner" : { - "id" : "2c91808570313110017040b06f344ec9" - }, - "managementWorkgroup" : "123299", - "accountManagers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ], - "name" : "Retail", - "description" : "Source description", - "approvers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ] - } - "@ - - # Create Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-V2025NonEmployeeSource -NonEmployeeSourceRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2025NonEmployeeSource -NonEmployeeSourceRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeSource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#create-non-employee-source - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_source_request_body import NonEmployeeSourceRequestBody - from sailpoint.v2025.models.non_employee_source_with_cloud_external_id import NonEmployeeSourceWithCloudExternalId - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - non_employee_source_request_body = '''{ - "owner" : { - "id" : "2c91808570313110017040b06f344ec9" - }, - "managementWorkgroup" : "123299", - "accountManagers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ], - "name" : "Retail", - "description" : "Source description", - "approvers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ] - }''' # NonEmployeeSourceRequestBody | Non-Employee source creation request body. - try: - # Create Non-Employee Source - new_non_employee_source_request_body = NonEmployeeSourceRequestBody.from_json(non_employee_source_request_body) - results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(non_employee_source_request_body=new_non_employee_source_request_body) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(new_non_employee_source_request_body) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) - get: - operationId: listNonEmployeeSources - security: - - userAuth: - - idn:nelm:read - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Non-Employee Lifecycle Management - summary: List Non-Employee Sources - description: |- - Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: - 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. - 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: requested-for - required: false - schema: - type: string - example: me - description: Identity the request was made for. Use 'me' to indicate the current user. - - in: query - name: non-employee-count - required: false - example: true - schema: - type: boolean - default: false - description: Flag that determines whether the API will return a non-employee count associated with the source. - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: name,created - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created, sourceId** - responses: - '200': - description: List of non-employee sources objects. - content: - application/json: - schema: - type: array - items: - allOf: - - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeSource.yaml - - type: object - properties: - nonEmployeeCount: - type: integer - description: Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. - format: int32 - example: 120 - nullable: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-sources - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) - $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) - $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - - # List Non-Employee Sources - - try { - Get-V2025NonEmployeeSources - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSources" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#list-non-employee-sources - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_source_with_ne_count import NonEmployeeSourceWithNECount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - requested_for = 'me' # str | Identity the request was made for. Use 'me' to indicate the current user. (optional) # str | Identity the request was made for. Use 'me' to indicate the current user. (optional) - non_employee_count = False # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) - sorters = 'name,created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - try: - # List Non-Employee Sources - - results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources() - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - /non-employee-sources/{sourceId}: - get: - operationId: getNonEmployeeSource - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get a Non-Employee Source - description: |- - This gets a non-employee source. There are two contextual uses for the requested-for path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request any source. - 2. The current user is an account manager, in which case the user can only - request sources that they own. - parameters: - - in: path - name: sourceId - description: Source Id - example: 2c91808b7c28b350017c2a2ec5790aa1 - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - schema: - type: string - responses: - '200': - description: Non-Employee source object. - content: - application/json: - schema: - allOf: - - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeSourceLite.yaml - - type: object - properties: - approvers: - description: List of approvers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountManagers: - description: List of account managers - type: array - items: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/approvers/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeIdentityReferenceWithId.yaml - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-source - source: | - $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id - - # Get a Non-Employee Source - - try { - Get-V2025NonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-source - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_source import NonEmployeeSource - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id - try: - # Get a Non-Employee Source - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id=source_id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) - patch: - operationId: patchNonEmployeeSource - tags: - - Non-Employee Lifecycle Management - summary: Patch a Non-Employee Source - description: 'patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`.' - parameters: - - in: path - name: sourceId - description: Source Id - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - requestBody: - description: A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - required: true - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /name - value: - new name: null - - op: replace - path: /approvers - value: - - 2c91809f703bb37a017040a2fe8748c7 - - 48b1f463c9e8427db5a5071bd81914b8 - responses: - '200': - description: A patched non-employee source object. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeSource.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#patch-non-employee-source - source: | - $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeSource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#patch-non-employee-source - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.non_employee_source import NonEmployeeSource - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id - json_patch_operation = '''[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]''' # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - try: - # Patch a Non-Employee Source - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id=source_id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) - delete: - operationId: deleteNonEmployeeSource - tags: - - Non-Employee Lifecycle Management - summary: Delete Non-Employee Source - description: This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - parameters: - - in: path - name: sourceId - description: Source Id - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source - source: | - $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - - # Delete Non-Employee Source - - try { - Remove-V2025NonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeSource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id - try: - # Delete Non-Employee Source - - NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id=source_id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) - /non-employee-sources/{id}/non-employees/download: - get: - operationId: exportNonEmployeeRecords - tags: - - Non-Employee Lifecycle Management - summary: Exports Non-Employee Records to CSV - description: This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - parameters: - - in: path - name: id - description: Source Id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - responses: - '200': - description: Exported CSV - content: - text/csv: - example: | - accountName,firstName,lastName,phone,email,manager,startDate,endDate - Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00 - William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#export-non-employee-records - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - - # Exports Non-Employee Records to CSV - - try { - Export-V2025NonEmployeeRecords -Id $Id - - # Below is a request that includes all optional parameters - # Export-V2025NonEmployeeRecords -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025NonEmployeeRecords" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#export-non-employee-records - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) - try: - # Exports Non-Employee Records to CSV - - NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id=id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) - /non-employee-sources/{id}/non-employee-bulk-upload: - post: - operationId: importNonEmployeeRecordsInBulk - security: - - userAuth: - - idn:nelm:manage - tags: - - Non-Employee Lifecycle Management - summary: Imports, or Updates, Non-Employee Records - description: This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - parameters: - - in: path - name: id - description: Source Id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - requestBody: - content: - multipart/form-data: - schema: - type: object - properties: - data: - type: string - format: binary - required: - - data - responses: - '202': - description: The CSV was accepted to be bulk inserted now or at a later time. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The bulk upload job's ID. (UUID) - example: 2c91808568c529c60168cca6f90cffff - sourceId: - type: string - description: The ID of the source to bulk-upload non-employees to. (UUID) - example: 2c91808568c529c60168cca6f90c1313 - created: - type: string - format: date-time - description: The date-time the job was submitted. - example: '2019-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: The date-time that the job was last updated. - example: '2019-08-23T18:52:59.162Z' - status: - type: string - enum: - - PENDING - - IN_PROGRESS - - COMPLETED - - ERROR - description: | - Returns the following values indicating the progress or result of the bulk upload job. - "PENDING" means the job is queued and waiting to be processed. - "IN_PROGRESS" means the job is currently being processed. - "COMPLETED" means the job has been completed without any errors. - "ERROR" means the job failed to process with errors. - example: PENDING - '400': - description: | - Client Error - Returned if the request body is invalid. - The response body will contain the list of specific errors with one on each line. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - $Data = # System.IO.FileInfo | - - # Imports, or Updates, Non-Employee Records - - try { - Import-V2025NonEmployeeRecordsInBulk -Id $Id -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2025NonEmployeeRecordsInBulk -Id $Id -Data $Data - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025NonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_bulk_upload_job import NonEmployeeBulkUploadJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) - data = None # bytearray | # bytearray | - try: - # Imports, or Updates, Non-Employee Records - - results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id=id, data=data) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id, data) - print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) - /non-employee-sources/{id}/non-employee-bulk-upload/status: - get: - operationId: getNonEmployeeBulkUploadStatus - tags: - - Non-Employee Lifecycle Management - summary: Obtain the status of bulk upload on the source - description: | - The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. - Requires role context of `idn:nesr:read` - parameters: - - in: path - name: id - description: Source ID (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - responses: - '200': - description: Status of the newest bulk-upload job, if any. - content: - application/json: - schema: - type: object - properties: - status: - type: string - enum: - - PENDING - - IN_PROGRESS - - COMPLETED - - ERROR - description: | - Returns the following values indicating the progress or result of the bulk upload job. - "PENDING" means the job is queued and waiting to be processed. - "IN_PROGRESS" means the job is currently being processed. - "COMPLETED" means the job has been completed without any errors. - "ERROR" means the job failed to process with errors. - null means job has been submitted to the source. - example: PENDING - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) - - # Obtain the status of bulk upload on the source - - try { - Get-V2025NonEmployeeBulkUploadStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeBulkUploadStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeBulkUploadStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_bulk_upload_status import NonEmployeeBulkUploadStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source ID (UUID) # str | Source ID (UUID) - try: - # Obtain the status of bulk upload on the source - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id=id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) - /non-employee-sources/{id}/schema-attributes-template/download: - get: - operationId: exportNonEmployeeSourceSchemaTemplate - tags: - - Non-Employee Lifecycle Management - summary: Exports Source Schema Template - description: This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - parameters: - - in: path - name: id - description: Source Id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - example: ef38f94347e94562b5bb8424a56397d8 - schema: - type: string - responses: - '200': - description: Exported Source Schema Template - content: - text/csv: - example: | - accountName,firstName,lastName,phone,email,manager,startDate,endDate - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) - - # Exports Source Schema Template - - try { - Export-V2025NonEmployeeSourceSchemaTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Export-V2025NonEmployeeSourceSchemaTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025NonEmployeeSourceSchemaTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID) - try: - # Exports Source Schema Template - - NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id=id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_source_schema_template: %s\n" % e) - /non-employee-approvals: - get: - operationId: listNonEmployeeApprovals - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get List of Non-Employee Approval Requests - description: |- - This gets a list of non-employee approval requests. - There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:read`, in which case they - can list the approvals for any approver. - 2. The user owns the requested approval. - parameters: - - in: query - name: requested-for - schema: - type: string - description: The identity for whom the request was made. *me* indicates the current user. - required: false - example: 2c91808280430dfb0180431a59440460 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **approvalStatus**: *eq* - example: approvalStatus eq "Pending" - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, modified** - required: false - example: created - responses: - '200': - description: List of approval items. - content: - application/json: - schema: - type: array - items: - allOf: - - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/1/properties/approvalItems/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeApprovalItemBase.yaml - - type: object - properties: - nonEmployeeRequest: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee request id. - example: ac110005-7156-1150-8171-5b292e3e0084 - requester: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/approvers/items' - example: - type: IDENTITY - id: 2c9180866166b5b0016167c32ef31a66 - name: William Smith - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeIdentityReferenceWithId.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-approvals - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Get List of Non-Employee Approval Requests - - try { - Get-V2025NonEmployeeApprovals - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeApprovals" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#list-non-employee-approvals - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_approval_item import NonEmployeeApprovalItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = '2c91808280430dfb0180431a59440460' # str | The identity for whom the request was made. *me* indicates the current user. (optional) # str | The identity for whom the request was made. *me* indicates the current user. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'approvalStatus eq \"Pending\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) - sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - try: - # Get List of Non-Employee Approval Requests - - results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals() - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) - /non-employee-approvals/{id}: - get: - operationId: getNonEmployeeApproval - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get a non-employee approval item detail - description: |- - Gets a non-employee approval item detail. There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:read`, in which case they - can get any approval. - 2. The user owns the requested approval. - parameters: - - in: path - name: id - description: Non-Employee approval item id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeApprovals - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - - in: query - name: include-detail - description: The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - required: false - schema: - type: boolean - example: true - responses: - '200': - description: Non-Employee approval item object. - content: - application/json: - schema: - allOf: - - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/1/properties/approvalItems/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeApprovalItemBase.yaml - - type: object - properties: - nonEmployeeRequest: - allOf: - - $ref: '#/paths/~1non-employee-approvals/get/responses/200/content/application~1json/schema/items/allOf/1/properties/nonEmployeeRequest' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeRequestLite.yaml - - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5125555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - nonEmployeeSource: - allOf: - - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeSourceLite.yaml - - type: object - properties: - schemaAttributes: - description: List of schema attributes associated with this non-employee source. - type: array - items: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D~1schema-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeSchemaAttribute.yaml - data: - type: object - additionalProperties: - type: string - description: Additional attributes for a non-employee. Up to 10 custom attributes can be added. - example: - description: Auditing - approvalStatus: - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/1/properties/approvalStatus' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/ApprovalStatus.yaml - comment: - type: string - description: Comment of requester - example: approved - completionDate: - type: string - format: date-time - description: When the request was completely approved. - example: '2020-03-24T11:11:41.139-05:00' - startDate: - type: string - format: date - description: Non-Employee employment start date. - example: '2020-03-24' - endDate: - type: string - format: date - description: Non-Employee employment end date. - example: '2021-03-25' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2020-03-24T11:11:41.139-05:00' - created: - type: string - format: date-time - description: When the request was created. - example: '2020-03-24T11:11:41.139-05:00' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) - - # Get a non-employee approval item detail - - try { - Get-V2025NonEmployeeApproval -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeApproval" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_approval_item_detail import NonEmployeeApprovalItemDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) - include_detail = true # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) - try: - # Get a non-employee approval item detail - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id=id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, include_detail) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) - /non-employee-approvals/{id}/approve: - post: - operationId: approveNonEmployeeRequest - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Approve a Non-Employee Request - description: Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - parameters: - - in: path - name: id - description: Non-Employee approval item id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeApprovals - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - comment: - type: string - description: Comment on the approval item. - maxLength: 4000 - example: Approved by manager - responses: - '200': - description: Non-Employee approval item object. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-approvals/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeApprovalItem.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#approve-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeApprovalDecision = @" - { - "comment" : "Approved by manager" - } - "@ - - # Approve a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-V2025NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Approve-V2025NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#approve-non-employee-request - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_approval_decision import NonEmployeeApprovalDecision - from sailpoint.v2025.models.non_employee_approval_item import NonEmployeeApprovalItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) - non_employee_approval_decision = '''{ - "comment" : "Approved by manager" - }''' # NonEmployeeApprovalDecision | - try: - # Approve a Non-Employee Request - new_non_employee_approval_decision = NonEmployeeApprovalDecision.from_json(non_employee_approval_decision) - results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id=id, non_employee_approval_decision=new_non_employee_approval_decision) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, new_non_employee_approval_decision) - print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) - /non-employee-approvals/{id}/reject: - post: - operationId: rejectNonEmployeeRequest - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Reject a Non-Employee Request - description: This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - parameters: - - in: path - name: id - description: Non-Employee approval item id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeApprovals - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - comment: - type: string - description: Comment on the approval item. - maxLength: 4000 - example: approved - required: - - comment - responses: - '200': - description: Non-Employee approval item object. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-approvals/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeApprovalItem.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#reject-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeRejectApprovalDecision = @" - { - "comment" : "approved" - } - "@ - - # Reject a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-V2025NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Deny-V2025NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#reject-non-employee-request - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_approval_item import NonEmployeeApprovalItem - from sailpoint.v2025.models.non_employee_reject_approval_decision import NonEmployeeRejectApprovalDecision - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) - non_employee_reject_approval_decision = '''{ - "comment" : "approved" - }''' # NonEmployeeRejectApprovalDecision | - try: - # Reject a Non-Employee Request - new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision.from_json(non_employee_reject_approval_decision) - results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id=id, non_employee_reject_approval_decision=new_non_employee_reject_approval_decision) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision) - print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) - /non-employee-approvals/summary/{requested-for}: - get: - operationId: getNonEmployeeApprovalSummary - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get Summary of Non-Employee Approval Requests - description: |- - This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. - 2. The current user is an approver, in which case "me" should be provided - as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - parameters: - - in: path - name: requested-for - schema: - type: string - description: The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use "me" instead to indicate the current user. - required: true - x-sailpoint-resource-operation-id: listIdentities - example: 2c91808280430dfb0180431a59440460 - responses: - '200': - description: summary of non-employee approval requests - content: - application/json: - schema: - type: object - properties: - approved: - type: integer - description: The number of approved non-employee approval requests. - format: int32 - example: 2 - pending: - type: integer - description: The number of pending non-employee approval requests. - format: int32 - example: 2 - rejected: - type: integer - description: The number of rejected non-employee approval requests. - format: int32 - example: 2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval-summary - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Approval Requests - - try { - Get-V2025NonEmployeeApprovalSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeApprovalSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeApprovalSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval-summary - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_approval_summary import NonEmployeeApprovalSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - requested_for = '2c91808280430dfb0180431a59440460' # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - try: - # Get Summary of Non-Employee Approval Requests - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for=requested_for) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) - /non-employee-sources/{sourceId}/schema-attributes: - get: - operationId: getNonEmployeeSourceSchemaAttributes - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: List Schema Attributes Non-Employee Source - description: |- - This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. - Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - example: ef38f94347e94562b5bb8424a56397d8 - description: The Source id - responses: - '200': - description: A list of Schema Attributes - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - format: UUID - example: ac110005-7156-1150-8171-5b292e3e0084 - description: Schema Attribute Id - system: - type: boolean - description: True if this schema attribute is mandatory on all non-employees sources. - example: true - default: false - modified: - type: string - format: date-time - description: When the schema attribute was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the schema attribute was created. - example: '2019-08-23T18:40:35.772Z' - type: - type: string - enum: - - TEXT - - DATE - - IDENTITY - description: Enum representing the type of data a schema attribute accepts. - example: TEXT - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: If true, the schema attribute is required for all non-employees in the source - example: true - default: false - required: - - type - - technicalName - - label - maxItems: 18 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # List Schema Attributes Non-Employee Source - - try { - Get-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - try: - # List Schema Attributes Non-Employee Source - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id=source_id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - post: - operationId: createNonEmployeeSourceSchemaAttributes - tags: - - Non-Employee Lifecycle Management - summary: Create a new Schema Attribute for Non-Employee Source - description: |- - This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. - Requires role context of `idn:nesr:create` - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - description: The Source id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - type: - type: string - description: Type of the attribute. Only type 'TEXT' is supported for custom attributes. - example: TEXT - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: If true, the schema attribute is required for all non-employees in the source - example: true - required: - - type - - technicalName - - label - responses: - '200': - description: Schema Attribute created. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D~1schema-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeSchemaAttribute.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - $NonEmployeeSchemaAttributeBody = @" - { - "helpText" : "The unique identifier for the account", - "label" : "Account Name", - "placeholder" : "Enter a unique user name for this account.", - "type" : "TEXT", - "technicalName" : "account.name", - "required" : true - } - "@ - - # Create a new Schema Attribute for Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - - # Below is a request that includes all optional parameters - # New-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute - from sailpoint.v2025.models.non_employee_schema_attribute_body import NonEmployeeSchemaAttributeBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - non_employee_schema_attribute_body = '''{ - "helpText" : "The unique identifier for the account", - "label" : "Account Name", - "placeholder" : "Enter a unique user name for this account.", - "type" : "TEXT", - "technicalName" : "account.name", - "required" : true - }''' # NonEmployeeSchemaAttributeBody | - try: - # Create a new Schema Attribute for Non-Employee Source - new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody.from_json(non_employee_schema_attribute_body) - results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id=source_id, non_employee_schema_attribute_body=new_non_employee_schema_attribute_body) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, new_non_employee_schema_attribute_body) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) - delete: - operationId: deleteNonEmployeeSourceSchemaAttributes - tags: - - Non-Employee Lifecycle Management - summary: Delete all custom schema attributes for Non-Employee Source - description: This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - description: The Source id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Delete all custom schema attributes for Non-Employee Source - - try { - Remove-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - try: - # Delete all custom schema attributes for Non-Employee Source - - NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id=source_id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source_schema_attributes: %s\n" % e) - /non-employee-sources/{sourceId}/schema-attributes/{attributeId}: - get: - operationId: getNonEmployeeSchemaAttribute - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get Schema Attribute Non-Employee Source - description: This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - parameters: - - in: path - name: attributeId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getNonEmployeeSourceSchemaAttributes - example: ef38f94347e94562b5bb8424a56397d8 - description: The Schema Attribute Id (UUID) - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - example: ef38f94347e94562b5bb8424a56397d8 - description: The Source id - responses: - '200': - description: The Schema Attribute - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D~1schema-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeSchemaAttribute.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Get Schema Attribute Non-Employee Source - - try { - Get-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) - source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - try: - # Get Schema Attribute Non-Employee Source - - results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id, source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) - patch: - operationId: patchNonEmployeeSchemaAttribute - tags: - - Non-Employee Lifecycle Management - summary: Patch a Schema Attribute for Non-Employee Source - description: | - This end-point patches a specific schema attribute for a non-employee SourceId. - Requires role context of `idn:nesr:update` - parameters: - - in: path - name: attributeId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getNonEmployeeSourceSchemaAttributes - description: The Schema Attribute Id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - description: The Source id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - description: A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /label - value: - new attribute label: null - required: true - responses: - '200': - description: The Schema Attribute was successfully patched. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D~1schema-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/non-employee/NonEmployeeSchemaAttribute.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Schema Attribute for Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) - source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - json_patch_operation = '''[{op=replace, path=/label, value={new attribute label=null}}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. - try: - # Patch a Schema Attribute for Non-Employee Source - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, new_json_patch_operation) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) - delete: - operationId: deleteNonEmployeeSchemaAttribute - tags: - - Non-Employee Lifecycle Management - summary: Delete a Schema Attribute for Non-Employee Source - description: | - This end-point deletes a specific schema attribute for a non-employee source. - Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: attributeId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getNonEmployeeSourceSchemaAttributes - description: The Schema Attribute Id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - description: The Source id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Delete a Schema Attribute for Non-Employee Source - - try { - Remove-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute - source: | - from sailpoint.v2025.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) - source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - try: - # Delete a Schema Attribute for Non-Employee Source - - NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id) - # Below is a request that includes all optional parameters - # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id, source_id) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_schema_attribute: %s\n" % e) - /oauth-clients: - get: - operationId: listOauthClients - security: - - userAuth: - - sp:oauth-client:manage - tags: - - OAuth Clients - summary: List OAuth Clients - description: This gets a list of OAuth clients. - parameters: - - in: query - name: filters - required: false - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **lastUsed**: *le, isnull* - example: lastUsed le 2023-02-05T10:59:27.214Z - responses: - '200': - description: List of OAuth clients. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the OAuth client - example: 2c9180835d2e5168015d32f890ca1581 - businessName: - type: string - nullable: true - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - nullable: true - description: The homepage URL associated with the owner of the API Client - example: http://localhost:12345 - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - nullable: true - description: A description of the API Client - example: An API client used for the authorization_code, refresh_token, and client_credentials flows - accessTokenValiditySeconds: - type: integer - format: int32 - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - refreshTokenValiditySeconds: - type: integer - format: int32 - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - redirectUris: - type: array - nullable: true - items: - type: string - description: A list of the approved redirect URIs used with the authorization_code flow - example: - - http://localhost:12345 - grantTypes: - type: array - items: - description: OAuth2 Grant Type - type: string - example: CLIENT_CREDENTIALS - enum: - - CLIENT_CREDENTIALS - - AUTHORIZATION_CODE - - REFRESH_TOKEN - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - type: string - enum: - - ONLINE - - OFFLINE - description: Access type of API Client indicating online or offline use - example: OFFLINE - type: - type: string - enum: - - CONFIDENTIAL - - PUBLIC - description: Type of an API Client indicating public or confidentials use - example: CONFIDENTIAL - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal to IDN - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - created: - type: string - format: date-time - description: The date and time, down to the millisecond, when the API Client was created - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: The date and time, down to the millisecond, when the API Client was last updated - example: '2018-06-25T20:22:28.104Z' - secret: - type: string - nullable: true - metadata: - type: string - nullable: true - lastUsed: - type: string - nullable: true - format: date-time - description: The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. - example: '2017-07-11T18:45:37.098Z' - scope: - type: array - nullable: true - items: - type: string - default: sp:scopes:all - description: Scopes of the API Client. - example: - - demo:api-client-scope:first - - demo:api-client-scope:second - required: - - id - - businessName - - homepageUrl - - name - - description - - accessTokenValiditySeconds - - refreshTokenValiditySeconds - - redirectUris - - grantTypes - - accessType - - type - - internal - - enabled - - strongAuthSupported - - claimsSupported - - created - - modified - - scope - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#list-oauth-clients - source: | - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - - # List OAuth Clients - - try { - Get-V2025OauthClients - - # Below is a request that includes all optional parameters - # Get-V2025OauthClients -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OauthClients" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/o-auth-clients#list-oauth-clients - source: | - from sailpoint.v2025.api.o_auth_clients_api import OAuthClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_o_auth_client_response import GetOAuthClientResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - try: - # List OAuth Clients - - results = OAuthClientsApi(api_client).list_oauth_clients() - # Below is a request that includes all optional parameters - # results = OAuthClientsApi(api_client).list_oauth_clients(filters) - print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - post: - operationId: createOauthClient - security: - - userAuth: - - sp:oauth-client:manage - tags: - - OAuth Clients - summary: Create OAuth Client - description: This creates an OAuth client. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - businessName: - type: string - nullable: true - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - nullable: true - description: The homepage URL associated with the owner of the API Client - example: http://localhost:12345 - name: - type: string - nullable: true - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - nullable: true - description: A description of the API Client - example: An API client used for the authorization_code, refresh_token, and client_credentials flows - accessTokenValiditySeconds: - description: The number of seconds an access token generated for this API Client is valid for - type: integer - format: int32 - example: 750 - refreshTokenValiditySeconds: - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - type: integer - format: int32 - redirectUris: - type: array - nullable: true - items: - type: string - description: A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. - example: - - http://localhost:12345 - grantTypes: - type: array - nullable: true - items: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/grantTypes/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/GrantType.yaml - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/accessType' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessType.yaml - type: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ClientType.yaml - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal within the product. - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - scope: - type: array - nullable: true - items: - type: string - default: sp:scopes:all - description: Scopes of the API Client. If no scope is specified, the client will be created with the default scope "sp:scopes:all". This means the API Client will have all the rights of the owner who created it. - example: - - demo:api-client-scope:first - - demo:api-client-scope:second - required: - - name - - description - - accessTokenValiditySeconds - - grantTypes - - accessType - - enabled - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the OAuth client - example: 2c9180835d2e5168015d32f890ca1581 - secret: - type: string - description: Secret of the OAuth client (This field is only returned on the intial create call.) - example: 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3 - businessName: - type: string - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - description: The homepage URL associated with the owner of the API Client - example: http://localhost:12345 - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - description: A description of the API Client - example: An API client used for the authorization_code, refresh_token, and client_credentials flows - accessTokenValiditySeconds: - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - type: integer - format: int32 - refreshTokenValiditySeconds: - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - type: integer - format: int32 - redirectUris: - type: array - items: - type: string - description: A list of the approved redirect URIs used with the authorization_code flow - example: - - http://localhost:12345 - grantTypes: - type: array - items: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/grantTypes/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/GrantType.yaml - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/accessType' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessType.yaml - type: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ClientType.yaml - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal to IDN - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - created: - type: string - format: date-time - description: The date and time, down to the millisecond, when the API Client was created - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: The date and time, down to the millisecond, when the API Client was last updated - example: '2018-06-25T20:22:28.104Z' - scope: - type: array - nullable: true - items: - type: string - default: sp:scopes:all - description: Scopes of the API Client. - example: - - demo:api-client-scope:first - - demo:api-client-scope:second - required: - - id - - secret - - businessName - - homepageUrl - - name - - description - - accessTokenValiditySeconds - - refreshTokenValiditySeconds - - redirectUris - - grantTypes - - accessType - - type - - internal - - enabled - - strongAuthSupported - - claimsSupported - - created - - modified - - scope - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#create-oauth-client - source: | - $CreateOAuthClientRequest = @" - { - "internal" : false, - "businessName" : "Acme-Solar", - "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", - "refreshTokenValiditySeconds" : 86400, - "type" : "CONFIDENTIAL", - "redirectUris" : [ "http://localhost:12345" ], - "enabled" : true, - "accessType" : "OFFLINE", - "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], - "strongAuthSupported" : false, - "homepageUrl" : "http://localhost:12345", - "accessTokenValiditySeconds" : 750, - "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], - "name" : "Demo API Client", - "claimsSupported" : false - } - "@ - - # Create OAuth Client - - try { - $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-V2025OauthClient -CreateOAuthClientRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025OauthClient -CreateOAuthClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025OauthClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/o-auth-clients#create-oauth-client - source: | - from sailpoint.v2025.api.o_auth_clients_api import OAuthClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_o_auth_client_request import CreateOAuthClientRequest - from sailpoint.v2025.models.create_o_auth_client_response import CreateOAuthClientResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_o_auth_client_request = '''{ - "internal" : false, - "businessName" : "Acme-Solar", - "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", - "refreshTokenValiditySeconds" : 86400, - "type" : "CONFIDENTIAL", - "redirectUris" : [ "http://localhost:12345" ], - "enabled" : true, - "accessType" : "OFFLINE", - "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], - "strongAuthSupported" : false, - "homepageUrl" : "http://localhost:12345", - "accessTokenValiditySeconds" : 750, - "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], - "name" : "Demo API Client", - "claimsSupported" : false - }''' # CreateOAuthClientRequest | - try: - # Create OAuth Client - new_create_o_auth_client_request = CreateOAuthClientRequest.from_json(create_o_auth_client_request) - results = OAuthClientsApi(api_client).create_oauth_client(create_o_auth_client_request=new_create_o_auth_client_request) - # Below is a request that includes all optional parameters - # results = OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request) - print("The response of OAuthClientsApi->create_oauth_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) - /oauth-clients/{id}: - get: - operationId: getOauthClient - security: - - userAuth: - - sp:oauth-client:manage - - sp:oauth-client:read - tags: - - OAuth Clients - summary: Get OAuth Client - description: This gets details of an OAuth client. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listOauthClients - description: The OAuth client id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/GetOAuthClientResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#get-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Get OAuth Client - - try { - Get-V2025OauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025OauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OauthClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/o-auth-clients#get-oauth-client - source: | - from sailpoint.v2025.api.o_auth_clients_api import OAuthClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_o_auth_client_response import GetOAuthClientResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id - try: - # Get OAuth Client - - results = OAuthClientsApi(api_client).get_oauth_client(id=id) - # Below is a request that includes all optional parameters - # results = OAuthClientsApi(api_client).get_oauth_client(id) - print("The response of OAuthClientsApi->get_oauth_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) - delete: - operationId: deleteOauthClient - security: - - userAuth: - - sp:oauth-client:manage - tags: - - OAuth Clients - summary: Delete OAuth Client - description: This deletes an OAuth client. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listOauthClients - description: The OAuth client id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: No content. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#delete-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Delete OAuth Client - - try { - Remove-V2025OauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025OauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025OauthClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/o-auth-clients#delete-oauth-client - source: | - from sailpoint.v2025.api.o_auth_clients_api import OAuthClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id - try: - # Delete OAuth Client - - OAuthClientsApi(api_client).delete_oauth_client(id=id) - # Below is a request that includes all optional parameters - # OAuthClientsApi(api_client).delete_oauth_client(id) - except Exception as e: - print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) - patch: - operationId: patchOauthClient - security: - - userAuth: - - sp:oauth-client:manage - tags: - - OAuth Clients - summary: Patch OAuth Client - description: This performs a targeted update to the field(s) of an OAuth client. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listOauthClients - description: The OAuth client id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * tenant - * businessName - * homepageUrl - * name - * description - * accessTokenValiditySeconds - * refreshTokenValiditySeconds - * redirectUris - * grantTypes - * accessType - * enabled - * strongAuthSupported - * claimsSupported - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /strongAuthSupported - value: true - - op: replace - path: /businessName - value: acme-solar - responses: - '200': - description: Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. - content: - application/json: - schema: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/GetOAuthClientResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#patch-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch OAuth Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025OauthClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025OauthClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025OauthClient" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/o-auth-clients#patch-oauth-client - source: | - from sailpoint.v2025.api.o_auth_clients_api import OAuthClientsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_o_auth_client_response import GetOAuthClientResponse - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id - json_patch_operation = '''[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - try: - # Patch OAuth Client - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = OAuthClientsApi(api_client).patch_oauth_client(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation) - print("The response of OAuthClientsApi->patch_oauth_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) - /password-sync-groups: - get: - operationId: getPasswordSyncGroups - tags: - - Password Sync Groups - summary: Get Password Sync Group List - description: This API returns a list of password sync groups. - security: - - userAuth: - - idn:password-sync-group-management:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - responses: - '200': - description: A list of password sync groups. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the sync group - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: - description: Name of the sync group - type: string - example: Password Sync Group 1 - passwordPolicyId: - type: string - description: ID of the password policy - example: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - type: array - description: List of password managed sources IDs - items: - type: string - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - created: - type: string - description: The date and time this sync group was created - format: date-time - example: '2023-03-16T04:00:00Z' - nullable: true - modified: - type: string - description: The date and time this sync group was last modified - format: date-time - example: '2023-03-16T04:00:00Z' - nullable: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#get-password-sync-groups - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Get Password Sync Group List - - try { - Get-V2025PasswordSyncGroups - - # Below is a request that includes all optional parameters - # Get-V2025PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordSyncGroups" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-sync-groups#get-password-sync-groups - source: | - from sailpoint.v2025.api.password_sync_groups_api import PasswordSyncGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_sync_group import PasswordSyncGroup - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Get Password Sync Group List - - results = PasswordSyncGroupsApi(api_client).get_password_sync_groups() - # Below is a request that includes all optional parameters - # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) - print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - post: - operationId: createPasswordSyncGroup - tags: - - Password Sync Groups - summary: Create Password Sync Group - description: This API creates a password sync group based on the specifications provided. - security: - - userAuth: - - idn:password-sync-group-management:write - x-sailpoint-userLevels: - - ORG_ADMIN - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordSyncGroup.yaml - example: - name: Password Sync Group 2 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - responses: - '200': - description: Reference to the password sync group. - content: - application/json: - schema: - $ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordSyncGroup.yaml - example: - id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: Password Sync Group 2 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#create-password-sync-group - source: | - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Create Password Sync Group - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-V2025PasswordSyncGroup -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # New-V2025PasswordSyncGroup -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordSyncGroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-sync-groups#create-password-sync-group - source: | - from sailpoint.v2025.api.password_sync_groups_api import PasswordSyncGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_sync_group import PasswordSyncGroup - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - password_sync_group = '''{ - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - }''' # PasswordSyncGroup | - try: - # Create Password Sync Group - new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) - results = PasswordSyncGroupsApi(api_client).create_password_sync_group(password_sync_group=new_password_sync_group) - # Below is a request that includes all optional parameters - # results = PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group) - print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) - /password-sync-groups/{id}: - get: - operationId: getPasswordSyncGroup - tags: - - Password Sync Groups - summary: Get Password Sync Group by ID - description: This API returns the sync group for the specified ID. - security: - - userAuth: - - idn:password-sync-group-management:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPasswordSyncGroups - description: The ID of password sync group to retrieve. - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - responses: - '200': - description: Reference to the password sync group. - content: - application/json: - schema: - $ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordSyncGroup.yaml - example: - id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: Password Sync Group 1 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#get-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. - - # Get Password Sync Group by ID - - try { - Get-V2025PasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025PasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordSyncGroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-sync-groups#get-password-sync-group - source: | - from sailpoint.v2025.api.password_sync_groups_api import PasswordSyncGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_sync_group import PasswordSyncGroup - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to retrieve. # str | The ID of password sync group to retrieve. - try: - # Get Password Sync Group by ID - - results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id=id) - # Below is a request that includes all optional parameters - # results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id) - print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) - put: - operationId: updatePasswordSyncGroup - tags: - - Password Sync Groups - summary: Update Password Sync Group by ID - description: This API updates the specified password sync group. - security: - - userAuth: - - idn:password-sync-group-management:write - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPasswordSyncGroups - description: The ID of password sync group to update. - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordSyncGroup.yaml - example: - id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: Password Sync Group 2 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - responses: - '200': - description: Reference to the password sync group. - content: - application/json: - schema: - $ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordSyncGroup.yaml - example: - id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: Password Sync Group 2 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#update-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Update Password Sync Group by ID - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-V2025PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # Update-V2025PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PasswordSyncGroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-sync-groups#update-password-sync-group - source: | - from sailpoint.v2025.api.password_sync_groups_api import PasswordSyncGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_sync_group import PasswordSyncGroup - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to update. # str | The ID of password sync group to update. - password_sync_group = '''{ - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - }''' # PasswordSyncGroup | - try: - # Update Password Sync Group by ID - new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) - results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id=id, password_sync_group=new_password_sync_group) - # Below is a request that includes all optional parameters - # results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group) - print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) - delete: - operationId: deletePasswordSyncGroup - tags: - - Password Sync Groups - summary: Delete Password Sync Group by ID - description: This API deletes the specified password sync group. - security: - - userAuth: - - idn:password-sync-group-management:write - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPasswordSyncGroups - description: The ID of password sync group to delete. - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#delete-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. - - # Delete Password Sync Group by ID - - try { - Remove-V2025PasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025PasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PasswordSyncGroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-sync-groups#delete-password-sync-group - source: | - from sailpoint.v2025.api.password_sync_groups_api import PasswordSyncGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to delete. # str | The ID of password sync group to delete. - try: - # Delete Password Sync Group by ID - - PasswordSyncGroupsApi(api_client).delete_password_sync_group(id=id) - # Below is a request that includes all optional parameters - # PasswordSyncGroupsApi(api_client).delete_password_sync_group(id) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) - /password-policies/{id}: - get: - operationId: getPasswordPolicyById - tags: - - Password Policies - summary: Get Password Policy by ID - description: This API returns the password policy for the specified ID. - security: - - userAuth: - - idn:password-policy:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPasswordPolicies - description: The ID of password policy to retrieve. - example: ff808081838d9e9d01838da6a03e0005 - responses: - '200': - description: Reference to the password policy. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The password policy Id. - example: 2c91808e7d976f3b017d9f5ceae440c8 - description: - type: string - nullable: true - description: Description for current password policy. - example: Information about the Password Policy - name: - type: string - description: The name of the password policy. - example: PasswordPolicy Example - dateCreated: - type: integer - format: int64 - description: Date the Password Policy was created. - example: 1639056206564 - lastUpdated: - type: integer - format: int64 - nullable: true - description: Date the Password Policy was updated. - example: 1939056206564 - firstExpirationReminder: - type: integer - format: int64 - description: The number of days before expiration remaninder. - example: 45 - accountIdMinWordLength: - type: integer - format: int64 - description: The minimun length of account Id. By default is equals to -1. - example: 4 - accountNameMinWordLength: - type: integer - format: int64 - description: The minimun length of account name. By default is equals to -1. - example: 6 - minAlpha: - type: integer - format: int64 - description: Maximum alpha. By default is equals to 0. - example: 5 - minCharacterTypes: - type: integer - format: int64 - description: MinCharacterTypes. By default is equals to -1. - example: 5 - maxLength: - type: integer - format: int64 - description: Maximum length of the password. - example: 25 - minLength: - type: integer - format: int64 - description: Minimum length of the password. By default is equals to 0. - example: 8 - maxRepeatedChars: - type: integer - format: int64 - description: Maximum repetition of the same character in the password. By default is equals to -1. - example: 3 - minLower: - type: integer - format: int64 - description: Minimum amount of lower case character in the password. By default is equals to 0. - example: 8 - minNumeric: - type: integer - format: int64 - description: Minimum amount of numeric characters in the password. By default is equals to 0. - example: 8 - minSpecial: - type: integer - format: int64 - description: Minimum amount of special symbols in the password. By default is equals to 0. - example: 8 - minUpper: - type: integer - format: int64 - description: Minimum amount of upper case symbols in the password. By default is equals to 0. - example: 8 - passwordExpiration: - type: integer - format: int64 - description: Number of days before current password expires. By default is equals to 90. - example: 8 - defaultPolicy: - type: boolean - description: Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. - example: true - default: false - enablePasswdExpiration: - type: boolean - description: Defines whether this policy is enabled to expire or not. This field is false by default. - example: true - default: false - requireStrongAuthn: - type: boolean - description: Defines whether this policy require strong Auth or not. This field is false by default. - example: true - default: false - requireStrongAuthOffNetwork: - type: boolean - description: Defines whether this policy require strong Auth of network or not. This field is false by default. - example: true - default: false - requireStrongAuthUntrustedGeographies: - type: boolean - description: Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. - example: true - default: false - useAccountAttributes: - type: boolean - description: Defines whether this policy uses account attributes or not. This field is false by default. - example: false - default: false - useDictionary: - type: boolean - description: Defines whether this policy uses dictionary or not. This field is false by default. - example: false - default: false - useIdentityAttributes: - type: boolean - description: Defines whether this policy uses identity attributes or not. This field is false by default. - example: false - default: false - validateAgainstAccountId: - type: boolean - description: Defines whether this policy validate against account id or not. This field is false by default. - example: false - default: false - validateAgainstAccountName: - type: boolean - description: Defines whether this policy validate against account name or not. This field is false by default. - example: true - default: false - created: - type: string - nullable: true - modified: - type: string - nullable: true - sourceIds: - type: array - description: List of sources IDs managed by this password policy. - items: - type: string - example: - - 2c91808382ffee0b01830de154f14034 - - 2f98808382ffee0b01830de154f12134 - example: - description: Default Password Policy - id: 2c91808e7d976f3b017d9f5ceae440c8 - name: Example PP - dateCreated: 1639056206564 - lastUpdated: 1662385430753 - firstExpirationReminder: 90 - accountIdMinWordLength: 3 - accountNameMinWordLength: 3 - maxLength: 0 - maxRepeatedChars: 4 - minAlpha: 1 - minCharacterTypes: -1 - minLength: 8 - minLower: 0 - minNumeric: 1 - minSpecial: 0 - minUpper: 0 - passwordExpiration: 90 - defaultPolicy: true - enablePasswdExpiration: false - requireStrongAuthn: false - requireStrongAuthOffNetwork: false - requireStrongAuthUntrustedGeographies: false - useAccountAttributes: false - useDictionary: false - useIdentityAttributes: false - validateAgainstAccountId: true - validateAgainstAccountName: true - sourceIds: - - 2c91808382ffee0b01830de154f14034 - - 2c91808582ffee0c01830de36511405f - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#get-password-policy-by-id - source: | - $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. - - # Get Password Policy by ID - - try { - Get-V2025PasswordPolicyById -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025PasswordPolicyById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicyById" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-policies#get-password-policy-by-id - source: | - from sailpoint.v2025.api.password_policies_api import PasswordPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_policy_v3_dto import PasswordPolicyV3Dto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. - try: - # Get Password Policy by ID - - results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id=id) - # Below is a request that includes all optional parameters - # results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id) - print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) - put: - operationId: setPasswordPolicy - tags: - - Password Policies - summary: Update Password Policy by ID - description: This API updates the specified password policy. - security: - - userAuth: - - idn:password-policy:write - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPasswordPolicies - description: The ID of password policy to update. - example: ff808081838d9e9d01838da6a03e0007 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordPolicyV3Dto.yaml - example: - description: Password Policy after update. - id: 2c91808e7d976f3b017d9f5ceae440c8 - name: Improved Password Policy - dateCreated: 1639056206564 - lastUpdated: 1662385430753 - firstExpirationReminder: 90 - accountIdMinWordLength: 3 - accountNameMinWordLength: 3 - maxLength: 0 - maxRepeatedChars: 4 - minAlpha: 1 - minCharacterTypes: -1 - minLength: 8 - minLower: 0 - minNumeric: 1 - minSpecial: 0 - minUpper: 0 - passwordExpiration: 90 - defaultPolicy: false - enablePasswdExpiration: false - requireStrongAuthn: false - requireStrongAuthOffNetwork: false - requireStrongAuthUntrustedGeographies: false - useAccountAttributes: false - useDictionary: false - useIdentityAttributes: false - validateAgainstAccountId: true - validateAgainstAccountName: true - sourceIds: - - 2c91808382ffee0b01830de154f14034 - - 2c91808582ffee0c01830de36511405f - responses: - '200': - description: Reference to the password policy. - content: - application/json: - schema: - $ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordPolicyV3Dto.yaml - example: - description: Password Policy after update. - id: 2c91808e7d976f3b017d9f5ceae440c8 - name: Improved Password Policy - dateCreated: 1639056206564 - lastUpdated: 1662385430753 - firstExpirationReminder: 90 - accountIdMinWordLength: 3 - accountNameMinWordLength: 3 - maxLength: 0 - maxRepeatedChars: 4 - minAlpha: 1 - minCharacterTypes: -1 - minLength: 8 - minLower: 0 - minNumeric: 1 - minSpecial: 0 - minUpper: 0 - passwordExpiration: 90 - defaultPolicy: false - enablePasswdExpiration: false - requireStrongAuthn: false - requireStrongAuthOffNetwork: false - requireStrongAuthUntrustedGeographies: false - useAccountAttributes: false - useDictionary: false - useIdentityAttributes: false - validateAgainstAccountId: true - validateAgainstAccountName: true - sourceIds: - - 2c91808382ffee0b01830de154f14034 - - 2c91808582ffee0c01830de36511405f - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#set-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : 1939056206564, - "validateAgainstAccountId" : false, - "dateCreated" : 1639056206564, - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Update Password Policy by ID - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025PasswordPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-policies#set-password-policy - source: | - from sailpoint.v2025.api.password_policies_api import PasswordPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_policy_v3_dto import PasswordPolicyV3Dto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ff808081838d9e9d01838da6a03e0007' # str | The ID of password policy to update. # str | The ID of password policy to update. - password_policy_v3_dto = '''{ - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : 1939056206564, - "validateAgainstAccountId" : false, - "dateCreated" : 1639056206564, - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - }''' # PasswordPolicyV3Dto | - try: - # Update Password Policy by ID - new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) - results = PasswordPoliciesApi(api_client).set_password_policy(id=id, password_policy_v3_dto=new_password_policy_v3_dto) - # Below is a request that includes all optional parameters - # results = PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto) - print("The response of PasswordPoliciesApi->set_password_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) - delete: - operationId: deletePasswordPolicy - tags: - - Password Policies - summary: Delete Password Policy by ID - description: This API deletes the specified password policy. - security: - - userAuth: - - idn:password-policy:write - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPasswordPolicies - description: The ID of password policy to delete. - example: ff808081838d9e9d01838da6a03e0002 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#delete-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. - - # Delete Password Policy by ID - - try { - Remove-V2025PasswordPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025PasswordPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PasswordPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-policies#delete-password-policy - source: | - from sailpoint.v2025.api.password_policies_api import PasswordPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. - try: - # Delete Password Policy by ID - - PasswordPoliciesApi(api_client).delete_password_policy(id=id) - # Below is a request that includes all optional parameters - # PasswordPoliciesApi(api_client).delete_password_policy(id) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) - /password-policies: - post: - operationId: createPasswordPolicy - tags: - - Password Policies - summary: Create Password Policy - description: This API creates the specified password policy. - security: - - userAuth: - - idn:password-policy:write - x-sailpoint-userLevels: - - ORG_ADMIN - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordPolicyV3Dto.yaml - example: - description: New Password Policy with high requirements to password complexity. - id: null - name: High security Password Policy - dateCreated: 1639056206564 - lastUpdated: 1662385430753 - firstExpirationReminder: 90 - accountIdMinWordLength: 3 - accountNameMinWordLength: 3 - maxLength: 0 - maxRepeatedChars: 4 - minAlpha: 1 - minCharacterTypes: -1 - minLength: 8 - minLower: 0 - minNumeric: 1 - minSpecial: 0 - minUpper: 0 - passwordExpiration: 90 - defaultPolicy: false - enablePasswdExpiration: false - requireStrongAuthn: false - requireStrongAuthOffNetwork: false - requireStrongAuthUntrustedGeographies: false - useAccountAttributes: false - useDictionary: false - useIdentityAttributes: false - validateAgainstAccountId: true - validateAgainstAccountName: true - sourceIds: - - 2c91808382ffee0b01830de154f14034 - - 2c91808582ffee0c01830de36511405f - responses: - '200': - description: Reference to the password policy. - content: - application/json: - schema: - $ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordPolicyV3Dto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#create-password-policy - source: | - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : 1939056206564, - "validateAgainstAccountId" : false, - "dateCreated" : 1639056206564, - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Create Password Policy - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-policies#create-password-policy - source: | - from sailpoint.v2025.api.password_policies_api import PasswordPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_policy_v3_dto import PasswordPolicyV3Dto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - password_policy_v3_dto = '''{ - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : 1939056206564, - "validateAgainstAccountId" : false, - "dateCreated" : 1639056206564, - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - }''' # PasswordPolicyV3Dto | - try: - # Create Password Policy - new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) - results = PasswordPoliciesApi(api_client).create_password_policy(password_policy_v3_dto=new_password_policy_v3_dto) - # Below is a request that includes all optional parameters - # results = PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto) - print("The response of PasswordPoliciesApi->create_password_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) - get: - operationId: listPasswordPolicies - tags: - - Password Policies - summary: List Password Policies - description: |- - This gets list of all Password Policies. - Requires role of ORG_ADMIN - security: - - userAuth: - - idn:password-policy:read - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - responses: - '200': - description: List of all Password Policies. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordPolicyV3Dto.yaml - example: - - description: Example Password Policy - id: 2c91808e7d976f3b017d9f5ceae440c8 - name: Example PP - dateCreated: 1639056206564 - lastUpdated: 1662385430753 - firstExpirationReminder: 90 - accountIdMinWordLength: 3 - accountNameMinWordLength: 3 - maxLength: 0 - maxRepeatedChars: 4 - minAlpha: 1 - minCharacterTypes: -1 - minLength: 8 - minLower: 0 - minNumeric: 1 - minSpecial: 0 - minUpper: 0 - passwordExpiration: 90 - defaultPolicy: false - enablePasswdExpiration: false - requireStrongAuthn: false - requireStrongAuthOffNetwork: false - requireStrongAuthUntrustedGeographies: false - useAccountAttributes: false - useDictionary: false - useIdentityAttributes: false - validateAgainstAccountId: true - validateAgainstAccountName: true - sourceIds: - - 2c91808382ffee0b01830de154f14034 - - 2c91808582ffee0c01830de36511405f - - description: null - id: 2c91808780b8b8430180ff7a093f3bf2 - name: Password Policy 1 test - dateCreated: 1653553629503 - lastUpdated: null - firstExpirationReminder: null - accountIdMinWordLength: -1 - accountNameMinWordLength: -1 - maxLength: 0 - maxRepeatedChars: -1 - minAlpha: 1 - minCharacterTypes: -1 - minLength: 8 - minLower: 0 - minNumeric: 1 - minSpecial: 0 - minUpper: 0 - passwordExpiration: 90 - defaultPolicy: false - enablePasswdExpiration: false - requireStrongAuthn: false - requireStrongAuthOffNetwork: false - requireStrongAuthUntrustedGeographies: false - useAccountAttributes: false - useDictionary: false - useIdentityAttributes: true - validateAgainstAccountId: false - validateAgainstAccountName: false - sourceIds: [] - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#list-password-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Password Policies - - try { - Get-V2025PasswordPolicies - - # Below is a request that includes all optional parameters - # Get-V2025PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicies" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-policies#list-password-policies - source: | - from sailpoint.v2025.api.password_policies_api import PasswordPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_policy_v3_dto import PasswordPolicyV3Dto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Password Policies - - results = PasswordPoliciesApi(api_client).list_password_policies() - # Below is a request that includes all optional parameters - # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) - print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - /personal-access-tokens: - get: - operationId: listPersonalAccessTokens - security: - - userAuth: - - sp:my-personal-access-tokens:read - - sp:my-personal-access-tokens:manage - - sp:all-personal-access-tokens:read - - sp:all-personal-access-tokens:manage - tags: - - Personal Access Tokens - summary: List Personal Access Tokens - description: This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. - parameters: - - in: query - name: owner-id - description: |- - The identity ID of the owner whose personal access tokens should be listed. If "me", the caller should have the following right: 'idn:my-personal-access-tokens:read' - If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. - If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' - required: false - schema: - type: string - default: null - example: 2c9180867b50d088017b554662fb281e - - in: query - name: filters - required: false - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **lastUsed**: *le, isnull* - example: lastUsed le 2023-02-05T10:59:27.214Z - responses: - '200': - description: List of personal access tokens. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of the personal access token (to be used as the username for Basic Auth). - example: 86f1dc6fe8f54414950454cbb11278fa - name: - type: string - description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - example: NodeJS Integration - scope: - type: array - nullable: true - items: - type: string - default: sp:scopes:all - description: Scopes of the personal access token. - example: - - demo:personal-access-token-scope:first - - demo:personal-access-token-scope:second - owner: - type: object - description: Personal access token owner's identity. - properties: - type: - type: string - description: Personal access token owner's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Personal access token owner's identity ID. - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Personal access token owner's human-readable display name. - example: Support - created: - type: string - format: date-time - description: The date and time, down to the millisecond, when this personal access token was created. - example: '2017-07-11T18:45:37.098Z' - lastUsed: - type: string - nullable: true - format: date-time - description: The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. - example: '2017-07-11T18:45:37.098Z' - managed: - type: boolean - default: false - example: false - description: If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. - required: - - id - - name - - scope - - owner - - created - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#list-personal-access-tokens - source: | - $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - - # List Personal Access Tokens - - try { - Get-V2025PersonalAccessTokens - - # Below is a request that includes all optional parameters - # Get-V2025PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PersonalAccessTokens" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/personal-access-tokens#list-personal-access-tokens - source: | - from sailpoint.v2025.api.personal_access_tokens_api import PersonalAccessTokensApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_personal_access_token_response import GetPersonalAccessTokenResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '2c9180867b50d088017b554662fb281e' # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) - filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - try: - # List Personal Access Tokens - - results = PersonalAccessTokensApi(api_client).list_personal_access_tokens() - # Below is a request that includes all optional parameters - # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) - print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - post: - operationId: createPersonalAccessToken - security: - - userAuth: - - sp:my-personal-access-tokens:manage - - sp:all-personal-access-tokens:manage - tags: - - Personal Access Tokens - summary: Create Personal Access Token - description: This creates a personal access token. - requestBody: - description: Name and scope of personal access token. - required: true - content: - application/json: - schema: - type: object - description: Object for specifying the name of a personal access token to create - properties: - name: - type: string - description: The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. - example: NodeJS Integration - scope: - type: array - nullable: true - items: - type: string - default: sp:scopes:all - description: Scopes of the personal access token. If no scope is specified, the token will be created with the default scope "sp:scopes:all". This means the personal access token will have all the rights of the owner who created it. - example: - - demo:personal-access-token-scope:first - - demo:personal-access-token-scope:second - accessTokenValiditySeconds: - type: integer - format: int32 - minimum: 15 - maximum: 43200 - items: - type: integer - format: int32 - default: 43200 - description: Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - example: 36900 - required: - - name - responses: - '200': - description: Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The ID of the personal access token (to be used as the username for Basic Auth). - example: 86f1dc6fe8f54414950454cbb11278fa - secret: - type: string - description: The secret of the personal access token (to be used as the password for Basic Auth). - example: 1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9 - scope: - type: array - nullable: true - items: - type: string - default: sp:scopes:all - description: Scopes of the personal access token. - example: - - demo:personal-access-token-scope:first - - demo:personal-access-token-scope:second - name: - type: string - description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - example: NodeJS Integration - owner: - $ref: '#/paths/~1personal-access-tokens/get/responses/200/content/application~1json/schema/items/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PatOwner.yaml - created: - type: string - format: date-time - description: The date and time, down to the millisecond, when this personal access token was created. - example: '2017-07-11T18:45:37.098Z' - accessTokenValiditySeconds: - type: integer - format: int32 - items: - type: integer - format: int32 - default: 43200 - description: Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - example: 36900 - required: - - id - - secret - - scope - - name - - owner - - created - - accessTokenValiditySeconds - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#create-personal-access-token - source: | - $CreatePersonalAccessTokenRequest = @" - { - "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], - "accessTokenValiditySeconds" : 36900, - "name" : "NodeJS Integration" - } - "@ - - # Create Personal Access Token - - try { - $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-V2025PersonalAccessToken -CreatePersonalAccessTokenRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025PersonalAccessToken -CreatePersonalAccessTokenRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PersonalAccessToken" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/personal-access-tokens#create-personal-access-token - source: | - from sailpoint.v2025.api.personal_access_tokens_api import PersonalAccessTokensApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest - from sailpoint.v2025.models.create_personal_access_token_response import CreatePersonalAccessTokenResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_personal_access_token_request = '''{ - "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], - "accessTokenValiditySeconds" : 36900, - "name" : "NodeJS Integration" - }''' # CreatePersonalAccessTokenRequest | Name and scope of personal access token. - try: - # Create Personal Access Token - new_create_personal_access_token_request = CreatePersonalAccessTokenRequest.from_json(create_personal_access_token_request) - results = PersonalAccessTokensApi(api_client).create_personal_access_token(create_personal_access_token_request=new_create_personal_access_token_request) - # Below is a request that includes all optional parameters - # results = PersonalAccessTokensApi(api_client).create_personal_access_token(new_create_personal_access_token_request) - print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) - /personal-access-tokens/{id}: - patch: - operationId: patchPersonalAccessToken - security: - - userAuth: - - sp:my-personal-access-tokens:manage - tags: - - Personal Access Tokens - summary: Patch Personal Access Token - description: |- - This performs a targeted update to the field(s) of a Personal Access Token. - Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPersonalAccessTokens - description: The Personal Access Token id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * name - * scope - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /name - value: New name - - op: replace - path: /scope - value: - - sp:scopes:all - responses: - '200': - description: Indicates the PATCH operation succeeded, and returns the PAT's new representation. - content: - application/json: - schema: - $ref: '#/paths/~1personal-access-tokens/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/GetPersonalAccessTokenResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#patch-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Personal Access Token - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025PersonalAccessToken -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025PersonalAccessToken -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PersonalAccessToken" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/personal-access-tokens#patch-personal-access-token - source: | - from sailpoint.v2025.api.personal_access_tokens_api import PersonalAccessTokensApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_personal_access_token_response import GetPersonalAccessTokenResponse - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id - json_patch_operation = '''[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - try: - # Patch Personal Access Token - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation) - print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) - delete: - operationId: deletePersonalAccessToken - security: - - userAuth: - - sp:my-personal-access-tokens:manage - - sp:all-personal-access-tokens:manage - tags: - - Personal Access Tokens - summary: Delete Personal Access Token - description: This deletes a personal access token. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPersonalAccessTokens - description: The personal access token id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: No content. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#delete-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id - - # Delete Personal Access Token - - try { - Remove-V2025PersonalAccessToken -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025PersonalAccessToken -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PersonalAccessToken" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/personal-access-tokens#delete-personal-access-token - source: | - from sailpoint.v2025.api.personal_access_tokens_api import PersonalAccessTokensApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id - try: - # Delete Personal Access Token - - PersonalAccessTokensApi(api_client).delete_personal_access_token(id=id) - # Below is a request that includes all optional parameters - # PersonalAccessTokensApi(api_client).delete_personal_access_token(id) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) - /public-identities: - get: - operationId: getPublicIdentities - tags: - - Public Identities - summary: Get list of public identities - description: Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - security: - - userAuth: - - sp:scopes:default - x-sailpoint-userLevels: - - USER - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - required: false - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **alias**: *eq, sw* - - **email**: *eq, sw* - - **firstname**: *eq, sw* - - **lastname**: *eq, sw* - example: firstname eq "John" - - in: query - name: add-core-filters - description: |- - If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - - Should be either correlated or protected. - - Should not be "spadmin" or "cloudadmin". - - uid should not be null. - - lastname should not be null. - - email should not be null. - required: false - example: false - schema: - type: boolean - default: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - required: false - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - example: name - responses: - '200': - description: A list of public identity objects. - content: - application/json: - schema: - type: array - items: - type: object - title: Public Identity - description: Details about a public identity - properties: - id: - type: string - description: Identity id - example: 2c9180857182305e0171993735622948 - name: - type: string - description: Human-readable display name of identity. - example: Alison Ferguso - alias: - type: string - description: Alternate unique identifier for the identity. - example: alison.ferguso - email: - nullable: true - type: string - description: Email address of identity. - example: alison.ferguso@acme-solar.com - status: - nullable: true - type: string - description: The lifecycle status for the identity - example: Active - identityState: - nullable: true - type: string - enum: - - ACTIVE - - INACTIVE_SHORT_TERM - - INACTIVE_LONG_TERM - - null - example: ACTIVE - description: | - The current state of the identity, which determines how Identity Security Cloud interacts with the identity. - An identity that is Active will be included identity picklists in Request Center, identity processing, and more. - Identities that are Inactive will be excluded from these features. - manager: - type: object - nullable: true - description: The manager for the identity. - properties: - type: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - example: IDENTITY - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of identity. - example: Thomas Edison - attributes: - type: array - description: The public identity attributes of the identity - items: - type: object - properties: - key: - type: string - description: The attribute key - example: country - name: - type: string - description: Human-readable display name of the attribute - example: Country - value: - type: string - description: The attribute value - example: US - nullable: true - example: - - id: 2c9180857182305e0171993735622948 - name: Alison Ferguso - alias: alison.ferguso - email: alison.ferguso@acme-solar.com - status: Active - manager: - type: IDENTITY - id: 2c9180a46faadee4016fb4e018c20639 - name: Thomas Edison - attributes: - - key: phone - name: Phone - value: '5125551234' - - key: country - name: Country - value: US - - id: 2c9180a46faadee4016fb4e018c20639 - name: Thomas Edison - alias: thomas.edison - email: thomas.edison@acme-solar.com - status: Active - manager: - type: IDENTITY - id: 2c918086676d3e0601677611dbde220f - name: Mister Manager - attributes: - - key: phone - name: Phone - value: '5125554321' - - key: country - name: Country - value: US - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/public-identities#get-public-identities - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) - $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Get list of public identities - - try { - Get-V2025PublicIdentities - - # Below is a request that includes all optional parameters - # Get-V2025PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PublicIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/public-identities#get-public-identities - source: | - from sailpoint.v2025.api.public_identities_api import PublicIdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.public_identity import PublicIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'firstname eq \"John\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) - add_core_filters = False # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Get list of public identities - - results = PublicIdentitiesApi(api_client).get_public_identities() - # Below is a request that includes all optional parameters - # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) - print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) - /public-identities-config: - get: - operationId: getPublicIdentityConfig - tags: - - Public Identities Config - summary: Get the Public Identities Configuration - description: Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - description: Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. - properties: - attributes: - type: array - description: Up to 5 identity attributes that will be available to everyone in the org for all users in the org. - items: - type: object - description: Used to map an attribute key for an Identity to its display name. - properties: - key: - type: string - description: The attribute key - example: country - name: - type: string - description: The attribute display name - example: Country - modified: - nullable: true - type: string - description: When this configuration was last modified. - format: date-time - example: '2018-06-25T20:22:28.104Z' - modifiedBy: - $ref: '#/paths/~1public-identities/get/responses/200/content/application~1json/schema/items/properties/manager' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityReference.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/public-identities-config#get-public-identity-config - source: | - - # Get the Public Identities Configuration - - try { - Get-V2025PublicIdentityConfig - - # Below is a request that includes all optional parameters - # Get-V2025PublicIdentityConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PublicIdentityConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/public-identities-config#get-public-identity-config - source: | - from sailpoint.v2025.api.public_identities_config_api import PublicIdentitiesConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.public_identity_config import PublicIdentityConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get the Public Identities Configuration - - results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() - # Below is a request that includes all optional parameters - # results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() - print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) - put: - operationId: updatePublicIdentityConfig - tags: - - Public Identities Config - summary: Update the Public Identities Configuration - description: Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1public-identities-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PublicIdentityConfig.yaml - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - $ref: '#/paths/~1public-identities-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PublicIdentityConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/public-identities-config#update-public-identity-config - source: | - $PublicIdentityConfig = @" - { - "modified" : "2018-06-25T20:22:28.104Z", - "attributes" : [ { - "name" : "Country", - "key" : "country" - }, { - "name" : "Country", - "key" : "country" - } ], - "modifiedBy" : { - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - } - "@ - - # Update the Public Identities Configuration - - try { - $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-V2025PublicIdentityConfig -PublicIdentityConfig $Result - - # Below is a request that includes all optional parameters - # Update-V2025PublicIdentityConfig -PublicIdentityConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PublicIdentityConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/public-identities-config#update-public-identity-config - source: | - from sailpoint.v2025.api.public_identities_config_api import PublicIdentitiesConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.public_identity_config import PublicIdentityConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - public_identity_config = '''{ - "modified" : "2018-06-25T20:22:28.104Z", - "attributes" : [ { - "name" : "Country", - "key" : "country" - }, { - "name" : "Country", - "key" : "country" - } ], - "modifiedBy" : { - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }''' # PublicIdentityConfig | - try: - # Update the Public Identities Configuration - new_public_identity_config = PublicIdentityConfig.from_json(public_identity_config) - results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(public_identity_config=new_public_identity_config) - # Below is a request that includes all optional parameters - # results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config) - print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) - /requestable-objects: - get: - operationId: listRequestableObjects - tags: - - Requestable Objects - summary: Requestable Objects List - security: - - userAuth: - - idn:requestable-objects:read - x-sailpoint-userLevels: - - ORG_ADMIN - description: |- - Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. - Any authenticated token can call this endpoint to see their requestable access items. - parameters: - - in: query - name: identity-id - required: false - schema: - type: string - example: e7eab60924f64aa284175b9fa3309599 - description: |- - If present, the value returns only requestable objects for the specified identity. - * Admin users can call this with any identity ID value. - * Non-admin users can only specify *me* or pass their own identity ID value. - * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - - in: query - name: types - description: Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - required: false - schema: - type: array - items: - $ref: '#/components/schemas/RequestableObject/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RequestableObjectType.yaml - example: ROLE,ACCESS_PROFILE - explode: false - - in: query - name: term - required: false - schema: - type: string - example: Finance Role - description: Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - - in: query - name: statuses - description: Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - required: false - schema: - type: array - items: - $ref: '#/components/schemas/RequestableObject/properties/requestStatus/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RequestableObjectRequestStatus.yaml - explode: false - example: - - ASSIGNED - - PENDING - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - example: name sw "bob" - description: | - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, in, sw* - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - required: false - example: name - description: | - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - responses: - '200': - description: List of requestable objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Id of the requestable object itself - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Human-readable display name of the requestable object - example: Applied Research Access - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - description: The time when the requestable object was created - modified: - nullable: true - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: The time when the requestable object was last modified - description: - type: string - description: Description of the requestable object. - example: Access to research information, lab results, and schematics. - nullable: true - type: - $ref: '#/components/schemas/RequestableObject/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RequestableObjectType.yaml - requestStatus: - allOf: - - $ref: '#/components/schemas/RequestableObject/properties/requestStatus/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RequestableObjectRequestStatus.yaml - - nullable: true - identityRequestId: - type: string - description: If *requestStatus* is *PENDING*, indicates the id of the associated account activity. - nullable: true - example: null - ownerRef: - $ref: '#/components/schemas/RequestableObject/properties/ownerRef' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityReferenceWithNameAndEmail.yaml - requestCommentsRequired: - type: boolean - description: Whether the requester must provide comments when requesting the object. - example: false - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/requestable-objects#list-requestable-objects - source: | - $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) - $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) - - $Types = @"ROLE,ACCESS_PROFILE"@ - $Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) - $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) - - $Statuses = @"[ASSIGNED, PENDING]"@ - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Requestable Objects List - - try { - Get-V2025RequestableObjects - - # Below is a request that includes all optional parameters - # Get-V2025RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RequestableObjects" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/requestable-objects#list-requestable-objects - source: | - from sailpoint.v2025.api.requestable_objects_api import RequestableObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.requestable_object import RequestableObject - from sailpoint.v2025.models.requestable_object_request_status import RequestableObjectRequestStatus - from sailpoint.v2025.models.requestable_object_type import RequestableObjectType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_id = 'e7eab60924f64aa284175b9fa3309599' # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) - types = '''[sailpoint.v2025.RequestableObjectType()]''' # List[RequestableObjectType] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) - term = 'Finance Role' # str | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) # str | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) - statuses = '''[sailpoint.v2025.RequestableObjectRequestStatus()]''' # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name sw \"bob\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Requestable Objects List - - results = RequestableObjectsApi(api_client).list_requestable_objects() - # Below is a request that includes all optional parameters - # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) - print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - /roles: - get: - operationId: listRoles - tags: - - Roles - summary: List Roles - description: |- - This API returns a list of Roles. - - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - parameters: - - in: query - name: for-subadmin - schema: - type: string - description: If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - example: 5168015d32f890ca15812c9180835d2e - required: false - - $ref: '#/paths/~1connector-rules/get/parameters/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit50.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **owner.id**: *eq, in* - - **requestable**: *eq* - example: requestable eq false - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created, modified** - example: name,-modified - required: false - - in: query - name: for-segment-ids - schema: - type: string - format: comma-separated - description: |- - If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. - - If segmentation is currently unavailable, specifying this parameter results in an error. - example: 0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d - required: false - - in: query - name: include-unsegmented - schema: - type: boolean - default: true - description: Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - example: false - required: false - responses: - '200': - description: List of Roles - content: - application/json: - schema: - type: array - items: - type: object - description: A Role - properties: - id: - type: string - description: The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. - example: 2c918086749d78830174a1a40e121518 - name: - type: string - description: The human-readable display name of the Role - maxLength: 128 - example: Role 2567 - created: - type: string - description: Date the Role was created - format: date-time - example: '2021-03-01T22:32:58.104Z' - readOnly: true - modified: - type: string - description: Date the Role was last modified. - format: date-time - example: '2021-03-02T20:22:28.104Z' - readOnly: true - description: - type: string - nullable: true - description: A human-readable description of the Role - example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. - owner: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/OwnerReference.yaml - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the Access Profile - example: ff808081751e6e129f1518161919ecca - type: - type: string - description: Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. - enum: - - ACCESS_PROFILE - example: ACCESS_PROFILE - name: - type: string - description: Human-readable display name of the Access Profile. This field is ignored on input. - example: Access Profile 2567 - nullable: true - entitlements: - type: array - items: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/entitlements/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/EntitlementRef.yaml - membership: - type: object - nullable: true - description: When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. - properties: - type: - type: string - enum: - - STANDARD - - IDENTITY_LIST - description: |- - This enum characterizes the type of a Role's membership selector. Only the following two are fully supported: - - STANDARD: Indicates that Role membership is defined in terms of a criteria expression - - IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed - example: IDENTITY_LIST - criteria: - type: object - nullable: true - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively. - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - nullable: true - description: String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - nullable: true - description: Defines STANDARD type Role membership - properties: - operation: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/operation' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/RoleCriteriaOperation.yaml - key: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/key' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/RoleCriteriaKey.yaml - stringValue: - type: string - nullable: true - description: String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - description: Defines STANDARD type Role membership - properties: - operation: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/operation' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/RoleCriteriaOperation.yaml - key: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/key' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/RoleCriteriaKey.yaml - stringValue: - type: string - description: String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - example: carlee.cert1c9f9b6fd@mailinator.com - nullable: true - description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - nullable: true - description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - identities: - type: array - items: - type: object - description: A reference to an Identity in an IDENTITY_LIST role membership criteria. - properties: - type: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - nullable: true - example: IDENTITY - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - nullable: true - description: Human-readable display name of the Identity. - example: Thomas Edison - aliasName: - type: string - nullable: true - description: User name of the Identity - example: t.edison - nullable: true - description: Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. - legacyMembershipInfo: - type: object - nullable: true - description: This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. - example: - type: IDENTITY_LIST - additionalProperties: true - enabled: - type: boolean - description: Whether the Role is enabled or not. - example: true - default: false - requestable: - type: boolean - description: Whether the Role can be the target of access requests. - example: true - default: false - accessRequestConfig: - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: true - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: true - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the request - items: - type: object - properties: - approverType: - type: string - enum: - - OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - - **OWNER**: Owner of the associated Role - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - revocationRequestConfig: - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: false - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: false - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the revocation request - items: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/accessRequestConfig/properties/approvalSchemes/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/ApprovalSchemeForRole.yaml - segments: - type: array - items: - type: string - nullable: true - description: List of IDs of segments, if any, to which this Role is assigned. - example: - - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - - 29cb6c06-1da8-43ea-8be4-b3125f248f2a - dimensional: - description: Whether the Role is dimensional. - type: boolean - nullable: true - default: false - dimensionRefs: - type: array - items: - type: object - properties: - type: - type: string - enum: - - DIMENSION - description: The type of the object to which this reference applies - example: DIMENSION - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: Role 2 - nullable: true - description: List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. - accessModelMetadata: - type: object - properties: - attributes: - type: array - nullable: true - items: - $ref: '#/paths/~1access-model-metadata~1attributes/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/gov-attributes/AttributeDTO.yaml - example: - - key: iscPrivacy - name: Privacy - multiselect: false - status: active - type: governance - objectTypes: - - all - description: Specifies the level of privacy associated with an access item. - values: - - value: public - name: Public - status: active - required: - - name - - owner - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:read - - idn:role-unchecked:manage - - idn:role-checked:manage - - idn:role-checked:read - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#list-roles - source: | - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) - - # List Roles - - try { - Get-V2025Roles - - # Below is a request that includes all optional parameters - # Get-V2025Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Roles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#list-roles - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role import Role - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) - try: - # List Roles - - results = RolesApi(api_client).list_roles() - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) - print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->list_roles: %s\n" % e) - post: - operationId: createRole - tags: - - Roles - summary: Create a Role - description: |- - This API creates a role. - - You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. - - In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. - - The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/Role.yaml - responses: - '201': - description: Role created - content: - application/json: - schema: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/Role.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:manage - - idn:role-checked:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#create-role - source: | - $Role = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "dimensional" : false, - "created" : "2021-03-01T22:32:58.104Z", - "dimensionRefs" : [ { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - }, { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - } ], - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "membership" : { - "identities" : [ { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } ], - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, - "type" : "IDENTITY_LIST" - }, - "enabled" : true, - "revocationRequestConfig" : { - "commentsRequired" : false, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : false - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "legacyMembershipInfo" : { - "type" : "IDENTITY_LIST" - }, - "accessRequestConfig" : { - "commentsRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "name" : "Role 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "accessModelMetadata" : { - "attributes" : [ { - "key" : "iscPrivacy", - "name" : "Privacy", - "multiselect" : false, - "status" : "active", - "type" : "governance", - "objectTypes" : [ "all" ], - "description" : "Specifies the level of privacy associated with an access item.", - "values" : [ { - "value" : "public", - "name" : "Public", - "status" : "active" - } ] - } ] - }, - "id" : "2c918086749d78830174a1a40e121518", - "requestable" : true - } - "@ - - # Create a Role - - try { - $Result = ConvertFrom-JsonToRole -Json $Role - New-V2025Role -Role $Result - - # Below is a request that includes all optional parameters - # New-V2025Role -Role $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Role" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#create-role - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role import Role - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "dimensional" : false, - "created" : "2021-03-01T22:32:58.104Z", - "dimensionRefs" : [ { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - }, { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - } ], - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "membership" : { - "identities" : [ { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } ], - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, - "type" : "IDENTITY_LIST" - }, - "enabled" : true, - "revocationRequestConfig" : { - "commentsRequired" : false, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : false - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "legacyMembershipInfo" : { - "type" : "IDENTITY_LIST" - }, - "accessRequestConfig" : { - "commentsRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "name" : "Role 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "accessModelMetadata" : { - "attributes" : [ { - "key" : "iscPrivacy", - "name" : "Privacy", - "multiselect" : false, - "status" : "active", - "type" : "governance", - "objectTypes" : [ "all" ], - "description" : "Specifies the level of privacy associated with an access item.", - "values" : [ { - "value" : "public", - "name" : "Public", - "status" : "active" - } ] - } ] - }, - "id" : "2c918086749d78830174a1a40e121518", - "requestable" : true - }''' # Role | - try: - # Create a Role - new_role = Role.from_json(role) - results = RolesApi(api_client).create_role(role=new_role) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).create_role(new_role) - print("The response of RolesApi->create_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->create_role: %s\n" % e) - /roles/{id}: - get: - operationId: getRole - tags: - - Roles - summary: Get a Role - description: |- - This API returns a Role by its ID. - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - description: ID of the Role - example: 2c91808a7813090a017814121e121518 - responses: - '200': - description: List of all Roles - content: - application/json: - schema: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/Role.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:read - - idn:role-unchecked:manage - - idn:role-checked:manage - - idn:role-checked:read - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - - # Get a Role - - try { - Get-V2025Role -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Role -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Role" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#get-role - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role import Role - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role - try: - # Get a Role - - results = RolesApi(api_client).get_role(id=id) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).get_role(id) - print("The response of RolesApi->get_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->get_role: %s\n" % e) - patch: - operationId: patchRole - tags: - - Roles - summary: Patch a specified Role - description: |- - This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - - The following fields are patchable: - - * name - * description - * enabled - * owner - * accessProfiles - * entitlements - * membership - * requestable - * accessRequestConfig - * revokeRequestConfig - * segments - * accessModelMetadata - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - - The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - - When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. - parameters: - - name: id - in: path - description: ID of the Role to patch - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - example: 2c91808a7813090a017814121e121518 - requestBody: - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - examples: - Make a Role Requestable and Enable it in One Call: - description: This example shows how multiple fields may be updated with a single patch call. - value: - - op: replace - path: /requestable - value: true - - op: replace - path: /enabled - value: true - Assign a Role to a Segment: - description: This example illustrates the use of patch to assign a Role to a Segment by adding the Segment's ID to the Role's segments array. - value: - - op: add - path: /segments/- - value: f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - Set the Membership Selection Criteria to a List of Identities: - description: This example shows how to define a Role's membershp by providing a list of Identities, referenced by their IDs. - value: - - op: replace - path: /membership - value: - type: IDENTITY_LIST - identities: - - id: 2c91808973fe906c0174262092014ed9 - - id: 2c918086262092014ed94fb8a47612f3 - Set the Membership Selection Criteria to a Standard Expression: - description: This example shows how to define a Role's membership using STANDARD criteria. In this case, the Role will be granted to all Identities which have the *Engineering* attribute from the indicated Source. - value: - - op: replace - path: /membership - value: - type: STANDARD - criteria: - operation: OR - children: - - operation: EQUALS - key: - type: ENTITLEMENT - property: attribute.memberOf - sourceId: 2c9180887701fb2014213e122092014e - stringValue: Engineering - Add a New Clause as the Child of an Existing Standard Expression: - description: This example shows how to add a child clause to an existing STANDARD criteria expression. - value: - - op: add - path: /membership/criteria/children/- - value: - operation: ENDS_WITH - key: - type: IDENTITY - property: attribute.email - stringValue: '@identitynow.com' - Assign a Access Model Metadata to a Role: - description: This example shows how to assign a existing metadata to a role. - value: - - op: add - path: /accessModelMetadata/attributes/0 - value: - key: iscFederalClassifications - values: - - value: secret - Add an Access Profile to a Role: - description: This example shows how to add an access profile to a role. - value: - - op: add - path: /accessProfiles/- - value: - id: 1de104e1f9024b1289b3a31e22d28cd1 - type: ACCESS_PROFILE - Add an Entitlement to a Role: - description: This example shows how to add an entitlement to a role. - value: - - op: add - path: /entitlements/- - value: - id: 0fb2f8051e48421b8f1f8a64aee3b205 - type: ENTITLEMENT - required: true - responses: - '200': - description: Responds with the Role as updated. - content: - application/json: - schema: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/Role.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:manage - - idn:role-checked:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#patch-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Role - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Role -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Role -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Role" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#patch-role - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.role import Role - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch - json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | - try: - # Patch a specified Role - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).patch_role(id, new_json_patch_operation) - print("The response of RolesApi->patch_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->patch_role: %s\n" % e) - delete: - operationId: deleteRole - tags: - - Roles - summary: Delete a Role - description: |- - This API deletes a Role by its ID. - - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - description: ID of the Role - example: 2c91808a7813090a017814121e121518 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:manage - - idn:role-checked:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - - # Delete a Role - - try { - Remove-V2025Role -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Role -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Role" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#delete-role - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role - try: - # Delete a Role - - RolesApi(api_client).delete_role(id=id) - # Below is a request that includes all optional parameters - # RolesApi(api_client).delete_role(id) - except Exception as e: - print("Exception when calling RolesApi->delete_role: %s\n" % e) - /roles/bulk-delete: - post: - operationId: deleteBulkRoles - summary: Delete Role(s) - tags: - - Roles - description: |- - This endpoint initiates a bulk deletion of one or more roles. - When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. - This endpoint can only bulk delete up to a limit of 50 roles per request. - A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - roleIds: - description: List of IDs of Roles to be deleted. - type: array - items: - type: string - example: - - 2c9180847812e0b1017817051919ecca - - 2c9180887812e0b201781e129f151816 - required: - - roleIds - example: - roleIds: - - 2c91808876438bb2017668b91919ecca - - 2c91808876438ba801766e129f151816 - responses: - '202': - description: Returns an object with the id of the task performing the delete operation. - content: - application/json: - schema: - type: object - description: Task result. - properties: - type: - type: string - description: Task result DTO type. - enum: - - TASK_RESULT - example: TASK_RESULT - id: - type: string - description: Task result ID. - example: 464ae7bf791e49fdb74606a2e4a89635 - name: - type: string - description: Task result display name. - nullable: true - example: null - example: - type: TASK_RESULT - id: 464ae7bf791e49fdb74606a2e4a89635 - name: null - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml - examples: - 400.1 Bad Request Content: - description: Response for bad request content - value: - detailCode: 400.1 Bad Request Content - trackingId: 1ea1adcb84da4dcb890145e05745774e - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The request was syntactically correct but its content is semantically invalid. - 400.1 Role ids limit violation: - description: Role ids limit violation response - value: - detailCode: 400.1 Bad Request Content - trackingId: 77aa89ac6f0e422dbc588866abc22be9 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: roleIds count exceeded max limit of 50 for bulk-delete. - 400.1.404 Referenced object not found: - description: Referenced object not found response - value: - detailCode: 400.1.404 Referenced object not found - trackingId: 77aa89ac6f0e422dbc588866abc22be9 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: Referenced roleIds ["2c91808876438bb2017668b91919ecca"] was not found. - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:manage - - idn:role-checked:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-bulk-roles - source: | - $RoleBulkDeleteRequest = @" - { - "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - } - "@ - - # Delete Role(s) - - try { - $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-V2025BulkRoles -RoleBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025BulkRoles -RoleBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025BulkRoles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#delete-bulk-roles - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_bulk_delete_request import RoleBulkDeleteRequest - from sailpoint.v2025.models.task_result_dto import TaskResultDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_bulk_delete_request = '''{ - "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - }''' # RoleBulkDeleteRequest | - try: - # Delete Role(s) - new_role_bulk_delete_request = RoleBulkDeleteRequest.from_json(role_bulk_delete_request) - results = RolesApi(api_client).delete_bulk_roles(role_bulk_delete_request=new_role_bulk_delete_request) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request) - print("The response of RolesApi->delete_bulk_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) - /roles/{id}/assigned-identities: - get: - operationId: getRoleAssignedIdentities - tags: - - Roles - summary: List Identities assigned a Role - parameters: - - in: path - name: id - schema: - type: string - description: ID of the Role for which the assigned Identities are to be listed - example: 2c91808a7813090a017814121e121518 - required: true - x-sailpoint-resource-operation-id: listRoles - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **aliasName**: *eq, sw* - - **email**: *eq, sw* - - **name**: *eq, sw, co* - example: name sw Joe - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, aliasName, email** - example: aliasName,name - responses: - '200': - description: List of Identities assigned the Role - content: - application/json: - schema: - type: array - items: - type: object - description: A subset of the fields of an Identity which is a member of a Role. - properties: - id: - type: string - description: The ID of the Identity - example: 2c9180a46faadee4016fb4e018c20639 - aliasName: - type: string - description: The alias / username of the Identity - example: t.edison - name: - type: string - description: The human-readable display name of the Identity - example: Thomas Edison - email: - type: string - description: Email address of the Identity - example: t.edison@identitynow.com - roleAssignmentSource: - type: string - enum: - - ACCESS_REQUEST - - ROLE_MEMBERSHIP - description: Type which indicates how a particular Identity obtained a particular Role - example: ACCESS_REQUEST - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:read - - idn:role-unchecked:manage - - idn:role-checked:manage - - idn:role-checked:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role-assigned-identities - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) - $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) - - # List Identities assigned a Role - - try { - Get-V2025RoleAssignedIdentities -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignedIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#get-role-assigned-identities - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_identity import RoleIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role for which the assigned Identities are to be listed # str | ID of the Role for which the assigned Identities are to be listed - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name sw Joe' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) - sorters = 'aliasName,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) - try: - # List Identities assigned a Role - - results = RolesApi(api_client).get_role_assigned_identities(id=id) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) - print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - /roles/{roleId}/dimensions: - get: - operationId: listDimensions - tags: - - Dimensions - summary: List Dimensions - description: |- - This API returns a list of dimensions under a specified role. - - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - parameters: - - in: path - name: roleId - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - description: Parent Role Id of the dimension. - example: 6603fba3004f43c687610a29195252ce - - in: query - name: for-subadmin - schema: - type: string - description: If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - example: 5168015d32f890ca15812c9180835d2e - required: false - - $ref: '#/paths/~1connector-rules/get/parameters/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit50.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **owner.id**: *eq, in* - example: id eq '2c918086749d78830174a1a40e121518' - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created, modified** - example: name,-modified - required: false - responses: - '200': - description: List of Dimensions - content: - application/json: - schema: - type: array - items: - type: object - description: A Dimension - properties: - id: - type: string - description: The id of the Dimension. This field must be left null when creating a dimension, otherwise a 400 Bad Request error will result. - example: 2c918086749d78830174a1a40e121518 - name: - type: string - description: The human-readable display name of the Dimension - maxLength: 128 - example: Dimension 2567 - created: - type: string - description: Date the Dimension was created - format: date-time - example: '2021-03-01T22:32:58.104Z' - readOnly: true - modified: - type: string - description: Date the Dimension was last modified. - format: date-time - example: '2021-03-02T20:22:28.104Z' - readOnly: true - description: - type: string - nullable: true - description: A human-readable description of the Dimension - example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. - owner: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/OwnerReference.yaml - accessProfiles: - type: array - items: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/accessProfiles/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/AccessProfileRef.yaml - nullable: true - entitlements: - type: array - items: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/entitlements/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/EntitlementRef.yaml - membership: - type: object - nullable: true - description: When present, specifies that the Dimension is to be granted to Identities which either satisfy specific criteria. - properties: - type: - type: string - enum: - - STANDARD - description: |- - This enum characterizes the type of a Dimension's membership selector. Only the STANDARD type supported: - - STANDARD: Indicates that Dimension membership is defined in terms of a criteria expression - example: STANDARD - criteria: - type: object - nullable: true - description: Defines STANDARD type Dimension membership - properties: - operation: - type: string - enum: - - EQUALS - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: Refers to a specific Identity attribute used in Dimension membership criteria. - properties: - type: - type: string - enum: - - IDENTITY - description: Indicates whether the associated criteria represents an expression on identity attributes. - example: IDENTITY - property: - type: string - description: The name of the identity attribute to which the associated criteria applies. - example: attribute.email - required: - - type - - property - stringValue: - type: string - nullable: true - description: String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is EQUALS, this field is required. Otherwise, specifying it is an error. - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - nullable: true - description: Defines STANDARD type Role membership - properties: - operation: - $ref: '#/paths/~1roles~1%7BroleId%7D~1dimensions/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/operation' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/DimensionCriteriaOperation.yaml - key: - $ref: '#/paths/~1roles~1%7BroleId%7D~1dimensions/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/key' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/DimensionCriteriaKey.yaml - stringValue: - type: string - nullable: true - description: String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - description: Defines STANDARD type Dimension membership - properties: - operation: - $ref: '#/paths/~1roles~1%7BroleId%7D~1dimensions/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/operation' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/DimensionCriteriaOperation.yaml - key: - $ref: '#/paths/~1roles~1%7BroleId%7D~1dimensions/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/key' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/DimensionCriteriaKey.yaml - stringValue: - type: string - description: String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. - example: carlee.cert1c9f9b6fd@mailinator.com - nullable: true - description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - nullable: true - description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - parentId: - type: string - nullable: true - description: The ID of the parent role. This field can be left null when creating a dimension, but if provided, it must match the role ID specified in the path variable of the API call. - example: 2c918086749d78830174a1a40e121518 - required: - - name - - owner - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:read - - idn:role-unchecked:manage - - idn:role-checked:manage - - idn:role-checked:read - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#list-dimensions - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq '2c918086749d78830174a1a40e121518'" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Dimensions - - try { - Get-V2025Dimensions -RoleId $RoleId - - # Below is a request that includes all optional parameters - # Get-V2025Dimensions -RoleId $RoleId -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Dimensions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#list-dimensions - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.dimension import Dimension - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \'2c918086749d78830174a1a40e121518\'' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - try: - # List Dimensions - - results = DimensionsApi(api_client).list_dimensions(role_id=role_id) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) - print("The response of DimensionsApi->list_dimensions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) - post: - operationId: createDimension - tags: - - Dimensions - summary: Create a Dimension - description: |- - This API creates a dimension. - You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. - Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. - The maximum supported length for the description field is 2000 characters. - parameters: - - in: path - name: roleId - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - description: Parent Role Id of the dimension. - example: 6603fba3004f43c687610a29195252ce - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1roles~1%7BroleId%7D~1dimensions/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/Dimension.yaml - responses: - '201': - description: Dimension created - content: - application/json: - schema: - $ref: '#/paths/~1roles~1%7BroleId%7D~1dimensions/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/Dimension.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:manage - - idn:role-checked:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#create-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $Dimension = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "name" : "Dimension 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "id" : "2c918086749d78830174a1a40e121518", - "membership" : { - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, - "type" : "STANDARD" - }, - "parentId" : "2c918086749d78830174a1a40e121518" - } - "@ - - # Create a Dimension - - try { - $Result = ConvertFrom-JsonToDimension -Json $Dimension - New-V2025Dimension -RoleId $RoleId -Dimension $Result - - # Below is a request that includes all optional parameters - # New-V2025Dimension -RoleId $RoleId -Dimension $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Dimension" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#create-dimension - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.dimension import Dimension - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "name" : "Dimension 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "id" : "2c918086749d78830174a1a40e121518", - "membership" : { - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, - "type" : "STANDARD" - }, - "parentId" : "2c918086749d78830174a1a40e121518" - }''' # Dimension | - try: - # Create a Dimension - new_dimension = Dimension.from_json(dimension) - results = DimensionsApi(api_client).create_dimension(role_id=role_id, dimension=new_dimension) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).create_dimension(role_id, new_dimension) - print("The response of DimensionsApi->create_dimension:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->create_dimension: %s\n" % e) - /roles/{roleId}/dimensions/{dimensionId}: - get: - operationId: getDimension - tags: - - Dimensions - summary: Get a Dimension under Role. - description: |- - This API returns a Dimension by its ID. - - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - parameters: - - in: path - name: roleId - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - description: Parent Role Id of the dimension. - example: 6603fba3004f43c687610a29195252ce - - in: path - name: dimensionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listDimensions - description: Id of the Dimension - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: Dimension - content: - application/json: - schema: - $ref: '#/paths/~1roles~1%7BroleId%7D~1dimensions/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/Dimension.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:read - - idn:role-unchecked:manage - - idn:role-checked:manage - - idn:role-checked:read - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#get-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - - # Get a Dimension under Role. - - try { - Get-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Get-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Dimension" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#get-dimension - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.dimension import Dimension - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension - try: - # Get a Dimension under Role. - - results = DimensionsApi(api_client).get_dimension(role_id=role_id, dimension_id=dimension_id) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).get_dimension(role_id, dimension_id) - print("The response of DimensionsApi->get_dimension:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->get_dimension: %s\n" % e) - patch: - operationId: patchDimension - tags: - - Dimensions - summary: Patch a specified Dimension - description: |- - This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - The maximum supported length for the description field is 2000 characters. - When you use this API to modify a dimension's membership identities, you can only modify up to a limit of 500 membership identities at a time. - parameters: - - in: path - name: roleId - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - description: Parent Role Id of the dimension. - example: 6603fba3004f43c687610a29195252ce - - in: path - name: dimensionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listDimensions - description: Id of the Dimension - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - examples: - Update a Dimension name and description field in One Call: - description: This example shows how multiple fields may be updated with a single patch call. - value: - - op: replace - path: /description - value: Test Description - - op: replace - path: /name - value: new name - Set the Membership Selection Criteria to a List of Identities: - description: This example shows how to define a Dimension's membershp by providing a list of Identities, referenced by their IDs. - value: - - op: replace - path: /membership - value: - type: IDENTITY_LIST - identities: - - id: 2c91808973fe906c0174262092014ed9 - - id: 2c918086262092014ed94fb8a47612f3 - Set the Membership Selection Criteria to a Standard Expression: - description: This example shows how to define a Dimensions's membership using STANDARD criteria. In this case, the Dimension will be granted to all Identities which have the *Engineering* attribute from the indicated Source. - value: - - op: replace - path: /membership - value: - type: STANDARD - criteria: - operation: OR - children: - - operation: EQUALS - key: - type: ENTITLEMENT - property: attribute.memberOf - sourceId: 2c9180887701fb2014213e122092014e - stringValue: Engineering - Add a New Clause as the Child of an Existing Standard Expression: - description: This example shows how to add a child clause to an existing STANDARD criteria expression. - value: - - op: add - path: /membership/criteria/children/- - value: - operation: ENDS_WITH - key: - type: IDENTITY - property: attribute.email - stringValue: '@identitynow.com' - required: true - responses: - '200': - description: Responds with the Dimension as updated. - content: - application/json: - schema: - $ref: '#/paths/~1roles~1%7BroleId%7D~1dimensions/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/Dimension.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:manage - - idn:role-checked:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#patch-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Dimension - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Dimension" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#patch-dimension - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.dimension import Dimension - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension - json_patch_operation = '''[{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}]''' # List[JsonPatchOperation] | - try: - # Patch a specified Dimension - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = DimensionsApi(api_client).patch_dimension(role_id=role_id, dimension_id=dimension_id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).patch_dimension(role_id, dimension_id, new_json_patch_operation) - print("The response of DimensionsApi->patch_dimension:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->patch_dimension: %s\n" % e) - delete: - operationId: deleteDimension - tags: - - Dimensions - summary: Delete a Dimension - description: |- - This API deletes a Dimension by its ID. - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - parameters: - - in: path - name: roleId - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - description: Parent Role Id of the dimension. - example: 6603fba3004f43c687610a29195252ce - - in: path - name: dimensionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listDimensions - description: Id of the Dimension - example: 2c9180835d191a86015d28455b4a2329 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:manage - - idn:role-checked:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#delete-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - - # Delete a Dimension - - try { - Remove-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Remove-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Dimension" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#delete-dimension - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension - try: - # Delete a Dimension - - DimensionsApi(api_client).delete_dimension(role_id=role_id, dimension_id=dimension_id) - # Below is a request that includes all optional parameters - # DimensionsApi(api_client).delete_dimension(role_id, dimension_id) - except Exception as e: - print("Exception when calling DimensionsApi->delete_dimension: %s\n" % e) - /roles/{roleId}/dimensions/bulk-delete: - post: - operationId: deleteBulkDimensions - summary: Delete Dimension(s) - tags: - - Dimensions - description: |- - This endpoint initiates a bulk deletion of one or more dimensions. - When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. - This endpoint can only bulk delete up to a limit of 50 roles per request. - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - parameters: - - in: path - name: roleId - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - description: Parent Role Id of the dimensions. - example: 6603fba3004f43c687610a29195252ce - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - dimensionIds: - description: List of IDs of Dimensions to be deleted. - type: array - items: - type: string - example: - - 2c9180847812e0b1017817051919ecca - - 2c9180887812e0b201781e129f151816 - required: - - dimensionIds - example: - dimensionIds: - - 2c91808876438bb2017668b91919ecca - - 2c91808876438ba801766e129f151816 - responses: - '202': - description: Returns an object with the id of the task performing the delete operation. - content: - application/json: - schema: - $ref: '#/paths/~1roles~1bulk-delete/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskResultDto.yaml - example: - type: TASK_RESULT - id: 464ae7bf791e49fdb74606a2e4a89635 - name: null - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml - examples: - 400.1 Bad Request Content: - description: Response for bad request content - value: - detailCode: 400.1 Bad Request Content - trackingId: 1ea1adcb84da4dcb890145e05745774e - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The request was syntactically correct but its content is semantically invalid. - 400.1 Dimension ids limit violation: - description: Dimension ids limit violation response - value: - detailCode: 400.1 Bad Request Content - trackingId: 77aa89ac6f0e422dbc588866abc22be9 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: dimensionIds count exceeded max limit of 50 for bulk-delete. - 400.1.404 Referenced object not found: - description: Referenced object not found response - value: - detailCode: 400.1.404 Referenced object not found - trackingId: 77aa89ac6f0e422dbc588866abc22be9 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: Referenced dimensionIds ["2c91808876438bb2017668b91919ecca"] was not found. - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:manage - - idn:role-checked:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#delete-bulk-dimensions - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimensions. - $DimensionBulkDeleteRequest = @" - { - "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - } - "@ - - # Delete Dimension(s) - - try { - $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest - Remove-V2025BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025BulkDimensions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#delete-bulk-dimensions - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.dimension_bulk_delete_request import DimensionBulkDeleteRequest - from sailpoint.v2025.models.task_result_dto import TaskResultDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimensions. # str | Parent Role Id of the dimensions. - dimension_bulk_delete_request = '''{ - "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - }''' # DimensionBulkDeleteRequest | - try: - # Delete Dimension(s) - new_dimension_bulk_delete_request = DimensionBulkDeleteRequest.from_json(dimension_bulk_delete_request) - results = DimensionsApi(api_client).delete_bulk_dimensions(role_id=role_id, dimension_bulk_delete_request=new_dimension_bulk_delete_request) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).delete_bulk_dimensions(role_id, new_dimension_bulk_delete_request) - print("The response of DimensionsApi->delete_bulk_dimensions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->delete_bulk_dimensions: %s\n" % e) - /roles/{roleId}/dimensions/{dimensionId}/access-profiles: - get: - operationId: listDimensionAccessProfiles - tags: - - Dimensions - summary: List Dimension's Access Profiles - description: |- - This API lists the Access Profiles associated with a given Dimension - - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - parameters: - - in: path - name: roleId - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - description: Parent Role Id of the dimension. - example: 6603fba3004f43c687610a29195252ce - - in: path - name: dimensionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listDimensions - description: Id of the Dimension - example: 2c9180835d191a86015d28455b4a2329 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **owner.id**: *eq, in* - - **source.id**: *eq, in* - example: source.id eq "2c91808982f979270182f99e386d00fa" - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created, modified** - example: name,-modified - required: false - responses: - '200': - description: List of Access Profiles - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:read - - idn:role-unchecked:manage - - idn:role-checked:manage - - idn:role-checked:read - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#list-dimension-access-profiles - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "source.id eq "2c91808982f979270182f99e386d00fa"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Dimension's Access Profiles - - try { - Get-V2025DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Get-V2025DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DimensionAccessProfiles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#list-dimension-access-profiles - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile import AccessProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'source.id eq \"2c91808982f979270182f99e386d00fa\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - try: - # List Dimension's Access Profiles - - results = DimensionsApi(api_client).list_dimension_access_profiles(role_id=role_id, dimension_id=dimension_id) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) - print("The response of DimensionsApi->list_dimension_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) - /roles/{roleId}/dimensions/{dimensionId}/entitlements: - get: - operationId: getDimensionEntitlements - tags: - - Dimensions - summary: List Dimension's Entitlements - description: |- - This API lists the Entitlements associated with a given dimension. - - A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - parameters: - - in: path - name: roleId - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - description: Parent Role Id of the dimension. - example: 6603fba3004f43c687610a29195252ce - - in: path - name: dimensionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listDimensions - description: Id of the Dimension - example: 2c9180835d191a86015d28455b4a2329 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **attribute**: *eq, sw* - - **value**: *eq, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **owner.id**: *eq, in* - - **source.id**: *eq, in* - example: attribute eq "memberOf" - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, attribute, value, created, modified** - example: name,-modified - required: false - responses: - '200': - description: List of Entitlements - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:read - - idn:role-unchecked:manage - - idn:role-checked:manage - - idn:role-checked:read - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#get-dimension-entitlements - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Dimension's Entitlements - - try { - Get-V2025DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Get-V2025DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DimensionEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/dimensions#get-dimension-entitlements - source: | - from sailpoint.v2025.api.dimensions_api import DimensionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'attribute eq \"memberOf\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - try: - # List Dimension's Entitlements - - results = DimensionsApi(api_client).get_dimension_entitlements(role_id=role_id, dimension_id=dimension_id) - # Below is a request that includes all optional parameters - # results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) - print("The response of DimensionsApi->get_dimension_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) - /saved-searches: - post: - security: - - userAuth: - - sp:saved-search:create - tags: - - Saved Search - description: | - Creates a new saved search. - summary: Create a saved search - operationId: createSavedSearch - requestBody: - description: The saved search to persist. - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/SavedSearch/allOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/saved/SavedSearchName.yaml - - $ref: '#/components/schemas/SavedSearch/allOf/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/saved/SavedSearchDetail.yaml - required: true - responses: - '201': - description: The persisted saved search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - $ref: '#/components/schemas/SavedSearch/allOf/0/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/TypedReference.yaml - ownerId: - type: string - description: The ID of the identity that owns this saved search. - example: 2c91808568c529c60168cca6f90c1313 - public: - type: boolean - description: Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. - default: false - example: false - - $ref: '#/components/schemas/SavedSearch/allOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/saved/SavedSearchName.yaml - - $ref: '#/components/schemas/SavedSearch/allOf/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/saved/SavedSearchDetail.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#create-saved-search - source: | - $CreateSavedSearchRequest = @" - - "@ - - # Create a saved search - - try { - $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-V2025SavedSearch -CreateSavedSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025SavedSearch -CreateSavedSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SavedSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/saved-search#create-saved-search - source: | - from sailpoint.v2025.api.saved_search_api import SavedSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_saved_search_request import CreateSavedSearchRequest - from sailpoint.v2025.models.saved_search import SavedSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_saved_search_request = '''sailpoint.v2025.CreateSavedSearchRequest()''' # CreateSavedSearchRequest | The saved search to persist. - try: - # Create a saved search - new_create_saved_search_request = CreateSavedSearchRequest.from_json(create_saved_search_request) - results = SavedSearchApi(api_client).create_saved_search(create_saved_search_request=new_create_saved_search_request) - # Below is a request that includes all optional parameters - # results = SavedSearchApi(api_client).create_saved_search(new_create_saved_search_request) - print("The response of SavedSearchApi->create_saved_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) - get: - security: - - userAuth: - - sp:saved-search:read - tags: - - Saved Search - description: | - Returns a list of saved searches. - summary: A list of Saved Searches - operationId: listSavedSearches - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: filters - in: query - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **owner.id**: *eq* - example: owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8" - responses: - '200': - description: The list of requested saved searches. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1saved-searches/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/saved/SavedSearch.yaml - headers: - X-Total-Count: - description: The total result count (returned only if the *count* parameter is specified as *true*). - schema: - type: integer - example: 5 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#list-saved-searches - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) - - # A list of Saved Searches - - try { - Get-V2025SavedSearches - - # Below is a request that includes all optional parameters - # Get-V2025SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedSearches" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/saved-search#list-saved-searches - source: | - from sailpoint.v2025.api.saved_search_api import SavedSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.saved_search import SavedSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'owner.id eq \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) - try: - # A list of Saved Searches - - results = SavedSearchApi(api_client).list_saved_searches() - # Below is a request that includes all optional parameters - # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) - print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) - /saved-searches/{id}: - put: - tags: - - Saved Search - description: | - Updates an existing saved search. - - >**NOTE: You cannot update the `owner` of the saved search.** - summary: | - Updates an existing saved search - operationId: putSavedSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: listSavedSearches - requestBody: - description: The saved search to persist. - content: - application/json: - schema: - $ref: '#/paths/~1saved-searches/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/saved/SavedSearch.yaml - required: true - responses: - '200': - description: The persisted saved search. - content: - application/json: - schema: - $ref: '#/paths/~1saved-searches/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/saved/SavedSearch.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#put-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SavedSearch = @" - { - "owner" : { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2018-06-25T20:22:28.104Z", - "columns" : { - "identity" : [ { - "field" : "displayName", - "header" : "Display Name" - }, { - "field" : "e-mail", - "header" : "Work Email" - } ] - }, - "query" : "@accounts(disabled:true)", - "description" : "Disabled accounts", - "orderBy" : { - "identity" : [ "lastName", "firstName" ], - "role" : [ "name" ] - }, - "sort" : [ "displayName" ], - "filters" : { - "terms" : [ "account_count", "account_count" ], - "range" : { - "lower" : { - "inclusive" : false, - "value" : "1" - }, - "upper" : { - "inclusive" : false, - "value" : "1" - } - }, - "exclude" : false, - "type" : "RANGE" - }, - "ownerId" : "2c91808568c529c60168cca6f90c1313", - "indices" : [ "identities" ], - "public" : false, - "name" : "Disabled accounts", - "modified" : "2018-06-25T20:22:28.104Z", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "fields" : [ "disabled" ] - } - "@ - - # Updates an existing saved search - - try { - $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-V2025SavedSearch -Id $Id -SavedSearch $Result - - # Below is a request that includes all optional parameters - # Send-V2025SavedSearch -Id $Id -SavedSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SavedSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/saved-search#put-saved-search - source: | - from sailpoint.v2025.api.saved_search_api import SavedSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.saved_search import SavedSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - saved_search = '''{ - "owner" : { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2018-06-25T20:22:28.104Z", - "columns" : { - "identity" : [ { - "field" : "displayName", - "header" : "Display Name" - }, { - "field" : "e-mail", - "header" : "Work Email" - } ] - }, - "query" : "@accounts(disabled:true)", - "description" : "Disabled accounts", - "orderBy" : { - "identity" : [ "lastName", "firstName" ], - "role" : [ "name" ] - }, - "sort" : [ "displayName" ], - "filters" : { - "terms" : [ "account_count", "account_count" ], - "range" : { - "lower" : { - "inclusive" : false, - "value" : "1" - }, - "upper" : { - "inclusive" : false, - "value" : "1" - } - }, - "exclude" : false, - "type" : "RANGE" - }, - "ownerId" : "2c91808568c529c60168cca6f90c1313", - "indices" : [ "identities" ], - "public" : false, - "name" : "Disabled accounts", - "modified" : "2018-06-25T20:22:28.104Z", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "fields" : [ "disabled" ] - }''' # SavedSearch | The saved search to persist. - try: - # Updates an existing saved search - new_saved_search = SavedSearch.from_json(saved_search) - results = SavedSearchApi(api_client).put_saved_search(id=id, saved_search=new_saved_search) - # Below is a request that includes all optional parameters - # results = SavedSearchApi(api_client).put_saved_search(id, new_saved_search) - print("The response of SavedSearchApi->put_saved_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) - get: - tags: - - Saved Search - description: | - Returns the specified saved search. - summary: Return saved search by ID - operationId: getSavedSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: listSavedSearches - responses: - '200': - description: The requested saved search. - content: - application/json: - schema: - $ref: '#/paths/~1saved-searches/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/saved/SavedSearch.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#get-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Return saved search by ID - - try { - Get-V2025SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/saved-search#get-saved-search - source: | - from sailpoint.v2025.api.saved_search_api import SavedSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.saved_search import SavedSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - try: - # Return saved search by ID - - results = SavedSearchApi(api_client).get_saved_search(id=id) - # Below is a request that includes all optional parameters - # results = SavedSearchApi(api_client).get_saved_search(id) - print("The response of SavedSearchApi->get_saved_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) - delete: - tags: - - Saved Search - description: | - Deletes the specified saved search. - summary: Delete document by ID - operationId: deleteSavedSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: listSavedSearches - responses: - '204': - description: No Content - Indicates the request was successful but there is no content to be returned in the response. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#delete-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete document by ID - - try { - Remove-V2025SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SavedSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/saved-search#delete-saved-search - source: | - from sailpoint.v2025.api.saved_search_api import SavedSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - try: - # Delete document by ID - - SavedSearchApi(api_client).delete_saved_search(id=id) - # Below is a request that includes all optional parameters - # SavedSearchApi(api_client).delete_saved_search(id) - except Exception as e: - print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) - /saved-searches/{id}/execute: - post: - tags: - - Saved Search - description: | - Executes the specified saved search. - summary: Execute a saved search by ID - operationId: executeSavedSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: - - listAccessProfiles - - listAccountActivities - - listEntitlements - - listRoles - - listIdentities - requestBody: - description: | - When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. - - If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - content: - application/json: - schema: - type: object - properties: - scheduleId: - description: | - The ID of the scheduled search that triggered the saved search execution. - type: string - example: 7a724640-0c17-4ce9-a8c3-4a89738459c8 - owner: - description: | - The owner of the scheduled search being tested. - allOf: - - $ref: '#/components/schemas/SavedSearch/allOf/0/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/TypedReference.yaml - recipients: - description: | - The email recipients of the scheduled search being tested. - type: array - items: - $ref: '#/components/schemas/SavedSearch/allOf/0/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/TypedReference.yaml - examples: - scheduled: - summary: Triggered by Scheduled Search - value: - scheduleId: 7a724640-0c17-4ce9-a8c3-4a89738459c8 - test: - summary: Triggered by UI Test - value: - owner: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - recipients: - - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - required: true - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#execute-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SearchArguments = @" - { - "owner" : "", - "recipients" : [ { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - } - "@ - - # Execute a saved search by ID - - try { - $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-V2025ExecuteSavedSearch -Id $Id -SearchArguments $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025ExecuteSavedSearch -Id $Id -SearchArguments $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ExecuteSavedSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/saved-search#execute-saved-search - source: | - from sailpoint.v2025.api.saved_search_api import SavedSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.search_arguments import SearchArguments - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - search_arguments = '''{ - "owner" : "", - "recipients" : [ { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - }''' # SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - try: - # Execute a saved search by ID - new_search_arguments = SearchArguments.from_json(search_arguments) - SavedSearchApi(api_client).execute_saved_search(id=id, search_arguments=new_search_arguments) - # Below is a request that includes all optional parameters - # SavedSearchApi(api_client).execute_saved_search(id, new_search_arguments) - except Exception as e: - print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e) - /scheduled-searches: - post: - tags: - - Scheduled Search - description: | - Creates a new scheduled search. - summary: Create a new scheduled search - operationId: createScheduledSearch - requestBody: - description: The scheduled search to persist. - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ScheduledSearch/allOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/scheduled/ScheduledSearchName.yaml - - $ref: '#/components/schemas/ScheduledSearch/allOf/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/scheduled/SearchSchedule.yaml - examples: - Daily Search: - description: A search that executes each day at a 9 AM - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: DAILY - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - Weekly Search: - description: A search that executes each week on select days and times - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: WEEKLY - days: - type: LIST - values: - - MON - - TUE - - WED - - THU - - FRI - - SAT - - SUN - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - Monthly Search: - description: A search that executes each month on select days and times - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: MONTHLY - days: - type: LIST - values: - - '1' - - '7' - - '14' - - L - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - Annual Search: - description: A search that executes each year on the defined months, days, and times. - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: ANNUALLY - months: - type: LIST - values: - - '1' - interval: 3 - days: - type: LIST - values: - - '1' - - '7' - - '14' - - L - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - Calendar Search: - description: A search that executes on specific calendar days - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: CALENDAR - days: - type: LIST - values: - - '2023-01-22' - - '2023-02-22' - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - required: true - responses: - '201': - description: The persisted scheduled search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - readOnly: true - owner: - description: The owner of the scheduled search - readOnly: true - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - ownerId: - description: | - The ID of the scheduled search owner. - - Please use the `id` in the `owner` object instead. - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - readOnly: true - deprecated: true - - $ref: '#/components/schemas/ScheduledSearch/allOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/scheduled/ScheduledSearchName.yaml - - $ref: '#/components/schemas/ScheduledSearch/allOf/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/scheduled/SearchSchedule.yaml - required: - - id - - owner - - ownerId - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#create-scheduled-search - source: | - $CreateScheduledSearchRequest = @" - {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} - "@ - - # Create a new scheduled search - - try { - $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-V2025ScheduledSearch -CreateScheduledSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ScheduledSearch -CreateScheduledSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/scheduled-search#create-scheduled-search - source: | - from sailpoint.v2025.api.scheduled_search_api import ScheduledSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_scheduled_search_request import CreateScheduledSearchRequest - from sailpoint.v2025.models.scheduled_search import ScheduledSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_scheduled_search_request = '''{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}''' # CreateScheduledSearchRequest | The scheduled search to persist. - try: - # Create a new scheduled search - new_create_scheduled_search_request = CreateScheduledSearchRequest.from_json(create_scheduled_search_request) - results = ScheduledSearchApi(api_client).create_scheduled_search(create_scheduled_search_request=new_create_scheduled_search_request) - # Below is a request that includes all optional parameters - # results = ScheduledSearchApi(api_client).create_scheduled_search(new_create_scheduled_search_request) - print("The response of ScheduledSearchApi->create_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) - get: - tags: - - Scheduled Search - description: | - Returns a list of scheduled searches. - summary: List scheduled searches - operationId: listScheduledSearch - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: filters - in: query - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **owner.id**: *eq* - - **savedSearchId**: *eq* - example: savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e" - responses: - '200': - description: The list of requested scheduled searches. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1scheduled-searches/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/scheduled/ScheduledSearch.yaml - headers: - X-Total-Count: - description: The total result count (returned only if the *count* parameter is specified as *true*). - schema: - type: integer - example: 5 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#list-scheduled-search - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - - # List scheduled searches - - try { - Get-V2025ScheduledSearch - - # Below is a request that includes all optional parameters - # Get-V2025ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/scheduled-search#list-scheduled-search - source: | - from sailpoint.v2025.api.scheduled_search_api import ScheduledSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.scheduled_search import ScheduledSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - try: - # List scheduled searches - - results = ScheduledSearchApi(api_client).list_scheduled_search() - # Below is a request that includes all optional parameters - # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) - print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) - /scheduled-searches/{id}: - put: - tags: - - Scheduled Search - description: | - Updates an existing scheduled search. - summary: Update an existing Scheduled Search - operationId: updateScheduledSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: listScheduledSearch - requestBody: - description: The scheduled search to persist. - content: - application/json: - schema: - $ref: '#/paths/~1scheduled-searches/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/scheduled/ScheduledSearch.yaml - required: true - responses: - '200': - description: The persisted scheduled search. - content: - application/json: - schema: - $ref: '#/paths/~1scheduled-searches/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/scheduled/ScheduledSearch.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#update-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $ScheduledSearch = @" - { - "owner" : { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "displayQueryDetails" : false, - "created" : "", - "description" : "Daily disabled accounts", - "ownerId" : "2c9180867624cbd7017642d8c8c81f67", - "enabled" : false, - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "recipients" : [ { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - } ], - "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", - "name" : "Daily disabled accounts", - "modified" : "", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "emailEmptyResults" : false - } - "@ - - # Update an existing Scheduled Search - - try { - $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-V2025ScheduledSearch -Id $Id -ScheduledSearch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ScheduledSearch -Id $Id -ScheduledSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/scheduled-search#update-scheduled-search - source: | - from sailpoint.v2025.api.scheduled_search_api import ScheduledSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.scheduled_search import ScheduledSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - scheduled_search = '''{ - "owner" : { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "displayQueryDetails" : false, - "created" : "", - "description" : "Daily disabled accounts", - "ownerId" : "2c9180867624cbd7017642d8c8c81f67", - "enabled" : false, - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "recipients" : [ { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - } ], - "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", - "name" : "Daily disabled accounts", - "modified" : "", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "emailEmptyResults" : false - }''' # ScheduledSearch | The scheduled search to persist. - try: - # Update an existing Scheduled Search - new_scheduled_search = ScheduledSearch.from_json(scheduled_search) - results = ScheduledSearchApi(api_client).update_scheduled_search(id=id, scheduled_search=new_scheduled_search) - # Below is a request that includes all optional parameters - # results = ScheduledSearchApi(api_client).update_scheduled_search(id, new_scheduled_search) - print("The response of ScheduledSearchApi->update_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) - get: - tags: - - Scheduled Search - description: Returns the specified scheduled search. - summary: Get a Scheduled Search - operationId: getScheduledSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: listScheduledSearch - responses: - '200': - description: The requested scheduled search. - content: - application/json: - schema: - $ref: '#/paths/~1scheduled-searches/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/scheduled/ScheduledSearch.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#get-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Scheduled Search - - try { - Get-V2025ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/scheduled-search#get-scheduled-search - source: | - from sailpoint.v2025.api.scheduled_search_api import ScheduledSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.scheduled_search import ScheduledSearch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - try: - # Get a Scheduled Search - - results = ScheduledSearchApi(api_client).get_scheduled_search(id=id) - # Below is a request that includes all optional parameters - # results = ScheduledSearchApi(api_client).get_scheduled_search(id) - print("The response of ScheduledSearchApi->get_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) - delete: - tags: - - Scheduled Search - description: | - Deletes the specified scheduled search. - operationId: deleteScheduledSearch - summary: Delete a Scheduled Search - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: listScheduledSearch - responses: - '204': - description: No Content - Indicates the request was successful but there is no content to be returned in the response. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#delete-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete a Scheduled Search - - try { - Remove-V2025ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/scheduled-search#delete-scheduled-search - source: | - from sailpoint.v2025.api.scheduled_search_api import ScheduledSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - try: - # Delete a Scheduled Search - - ScheduledSearchApi(api_client).delete_scheduled_search(id=id) - # Below is a request that includes all optional parameters - # ScheduledSearchApi(api_client).delete_scheduled_search(id) - except Exception as e: - print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e) - /scheduled-searches/{id}/unsubscribe: - post: - tags: - - Scheduled Search - description: | - Unsubscribes a recipient from the specified scheduled search. - operationId: unsubscribeScheduledSearch - summary: Unsubscribe a recipient from Scheduled Search - parameters: - - $ref: '#/paths/~1saved-searches~1%7Bid%7D~1execute/post/parameters/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/path/search/id.yaml - requestBody: - description: | - The recipient to be removed from the scheduled search. - content: - application/json: - schema: - $ref: '#/components/schemas/SavedSearch/allOf/0/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/TypedReference.yaml - required: true - responses: - '204': - description: No Content - Indicates the request was successful but there is no content to be returned in the response. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#unsubscribe-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $TypedReference = @" - { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - "@ - - # Unsubscribe a recipient from Scheduled Search - - try { - $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-V2025UnsubscribeScheduledSearch -Id $Id -TypedReference $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025UnsubscribeScheduledSearch -Id $Id -TypedReference $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025UnsubscribeScheduledSearch" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/scheduled-search#unsubscribe-scheduled-search - source: | - from sailpoint.v2025.api.scheduled_search_api import ScheduledSearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.typed_reference import TypedReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - typed_reference = '''{ - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }''' # TypedReference | The recipient to be removed from the scheduled search. - try: - # Unsubscribe a recipient from Scheduled Search - new_typed_reference = TypedReference.from_json(typed_reference) - ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id=id, typed_reference=new_typed_reference) - # Below is a request that includes all optional parameters - # ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id, new_typed_reference) - except Exception as e: - print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e) - /search: - post: - tags: - - Search - description: 'Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. ' - externalDocs: - description: Learn more about search. - url: https://documentation.sailpoint.com/saas/help/search/index.html - operationId: searchPost - security: - - userAuth: - - sp:search:read - - applicationAuth: - - sp:search:read - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - - REPORT_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - HELPDESK - summary: Perform Search - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 10000 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 10000 - default: 250 - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoleMetadataBulkUpdateByQueryRequest/properties/query/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/Search.yaml - examples: - accessProfiles: - summary: Query for Access Profiles - value: - indices: - - accessprofiles - query: - query: requestable:true - accountActivities: - summary: Query for Acccount Activities - value: - indices: - - accountactivities - query: - query: sources:"Active Directory" - entitlements: - summary: Query for Entitlements - value: - indices: - - entitlements - query: - query: source.name:Finance - events: - summary: Query for Events - value: - indices: - - events - query: - query: type:PROVISIONING - identities: - summary: Query for Identities - value: - indices: - - identities - query: - query: attributes.cloudLifecycleState:active - roles: - summary: Query for Roles - value: - indices: - - roles - query: - query: enabled:true - query-fields: - summary: Query with Fields - value: - indices: - - identities - query: - query: '"John Doe"' - fields: - - name - query-timeZone: - summary: Query with TimeZone - value: - indices: - - identities - query: - query: 'created: [2022-05-19T19:26:03.351Z TO now]' - timeZone: America/Los_Angeles - query-innerHit: - summary: Query with InnerHit - value: - indices: - - identities - query: - query: '"John Doe"' - innerHit: - type: access - query: source.name:"Active Directory" - typeAheadQuery: - summary: TypeAhead Query - value: - indices: - - identities - queryType: TYPEAHEAD - typeAheadQuery: - field: name - query: Jo - maxExpansions: 50 - size: 100 - sort: desc - sortByValue: false - typeAheadQuery-nestedType: - summary: TypeAhead Query with NestedType - value: - indices: - - identities - queryType: TYPEAHEAD - typeAheadQuery: - field: source.name - nestedType: access - query: Work - maxExpansions: 50 - size: 100 - sort: desc - sortByValue: false - filter-exists: - summary: Filter with Exists - value: - indices: - - identities - query: - query: attributes.city:Austin - filters: - attributes.personalEmail: - type: EXISTS - exclude: true - filter-range: - summary: Filter with Range - value: - indices: - - identities - query: - query: attributes.city:London - timeZone: Europe/London - filters: - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2023-12-01' - inclusive: true - upper: - value: '2025-01-01' - filter-terms: - summary: Filter with Terms - value: - indices: - - identities - query: - query: attributes.city:London - filters: - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - isManager: - type: TERMS - terms: - - 'true' - required: true - responses: - '200': - description: List of matching documents. - content: - application/json: - schema: - type: array - items: - type: object - oneOf: - - type: object - allOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/profile/AccessProfileDocument.yaml - - type: object - properties: - pod: - type: string - example: pod01-useast1 - description: Name of the pod. - org: - type: string - example: org-name - description: Name of the tenant. - _type: - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items/oneOf/3/allOf/1/properties/_type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DocumentType.yaml - type: - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items/oneOf/3/allOf/1/properties/_type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DocumentType.yaml - _version: - type: string - example: v2 - description: Version number. - - type: object - allOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/AccountActivityDocument.yaml - - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items/oneOf/0/allOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DocumentFields.yaml - - type: object - allOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/entitlement/EntitlementDocument.yaml - - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items/oneOf/0/allOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DocumentFields.yaml - - type: object - allOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/event/EventDocument.yaml - - properties: - pod: - type: string - example: pod01-useast1 - org: - type: string - example: org-name - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - entitlement - - event - - identity - - role - example: identity - _version: - type: string - example: v2 - - type: object - allOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/4' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/identity/IdentityDocument.yaml - - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items/oneOf/0/allOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DocumentFields.yaml - - type: object - allOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/5' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/role/RoleDocument.yaml - - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items/oneOf/0/allOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DocumentFields.yaml - examples: - accessProfiles: - summary: A collection of Access Profiles - value: - - id: 13b856dd9a264206954b63ecbb57a853 - name: Cloud Eng - description: Cloud Eng - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - entitlements: - - hasPermissions: false - attribute: memberOf - value: CN=Cloud Engineering,DC=sailpoint,DC=com - schema: group - privileged: false - id: 7372eaddd75749bd89a2e76a363eb891 - name: Cloud Engineering - description: Cloud Engineering - entitlementCount: 1 - segments: [] - segmentCount: 0 - apps: [] - created: '2024-09-16T17:41:25.000Z' - modified: '2024-09-16T19:30:54.000Z' - synced: '2025-02-12T06:32:40.156Z' - enabled: true - requestable: true - requestCommentsRequired: false - owner: - id: ff8081815757d36a015757d42e56031e - name: SailPoint Support - type: IDENTITY - email: cloud-support@sailpoint.com - tags: - - TAG_1 - - TAG_2 - _type: accessprofile - type: accessprofile - pod: pod01-useast1 - org: org-name - _version: v2 - accountActivities: - summary: A collection of Account Activities - value: - - id: 6f76c3add1db4ba8bbe0d42aaceb7a07 - _type: accountactivity - type: accountactivity - requester: - name: Amos.Cunningham - id: ef1e2a36099447cb9448c68e1804dd9f - type: Identity - sources: Active Directory - created: '2025-01-02T21:45:59.795Z' - accountRequests: - - result: - status: committed - accountId: CN=Amos Cunningham,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - op: Modify - provisioningTarget: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - attributeRequests: - - op: Add - name: memberOf - value: CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - stage: Completed - originalRequests: - - result: - status: Manual Task Created - accountId: CN=Amos Cunningham,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - op: Modify - accountUuid: '{17413e85-1c08-4bb0-b658-9afdaad11d0a}' - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - attributeRequests: - - op: Add - name: memberOf - value: CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - expansionItems: [] - approvals: - - owner: - name: tina.smith - id: 322c6bce405a495a8e841a014b7d8410 - type: Identity - result: Finished - attributeRequest: - op: Add - name: memberOf - value: - - CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - accountUuid: '{17413e85-1c08-4bb0-b658-9afdaad11d0a}' - modified: '2025-01-02T21:47:16.903Z' - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - recipient: - name: Amos.Cunningham - id: ef1e2a36099447cb9448c68e1804dd9f - type: Identity - action: Access Request - modified: '2025-01-02T21:47:16.903Z' - trackingNumber: 051d09b0bb5b453d91f658ba7f1e3171 - status: Complete - pod: pod01-useast1 - org: org-name - synced: '2025-01-02T21:47:16.953Z' - _version: v2 - entitlements: - summary: A collection of Entitlements - value: - - id: 2c9180867dde18d1017de8ea1f5c130f - name: Vendor Creation - displayName: Vendor Creation - created: '2021-12-23T20:09:57.340Z' - modified: '2023-05-02T06:31:19.357Z' - attribute: groups - value: VC - sourceSchemaObjectType: group - schema: group - privileged: false - cloudGoverned: false - hash: 22ac1f7a13c8a462c67ee74f5fcbf06a277cce50 - description: Set up new AP vendors - requestable: false - source: - id: 2c9180887de347a7017de8e75fa5570a - type: SOURCE - name: Finance - containsDataAccess: 'false' - pod: pod01-useast1 - org: org-name - synced: '2024-11-07T16:29:06.131Z' - _type: entitlement - type: entitlement - _version: v2 - events: - summary: A collection of Events - value: - - id: 001909ce8cc3b519436197105426b18b5fc6ca179803c0c3702e9038107bec78 - stack: wps - synced: '2023-06-01T22:01:38.170Z' - created: '2023-06-01T22:01:37.818Z' - objects: - - ACCOUNT - type: PROVISIONING - technicalName: ACCOUNT_MODIFY_PASSED - target: - name: Colt.Spears - actor: - name: System - name: Modify Account Passed - action: ModifyAccount - attributes: - accountUuid: '{2d1ec18a-84cc-4659-bf75-a1ce4d56a9c5}' - cloudAppName: Active Directory - appId: 5c71ff71195b4794a0b87e7cf36fb017 - sourceId: source - sourceName: Active Directory - accountName: CN=Colt Spears,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpoint,DC=com - interface: Identity Refresh - trackingNumber: 1f74901adbc0412d9fa51314195155be - operation: MODIFY - status: PASSED - pod: pod01-useast1 - org: org-name - _type: event - _version: v2 - identities: - summary: A collection of Identities - value: - - id: 2c9180865c45e7e3015c46c434a80622 - name: Laura Peeters - firstName: Laura - lastName: Peeters - displayName: Laura Peeters - email: Laura.Peeters@sailpointdemo.com - created: '2024-04-04T21:36:00.385Z' - inactive: false - protected: false - status: ACTIVE - employeeNumber: '10673' - manager: - id: 88e405b1a3b8439daf2efc8f4ff0a98b - name: Mia Garcia - displayName: Mia Garcia - isManager: true - identityProfile: - id: 00a2bc6244b34f4a88d985f035f2b68b - name: HR Global - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - attributes: - city: Brussels - cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 - cloudLifecycleState: active - cloudStatus: ACTIVE - country: BE - department: EMEA Sales - displayName: Laura Peeters - email: Laura.Peeters@sailpointdemo.com - firstname: Laura - identificationNumber: '10673' - identityState: ACTIVE - internalCloudStatus: ACTIVE - jobTitle: Manager, Sales - Belgium - lastname: Peeters - location: EMEA - uid: '10673' - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - disabled: false - locked: false - accounts: - - id: 830396e8863442f1bce7b485612c8b51 - name: Laura Peeters - accountId: '10673' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:00.385Z' - supportsPasswordChange: false - - id: cd6797419f37492ba22ea991f9d6ba90 - name: $SEK300-N3K0K4HOPEB6 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - passwordLastSet: '2024-04-04T21:38:57.434Z' - entitlementAttributes: - memberOf: - - CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2024-04-04T21:42:26.787Z' - supportsPasswordChange: true - - id: db145fd0ec6a4e0cbc3a24bbe0758c8f - name: Laura Peeters - accountId: '10681' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:15.769Z' - supportsPasswordChange: false - - id: 6b75898eec394b4c98a5c3d2d9ba311b - name: Laura Peeters - accountId: Laura Peeters - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:15.809Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 3 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: 6b75898eec394b4c98a5c3d2d9ba311b - accountId: Laura Peeters - appCount: 5 - access: - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 4bf8f57887874e9c83ae3a662bf8988c - name: Sales-Folder - displayName: Sales-Folder - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: f1bea520cace4489805d26de3463262d - name: Salesforce Access - displayName: Salesforce Access - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 98a76b26b7884f3e8d115991cebc09b2 - name: Salesforce opportunity management - displayName: Salesforce opportunity management - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 468171f0af874adebb58d3718519bd56 - name: SalesCommonAccess - displayName: SalesCommonAccess - type: ACCESS_PROFILE - description: Grants basic access for everyone in the sale department - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: a8819cb0445541438fe08dd38f311b3c - name: SalesGlobal - displayName: SalesGlobal - type: ROLE - description: All Sales people in the company - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 29b6ee3f91484d159b1ceac3109af151 - name: se.admin - displayName: se.admin - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - accessCount: 8 - accessProfileCount: 2 - entitlementCount: 4 - roleCount: 2 - modified: '2025-01-17T03:17:17.895Z' - visibleSegments: - - All Employees - visibleSegmentCount: 1 - tagCount: 2 - tags: - - TAG_1 - - TAG_2 - pod: pod01-useast1 - org: org-name - synced: '2025-01-17T06:10:19.853Z' - _type: identity - type: identity - _version: v2 - roles: - summary: A collection of Roles - value: - - id: 2c91808c6faadea6016fb4f2bc69077b - accessProfileCount: 1 - accessProfiles: - - id: 468171f0af874adebb58d3718519bd56 - name: SalesCommonAccess - created: '2023-06-01T22:00:55.311Z' - description: All Sales people in the company - dimensional: false - enabled: true - modified: '2023-06-01T22:00:55.432Z' - name: SalesGlobal - owner: - email: admin@sailpointdemo.com - id: c18630c4811c4030810afb3a14f388cf - name: admin - type: IDENTITY - requestCommentsRequired: false - requestable: true - tags: - - TAG_1 - - TAG_2 - pod: pod01-useast1 - org: org-name - _type: role - type: role - _version: v2 - query-fields: - summary: Query with Fields - value: - - name: John Doe - firstName: John - lastName: Doe - displayName: John Doe - id: 655f6741762547ec937893f27eab0cec - email: John.Doe@sailpointdemo.com - created: '2025-01-03T22:36:20.025Z' - inactive: false - protected: false - status: UNREGISTERED - isManager: false - identityProfile: - id: 63e42f96f2fc4b8ba544654eba6068cf - name: Contractors - source: - id: b33c36dbaf974200b4d91f846abc30a5 - name: Contractors - attributes: - cloudAuthoritativeSource: b33c36dbaf974200b4d91f846abc30a5 - cloudLifecycleState: active - cloudStatus: UNREGISTERED - displayName: John Doe - email: John.Doe@sailpointdemo.com - endDate: '2199-01-01T00:00:00.000Z' - firstname: John - identityState: ACTIVE - internalCloudStatus: UNREGISTERED - lastname: Doe - startDate: '2199-01-01T00:00:00.000Z' - uid: John Doe - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - disabled: false - locked: false - accounts: - - id: 6f9cce655ddd40ca86a8faab8d5d52ec - name: John Doe - accountId: ac10e3a8-942a-1409-8194-2e4fe3090003 - source: - id: b33c36dbaf974200b4d91f846abc30a5 - name: Contractors - type: Non-Employee - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2025-01-03T22:36:20.045Z' - supportsPasswordChange: false - - id: 9e29df88d4c5449ea790b4c24135b85c - name: $FHK300-LAAKDKHU50K3 - accountId: CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - entitlementAttributes: - memberOf: - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2025-01-03T22:36:36.866Z' - supportsPasswordChange: true - - id: 74e0cd14200943ff92b4f11fa3596eba - name: John Doe - accountId: John Doe - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2025-01-03T22:36:20.076Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 2 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: 9e29df88d4c5449ea790b4c24135b85c - accountId: CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: 9e29df88d4c5449ea790b4c24135b85c - accountId: CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: 9e29df88d4c5449ea790b4c24135b85c - accountId: CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: 9e29df88d4c5449ea790b4c24135b85c - accountId: CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: 74e0cd14200943ff92b4f11fa3596eba - accountId: John Doe - appCount: 5 - access: - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - accessCount: 3 - accessProfileCount: 1 - entitlementCount: 1 - roleCount: 1 - modified: '2025-01-03T22:36:37.599Z' - visibleSegments: - - All Employees - visibleSegmentCount: 1 - tagCount: 0 - pod: pod01-useast1 - org: org-name - synced: '2025-01-03T22:37:04.452Z' - _type: identity - type: identity - _version: v2 - query-timeZone: - summary: Query with TimeZone - value: - - name: Laura Peeters - firstName: Laura - lastName: Peeters - displayName: Laura Peeters - id: 0011cac38db341738af1f2ce7bb3aede - email: Laura.Peeters@sailpointdemo.com - created: '2024-04-04T21:36:00.385Z' - inactive: false - protected: false - status: UNREGISTERED - employeeNumber: '10673' - manager: - id: 88e405b1a3b8439daf2efc8f4ff0a98b - name: Mia Garcia - displayName: Mia Garcia - isManager: true - identityProfile: - id: 00a2bc6244b34f4a88d985f035f2b68b - name: HR Global - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - attributes: - city: Brussels - cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 - cloudLifecycleState: active - cloudStatus: UNREGISTERED - country: BE - department: EMEA Sales - displayName: Laura Peeters - email: Laura.Peeters@sailpointdemo.com - firstname: Laura - identificationNumber: '10673' - identityState: ACTIVE - internalCloudStatus: UNREGISTERED - jobTitle: Manager, Sales - Belgium - lastname: Peeters - location: EMEA - uid: '10673' - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - disabled: false - locked: false - accounts: - - id: 830396e8863442f1bce7b485612c8b51 - name: Laura Peeters - accountId: '10673' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:00.385Z' - supportsPasswordChange: false - - id: cd6797419f37492ba22ea991f9d6ba90 - name: $SEK300-N3K0K4HOPEB6 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - passwordLastSet: '2024-04-04T21:38:57.434Z' - entitlementAttributes: - memberOf: - - CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2024-04-04T21:42:26.787Z' - supportsPasswordChange: true - - id: db145fd0ec6a4e0cbc3a24bbe0758c8f - name: Laura Peeters - accountId: '10681' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:15.769Z' - supportsPasswordChange: false - - id: 6b75898eec394b4c98a5c3d2d9ba311b - name: Laura Peeters - accountId: Laura Peeters - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:15.809Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 3 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: 6b75898eec394b4c98a5c3d2d9ba311b - accountId: Laura Peeters - appCount: 5 - access: - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 4bf8f57887874e9c83ae3a662bf8988c - name: Sales-Folder - displayName: Sales-Folder - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: f1bea520cace4489805d26de3463262d - name: Salesforce Access - displayName: Salesforce Access - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 98a76b26b7884f3e8d115991cebc09b2 - name: Salesforce opportunity management - displayName: Salesforce opportunity management - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 468171f0af874adebb58d3718519bd56 - name: SalesCommonAccess - displayName: SalesCommonAccess - type: ACCESS_PROFILE - description: Grants basic access for everyone in the sale department - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: a8819cb0445541438fe08dd38f311b3c - name: SalesGlobal - displayName: SalesGlobal - type: ROLE - description: All Sales people in the company - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 29b6ee3f91484d159b1ceac3109af151 - name: se.admin - displayName: se.admin - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - accessCount: 8 - accessProfileCount: 2 - entitlementCount: 4 - roleCount: 2 - modified: '2024-12-13T02:49:18.104Z' - visibleSegments: - - All Employees - visibleSegmentCount: 1 - tagCount: 0 - pod: pod01-useast1 - org: org-name - synced: '2024-12-13T06:10:14.229Z' - _type: identity - type: identity - _version: v2 - query-innerHit: - summary: Query with InnerHit - value: - - requestCommentsRequired: false - schema: group - cloudEligible: false - displayName: Benefits - standalone: false - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ENTITLEMENT - enabled: false - privileged: false - name: Benefits - disabled: false - id: 4919721c3c1a4ca484469b85f0fd9ba1 - requestable: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - cloudGoverned: false - _type: access - _originalType: identity - _version: v2 - - requestCommentsRequired: false - owner: - displayName: Jerry.Bennett - name: Jerry.Bennett - id: 278f8a1859df48d2a0adb204257b26a2 - cloudEligible: false - displayName: Benefits Employees - standalone: false - description: Access for Benefits Employees. Distribution group and File share access. - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - revocable: false - type: ACCESS_PROFILE - enabled: false - privileged: false - name: Benefits Employees - disabled: false - id: 7e277d102c874560becc464cdfe33a86 - requestable: false - cloudGoverned: false - _type: access - _originalType: identity - _version: v2 - typeAheadQuery: - summary: TypeAhead Query - value: - - Ethan Johnson - - Henry Jones - - Joan.Wells - - Joanna Gonzales - - Joe Cook - - Joe.Myers - - Johan Jacobs - - John Doe - - John Roberts - - John Smith - - John.Jarndyce - - John.Smithee - - John.Williams - - Johnny.Elliott - - Jonathan.West - - Jordan Wilson - - Jordan.Sullivan - - Jose.Reed - - Joao Carvalho - - Kamaria Jones - - Lisa Jones - - Mia Johnson - - Michael Johnson - - Scott Johnson - typeAheadQuery-nestedType: - summary: TypeAhead Query with NestedType - value: - - Active Directory - - PRISM - - ServiceNow - - TRAKK-WS - - AWS - filter-exists: - summary: Filter with Exists - value: - - name: Cory Henry - firstName: Cory - lastName: Henry - displayName: Cory Henry - id: 026bb65ed1f54fcd89197ca986e9acac - email: Cory.Henry@sailpointdemo.com - created: '2024-04-04T21:32:46.844Z' - inactive: false - protected: false - status: UNREGISTERED - employeeNumber: '10090' - manager: - id: 903349b85746471a9a898722206109bb - name: Layla Hendricks - displayName: Layla Hendricks - isManager: true - identityProfile: - id: 00a2bc6244b34f4a88d985f035f2b68b - name: HR Global - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - attributes: - city: Austin - cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 - cloudLifecycleState: active - cloudStatus: UNREGISTERED - country: US - department: Revenue Operations - displayName: Cory Henry - email: Cory.Henry@sailpointdemo.com - firstname: Cory - identificationNumber: '10090' - identityState: ACTIVE - internalCloudStatus: UNREGISTERED - jobTitle: Manager, System Operations - lastname: Henry - location: AMS - uid: '10090' - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - - 8ea4e957-f2f1-4cba-b202-54cc702528d1 - disabled: false - locked: false - accounts: - - id: a02142f41ad1407884da04a7bfa586d4 - name: Cory Henry - accountId: '10090' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:32:46.844Z' - supportsPasswordChange: false - - id: f30019e125c74684acee7da3f1643d2a - name: $LUJ300-P3QNVHE6R7FB - accountId: CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - passwordLastSet: '2024-04-04T21:33:34.488Z' - entitlementAttributes: - memberOf: - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2024-04-04T21:37:03.481Z' - supportsPasswordChange: true - - id: 7fe340119c5d4b00a9b85d55b18a6416 - name: Cory Henry - accountId: Cory Henry - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:37:03.536Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 2 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f30019e125c74684acee7da3f1643d2a - accountId: CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f30019e125c74684acee7da3f1643d2a - accountId: CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f30019e125c74684acee7da3f1643d2a - accountId: CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f30019e125c74684acee7da3f1643d2a - accountId: CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: 7fe340119c5d4b00a9b85d55b18a6416 - accountId: Cory Henry - appCount: 5 - access: - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - accessCount: 3 - accessProfileCount: 1 - entitlementCount: 1 - roleCount: 1 - modified: '2024-12-13T02:49:19.214Z' - visibleSegments: - - All Employees - - Austin Employees - visibleSegmentCount: 2 - tagCount: 0 - pod: pod01-useast1 - org: org-name - synced: '2024-12-13T06:10:29.734Z' - _type: identity - type: identity - _version: v2 - filter-range: - summary: Filter with Range - value: - - name: Mia Garcia - firstName: Mia - lastName: Garcia - displayName: Mia Garcia - id: 88e405b1a3b8439daf2efc8f4ff0a98b - email: Mia.Garcia@sailpointdemo.com - created: '2024-04-04T21:33:05.522Z' - inactive: false - protected: false - status: UNREGISTERED - employeeNumber: '10142' - manager: - id: 624db52c764f410baca2b192caad8e58 - name: Ethan Johnson - displayName: Ethan Johnson - isManager: true - identityProfile: - id: 00a2bc6244b34f4a88d985f035f2b68b - name: HR Global - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - attributes: - city: London - cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 - cloudLifecycleState: active - cloudStatus: UNREGISTERED - country: GB - department: EMEA Sales - displayName: Mia Garcia - email: Mia.Garcia@sailpointdemo.com - firstname: Mia - identificationNumber: '10142' - identityState: ACTIVE - internalCloudStatus: UNREGISTERED - jobTitle: Regional Director, EMEA Sales - lastname: Garcia - location: EMEA - uid: '10142' - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - disabled: false - locked: false - accounts: - - id: 9021760f10b64f42b7ebfb78085ccaff - name: Mia Garcia - accountId: '10142' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:33:05.522Z' - supportsPasswordChange: false - - id: f3ef91f3c2874e79981f2d97297660ee - name: $DUJ300-H5LFRVRDLKKM - accountId: CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - passwordLastSet: '2024-04-04T21:33:25.979Z' - entitlementAttributes: - memberOf: - - CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2024-04-04T21:36:54.974Z' - supportsPasswordChange: true - - id: c379279cc5b9450cbb274aad31486510 - name: Mia Garcia - accountId: Mia Garcia - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:55.027Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 2 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f3ef91f3c2874e79981f2d97297660ee - accountId: CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f3ef91f3c2874e79981f2d97297660ee - accountId: CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f3ef91f3c2874e79981f2d97297660ee - accountId: CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f3ef91f3c2874e79981f2d97297660ee - accountId: CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: c379279cc5b9450cbb274aad31486510 - accountId: Mia Garcia - appCount: 5 - access: - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 468171f0af874adebb58d3718519bd56 - name: SalesCommonAccess - displayName: SalesCommonAccess - type: ACCESS_PROFILE - description: Grants basic access for everyone in the sale department - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: a8819cb0445541438fe08dd38f311b3c - name: SalesGlobal - displayName: SalesGlobal - type: ROLE - description: All Sales people in the company - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 29b6ee3f91484d159b1ceac3109af151 - name: se.admin - displayName: se.admin - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 4bf8f57887874e9c83ae3a662bf8988c - name: Sales-Folder - displayName: Sales-Folder - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: f1bea520cace4489805d26de3463262d - name: Salesforce Access - displayName: Salesforce Access - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 98a76b26b7884f3e8d115991cebc09b2 - name: Salesforce opportunity management - displayName: Salesforce opportunity management - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - accessCount: 8 - accessProfileCount: 2 - entitlementCount: 4 - roleCount: 2 - modified: '2024-12-13T02:49:35.220Z' - visibleSegments: - - All Employees - visibleSegmentCount: 1 - tagCount: 0 - pod: pod01-useast1 - org: org-name - synced: '2024-12-13T06:25:44.222Z' - _type: identity - type: identity - _version: v2 - filter-terms: - summary: Filter with Terms - value: - - name: Oliver Davies - firstName: Oliver - lastName: Davies - displayName: Oliver Davies - id: b173815fef574b74a283f39e6634c215 - email: Oliver.Davies@sailpointdemo.com - created: '2024-04-04T21:32:27.473Z' - inactive: false - protected: false - status: UNREGISTERED - employeeNumber: '10029' - manager: - id: b8c8e021a4104eda91b80bfac6a99b47 - name: Jackson Brooks - displayName: Jackson Brooks - isManager: true - identityProfile: - id: 00a2bc6244b34f4a88d985f035f2b68b - name: HR Global - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - attributes: - city: London - cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 - cloudLifecycleState: active - cloudStatus: UNREGISTERED - country: GB - department: Customer Support - displayName: Oliver Davies - email: Oliver.Davies@sailpointdemo.com - firstname: Oliver - identificationNumber: '10029' - identityState: ACTIVE - internalCloudStatus: UNREGISTERED - jobTitle: Call Center - lastname: Davies - location: EMEA - uid: '10029' - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - disabled: false - locked: false - accounts: - - id: c8cacc7080254b2781f56e0ded6c8dea - name: $GRJ300-AQD2M7N9L7NT - accountId: CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - passwordLastSet: '2024-04-04T21:30:25.205Z' - entitlementAttributes: - memberOf: - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2024-04-04T21:33:54.332Z' - supportsPasswordChange: true - - id: cd7f58b2290c43909320ff89427b57a1 - name: Oliver Davies - accountId: '10029' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:32:27.473Z' - supportsPasswordChange: false - - id: a1ee6cd948754371a98105a5a6dd067d - name: Oliver Davies - accountId: Oliver Davies - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:33:54.377Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 2 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: c8cacc7080254b2781f56e0ded6c8dea - accountId: CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: c8cacc7080254b2781f56e0ded6c8dea - accountId: CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: c8cacc7080254b2781f56e0ded6c8dea - accountId: CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: c8cacc7080254b2781f56e0ded6c8dea - accountId: CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: a1ee6cd948754371a98105a5a6dd067d - accountId: Oliver Davies - appCount: 5 - access: - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - accessCount: 3 - accessProfileCount: 1 - entitlementCount: 1 - roleCount: 1 - modified: '2024-12-13T02:49:35.917Z' - visibleSegments: - - All Employees - visibleSegmentCount: 1 - tagCount: 0 - pod: pod01-useast1 - org: org-name - synced: '2024-12-13T06:28:14.763Z' - _type: identity - type: identity - _version: v2 - headers: - X-Total-Count: - schema: - type: integer - description: The total result count (returned only if the *count* parameter is specified as *true*). - example: 30 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search#search-post - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Perform Search - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2025Post -Search $Result - - # Below is a request that includes all optional parameters - # Search-V2025Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Post" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search#search-post - source: | - from sailpoint.v2025.api.search_api import SearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.search import Search - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - search = '''{ - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - }''' # Search | - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Perform Search - new_search = Search.from_json(search) - results = SearchApi(api_client).search_post(search=new_search) - # Below is a request that includes all optional parameters - # results = SearchApi(api_client).search_post(new_search, offset, limit, count) - print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchApi->search_post: %s\n" % e) - /search/count: - post: - tags: - - Search - description: Performs a search with a provided query and returns the count of results in the X-Total-Count header. - operationId: searchCount - security: - - userAuth: - - sp:search:read - summary: Count Documents Satisfying a Query - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoleMetadataBulkUpdateByQueryRequest/properties/query/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/Search.yaml - examples: - query-timeZone: - $ref: '#/paths/~1search/post/requestBody/content/application~1json/examples/query-timeZone' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/examples/query-timeZone.yaml - required: true - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - headers: - X-Total-Count: - description: The total result count. - schema: - type: integer - example: 5 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search#search-count - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - - # Count Documents Satisfying a Query - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2025Count -Search $Result - - # Below is a request that includes all optional parameters - # Search-V2025Count -Search $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Count" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search#search-count - source: | - from sailpoint.v2025.api.search_api import SearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.search import Search - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - search = '''{ - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - }''' # Search | - try: - # Count Documents Satisfying a Query - new_search = Search.from_json(search) - SearchApi(api_client).search_count(search=new_search) - # Below is a request that includes all optional parameters - # SearchApi(api_client).search_count(new_search) - except Exception as e: - print("Exception when calling SearchApi->search_count: %s\n" % e) - /search/aggregate: - post: - tags: - - Search - description: 'Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. ' - operationId: searchAggregate - security: - - userAuth: - - sp:search:read - summary: Perform a Search Query Aggregation - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RoleMetadataBulkUpdateByQueryRequest/properties/query/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/Search.yaml - examples: - metricAggregation: - summary: MetricAggregation - value: - indices: - - identities - aggregationType: SAILPOINT - aggregations: - metric: - name: How Many Locations - type: UNIQUE_COUNT - field: attributes.city - metricAggregation-dsl: - summary: MetricAggregation using DSL - value: - indices: - - identities - aggregationType: DSL - aggregationsDsl: - How Many Locations: - cardinality: - field: attributes.city.exact - bucketAggregation: - summary: BucketAggregation - value: - indices: - - identities - aggregationType: SAILPOINT - aggregations: - bucket: - name: Identity Locations - type: TERMS - field: attributes.city - bucketAggregation-dsl: - summary: BucketAggregation using DSL - value: - indices: - - identities - aggregationType: DSL - aggregationsDsl: - Identity Locations: - terms: - field: attributes.city.exact - nestedAggregation-bucketAggregation: - summary: NestedAggregation with BucketAggregation - value: - indices: - - identities - aggregationType: SAILPOINT - aggregations: - nested: - name: Access - field: access - type: TERMS - bucket: - name: Access Source Name - type: TERMS - field: access.source.name - nestedAggregation-bucketAggregation-dsl: - summary: NestedAggregation with BucketAggregation using DSL - value: - indices: - - identities - aggregationType: DSL - aggregationsDsl: - access: - nested: - path: access - aggs: - Access Source Name: - terms: - field: access.source.name.exact - nestedAggregation-filterAggregation-bucketAggregation: - summary: NestedAggregation with FilterAggregation and BucketAggregation - value: - indices: - - identities - aggregationType: SAILPOINT - aggregations: - nested: - name: Access - field: access - type: TERMS - filter: - name: Entitlements - field: access.type - value: ENTITLEMENT - bucket: - name: Access Name - type: TERMS - field: access.name - nestedAggregation-filterAggregation-bucketAggregation-dsl: - summary: NestedAggregation with FilterAggregation and BucketAggregation using DSL - value: - indices: - - identities - aggregationType: DSL - aggregationsDsl: - access: - nested: - path: access - aggs: - Entitlements: - filter: - term: - access.type: ENTITLEMENT - aggs: - Access Name: - terms: - field: access.name.exact - bucketAggregation-subAggregation: - summary: BucketAggregation with SubAggregation - value: - indices: - - identities - aggregationType: SAILPOINT - aggregations: - bucket: - name: Identity Department - type: TERMS - field: attributes.department - subAggregation: - bucket: - name: Identity Locations - type: TERMS - field: attributes.city - bucketAggregation-subAggregation-dsl: - summary: BucketAggregation with SubAggregation using DSL - value: - indices: - - identities - aggregationType: DSL - aggregationsDsl: - Identity Department: - terms: - field: attributes.department.exact - aggs: - Identity Locations: - terms: - field: attributes.city.exact - required: true - responses: - '200': - description: Aggregation results. - content: - application/json: - schema: - type: object - properties: - aggregations: - type: object - description: | - The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. - - See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. - example: - Identity Locations: - buckets: - - key: Austin - doc_count: 109 - - key: London - doc_count: 64 - - key: San Jose - doc_count: 27 - - key: Brussels - doc_count: 26 - - key: Sao Paulo - doc_count: 24 - - key: Munich - doc_count: 23 - - key: Singapore - doc_count: 22 - - key: Tokyo - doc_count: 20 - - key: Taipei - doc_count: 16 - hits: - description: | - The results of the aggregation search query. - type: array - items: - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/documents/SearchDocuments.yaml - text/csv: - schema: - description: | - If the *Accept:text/csv* header is specified and the *aggregationType* parameter in the request body is *SAILPOINT*, - - the aggregation result will be returned as a CSV document. - type: string - example: - - Identity Locations,Count - - Munich,23 - - Brussels,26 - - Singapore,22 - - Tokyo,20 - - Taipei,16 - - London,64 - - Austin,109 - - Sao Paulo,24 - - San Jose,27 - headers: - X-Total-Count: - description: The total result count (returned only if the *count* parameter is specified as *true*). - schema: - type: integer - example: 5 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search#search-aggregate - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Perform a Search Query Aggregation - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2025Aggregate -Search $Result - - # Below is a request that includes all optional parameters - # Search-V2025Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Aggregate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search#search-aggregate - source: | - from sailpoint.v2025.api.search_api import SearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.aggregation_result import AggregationResult - from sailpoint.v2025.models.search import Search - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - search = '''{ - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - }''' # Search | - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Perform a Search Query Aggregation - new_search = Search.from_json(search) - results = SearchApi(api_client).search_aggregate(search=new_search) - # Below is a request that includes all optional parameters - # results = SearchApi(api_client).search_aggregate(new_search, offset, limit, count) - print("The response of SearchApi->search_aggregate:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchApi->search_aggregate: %s\n" % e) - /search/{index}/{id}: - get: - tags: - - Search - description: Fetches a single document from the specified index, using the specified document ID. - operationId: searchGet - security: - - userAuth: - - sp:search:read - - applicationAuth: - - sp:search:read - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - - REPORT_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - HELPDESK - summary: Get a Document by ID - parameters: - - in: path - name: index - description: | - The index from which to fetch the specified document. - - The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - schema: - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - required: true - example: identities - - $ref: '#/paths/~1saved-searches~1%7Bid%7D~1execute/post/parameters/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/path/search/id.yaml - responses: - '200': - description: The requested document. - content: - application/json: - schema: - type: object - oneOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/profile/AccessProfileDocument.yaml - - $ref: '#/components/schemas/SearchDocument/oneOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/AccountActivityDocument.yaml - - $ref: '#/components/schemas/SearchDocument/oneOf/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/entitlement/EntitlementDocument.yaml - - $ref: '#/components/schemas/SearchDocument/oneOf/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/event/EventDocument.yaml - - $ref: '#/components/schemas/SearchDocument/oneOf/4' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/identity/IdentityDocument.yaml - - $ref: '#/components/schemas/SearchDocument/oneOf/5' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/role/RoleDocument.yaml - examples: - accessProfile: - summary: AccessProfile - value: - id: 13b856dd9a264206954b63ecbb57a853 - name: Cloud Eng - description: Cloud Eng - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - entitlements: - - hasPermissions: false - attribute: memberOf - value: CN=Cloud Engineering,DC=sailpoint,DC=COM - schema: group - privileged: false - id: 7372eaddd75749bd89a2e76a363eb891 - name: Cloud Engineering - description: Cloud Engineering - entitlementCount: 1 - segments: [] - segmentCount: 0 - apps: [] - created: '2024-09-16T17:41:25.000Z' - modified: '2024-09-16T19:30:54.000Z' - synced: '2025-02-12T06:32:40.156Z' - enabled: true - requestable: true - requestCommentsRequired: false - owner: - id: ff8081815757d36a015757d42e56031e - name: SailPoint Support - type: IDENTITY - email: cloud-support@sailpoint.com - tags: - - TAG_1 - - TAG_2 - accountActivity: - summary: AccountActivity - value: - id: 6f76c3add1db4ba8bbe0d42aaceb7a07 - requester: - name: Amos.Cunningham - id: ef1e2a36099447cb9448c68e1804dd9f - type: Identity - synced: '2025-01-02T21:47:16.953Z' - sources: Active Directory - created: '2025-01-02T21:45:59.795Z' - accountRequests: - - result: - status: committed - accountId: CN=Amos Cunningham,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - op: Modify - provisioningTarget: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - attributeRequests: - - op: Add - name: memberOf - value: CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - stage: Completed - originalRequests: - - result: - status: Manual Task Created - accountId: CN=Amos Cunningham,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - op: Modify - accountUuid: '{17413e85-1c08-4bb0-b658-9afdaad11d0a}' - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - attributeRequests: - - op: Add - name: memberOf - value: CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - expansionItems: [] - approvals: - - owner: - name: tina.smith - id: 322c6bce405a495a8e841a014b7d8410 - type: Identity - result: Finished - attributeRequest: - op: Add - name: memberOf - value: - - CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - accountUuid: '{17413e85-1c08-4bb0-b658-9afdaad11d0a}' - modified: '2025-01-02T21:47:16.903Z' - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - recipient: - name: Amos.Cunningham - id: ef1e2a36099447cb9448c68e1804dd9f - type: Identity - action: Access Request - modified: '2025-01-02T21:47:16.903Z' - trackingNumber: 051d09b0bb5b453d91f658ba7f1e3171 - status: Complete - entitlement: - summary: Entitlement - value: - id: 2c9180867dde18d1017de8ea1f5c130f - name: Vendor Creation - displayName: Vendor Creation - created: '2021-12-23T20:09:57.340Z' - modified: '2023-05-02T06:31:19.357Z' - attribute: groups - value: VC - sourceSchemaObjectType: group - schema: group - privileged: false - cloudGoverned: false - hash: 22ac1f7a13c8a462c67ee74f5fcbf06a277cce50 - description: Set up new AP vendors - requestable: false - source: - id: 2c9180887de347a7017de8e75fa5570a - type: SOURCE - name: Finance - containsDataAccess: 'false' - event: - summary: Event - value: - id: 001909ce8cc3b519436197105426b18b5fc6ca179803c0c3702e9038107bec78 - stack: wps - synced: '2023-06-01T22:01:38.170Z' - created: '2023-06-01T22:01:37.818Z' - objects: - - ACCOUNT - type: PROVISIONING - technicalName: ACCOUNT_MODIFY_PASSED - target: - name: Colt.Spears - actor: - name: System - name: Modify Account Passed - action: ModifyAccount - attributes: - accountUuid: '{2d1ec18a-84cc-4659-bf75-a1ce4d56a9c5}' - cloudAppName: Active Directory - appId: 5c71ff71195b4794a0b87e7cf36fb017 - sourceId: source - sourceName: Active Directory - accountName: CN=Colt Spears,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpoint,DC=com - interface: Identity Refresh - trackingNumber: 1f74901adbc0412d9fa51314195155be - operation: MODIFY - status: PASSED - identity: - summary: Identity - value: - id: 2c9180865c45e7e3015c46c434a80622 - name: Laura Peeters - firstName: Laura - lastName: Peeters - displayName: Laura Peeters - email: Laura.Peeters@sailpointdemo.com - created: '2024-04-04T21:36:00.385Z' - inactive: false - protected: false - status: ACTIVE - employeeNumber: '10673' - manager: - id: 88e405b1a3b8439daf2efc8f4ff0a98b - name: Mia Garcia - displayName: Mia Garcia - isManager: true - identityProfile: - id: 00a2bc6244b34f4a88d985f035f2b68b - name: HR Global - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - attributes: - city: Brussels - cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 - cloudLifecycleState: active - cloudStatus: UNREGISTERED - country: BE - department: EMEA Sales - displayName: Laura Peeters - email: Laura.Peeters@sailpointdemo.com - firstname: Laura - identificationNumber: '10673' - identityState: ACTIVE - internalCloudStatus: UNREGISTERED - jobTitle: Manager, Sales - Belgium - lastname: Peeters - location: EMEA - uid: '10673' - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - disabled: false - locked: false - accounts: - - id: 830396e8863442f1bce7b485612c8b51 - name: Laura Peeters - accountId: '10673' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:00.385Z' - supportsPasswordChange: false - - id: cd6797419f37492ba22ea991f9d6ba90 - name: $SEK300-N3K0K4HOPEB6 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - passwordLastSet: '2024-04-04T21:38:57.434Z' - entitlementAttributes: - memberOf: - - CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2024-04-04T21:42:26.787Z' - supportsPasswordChange: true - - id: db145fd0ec6a4e0cbc3a24bbe0758c8f - name: Laura Peeters - accountId: '10681' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:15.769Z' - supportsPasswordChange: false - - id: 6b75898eec394b4c98a5c3d2d9ba311b - name: Laura Peeters - accountId: Laura Peeters - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:15.809Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 3 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: 6b75898eec394b4c98a5c3d2d9ba311b - accountId: Laura Peeters - appCount: 5 - access: - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 4bf8f57887874e9c83ae3a662bf8988c - name: Sales-Folder - displayName: Sales-Folder - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: f1bea520cace4489805d26de3463262d - name: Salesforce Access - displayName: Salesforce Access - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 98a76b26b7884f3e8d115991cebc09b2 - name: Salesforce opportunity management - displayName: Salesforce opportunity management - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 468171f0af874adebb58d3718519bd56 - name: SalesCommonAccess - displayName: SalesCommonAccess - type: ACCESS_PROFILE - description: Grants basic access for everyone in the sale department - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: a8819cb0445541438fe08dd38f311b3c - name: SalesGlobal - displayName: SalesGlobal - type: ROLE - description: All Sales people in the company - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 29b6ee3f91484d159b1ceac3109af151 - name: se.admin - displayName: se.admin - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - accessCount: 8 - accessProfileCount: 2 - entitlementCount: 4 - roleCount: 2 - modified: '2025-01-17T03:17:17.895Z' - visibleSegments: - - All Employees - visibleSegmentCount: 1 - tagCount: 2 - tags: - - TAG_1 - - TAG_2 - role: - summary: Role - value: - id: 2c91808c6faadea6016fb4f2bc69077b - accessProfileCount: 1 - accessProfiles: - - id: 468171f0af874adebb58d3718519bd56 - name: SalesCommonAccess - created: '2023-06-01T22:00:55.311Z' - description: All Sales people in the company - dimensional: false - enabled: true - modified: '2023-06-01T22:00:55.432Z' - name: SalesGlobal - owner: - email: admin@sailpointdemo.com - id: c18630c4811c4030810afb3a14f388cf - name: admin - type: IDENTITY - requestCommentsRequired: false - requestable: true - tags: - - TAG_1 - - TAG_2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search#search-get - source: | - $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Document by ID - - try { - Search-V2025Get -Index $Index -Id $Id - - # Below is a request that includes all optional parameters - # Search-V2025Get -Index $Index -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Get" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search#search-get - source: | - from sailpoint.v2025.api.search_api import SearchApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - index = 'identities' # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - try: - # Get a Document by ID - - results = SearchApi(api_client).search_get(index=index, id=id) - # Below is a request that includes all optional parameters - # results = SearchApi(api_client).search_get(index, id) - print("The response of SearchApi->search_get:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchApi->search_get: %s\n" % e) - /segments: - post: - operationId: createSegment - security: - - userAuth: - - idn:segment:manage - - applicationAuth: - - idn:segment:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Segments - summary: Create Segment - description: |- - This API creates a segment. - >**Note:** Segment definitions may take time to propagate to all identities. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The segment's ID. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: - type: string - description: The segment's business name. - example: segment-xyz - created: - type: string - format: date-time - description: The time when the segment is created. - example: '2020-01-01T00:00:00.000000Z' - modified: - type: string - format: date-time - description: The time when the segment is modified. - example: '2020-01-01T00:00:00.000000Z' - description: - type: string - description: The segment's optional description. - example: This segment represents xyz - owner: - type: object - nullable: true - description: The owner of this object. - properties: - type: - type: string - enum: - - IDENTITY - description: Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. - example: IDENTITY - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. - example: support - visibilityCriteria: - allOf: - - $ref: '#/paths/~1data-segments~1%7BsegmentId%7D/get/responses/200/content/application~1json/schema/properties/memberFilter' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/VisibilityCriteria.yaml - - nullable: true - active: - type: boolean - description: This boolean indicates whether the segment is currently active. Inactive segments have no effect. - default: false - example: true - responses: - '201': - description: Segment created - content: - application/json: - schema: - $ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Segment.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#create-segment - source: | - $Segment = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-V2025Segment -Segment $Result - - # Below is a request that includes all optional parameters - # New-V2025Segment -Segment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Segment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/segments#create-segment - source: | - from sailpoint.v2025.api.segments_api import SegmentsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - segment = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - }''' # Segment | - try: - # Create Segment - new_segment = Segment.from_json(segment) - results = SegmentsApi(api_client).create_segment(segment=new_segment) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).create_segment(new_segment) - print("The response of SegmentsApi->create_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->create_segment: %s\n" % e) - get: - operationId: listSegments - security: - - userAuth: - - idn:segment:read - - idn:segment:manage - - applicationAuth: - - idn:segment:read - - idn:segment:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Segments - summary: List Segments - description: 'This API returns a list of all segments. ' - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - responses: - '200': - description: List of all segments - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Segment.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#list-segments - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Segments - - try { - Get-V2025Segments - - # Below is a request that includes all optional parameters - # Get-V2025Segments -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Segments" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/segments#list-segments - source: | - from sailpoint.v2025.api.segments_api import SegmentsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Segments - - results = SegmentsApi(api_client).list_segments() - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).list_segments(limit, offset, count) - print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - /segments/{id}: - get: - operationId: getSegment - security: - - userAuth: - - idn:segment:read - - idn:segment:manage - - applicationAuth: - - idn:segment:read - - idn:segment:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Segments - summary: Get Segment by ID - description: This API returns the segment specified by the given ID. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSegments - description: The segment ID to retrieve. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Segment - content: - application/json: - schema: - $ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Segment.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-V2025Segment -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Segment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/segments#get-segment - source: | - from sailpoint.v2025.api.segments_api import SegmentsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. - try: - # Get Segment by ID - - results = SegmentsApi(api_client).get_segment(id=id) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).get_segment(id) - print("The response of SegmentsApi->get_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->get_segment: %s\n" % e) - delete: - operationId: deleteSegment - security: - - userAuth: - - idn:segment:manage - - applicationAuth: - - idn:segment:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Segments - summary: Delete Segment by ID - description: |- - This API deletes the segment specified by the given ID. - >**Note:** that segment deletion may take some time to become effective. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSegments - description: The segment ID to delete. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: No content. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-V2025Segment -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Segment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/segments#delete-segment - source: | - from sailpoint.v2025.api.segments_api import SegmentsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. - try: - # Delete Segment by ID - - SegmentsApi(api_client).delete_segment(id=id) - # Below is a request that includes all optional parameters - # SegmentsApi(api_client).delete_segment(id) - except Exception as e: - print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) - patch: - operationId: patchSegment - security: - - userAuth: - - idn:segment:manage - - applicationAuth: - - idn:segment:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Segments - summary: Update Segment - description: |- - Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - >**Note:** Changes to a segment may take some time to propagate to all identities. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSegments - description: The segment ID to modify. - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * name - * description - * owner - * visibilityCriteria - * active - content: - application/json-patch+json: - schema: - type: array - items: - type: object - examples: - Set Visibility Criteria: - description: Set the visibility criteria - value: - - op: replace - path: /visibilityCriteria - value: - expression: - operator: AND - children: - - operator: EQUALS - attribute: location - value: - type: STRING - value: Philadelphia - - operator: EQUALS - attribute: department - value: - type: STRING - value: HR - responses: - '200': - description: Indicates the PATCH operation succeeded, and returns the segment's new representation. - content: - application/json: - schema: - $ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Segment.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#patch-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025Segment -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025Segment -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Segment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/segments#patch-segment - source: | - from sailpoint.v2025.api.segments_api import SegmentsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. - request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - try: - # Update Segment - new_request_body = RequestBody.from_json(request_body) - results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).patch_segment(id, new_request_body) - print("The response of SegmentsApi->patch_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) - /service-desk-integrations: - get: - tags: - - Service Desk Integration - summary: List existing Service Desk integrations - description: Get a list of Service Desk integration objects. - operationId: getServiceDeskIntegrations - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - name: sorters - in: query - required: false - style: form - explode: true - schema: - type: string - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - example: name - - name: filters - in: query - required: false - style: form - explode: true - schema: - type: string - format: comma-separated - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq* - - **type**: *eq, in* - - **cluster**: *eq, in* - example: name eq "John Doe" - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - responses: - '200': - description: List of ServiceDeskIntegrationDto - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - description: Service Desk integration's specification. - required: - - name - - description - - type - - attributes - properties: - id: - type: string - description: Unique identifier for the Service Desk integration - example: 62945a496ef440189b1f03e3623411c8 - name: - description: Service Desk integration's name. The name must be unique. - type: string - example: Service Desk Integration Name - created: - type: string - format: date-time - description: The date and time the Service Desk integration was created - example: '2024-01-17T18:45:25.994Z' - modified: - type: string - format: date-time - description: The date and time the Service Desk integration was last modified - example: '2024-02-18T18:45:25.994Z' - description: - description: Service Desk integration's description. - type: string - example: A very nice Service Desk integration - type: - description: | - Service Desk integration types: - - - ServiceNowSDIM - - ServiceNow - type: string - default: ServiceNowSDIM - example: ServiceNowSDIM - ownerRef: - allOf: - - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/ownerRef/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/OwnerDto.yaml - clusterRef: - allOf: - - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/clusterRef/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SourceClusterDto.yaml - cluster: - description: Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). - type: string - example: xyzzy999 - deprecated: true - nullable: true - managedSources: - description: Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). - type: array - items: - type: string - deprecated: true - example: - - 2c9180835d191a86015d28455b4a2329 - - 2c5680835d191a85765d28455b4a9823 - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/provisioningConfig' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningConfig.yaml - attributes: - description: Service Desk integration's attributes. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - example: - property: value - key: value - beforeProvisioningRule: - allOf: - - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/beforeProvisioningRule/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BeforeProvisioningRuleDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-integration:read - - idn:service-desk-integration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integrations - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List existing Service Desk integrations - - try { - Get-V2025ServiceDeskIntegrations - - # Below is a request that includes all optional parameters - # Get-V2025ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegrations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#get-service-desk-integrations - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'name eq \"John Doe\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List existing Service Desk integrations - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) - post: - tags: - - Service Desk Integration - summary: Create new Service Desk integration - description: Create a new Service Desk integration. - operationId: createServiceDeskIntegration - requestBody: - description: The specifics of a new integration to create - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml - required: true - responses: - '200': - description: Details of the created integration - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-integration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#create-service-desk-integration - source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ - - # Create new Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-V2025ServiceDeskIntegration -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-V2025ServiceDeskIntegration -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#create-service-desk-integration - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create - try: - # Create new Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) - /service-desk-integrations/{id}: - get: - tags: - - Service Desk Integration - summary: Get a Service Desk integration - description: Get an existing Service Desk integration by ID. - operationId: getServiceDeskIntegration - parameters: - - name: id - in: path - description: ID of the Service Desk integration to get - required: true - x-sailpoint-resource-operation-id: getServiceDeskIntegrations - style: simple - explode: false - schema: - type: string - example: anId - responses: - '200': - description: ServiceDeskIntegrationDto with the given ID - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-integration:read - - idn:service-desk-integration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to get - - # Get a Service Desk integration - - try { - Get-V2025ServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#get-service-desk-integration - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get - try: - # Get a Service Desk integration - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) - put: - tags: - - Service Desk Integration - summary: Update a Service Desk integration - description: Update an existing Service Desk integration by ID. - operationId: putServiceDeskIntegration - parameters: - - name: id - in: path - description: ID of the Service Desk integration to update - required: true - x-sailpoint-resource-operation-id: getServiceDeskIntegrations - style: simple - explode: false - schema: - type: string - example: anId - requestBody: - description: The specifics of the integration to update - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml - required: true - responses: - '200': - description: ServiceDeskIntegrationDto as updated - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-integration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#put-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ - - # Update a Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-V2025ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # Send-V2025ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#put-service-desk-integration - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of the integration to update - try: - # Update a Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) - delete: - tags: - - Service Desk Integration - summary: Delete a Service Desk integration - description: Delete an existing Service Desk integration by ID. - operationId: deleteServiceDeskIntegration - parameters: - - name: id - in: path - description: ID of Service Desk integration to delete - required: true - x-sailpoint-resource-operation-id: getServiceDeskIntegrations - style: simple - explode: false - schema: - type: string - example: anId - responses: - '204': - description: Service Desk integration with the given ID successfully deleted - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-integration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#delete-service-desk-integration - source: | - $Id = "anId" # String | ID of Service Desk integration to delete - - # Delete a Service Desk integration - - try { - Remove-V2025ServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#delete-service-desk-integration - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete - try: - # Delete a Service Desk integration - - ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) - patch: - operationId: patchServiceDeskIntegration - tags: - - Service Desk Integration - summary: Patch a Service Desk Integration - description: Update an existing Service Desk integration by ID with a PATCH request. - parameters: - - name: id - in: path - description: ID of the Service Desk integration to update - required: true - x-sailpoint-resource-operation-id: getServiceDeskIntegrations - style: simple - explode: false - schema: - type: string - example: anId - requestBody: - required: true - description: | - A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - Only `replace` operations are accepted by this endpoint. - - A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - content: - application/json-patch+json: - schema: - type: object - description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - properties: - operations: - description: Operations to be applied - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /ownerRef - value: - id: 2c9180867d05b227017d09921a205b4d - type: IDENTITY - name: Angelo Medici - responses: - '200': - description: ServiceDeskIntegrationDto as updated - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-integration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#patch-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - - "@ - - # Patch a Service Desk Integration - - try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2025ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#patch-service-desk-integration - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v2025.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - try: - # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) - print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) - /service-desk-integrations/types: - get: - tags: - - Service Desk Integration - summary: List Service Desk integration types - description: This API endpoint returns the current list of supported Service Desk integration types. - operationId: getServiceDeskIntegrationTypes - responses: - '200': - description: Responds with an array of the currently supported Service Desk integration types. - content: - application/json: - schema: - type: array - items: - description: This represents a Service Desk Integration template type. - required: - - type - - scriptName - type: object - properties: - name: - description: This is the name of the type. - example: aName - type: string - type: - description: This is the type value for the type. - example: aType - type: string - scriptName: - description: This is the scriptName attribute value for the type. - example: aScriptName - type: string - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-integration:read - - idn:service-desk-integration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration-types - source: | - - # List Service Desk integration types - - try { - Get-V2025ServiceDeskIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-V2025ServiceDeskIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegrationTypes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#get-service-desk-integration-types - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Service Desk integration types - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - /service-desk-integrations/templates/{scriptName}: - get: - tags: - - Service Desk Integration - summary: Service Desk integration template by scriptName - description: This API endpoint returns an existing Service Desk integration template by scriptName. - operationId: getServiceDeskIntegrationTemplate - parameters: - - name: scriptName - in: path - description: The scriptName value of the Service Desk integration template to get - required: true - x-sailpoint-resource-operation-id: getServiceDeskIntegrations - style: simple - explode: false - schema: - type: string - example: aScriptName - responses: - '200': - description: Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/Account/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - - type: object - description: This is the model for a Service Desk integration template, used to create and edit Service Desk Integrations. - required: - - type - - attributes - - provisioningConfig - properties: - type: - description: The 'type' property specifies the type of the Service Desk integration template. - type: string - example: Web Service SDIM - default: Web Service SDIM - attributes: - description: The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. - type: object - additionalProperties: true - example: - property: value - key: value - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations using the template. - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/provisioningConfig' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-integration:read - - idn:service-desk-integration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - - # Service Desk integration template by scriptName - - try { - Get-V2025ServiceDeskIntegrationTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025ServiceDeskIntegrationTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegrationTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#get-service-desk-integration-template - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get - try: - # Service Desk integration template by scriptName - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) - /service-desk-integrations/status-check-configuration: - get: - tags: - - Service Desk Integration - summary: Get the time check configuration - description: Get the time check configuration of queued SDIM tickets. - operationId: getStatusCheckDetails - responses: - '200': - description: QueuedCheckConfigDetails containing the configured values - content: - application/json: - schema: - description: Configuration of maximum number of days and interval for checking Service Desk integration queue status. - required: - - provisioningStatusCheckIntervalMinutes - - provisioningMaxStatusCheckDays - type: object - properties: - provisioningStatusCheckIntervalMinutes: - description: Interval in minutes between status checks - type: string - example: 30 - provisioningMaxStatusCheckDays: - description: Maximum number of days to check - type: string - example: 2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-integration:read - - idn:service-desk-integration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-status-check-details - source: | - - # Get the time check configuration - - try { - Get-V2025StatusCheckDetails - - # Below is a request that includes all optional parameters - # Get-V2025StatusCheckDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusCheckDetails" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#get-status-check-details - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get the time check configuration - - results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) - put: - tags: - - Service Desk Integration - summary: Update the time check configuration - description: Update the time check configuration of queued SDIM tickets. - operationId: updateStatusCheckDetails - requestBody: - description: The modified time check configuration - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations~1status-check-configuration/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/QueuedCheckConfigDetails.yaml - required: true - responses: - '200': - description: QueuedCheckConfigDetails as updated - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations~1status-check-configuration/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/QueuedCheckConfigDetails.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-integration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#update-status-check-details - source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ - - # Update the time check configuration - - try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-V2025StatusCheckDetails -QueuedCheckConfigDetails $Result - - # Below is a request that includes all optional parameters - # Update-V2025StatusCheckDetails -QueuedCheckConfigDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025StatusCheckDetails" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/service-desk-integration#update-status-check-details - source: | - from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - queued_check_config_details = '''{ - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - }''' # QueuedCheckConfigDetails | The modified time check configuration - try: - # Update the time check configuration - new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) - results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) - print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) - /query-password-info: - post: - operationId: queryPasswordInfo - tags: - - Password Management - summary: Query Password Info - security: - - applicationAuth: [] - description: | - This API is used to query password related information. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - userName: - type: string - description: The login name of the user - example: Abby.Smith - sourceName: - type: string - description: The display name of the source - example: My-AD - responses: - '200': - description: Reference to the password info. - content: - application/json: - schema: - type: object - properties: - identityId: - type: string - description: Identity ID - example: 2c918085744fec4301746f9a5bce4605 - sourceId: - type: string - description: source ID - example: 2c918083746f642c01746f990884012a - publicKeyId: - type: string - description: public key ID - example: N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh - publicKey: - type: string - description: User's public key with Base64 encoding - example: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB - accounts: - type: array - description: Account info related to queried identity and source - items: - type: object - properties: - accountId: - type: string - description: Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 - example: CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com - accountName: - type: string - description: Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 - example: Abby.Smith - policies: - type: array - description: Password constraints - items: - type: string - example: - - passwordRepeatedChar is 3 - - passwordMinAlpha is 1 - - passwordMinLength is 5 - - passwordMinNumeric is 1 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-management#query-password-info - source: | - $PasswordInfoQueryDTO = @" - { - "sourceName" : "My-AD", - "userName" : "Abby.Smith" - } - "@ - - # Query Password Info - - try { - $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO - Search-V2025PasswordInfo -PasswordInfoQueryDTO $Result - - # Below is a request that includes all optional parameters - # Search-V2025PasswordInfo -PasswordInfoQueryDTO $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025PasswordInfo" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-management#query-password-info - source: | - from sailpoint.v2025.api.password_management_api import PasswordManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_info import PasswordInfo - from sailpoint.v2025.models.password_info_query_dto import PasswordInfoQueryDTO - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - password_info_query_dto = '''{ - "sourceName" : "My-AD", - "userName" : "Abby.Smith" - }''' # PasswordInfoQueryDTO | - try: - # Query Password Info - new_password_info_query_dto = PasswordInfoQueryDto.from_json(password_info_query_dto) - results = PasswordManagementApi(api_client).query_password_info(password_info_query_dto=new_password_info_query_dto) - # Below is a request that includes all optional parameters - # results = PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto) - print("The response of PasswordManagementApi->query_password_info:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) - /set-password: - post: - operationId: setPassword - tags: - - Password Management - summary: Set Identity's Password - security: - - applicationAuth: [] - description: | - This API is used to set a password for an identity. - - An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). - - >**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** - - To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: - - ```bash - echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 - ``` - - In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. - - To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. - - If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. - - You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - identityId: - type: string - description: The identity ID that requested the password change - example: 8a807d4c73c545510173c545f0a002ff - encryptedPassword: - type: string - description: The RSA encrypted password - example: XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== - publicKeyId: - type: string - description: The encryption key ID - example: YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2 - accountId: - type: string - description: Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 - example: CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com - sourceId: - type: string - description: The ID of the source for which identity is requesting the password change - example: 8a807d4c73c545510173c545d4b60246 - responses: - '202': - description: Reference to the password change. - content: - application/json: - schema: - type: object - properties: - requestId: - type: string - nullable: true - description: The password change request ID - example: 089899f13a8f4da7824996191587bab9 - state: - type: string - enum: - - IN_PROGRESS - - FINISHED - - FAILED - description: Password change state - example: IN_PROGRESS - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-management#set-password - source: | - $PasswordChangeRequest = @" - { - "sourceId" : "8a807d4c73c545510173c545d4b60246", - "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", - "identityId" : "8a807d4c73c545510173c545f0a002ff", - "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", - "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" - } - "@ - - # Set Identity's Password - - try { - $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest - Set-V2025Password -PasswordChangeRequest $Result - - # Below is a request that includes all optional parameters - # Set-V2025Password -PasswordChangeRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025Password" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-management#set-password - source: | - from sailpoint.v2025.api.password_management_api import PasswordManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_change_request import PasswordChangeRequest - from sailpoint.v2025.models.password_change_response import PasswordChangeResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - password_change_request = '''{ - "sourceId" : "8a807d4c73c545510173c545d4b60246", - "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", - "identityId" : "8a807d4c73c545510173c545f0a002ff", - "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", - "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" - }''' # PasswordChangeRequest | - try: - # Set Identity's Password - new_password_change_request = PasswordChangeRequest.from_json(password_change_request) - results = PasswordManagementApi(api_client).set_password(password_change_request=new_password_change_request) - # Below is a request that includes all optional parameters - # results = PasswordManagementApi(api_client).set_password(new_password_change_request) - print("The response of PasswordManagementApi->set_password:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) - /password-change-status/{id}: - get: - operationId: getPasswordChangeStatus - tags: - - Password Management - summary: Get Password Change Request Status - security: - - userAuth: [] - - applicationAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: This API returns the status of a password change request. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: setPassword - example: 089899f13a8f4da7824996191587bab9 - description: Password change request ID - responses: - '200': - description: Status of the password change request - content: - application/json: - schema: - type: object - properties: - requestId: - type: string - nullable: true - description: The password change request ID - example: 089899f13a8f4da7824996191587bab9 - state: - type: string - enum: - - IN_PROGRESS - - FINISHED - - FAILED - description: Password change state - example: IN_PROGRESS - errors: - type: array - items: - type: string - description: The errors during the password change request - example: - - The password change payload is invalid - sourceIds: - type: array - items: - type: string - description: List of source IDs in the password change request - example: - - 2c918083746f642c01746f990884012a - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-management#get-password-change-status - source: | - $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID - - # Get Password Change Request Status - - try { - Get-V2025PasswordChangeStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025PasswordChangeStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordChangeStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-management#get-password-change-status - source: | - from sailpoint.v2025.api.password_management_api import PasswordManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_status import PasswordStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID - try: - # Get Password Change Request Status - - results = PasswordManagementApi(api_client).get_password_change_status(id=id) - # Below is a request that includes all optional parameters - # results = PasswordManagementApi(api_client).get_password_change_status(id) - print("The response of PasswordManagementApi->get_password_change_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) - /password-dictionary: - get: - operationId: getPasswordDictionary - tags: - - Password Dictionary - summary: Get Password Dictionary - description: |- - This gets password dictionary for the organization. - The password dictionary file can contain lines that are: - 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing - 2. empty lines - 3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines - 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; - maximum length of the line is 128 Unicode codepoints - - - Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). - Password dict file must contain UTF-8 characters only. - - # Sample password text file - - ``` - - # Password dictionary small test file - - locale=en_US - - # Password dictionary prohibited words - - qwerty - abcd - aaaaa - password - qazxsws - - ``` - security: - - userAuth: - - idn:password-dictionary-management:read - x-sailpoint-userLevels: - - ORG_ADMIN - responses: - '200': - description: A password dictionary response - content: - text/plain: - schema: - type: string - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-dictionary#get-password-dictionary - source: | - - # Get Password Dictionary - - try { - Get-V2025PasswordDictionary - - # Below is a request that includes all optional parameters - # Get-V2025PasswordDictionary - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordDictionary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-dictionary#get-password-dictionary - source: | - from sailpoint.v2025.api.password_dictionary_api import PasswordDictionaryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get Password Dictionary - - results = PasswordDictionaryApi(api_client).get_password_dictionary() - # Below is a request that includes all optional parameters - # results = PasswordDictionaryApi(api_client).get_password_dictionary() - print("The response of PasswordDictionaryApi->get_password_dictionary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) - put: - operationId: putPasswordDictionary - tags: - - Password Dictionary - summary: Update Password Dictionary - description: |- - This updates password dictionary for the organization. - The password dictionary file can contain lines that are: - 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing - 2. empty lines - 3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines - 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; - maximum length of the line is 128 Unicode codepoints - - - Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). - Password dict file must contain UTF-8 characters only. - - # Sample password text file - - ``` - - # Password dictionary small test file - - locale=en_US - - # Password dictionary prohibited words - - qwerty - abcd - aaaaa - password - qazxsws - - ``` - security: - - userAuth: - - idn:password-dictionary:manage - x-sailpoint-userLevels: - - ORG_ADMIN - requestBody: - required: true - description: The password dictionary file to be uploaded. - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - responses: - '200': - description: Successfully updated. - '201': - description: Created. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-dictionary#put-password-dictionary - source: | - $File = # System.IO.FileInfo | (optional) - - # Update Password Dictionary - - try { - Send-V2025PasswordDictionary - - # Below is a request that includes all optional parameters - # Send-V2025PasswordDictionary -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PasswordDictionary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-dictionary#put-password-dictionary - source: | - from sailpoint.v2025.api.password_dictionary_api import PasswordDictionaryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - file = None # bytearray | (optional) # bytearray | (optional) - try: - # Update Password Dictionary - - PasswordDictionaryApi(api_client).put_password_dictionary() - # Below is a request that includes all optional parameters - # PasswordDictionaryApi(api_client).put_password_dictionary(file) - except Exception as e: - print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) - /password-org-config: - get: - operationId: getPasswordOrgConfig - tags: - - Password Configuration - summary: Get Password Org Config - description: This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' - security: - - userAuth: - - idn:password-org-config:read - responses: - '200': - description: Reference to the password org config. - content: - application/json: - schema: - type: object - properties: - customInstructionsEnabled: - type: boolean - description: Indicator whether custom password instructions feature is enabled. The default value is false. - default: false - example: true - digitTokenEnabled: - type: boolean - description: Indicator whether "digit token" feature is enabled. The default value is false. - default: false - example: true - digitTokenDurationMinutes: - type: integer - format: int32 - description: The duration of "digit token" in minutes. The default value is 5. - minimum: 1 - maximum: 60 - default: 5 - example: 10 - digitTokenLength: - type: integer - format: int32 - description: The length of "digit token". The default value is 6. - minimum: 6 - maximum: 18 - default: 6 - example: 9 - example: - customInstructionsEnabled: true - digitTokenDurationMinutes: 9 - digitTokenEnabled: false - digitTokenLength: 6 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#get-password-org-config - source: | - - # Get Password Org Config - - try { - Get-V2025PasswordOrgConfig - - # Below is a request that includes all optional parameters - # Get-V2025PasswordOrgConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordOrgConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-configuration#get-password-org-config - source: | - from sailpoint.v2025.api.password_configuration_api import PasswordConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_org_config import PasswordOrgConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get Password Org Config - - results = PasswordConfigurationApi(api_client).get_password_org_config() - # Below is a request that includes all optional parameters - # results = PasswordConfigurationApi(api_client).get_password_org_config() - print("The response of PasswordConfigurationApi->get_password_org_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) - put: - operationId: putPasswordOrgConfig - tags: - - Password Configuration - summary: Update Password Org Config - description: |- - This API updates the password org config for specified fields. Other fields will keep original value. - You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. - Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' - security: - - userAuth: - - idn:password-org-config:write - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1password-org-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordOrgConfig.yaml - example: - digitTokenEnabled: true - digitTokenDurationMinutes: 12 - responses: - '200': - description: Reference to the password org config. - content: - application/json: - schema: - $ref: '#/paths/~1password-org-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordOrgConfig.yaml - example: - customInstructionsEnabled: true - digitTokenDurationMinutes: 12 - digitTokenEnabled: true - digitTokenLength: 6 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#put-password-org-config - source: | - $PasswordOrgConfig = @" - { - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - } - "@ - - # Update Password Org Config - - try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - Send-V2025PasswordOrgConfig -PasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025PasswordOrgConfig -PasswordOrgConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PasswordOrgConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-configuration#put-password-org-config - source: | - from sailpoint.v2025.api.password_configuration_api import PasswordConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_org_config import PasswordOrgConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - password_org_config = '''{ - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - }''' # PasswordOrgConfig | - try: - # Update Password Org Config - new_password_org_config = PasswordOrgConfig.from_json(password_org_config) - results = PasswordConfigurationApi(api_client).put_password_org_config(password_org_config=new_password_org_config) - # Below is a request that includes all optional parameters - # results = PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config) - print("The response of PasswordConfigurationApi->put_password_org_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) - post: - operationId: createPasswordOrgConfig - tags: - - Password Configuration - summary: Create Password Org Config - description: |- - This API creates the password org config. Unspecified fields will use default value. - To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". - Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' - security: - - userAuth: - - idn:password-org-config:write - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1password-org-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordOrgConfig.yaml - example: - customInstructionsEnabled: true - digitTokenEnabled: true - digitTokenDurationMinutes: 12 - digitTokenLength: 9 - responses: - '200': - description: Reference to the password org config. - content: - application/json: - schema: - $ref: '#/paths/~1password-org-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordOrgConfig.yaml - example: - customInstructionsEnabled: true - digitTokenDurationMinutes: 9 - digitTokenEnabled: true - digitTokenLength: 12 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#create-password-org-config - source: | - $PasswordOrgConfig = @" - { - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - } - "@ - - # Create Password Org Config - - try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - New-V2025PasswordOrgConfig -PasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # New-V2025PasswordOrgConfig -PasswordOrgConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordOrgConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-configuration#create-password-org-config - source: | - from sailpoint.v2025.api.password_configuration_api import PasswordConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_org_config import PasswordOrgConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - password_org_config = '''{ - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - }''' # PasswordOrgConfig | - try: - # Create Password Org Config - new_password_org_config = PasswordOrgConfig.from_json(password_org_config) - results = PasswordConfigurationApi(api_client).create_password_org_config(password_org_config=new_password_org_config) - # Below is a request that includes all optional parameters - # results = PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config) - print("The response of PasswordConfigurationApi->create_password_org_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) - /reports/{taskResultId}/result: - get: - tags: - - Reports Data Extraction - description: Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - operationId: getReportResult - summary: Get Report Result - security: - - userAuth: - - sp:report-result:read - parameters: - - in: path - name: taskResultId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: startReport - description: Unique identifier of the task result which handled report - example: ef38f94347e94562b5bb8424a56397d8 - - in: query - name: completed - schema: - type: boolean - default: false - required: false - description: state of task result to apply ordering when results are fetching from the DB - example: true - responses: - '200': - description: Details about report that was run or is running. - content: - application/json: - schema: - type: object - description: Details about report result or current state. - properties: - reportType: - type: string - enum: - - ACCOUNTS - - IDENTITIES_DETAILS - - IDENTITIES - - IDENTITY_PROFILE_IDENTITY_ERROR - - ORPHAN_IDENTITIES - - SEARCH_EXPORT - - UNCORRELATED_ACCOUNTS - description: Use this property to define what report should be processed in the RDE service. - example: IDENTITIES_DETAILS - taskDefName: - type: string - description: Name of the task definition which is started to process requesting report. Usually the same as report name - example: Identities Details Report - id: - type: string - description: Unique task definition identifier. - example: a248c16fe22222b2bd49615481311111 - created: - type: string - description: Report processing start date - format: date-time - example: '2020-09-07T42:14:00.364Z' - status: - type: string - enum: - - SUCCESS - - FAILURE - - WARNING - - TERMINATED - description: Report current state or result status. - example: SUCCESS - duration: - type: integer - format: int64 - description: Report processing time in ms. - example: 342 - rows: - type: integer - format: int64 - description: Report size in rows. - example: 37 - availableFormats: - type: array - items: - type: string - enum: - - CSV - - PDF - description: Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. - example: - - CSV - examples: - identityDetailsReport: - summary: Identities Details Report result. - value: - reportType: IDENTITIES_DETAILS - taskDefName: Identities Details Report - id: 1e01d272b8084c4fa12fcf8fa898102d - created: '2023-09-07T42:14:05.122Z' - status: SUCCESS - duration: 3681 - rows: 193 - availableFormats: - - CSV - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#get-report-result - source: | - $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report - $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) - - # Get Report Result - - try { - Get-V2025ReportResult -TaskResultId $TaskResultId - - # Below is a request that includes all optional parameters - # Get-V2025ReportResult -TaskResultId $TaskResultId -Completed $Completed - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReportResult" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/reports-data-extraction#get-report-result - source: | - from sailpoint.v2025.api.reports_data_extraction_api import ReportsDataExtractionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_results import ReportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report - completed = False # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) - try: - # Get Report Result - - results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id=task_result_id) - # Below is a request that includes all optional parameters - # results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id, completed) - print("The response of ReportsDataExtractionApi->get_report_result:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) - /reports/run: - post: - tags: - - Reports Data Extraction - description: Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - operationId: startReport - summary: Run Report - security: - - userAuth: - - sp:report:manage - - applicationAuth: - - sp:report:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - - REPORT_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - requestBody: - content: - application/json: - schema: - type: object - description: Details about report to be processed. - properties: - reportType: - type: string - enum: - - ACCOUNTS - - IDENTITIES_DETAILS - - IDENTITIES - - IDENTITY_PROFILE_IDENTITY_ERROR - - ORPHAN_IDENTITIES - - SEARCH_EXPORT - - UNCORRELATED_ACCOUNTS - description: Use this property to define what report should be processed in the RDE service. - example: ACCOUNTS - arguments: - anyOf: - - title: ACCOUNTS - type: object - description: Arguments for Account Export report (ACCOUNTS) - required: - - application - - sourceName - properties: - application: - type: string - description: Source ID. - example: 2c9180897eSourceIde781782f705b9 - sourceName: - type: string - description: Source name. - example: Active Directory - - title: IDENTITIES_DETAILS - type: object - description: Arguments for Identities Details report (IDENTITIES_DETAILS) - required: - - correlatedOnly - properties: - correlatedOnly: - type: boolean - description: Flag to specify if only correlated identities are included in report. - default: false - example: true - - title: IDENTITIES - type: object - description: Arguments for Identities report (IDENTITIES) - properties: - correlatedOnly: - type: boolean - description: Flag to specify if only correlated identities are included in report. - default: false - example: true - - title: IDENTITY_PROFILE_IDENTITY_ERROR - type: object - description: Arguments for Identity Profile Identity Error report (IDENTITY_PROFILE_IDENTITY_ERROR) - required: - - authoritativeSource - properties: - authoritativeSource: - type: string - description: Source ID. - example: 1234sourceId5678902 - - title: ORPHAN_IDENTITIES - type: object - description: Arguments for Orphan Identities report (ORPHAN_IDENTITIES) - properties: - selectedFormats: - type: array - items: - type: string - enum: - - CSV - - PDF - description: Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. - example: - - CSV - - title: SEARCH_EXPORT - type: object - description: | - Arguments for Search Export report (SEARCH_EXPORT) - - The report file generated will be a zip file containing csv files of the search results. - required: - - query - properties: - indices: - description: The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - externalDocs: - description: Learn more about search indices here. - url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html - type: array - items: - $ref: '#/components/schemas/SavedSearch/allOf/2/properties/indices/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/Index.yaml - example: - - entitlements - query: - description: The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - type: string - example: name:a* - columns: - description: | - Comma separated string consisting of technical attribute names of fields to include in report. - - Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. - - Use `accessProfiles.spread` to unclude access profile details. - - Use `entitlements.spread` to include entitlement details. - type: string - example: displayName,firstName,lastName,email,created,attributes.cloudLifecycleState - sort: - description: The fields to be used to sort the search results. Use + or - to specify the sort direction. - type: array - items: - type: string - example: - - displayName - - +id - - title: UNCORRELATED_ACCOUNTS - type: object - description: Arguments for Uncorrelated Accounts report (UNCORRELATED_ACCOUNTS) - properties: - selectedFormats: - type: array - items: - type: string - enum: - - CSV - - PDF - description: Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. - example: - - CSV - example: - application: 2c9180897e7742b2017e781782f705b9 - sourceName: Active Directory - description: The string-object map(dictionary) with the arguments needed for report processing. - examples: - Account Export Report: - summary: Account Export report - value: - reportType: ACCOUNTS - arguments: - application: 2c9180897eSourceIde781782f705b9 - sourceName: Active Directory - Identities Details Report: - summary: Identities Details report - value: - reportType: IDENTITIES_DETAILS - arguments: - correlatedOnly: true - Identities Report: - summary: Identities report - value: - reportType: IDENTITIES - arguments: - correlatedOnly: true - Identity Profile Identity Error Report: - summary: Identity Profile Identity Error report - value: - reportType: IDENTITY_PROFILE_IDENTITY_ERROR - arguments: - authoritativeSource: 2c9180847de347aa017de8ef09167792 - Orphan Identities Report: - summary: Orphan Identities report - value: - reportType: ORPHAN_IDENTITIES - arguments: - selectedFormats: - - CSV - - PDF - Search Export Report: - summary: Search Export report - value: - reportType: SEARCH_EXPORT - arguments: - indices: - - identities - query: attributes.city:London - columns: displayName,firstName,lastName,email,attributes.city,created,attributes.cloudLifecycleState,access.spread - sort: - - +displayName - Uncorrelated Accounts Report: - summary: Uncorrelated Accounts report - value: - reportType: UNCORRELATED_ACCOUNTS - arguments: - selectedFormats: - - CSV - - PDF - required: true - responses: - '200': - description: Details about running report task. - content: - application/json: - schema: - type: object - description: Details about job or task type, state and lifecycle. - properties: - type: - type: string - enum: - - QUARTZ - - QPOC - - MENTOS - - QUEUED_TASK - description: Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. - example: MENTOS - id: - type: string - description: Unique task definition identifier. - example: a248c16fe22222b2bd49615481311111 - reportType: - type: string - enum: - - ACCOUNTS - - IDENTITIES_DETAILS - - IDENTITIES - - IDENTITY_PROFILE_IDENTITY_ERROR - - ORPHAN_IDENTITIES - - SEARCH_EXPORT - - UNCORRELATED_ACCOUNTS - description: Use this property to define what report should be processed in the RDE service. - example: IDENTITIES_DETAILS - description: - type: string - description: Description of the report purpose and/or contents. - example: A detailed view of the identities in the system. - parentName: - type: string - nullable: true - description: Name of the parent task/report if exists. - example: Audit Report - launcher: - type: string - description: Name of the report processing initiator. - example: cloudadmin - created: - type: string - description: Report creation date - format: date-time - example: '2020-09-07T42:14:00.364Z' - launched: - type: string - nullable: true - format: date-time - description: Report start date - example: '2020-09-07T42:14:00.521Z' - completed: - type: string - nullable: true - format: date-time - description: Report completion date - example: '2020-09-07T42:14:01.137Z' - completionStatus: - type: string - nullable: true - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMP_ERROR - description: Report completion status. - example: Success - messages: - type: array - description: List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - example: [] - items: - type: object - properties: - type: - type: string - description: Type of the message. - enum: - - INFO - - WARN - - ERROR - example: WARN - error: - type: boolean - default: false - description: Flag whether message is an error. - example: false - warning: - type: boolean - default: false - description: Flag whether message is a warning. - example: true - key: - type: string - description: Message string identifier. - example: 'The following account(s) failed to correlate: A,B,C' - localizedText: - type: string - description: Message context with the locale based language. - example: 'The following account(s) failed to correlate: A,B,C' - returns: - type: array - description: Task definition results, if necessary. - example: [] - items: - type: object - properties: - displayLabel: - type: string - description: Attribute description. - example: ' ' - attributeName: - type: string - description: System or database attribute name. - example: ' ' - attributes: - type: object - description: Extra attributes map(dictionary) needed for the report. - example: - org: an-org - progress: - type: string - nullable: true - description: Current report state. - example: Initializing... - examples: - identityDetailsReport: - summary: Identities Details Report task result. - value: - reportType: IDENTITIES_DETAILS - taskDefName: Identities Details Report - type: QUARTZ - id: a248c16fe22222b2bd49615481311111 - created: '2023-09-07T42:14:00.364Z' - description: A detailed view of the identities in the system. - parentName: Audit Report - launcher: '9832285' - launched: '2023-09-07T42:14:00.521Z' - completed: '2023-09-07T42:14:01.137Z' - messages: [] - returns: [] - attributes: - org: an-org - progress: Initializing... - searchExportReport: - summary: Identities Details Report task result. - value: - reportType: SEARCH_EXPORT - taskDefName: Search Export - type: QUARTZ - id: a248c16fe22222b2bd49615481311111 - created: '2023-09-07T42:14:11.137Z' - description: Extract query data from ElasticSearch to CSV - parentName: null - launcher: T05293 - launched: '2020-09-07T42:14:11.137Z' - completed: '2020-09-07T42:14:13.451Z' - messages: [] - returns: [] - attributes: - queryHash: 5e12cf79c67d92e23d4d8cb3e974f87d164e86d4a48d32ecf89645cacfd3f2 - org: an-org - queryParams: - columns: displayName,firstName,lastName,email,created,attributes.cloudLifecycleState,tags,access.spread,apps.pread,accounts.spread - indices: identities - ownerId: 95ecba5c5444439c999aec638ce2a777 - query: 700007 - sort: displayName - progress: Initializing... - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#start-report - source: | - $ReportDetails = @" - { - "reportType" : "ACCOUNTS", - "arguments" : { - "application" : "2c9180897e7742b2017e781782f705b9", - "sourceName" : "Active Directory" - } - } - "@ - - # Run Report - - try { - $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails - Start-V2025Report -ReportDetails $Result - - # Below is a request that includes all optional parameters - # Start-V2025Report -ReportDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025Report" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/reports-data-extraction#start-report - source: | - from sailpoint.v2025.api.reports_data_extraction_api import ReportsDataExtractionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_details import ReportDetails - from sailpoint.v2025.models.task_result_details import TaskResultDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_details = '''{ - "reportType" : "ACCOUNTS", - "arguments" : { - "application" : "2c9180897e7742b2017e781782f705b9", - "sourceName" : "Active Directory" - } - }''' # ReportDetails | - try: - # Run Report - new_report_details = ReportDetails.from_json(report_details) - results = ReportsDataExtractionApi(api_client).start_report(report_details=new_report_details) - # Below is a request that includes all optional parameters - # results = ReportsDataExtractionApi(api_client).start_report(new_report_details) - print("The response of ReportsDataExtractionApi->start_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) - /reports/{id}/cancel: - post: - tags: - - Reports Data Extraction - description: Cancels a running report. - operationId: cancelReport - summary: Cancel Report - security: - - userAuth: - - sp:report:delete - parameters: - - name: id - in: path - description: ID of the running Report to cancel - required: true - x-sailpoint-resource-operation-id: startReport - style: simple - explode: false - schema: - type: string - example: a1ed223247144cc29d23c632624b4767 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#cancel-report - source: | - $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel - - # Cancel Report - - try { - Suspend-V2025Report -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2025Report -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025Report" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/reports-data-extraction#cancel-report - source: | - from sailpoint.v2025.api.reports_data_extraction_api import ReportsDataExtractionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel - try: - # Cancel Report - - ReportsDataExtractionApi(api_client).cancel_report(id=id) - # Below is a request that includes all optional parameters - # ReportsDataExtractionApi(api_client).cancel_report(id) - except Exception as e: - print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) - /reports/{taskResultId}: - get: - tags: - - Reports Data Extraction - description: Gets a report in file format. - operationId: getReport - summary: Get Report File - security: - - userAuth: - - sp:report:read - parameters: - - in: path - name: taskResultId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: startReport - description: Unique identifier of the task result which handled report - example: ef38f94347e94562b5bb8424a56397d8 - - in: query - name: fileFormat - schema: - type: string - enum: - - csv - - pdf - required: true - description: Output format of the requested report file - example: csv - - in: query - name: name - required: false - schema: - type: string - example: Identities Details Report - description: preferred Report file name, by default will be used report name from task result. - - in: query - name: auditable - required: false - schema: - type: boolean - default: false - example: true - description: Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - responses: - '200': - description: Report file in selected format. CSV by default. - content: - application/csv: - schema: - type: string - format: binary - application/pdf: - schema: - type: string - format: binary - headers: - Content-disposition: - description: The requested report's filename - schema: - type: string - example: attachment;filename=\"fileName" - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text:

File Not Found - 404 Error

The requested file was not found. - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#get-report - source: | - $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report - $FileFormat = "csv" # String | Output format of the requested report file - $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) - $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) - - # Get Report File - - try { - Get-V2025Report -TaskResultId $TaskResultId -FileFormat $FileFormat - - # Below is a request that includes all optional parameters - # Get-V2025Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Report" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/reports-data-extraction#get-report - source: | - from sailpoint.v2025.api.reports_data_extraction_api import ReportsDataExtractionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report - file_format = 'csv' # str | Output format of the requested report file # str | Output format of the requested report file - name = 'Identities Details Report' # str | preferred Report file name, by default will be used report name from task result. (optional) # str | preferred Report file name, by default will be used report name from task result. (optional) - auditable = False # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) - try: - # Get Report File - - results = ReportsDataExtractionApi(api_client).get_report(task_result_id=task_result_id, file_format=file_format) - # Below is a request that includes all optional parameters - # results = ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, name, auditable) - print("The response of ReportsDataExtractionApi->get_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) - /sod-policies: - post: - security: - - userAuth: - - idn:sod-policy:write - operationId: createSodPolicy - tags: - - SOD Policies - summary: Create SOD policy - description: |- - This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. - Requires role of ORG_ADMIN. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: Policy id - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - name: - type: string - description: Policy Business Name - example: policy-xyz - created: - type: string - format: date-time - description: The time when this SOD policy is created. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - modified: - type: string - format: date-time - description: The time when this SOD policy is modified. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - description: - type: string - description: Optional description of the SOD policy - example: This policy ensures compliance of xyz - nullable: true - ownerRef: - type: object - description: The owner of the SOD policy. - properties: - type: - type: string - description: Owner type. - enum: - - IDENTITY - - GOVERNANCE_GROUP - example: IDENTITY - id: - type: string - description: Owner's ID. - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Owner's name. - example: Support - externalPolicyReference: - type: string - description: Optional External Policy Reference - example: XYZ policy - nullable: true - policyQuery: - type: string - description: Search query of the SOD policy - example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)' - compensatingControls: - type: string - description: Optional compensating controls(Mitigating Controls) - example: Have a manager review the transaction decisions for their "out of compliance" employee - nullable: true - correctionAdvice: - type: string - description: Optional correction advice - example: Based on the role of the employee, managers should remove access that is not required for their job function. - nullable: true - state: - type: string - description: whether the policy is enforced or not - enum: - - ENFORCED - - NOT_ENFORCED - example: ENFORCED - tags: - type: array - description: tags for this policy object - example: - - TAG1 - - TAG2 - items: - type: string - creatorId: - type: string - description: Policy's creator ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - readOnly: true - modifierId: - type: string - description: Policy's modifier ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - nullable: true - readOnly: true - violationOwnerAssignmentConfig: - type: object - properties: - assignmentRule: - type: string - enum: - - MANAGER - - STATIC - - null - description: |- - Details about the violations owner. - MANAGER - identity's manager - STATIC - Governance Group or Identity - example: MANAGER - nullable: true - ownerRef: - type: object - description: The owner of the violation assignment config. - nullable: true - properties: - type: - type: string - description: Owner type. - enum: - - IDENTITY - - GOVERNANCE_GROUP - - MANAGER - - null - example: IDENTITY - id: - type: string - description: Owner's ID. - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Owner's name. - example: Support - scheduled: - type: boolean - description: defines whether a policy has been scheduled or not - example: true - default: false - type: - type: string - description: whether a policy is query based or conflicting access based - default: GENERAL - enum: - - GENERAL - - CONFLICTING_ACCESS_BASED - example: GENERAL - conflictingAccessCriteria: - allOf: - - type: object - properties: - leftCriteria: - type: object - properties: - name: - type: string - description: Business name for the access construct list - example: money-in - criteriaList: - type: array - description: List of criteria. There is a min of 1 and max of 50 items in the list. - minItems: 1 - maxItems: 50 - items: - type: object - properties: - type: - type: string - enum: - - ENTITLEMENT - description: Type of the propery to which this reference applies to - example: ENTITLEMENT - id: - type: string - description: ID of the object to which this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies to - example: Administrator - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - name: Administrator - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - name: Administrator - rightCriteria: - $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema/properties/conflictingAccessCriteria/allOf/0/properties/leftCriteria' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessCriteria.yaml - - nullable: true - examples: - Conflicting Access Based Policy: - value: - name: Conflicting-Policy-Name - description: This policy ensures compliance of xyz - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Owner Name - externalPolicyReference: XYZ policy - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function. - state: ENFORCED - tags: - - string - creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a68 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a69 - General Policy: - value: - description: Description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - name: General-Policy-Name - responses: - '201': - description: SOD policy created - content: - application/json: - schema: - $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicy.yaml - examples: - Conflicting Access Based Policy: - value: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: Conflicting-Policy-Name - created: '2020-01-01T00:00:00.000000Z' - modified: '2020-01-01T00:00:00.000000Z' - description: This policy ensures compliance of xyz - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Owner Name - externalPolicyReference: XYZ policy - policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)' - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function. - state: ENFORCED - tags: - - string - creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a68 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a69 - General Policy: - value: - description: Description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - type: GENERAL - conflictingAccessCriteria: null - id: 52c11db4-733e-4c31-949a-766c95ec95f1 - name: General-Policy-Name - created: '2020-05-12T19:47:38Z' - modified: '2020-05-12T19:47:38Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2025SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2025SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) - get: - security: - - userAuth: - - idn:sod-policy:read - operationId: listSodPolicies - tags: - - SOD Policies - summary: List SOD policies - description: |- - This gets list of all SOD policies. - Requires role of ORG_ADMIN - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, in* - - **state**: *eq, in* - example: id eq "bc693f07e7b645539626c25954c58554" - required: false - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: id,name - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, created, modified, description** - responses: - '200': - description: List of all SOD policies. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicy.yaml - example: - - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: Conflicting-Policy-Name - created: '2020-01-01T00:00:00.000000Z' - modified: '2020-01-01T00:00:00.000000Z' - description: This policy ensures compliance of xyz - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Owner Name - externalPolicyReference: XYZ policy - policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)' - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function. - state: ENFORCED - tags: - - string - creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a68 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a69 - - description: Description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - type: GENERAL - conflictingAccessCriteria: null - id: 52c11db4-733e-4c31-949a-766c95ec95f1 - name: General-Policy-Name - created: '2020-05-12T19:47:38Z' - modified: '2020-05-12T19:47:38Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-V2025SodPolicies - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - try: - # List SOD policies - - results = SODPoliciesApi(api_client).list_sod_policies() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - /sod-policies/{id}: - get: - security: - - userAuth: - - idn:sod-policy:read - operationId: getSodPolicy - tags: - - SOD Policies - summary: Get SOD policy by ID - description: |- - This gets specified SOD policy. - Requires role of ORG_ADMIN. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSodPolicies - description: The ID of the SOD Policy to retrieve. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - responses: - '200': - description: SOD policy ID. - content: - application/json: - schema: - $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicy.yaml - examples: - Conflicting Access Based Policy: - value: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: Conflicting-Policy-Name - created: '2020-01-01T00:00:00.000000Z' - modified: '2020-01-01T00:00:00.000000Z' - description: This policy ensures compliance of xyz - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Owner Name - externalPolicyReference: XYZ policy - policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)' - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function. - state: ENFORCED - tags: - - string - creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a68 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a69 - General Policy: - value: - description: Description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - type: GENERAL - conflictingAccessCriteria: null - id: 52c11db4-733e-4c31-949a-766c95ec95f1 - name: General-Policy-Name - created: '2020-05-12T19:47:38Z' - modified: '2020-05-12T19:47:38Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) - put: - security: - - userAuth: - - idn:sod-policy:write - operationId: putSodPolicy - tags: - - SOD Policies - summary: Update SOD policy by ID - description: |- - This updates a specified SOD policy. - Requires role of ORG_ADMIN. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSodPolicies - description: The ID of the SOD policy to update. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicy.yaml - examples: - Conflicting Access Based Policy: - value: - name: Conflicting-Policy-Name - description: Modified Description - externalPolicyReference: XYZ policy - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function. - state: ENFORCED - tags: - - string - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a68 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a69 - General Policy: - value: - description: Modified Description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - type: GENERAL - conflictingAccessCriteria: null - id: 52c11db4-733e-4c31-949a-766c95ec95f1 - name: General-Policy-Name - created: '2020-05-12T19:47:38Z' - modified: '2020-05-12T19:47:38Z' - responses: - '200': - description: SOD Policy by ID - content: - application/json: - schema: - $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicy.yaml - examples: - Conflicting Access Based Policy: - value: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: Conflicting-Policy-Name - created: '2020-01-01T00:00:00.000000Z' - modified: '2020-01-01T00:00:00.000000Z' - description: Modified description - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Owner Name - externalPolicyReference: XYZ policy - policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)' - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function. - state: ENFORCED - tags: - - string - creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a68 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a69 - General Policy: - value: - description: Modified Description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - type: GENERAL - conflictingAccessCriteria: null - id: 52c11db4-733e-4c31-949a-766c95ec95f1 - name: General-Policy-Name - created: '2020-05-12T19:47:38Z' - modified: '2020-05-12T19:47:38Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2025SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2025SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) - delete: - security: - - userAuth: - - idn:sod-policy:write - operationId: deleteSodPolicy - tags: - - SOD Policies - summary: Delete SOD policy by ID - description: |- - This deletes a specified SOD policy. - Requires role of ORG_ADMIN. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSodPolicies - description: The ID of the SOD Policy to delete. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - - in: query - name: logical - schema: - type: boolean - default: true - description: Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - example: true - required: false - responses: - '204': - description: No content. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) - patch: - security: - - userAuth: - - idn:sod-policy:write - operationId: patchSodPolicy - tags: - - SOD Policies - summary: Patch SOD policy by ID - description: |- - Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - Requires role of ORG_ADMIN. - This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSodPolicies - description: The ID of the SOD policy being modified. - example: 2c918083-5d19-1a86-015d-28455b4a2329 - requestBody: - required: true - description: | - A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * name - * description - * ownerRef - * externalPolicyReference - * compensatingControls - * correctionAdvice - * state - * tags - * violationOwnerAssignmentConfig - * scheduled - * conflictingAccessCriteria - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - examples: - Conflicting Access Based Policy: - value: - - op: replace - path: /description - value: Modified description - - op: replace - path: /conflictingAccessCriteria/leftCriteria/name - value: money-in-modified - - op: replace - path: /conflictingAccessCriteria/rightCriteria - value: - name: money-out-modified - criteriaList: - - type: ENTITLEMENT - id: 2c918087682f9a86016839c0509c1ab2 - General Policy: - value: - - op: replace - path: /description - value: Modified description - responses: - '200': - description: Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. - content: - application/json: - schema: - $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicy.yaml - examples: - Conflicting Access Based Policy: - value: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: Conflicting-Policy-Name - created: '2020-01-01T00:00:00.000000Z' - modified: '2020-01-01T00:00:00.000000Z' - description: Modified description - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Owner Name - externalPolicyReference: XYZ policy - policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c918087682f9a86016839c0509c1ab2)' - compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee - correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function. - state: ENFORCED - tags: - - string - creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - violationOwnerAssignmentConfig: - assignmentRule: MANAGER - ownerRef: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: Violation Owner Name - scheduled: true - type: CONFLICTING_ACCESS_BASED - conflictingAccessCriteria: - leftCriteria: - name: money-in-modified - criteriaList: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - rightCriteria: - name: money-out-modified - criteriaList: - - type: ENTITLEMENT - id: 2c918087682f9a86016839c0509c1ab2 - General Policy: - value: - description: Modified description - ownerRef: - type: IDENTITY - id: 2c918087682f9a86016839c05e8f1aff - name: Owner Name - externalPolicyReference: New policy - policyQuery: policy query implementation - compensatingControls: Compensating controls - correctionAdvice: Correction advice - tags: [] - state: ENFORCED - scheduled: false - creatorId: 2c918087682f9a86016839c05e8f1aff - modifierId: null - violationOwnerAssignmentConfig: null - type: GENERAL - conflictingAccessCriteria: null - id: 52c11db4-733e-4c31-949a-766c95ec95f1 - name: General-Policy-Name - created: '2020-05-12T19:47:38Z' - modified: '2020-05-12T19:47:38Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) - /sod-policies/{id}/evaluate: - post: - security: - - userAuth: - - idn:sod-violation:write - operationId: startEvaluateSodPolicy - tags: - - SOD Policies - summary: Evaluate one policy by ID - description: Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSodPolicies - description: The SOD policy ID to run. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - responses: - '200': - description: Reference to the violation report run task. - content: - application/json: - schema: - allOf: - - type: object - description: SOD policy violation report result. - properties: - type: - type: string - description: SOD policy violation report result DTO type. - enum: - - REPORT_RESULT - example: REPORT_RESULT - id: - type: string - description: SOD policy violation report result ID. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable name of the SOD policy violation report result. - example: SOD Policy 1 Violation - - type: object - properties: - status: - type: string - description: Status of a SOD policy violation report. - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMP_ERROR - - PENDING - example: PENDING - example: - status: PENDING - type: REPORT_RESULT - id: 37b3b32a-f394-46f8-acad-b5223969fa68 - name: Multi Query Report - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2025EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) - /sod-policies/{id}/schedule: - get: - security: - - userAuth: - - idn:sod-policy:read - operationId: getSodPolicySchedule - tags: - - SOD Policies - summary: Get SOD policy schedule - description: This endpoint gets a specified SOD policy's schedule. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSodPolicies - description: The ID of the SOD policy schedule to retrieve. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - responses: - '200': - description: SOD policy schedule. - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: SOD Policy schedule name - example: SCH-1584312283015 - created: - type: string - format: date-time - description: The time when this SOD policy schedule is created. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - modified: - type: string - format: date-time - description: The time when this SOD policy schedule is modified. - example: '2020-01-01T00:00:00.000000Z' - readOnly: true - description: - type: string - description: SOD Policy schedule description - example: Schedule for policy xyz - schedule: - $ref: '#/components/schemas/ScheduledSearch/allOf/2/properties/schedule' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/Schedule.yaml - recipients: - type: array - items: - type: object - description: SOD policy recipient. - properties: - type: - type: string - description: SOD policy recipient DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: SOD policy recipient's identity ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: SOD policy recipient's display name. - example: Michael Michaels - emailEmptyResults: - type: boolean - description: Indicates if empty results need to be emailed - example: false - default: false - creatorId: - type: string - description: Policy's creator ID - example: 0f11f2a47c944bf3a2bd742580fe3bde - readOnly: true - modifierId: - type: string - description: Policy's modifier ID - example: 0f11f2a47c944bf3a2bd742580fe3bde - readOnly: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) - put: - security: - - userAuth: - - idn:sod-policy:write - operationId: putPolicySchedule - tags: - - SOD Policies - summary: Update SOD Policy schedule - description: This updates schedule for a specified SOD policy. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSodPolicies - description: The ID of the SOD policy to update its schedule. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sod-policies~1%7Bid%7D~1schedule/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicySchedule.yaml - responses: - '200': - description: Created or updated SOD policy schedule. - content: - application/json: - schema: - $ref: '#/paths/~1sod-policies~1%7Bid%7D~1schedule/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicySchedule.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) - delete: - security: - - userAuth: - - idn:sod-policy:write - operationId: deleteSodPolicySchedule - tags: - - SOD Policies - summary: Delete SOD policy schedule - description: This deletes schedule for a specified SOD policy by ID. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSodPolicies - description: The ID of the SOD policy the schedule must be deleted for. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - responses: - '204': - description: No content response. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) - /sod-policies/{id}/violation-report/run: - post: - security: - - userAuth: - - idn:sod-violation:write - operationId: startSodPolicy - tags: - - SOD Policies - summary: Runs SOD policy violation report - description: This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSodPolicies - description: The SOD policy ID to run. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - responses: - '200': - description: Reference to the violation report run task. - content: - application/json: - schema: - $ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReportResultReference.yaml - example: - status: PENDING - type: REPORT_RESULT - id: 2e8d8180-24bc-4d21-91c6-7affdb473b0d - name: policy-xyz - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) - /sod-policies/{id}/violation-report: - get: - security: - - userAuth: - - idn:sod-violation:read - operationId: getSodViolationReportStatus - tags: - - SOD Policies - summary: Get SOD violation report status - description: This gets the status for a violation report run task that has already been invoked. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: startSodPolicy - description: The ID of the violation report to retrieve status for. - example: ef38f943-47e9-4562-b5bb-8424a56397d8 - responses: - '200': - description: Status of the violation report run task. - content: - application/json: - schema: - $ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReportResultReference.yaml - example: - status: SUCCESS - type: REPORT_RESULT - id: 2e8d8180-24bc-4d21-91c6-7affdb473b0d - name: policy-xyz - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2025SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) - /sod-policies/sod-violation-report-status/{reportResultId}: - get: - security: - - userAuth: - - idn:sod-violation:read - operationId: getSodViolationReportRunStatus - tags: - - SOD Policies - summary: Get violation report run status - description: This gets the status for a violation report run task that has already been invoked. - parameters: - - in: path - name: reportResultId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getSodAllReportRunStatus - description: The ID of the report reference to retrieve. - example: 2e8d8180-24bc-4d21-91c6-7affdb473b0d - responses: - '200': - description: Status of the violation report run task. - content: - application/json: - schema: - $ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReportResultReference.yaml - example: - status: SUCCESS - type: REPORT_RESULT - id: 2e8d8180-24bc-4d21-91c6-7affdb473b0d - name: policy-xyz - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) - /sod-violations/predict: - post: - security: - - userAuth: - - idn:sod-violation:read - - applicationAuth: - - idn:sod-violation:read - x-sailpoint-userLevels: - - ORG_ADMIN - operationId: startPredictSodViolations - tags: - - SOD Violations - summary: Predict SOD violations for identity. - description: This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - requestBody: - required: true - content: - application/json: - schema: - description: An identity with a set of access to be added - required: - - identityId - - accessRefs - type: object - properties: - identityId: - description: Identity id to be checked. - type: string - example: 2c91808568c529c60168cca6f90c1313 - accessRefs: - description: The list of entitlements to consider for possible violations in a preventive check. - type: array - items: - type: object - description: Entitlement including a specific set of access. - properties: - type: - type: string - description: Entitlement's DTO type. - enum: - - ENTITLEMENT - example: ENTITLEMENT - id: - type: string - description: Entitlement's ID. - example: 2c91809773dee32014e13e122092014e - name: - type: string - description: Entitlement's display name. - example: CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local - example: - - type: ENTITLEMENT - id: 2c918087682f9a86016839c050861ab1 - name: CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local - - type: ENTITLEMENT - id: 2c918087682f9a86016839c0509c1ab2 - name: CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local - example: - identityId: 2c91808568c529c60168cca6f90c1313 - accessRefs: - - type: ENTITLEMENT - id: 2c918087682f9a86016839c050861ab1 - name: CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local - - type: ENTITLEMENT - id: 2c918087682f9a86016839c0509c1ab2 - name: CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local - responses: - '200': - description: Violation Contexts - content: - application/json: - schema: - description: An object containing a listing of the SOD violation reasons detected by this check. - required: - - requestId - type: object - properties: - violationContexts: - type: array - description: List of Violation Contexts - items: - type: object - properties: - policy: - allOf: - - type: object - description: SOD policy. - properties: - type: - type: string - description: SOD policy DTO type. - enum: - - SOD_POLICY - example: SOD_POLICY - id: - type: string - description: SOD policy ID. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: - type: string - description: SOD policy display name. - example: Business SOD Policy - - type: object - properties: - type: - type: string - example: SOD_POLICY - name: - type: string - example: A very cool policy name - description: The types of objects supported for SOD violations - properties: - type: - enum: - - ENTITLEMENT - example: ENTITLEMENT - description: The type of object that is referenced - conflictingAccessCriteria: - type: object - properties: - leftCriteria: - type: object - properties: - criteriaList: - type: array - description: List of exception criteria. There is a min of 1 and max of 50 items in the list. - items: - allOf: - - type: object - properties: - type: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - description: DTO type - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local - existing: - type: boolean - description: Whether the subject identity already had that access or not - default: false - example: true - description: Access reference with addition of boolean existing flag to indicate whether the access was extant - description: The types of objects supported for SOD violations - properties: - type: - enum: - - ENTITLEMENT - example: ENTITLEMENT - description: The type of object that is referenced - example: - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a66 - existing: true - - type: ENTITLEMENT - id: 2c9180866166b5b0016167c32ef31a67 - existing: false - rightCriteria: - $ref: '#/paths/~1sod-violations~1predict/post/responses/200/content/application~1json/schema/properties/violationContexts/items/properties/conflictingAccessCriteria/properties/leftCriteria' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/sod/models/ExceptionCriteria.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2025.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) - /sod-violations/check: - post: - security: - - userAuth: - - idn:sod-violation:read - x-sailpoint-userLevels: - - ORG_ADMIN - operationId: startViolationCheck - tags: - - SOD Violations - summary: Check SOD violations - description: This API initiates a SOD policy verification asynchronously. - requestBody: - required: true - content: - application/json: - schema: - description: An identity with a set of access to be added - required: - - identityId - - accessRefs - type: object - properties: - identityId: - description: Set of identity IDs to be checked. - type: string - example: 2c91809050db617d0150e0bf3215385e - accessRefs: - description: The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. - type: array - items: - allOf: - - type: object - description: Entitlement including a specific set of access. - properties: - type: - type: string - description: Entitlement's DTO type. - enum: - - ENTITLEMENT - example: ENTITLEMENT - id: - type: string - description: Entitlement's ID. - example: 2c91809773dee32014e13e122092014e - name: - type: string - description: Entitlement's display name. - example: CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local - clientMetadata: - type: object - additionalProperties: - type: string - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - example: - clientName: client1 - clientId: 2c91808f7892918f0178b78da4a305a1 - example: - identityId: 2c91808568c529c60168cca6f90c1313 - accessRefs: - - type: ENTITLEMENT - id: 2c918087682f9a86016839c050861ab1 - name: CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local - - type: ENTITLEMENT - id: 2c918087682f9a86016839c0509c1ab2 - name: CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local - clientMetadata: - additionalProp1: string - additionalProp2: string - additionalProp3: string - responses: - '202': - description: Request ID with a timestamp. - content: - application/json: - schema: - description: An object referencing an SOD violation check - required: - - requestId - type: object - properties: - requestId: - description: The id of the original request - example: 089899f13a8f4da7824996191587bab9 - type: string - created: - type: string - format: date-time - readOnly: true - description: The date-time when this request was created. - example: '2020-01-01T00:00:00.000000Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2025.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - /sod-violation-report/run: - post: - security: - - userAuth: - - idn:sod-violation:write - operationId: startSodAllPoliciesForOrg - tags: - - SOD Policies - summary: Runs all policies for org - description: Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - filteredPolicyList: - type: array - description: Multi-policy report will be run for this list of ids - items: - type: string - example: - - b868cd40-ffa4-4337-9c07-1a51846cfa94 - - 63a07a7b-39a4-48aa-956d-50c827deba2a - example: - filteredPolicyList: - - b868cd40-ffa4-4337-9c07-1a51846cfa94 - - 63a07a7b-39a4-48aa-956d-50c827deba2a - responses: - '200': - description: Reference to the violation report run task. - content: - application/json: - schema: - $ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReportResultReference.yaml - example: - status: PENDING - type: REPORT_RESULT - id: 37b3b32a-f394-46f8-acad-b5223969fa68 - name: Multi Query Report - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2025SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) - /sod-violation-report: - get: - security: - - userAuth: - - idn:sod-violation:read - operationId: getSodAllReportRunStatus - tags: - - SOD Policies - summary: Get multi-report run task status - description: This endpoint gets the status for a violation report for all policy run. - responses: - '200': - description: Status of the violation report run task for all policy run. - content: - application/json: - schema: - $ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReportResultReference.yaml - example: - status: SUCCESS - type: REPORT_RESULT - id: 37b3b32a-f394-46f8-acad-b5223969fa68 - name: Multi Query Report - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2025SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2025SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) - /sod-violation-report/{reportResultId}/download: - get: - security: - - userAuth: - - idn:sod-violation:read - operationId: getDefaultViolationReport - tags: - - SOD Policies - summary: Download violation report - description: This allows to download a violation report for a given report reference. - parameters: - - in: path - name: reportResultId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: startSodPolicy - description: The ID of the report reference to download. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Returns the PolicyReport.zip that contains the violation report file. - content: - application/zip: - schema: - type: string - format: binary - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) - /sod-violation-report/{reportResultId}/download/{fileName}: - get: - security: - - userAuth: - - idn:sod-violation:read - operationId: getCustomViolationReport - tags: - - SOD Policies - summary: Download custom violation report - description: This allows to download a specified named violation report for a given report reference. - parameters: - - in: path - name: reportResultId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: startSodPolicy - description: The ID of the report reference to download. - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: fileName - schema: - type: string - required: true - description: Custom Name for the file. - example: custom-name - responses: - '200': - description: Returns the zip file with given custom name that contains the violation report file. - content: - application/zip: - schema: - type: string - format: binary - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) - /sources: - get: - operationId: listSources - security: - - userAuth: - - idn:sources:read - - idn:sources:manage - - applicationAuth: - - idn:sources:read - - idn:sources:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - ROLE_SUBADMIN - tags: - - Sources - summary: Lists all sources in IdentityNow. - description: This end-point lists all the sources in IdentityNow. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - example: name eq "Employees" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - - **name**: *co, eq, in, sw, ge, gt, ne, isnull* - - **type**: *eq, in, ge, gt, ne, isnull, sw* - - **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - - **features**: *ca, co* - - **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* - - **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* - - **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* - - **description**: *eq, sw* - - **authoritative**: *eq, ne, isnull* - - **healthy**: *isnull* - - **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - - **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* - - **connectorName**: *eq, ge, gt, in, ne, isnull, sw* - - **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - - in: query - name: sorters - schema: - type: string - format: comma-separated - example: name - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - - in: query - name: for-subadmin - schema: - type: string - example: name - description: |- - Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. - Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - - in: query - name: includeIDNSource - required: false - schema: - type: boolean - default: false - example: true - description: Include the IdentityNow source in the response. - responses: - '200': - description: List of Source objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - readOnly: true - description: Source ID. - example: 2c91808568c529c60168cca6f90c1324 - name: - type: string - description: Source's human-readable name. - example: My Source - description: - type: string - description: Source's human-readable description. - example: This is the corporate directory. - owner: - description: Reference to identity object who owns the source. - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Owner identity's ID. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Owner identity's human-readable display name. - example: MyName - cluster: - description: Reference to the source's associated cluster. - type: object - nullable: true - required: - - name - - id - - type - properties: - type: - description: Type of object being referenced. - type: string - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: Cluster ID. - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Cluster's human-readable display name. - example: Corporate Cluster - accountCorrelationConfig: - description: Reference to account correlation config object. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - example: ACCOUNT_CORRELATION_CONFIG - id: - type: string - description: Account correlation config ID. - example: 2c9180855d191c59015d28583727245a - name: - type: string - description: Account correlation config's human-readable display name. - example: Directory [source-62867] Account Correlation - accountCorrelationRule: - description: Reference to a rule that can do COMPLEX correlation. Only use this rule when you can't use accountCorrelationConfig. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - RULE - example: RULE - id: - type: string - description: Rule ID. - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Rule's human-readable display name. - example: Example Rule - managerCorrelationMapping: - allOf: - - $ref: '#/components/schemas/Source/properties/managerCorrelationMapping/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagerCorrelationMapping.yaml - - nullable: true - description: | - Filter object used during manager correlation to match incoming manager values to an existing manager's - account/identity. - managerCorrelationRule: - description: Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn't sufficient. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - RULE - example: RULE - id: - type: string - description: Rule ID. - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Rule's human-readable display name. - example: Example Rule - beforeProvisioningRule: - description: 'Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. ' - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - RULE - example: RULE - id: - type: string - description: Rule ID. - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Rule's human-readable display name. - example: Example Rule - schemas: - type: array - items: - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: Schema ID. - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Schema's human-readable display name. - example: MySchema - description: List of references to schema objects. - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - nullable: true - items: - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - PASSWORD_POLICY - example: PASSWORD_POLICY - id: - type: string - description: Policy ID. - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Policy's human-readable display name. - example: My Password Policy - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb057777 - name: Vendor Password Policy - features: - $ref: '#/components/schemas/Source/properties/features' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SourceFeature.yaml - type: - 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 - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: Fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration. This configuration will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When this is true, it indicates that the source is referenced by an identity profile. - default: false - example: false - managementWorkgroup: - description: Reference to management workgroup for the source. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - GOVERNANCE_GROUP - example: GOVERNANCE_GROUP - id: - type: string - description: Management workgroup ID. - example: 2c91808568c529c60168cca6f90c2222 - name: - type: string - description: Management workgroup's human-readable display name. - example: My Management Workgroup - healthy: - type: boolean - description: When this is true, it indicates that the source is healthy. - default: false - example: true - status: - type: string - enum: - - SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT - - SOURCE_STATE_ERROR_CLUSTER - - SOURCE_STATE_ERROR_SOURCE - - SOURCE_STATE_ERROR_VA - - SOURCE_STATE_FAILURE_CLUSTER - - SOURCE_STATE_FAILURE_SOURCE - - SOURCE_STATE_HEALTHY - - SOURCE_STATE_UNCHECKED_CLUSTER - - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES - - SOURCE_STATE_UNCHECKED_SOURCE - - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS - description: 'Status identifier that gives specific information about why a source is or isn''t healthy. ' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp that shows when a source health check was last performed. - example: '2021-09-28T15:48:29.380Z' - connectorId: - type: string - description: Connector ID - example: active-directory - connectorName: - type: string - description: Name of the connector that was chosen during source creation. - example: Active Directory - connectionType: - type: string - description: Type of connection (direct or file). - example: file - connectorImplementationId: - type: string - description: Connector implementation ID. - example: delimited-file - created: - type: string - description: Date-time when the source was created - format: date-time - example: '2022-02-08T14:50:03.827Z' - modified: - type: string - description: Date-time when the source was last modified. - format: date-time - example: '2024-01-23T18:08:50.897Z' - credentialProviderEnabled: - type: boolean - description: If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - default: false - example: false - category: - type: string - nullable: true - default: null - description: Source category (e.g. null, CredentialProvider). - example: CredentialProvider - required: - - name - - owner - - connector - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#list-sources - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) - $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) - $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) - - # Lists all sources in IdentityNow. - - try { - Get-V2025Sources - - # Below is a request that includes all optional parameters - # Get-V2025Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Sources" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#list-sources - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source import Source - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"Employees\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) - for_subadmin = 'name' # str | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # str | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) - include_idn_source = False # bool | Include the IdentityNow source in the response. (optional) (default to False) # bool | Include the IdentityNow source in the response. (optional) (default to False) - try: - # Lists all sources in IdentityNow. - - results = SourcesApi(api_client).list_sources() - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) - print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->list_sources: %s\n" % e) - post: - operationId: createSource - security: - - userAuth: - - idn:sources:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Sources - summary: Creates a source in IdentityNow. - description: This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - parameters: - - in: query - name: provisionAsCsv - description: 'If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don''t set this query parameter and you attempt to set the `type` attribute directly, the request won''t correctly generate the source. ' - schema: - type: boolean - required: false - example: false - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml - responses: - '201': - description: Created 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. - content: - application/json: - schema: - $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source - source: | - $Source = @" - { - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - } - "@ - $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) - - # Creates a source in IdentityNow. - - try { - $Result = ConvertFrom-JsonToSource -Json $Source - New-V2025Source -Source $Result - - # Below is a request that includes all optional parameters - # New-V2025Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Source" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#create-source - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source import Source - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source = '''{ - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - }''' # Source | - provision_as_csv = false # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) - try: - # Creates a source in IdentityNow. - new_source = Source.from_json(source) - results = SourcesApi(api_client).create_source(source=new_source) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).create_source(new_source, provision_as_csv) - print("The response of SourcesApi->create_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->create_source: %s\n" % e) - /sources/{id}: - get: - operationId: getSource - security: - - userAuth: - - idn:sources:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Sources - summary: Get Source by ID - description: Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: Source ID. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: Source object. - content: - application/json: - schema: - $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Get Source by ID - - try { - Get-V2025Source -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Source -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Source" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source import Source - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - try: - # Get Source by ID - - results = SourcesApi(api_client).get_source(id=id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source(id) - print("The response of SourcesApi->get_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source: %s\n" % e) - put: - operationId: putSource - security: - - userAuth: - - idn:sources:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Sources - summary: Update Source (Full) - description: | - Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. - - These fields are immutable, so they cannot be changed: - - * id - * type - * authoritative - * connector - * connectorClass - * passwordPolicies - - Attempts to modify these fields will result in a 400 error. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: Source ID. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml - responses: - '200': - description: Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable in Identity Security Cloud (ISC) cloud-based services, per ISC security design. - content: - application/json: - schema: - $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Source = @" - { - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - } - "@ - - # Update Source (Full) - - try { - $Result = ConvertFrom-JsonToSource -Json $Source - Send-V2025Source -Id $Id -Source $Result - - # Below is a request that includes all optional parameters - # Send-V2025Source -Id $Id -Source $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Source" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#put-source - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source import Source - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - source = '''{ - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - }''' # Source | - try: - # Update Source (Full) - new_source = Source.from_json(source) - results = SourcesApi(api_client).put_source(id=id, source=new_source) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).put_source(id, new_source) - print("The response of SourcesApi->put_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->put_source: %s\n" % e) - patch: - operationId: updateSource - security: - - userAuth: - - idn:sources:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Sources - summary: Update Source (Partial) - description: | - Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the - [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - These fields are immutable, so they cannot be changed: - - * id - * type - * authoritative - * created - * modified - * connector - * connectorClass - * passwordPolicies - - Attempts to modify these fields will result in a 400 error. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: Source ID. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - description: A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - examples: - Edit the source description: - description: This example shows how to edit a source description. - value: - - op: replace - path: /description - value: new description - Edit the source cluster: - description: This example shows how to edit a source cluster by ID. - value: - - op: replace - path: /cluster/id - value: 2c918087813a902001813f3f85736b45 - Edit source features: - description: This example illustrates how you can update source supported features. - value: - - op: replace - path: /features - value: - - PASSWORD - - PROVISIONING - - ENABLE - - AUTHENTICATE - Change a source description and cluster in one call: - description: This example shows how multiple fields may be updated with a single PATCH call. - value: - - op: replace - path: /description - value: new description - - op: replace - path: /cluster/id - value: 2c918087813a902001813f3f85736b45 - Add a filter string to the connector: - description: This example shows how you can add a filter to incoming accounts during the account aggregation process. In the example, any account that does not have an "m" or "d" in the ID will be aggregated. - value: - - op: add - path: /connectorAttributes/filterString - value: '!( id.contains( "m" ) ) || !( id.contains( "d" ) )' - Update connector attribute for specific operation type: - description: This example shows how you can update the 3rd object in the connection parameter's `operationType`. This changes it from a standard group aggregation to a group aggregation on the "test" entitlement type. - value: - - op: replace - path: /connectorAttributes/connectionParameters/2/operationType - value: Group Aggregation-test - Enable notifications for new account provisioning on a source: - description: This example shows how you can configure and enable email notifications that will send when new accounts are provisioned on a source. - value: - - op: replace - path: /connectorAttributes/accountCreateNotification - value: - notifyList: - - Distribution.list@demo.com - notifyAccountOwner: true - enabled: true - notifyAccountOwnerAltEmail: false - responses: - '200': - description: Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable in Identity Security Cloud (ISC) cloud-based services, per ISC security design. - content: - application/json: - schema: - $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Source -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Source -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Source" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-source - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.source import Source - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - json_patch_operation = '''[{op=replace, path=/description, value=new description}]''' # List[JsonPatchOperation] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - try: - # Update Source (Partial) - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SourcesApi(api_client).update_source(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_source(id, new_json_patch_operation) - print("The response of SourcesApi->update_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_source: %s\n" % e) - delete: - operationId: deleteSource - security: - - userAuth: - - idn:sources:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Sources - summary: Delete Source by ID - description: |- - Use this API to delete a specific source in Identity Security Cloud (ISC). - The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: Source ID. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - content: - application/json: - schema: - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - TASK_RESULT - example: TASK_RESULT - id: - type: string - description: Task result ID. - example: 2c91808779ecf55b0179f720942f181a - name: - type: string - description: Task result's human-readable display name (this should be null/empty). - example: null - examples: - deleteSource: - summary: Response returned when a source is being deleted. - value: - type: TASK_RESULT - id: 2c91808779ecf55b0179f720942f181a - name: null - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Delete Source by ID - - try { - Remove-V2025Source -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Source -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Source" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#delete-source - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.delete_source202_response import DeleteSource202Response - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - try: - # Delete Source by ID - - results = SourcesApi(api_client).delete_source(id=id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).delete_source(id) - print("The response of SourcesApi->delete_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->delete_source: %s\n" % e) - /sources/{sourceId}/provisioning-policies: - get: - operationId: listProvisioningPolicies - tags: - - Sources - summary: Lists ProvisioningPolicies - description: This end-point lists all the ProvisioningPolicies in IdentityNow. - security: - - userAuth: - - idn:provisioning-policy:read - - idn:provisioning-policy:manage - - applicationAuth: - - idn:provisioning-policy:read - - idn:provisioning-policy:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: List of ProvisioningPolicyDto objects - content: - application/json: - schema: - type: array - items: - type: object - required: - - name - properties: - name: - type: string - description: the provisioning policy name - example: example provisioning policy for inactive identities - description: - type: string - description: the description of the provisioning policy - example: this provisioning policy creates access based on an identity going inactive - usageType: - $ref: '#/components/schemas/ProvisioningPolicy/properties/usageType' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UsageType.yaml - fields: - type: array - items: - $ref: '#/components/schemas/ProvisioningPolicy/properties/fields/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/FieldDetailsDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#list-provisioning-policies - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - - # Lists ProvisioningPolicies - - try { - Get-V2025ProvisioningPolicies -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025ProvisioningPolicies -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProvisioningPolicies" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#list-provisioning-policies - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id - try: - # Lists ProvisioningPolicies - - results = SourcesApi(api_client).list_provisioning_policies(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).list_provisioning_policies(source_id) - print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - post: - operationId: createProvisioningPolicy - tags: - - Sources - summary: Create Provisioning Policy - description: |- - This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. - Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. - Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. - security: - - userAuth: - - idn:provisioning-policy:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml - examples: - Create Account Provisioning Policy: - value: - name: Account - description: Account Provisioning Policy - usageType: CREATE - fields: - - name: displayName - transform: - type: identityAttribute - attributes: - name: displayName - attributes: {} - isRequired: false - type: string - isMultiValued: false - - name: distinguishedName - transform: - type: usernameGenerator - attributes: - sourceCheck: true - patterns: - - CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - fn: - type: identityAttribute - attributes: - name: firstname - ln: - type: identityAttribute - attributes: - name: lastname - fi: - type: substring - attributes: - input: - type: identityAttribute - attributes: - name: firstname - begin: 0 - end: 1 - fti: - type: substring - attributes: - input: - type: identityAttribute - attributes: - name: firstname - begin: 0 - end: 2 - attributes: - cloudMaxUniqueChecks: '5' - cloudMaxSize: '100' - cloudRequired: 'true' - isRequired: false - type: '' - isMultiValued: false - - name: description - transform: - type: static - attributes: - value: '' - attributes: {} - isRequired: false - type: string - isMultiValued: false - responses: - '201': - description: Created ProvisioningPolicyDto object - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#create-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - $ProvisioningPolicyDto = @" - { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } - "@ - - # Create Provisioning Policy - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-V2025ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # New-V2025ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#create-provisioning-policy - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id - provisioning_policy_dto = '''{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - }''' # ProvisioningPolicyDto | - try: - # Create Provisioning Policy - new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) - results = SourcesApi(api_client).create_provisioning_policy(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto) - print("The response of SourcesApi->create_provisioning_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) - /sources/{sourceId}/provisioning-policies/{usageType}: - get: - operationId: getProvisioningPolicy - tags: - - Sources - summary: Get Provisioning Policy by UsageType - description: This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - security: - - userAuth: - - idn:provisioning-policy:read - - idn:provisioning-policy-source:read - - idn:provisioning-policy:manage - - idn:provisioning-policy-source-admin-operations:manage - - applicationAuth: - - idn:provisioning-policy:read - - idn:provisioning-policy-source:read - - idn:provisioning-policy:manage - - idn:provisioning-policy-source-admin-operations:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source ID. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: usageType - required: true - description: |- - The type of provisioning policy usage. - In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. - These are the common usage types: - CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. - UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. - ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. - DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. - You can use these four usage types for all your provisioning policy needs. - example: CREATE - schema: - $ref: '#/components/schemas/ProvisioningPolicy/properties/usageType' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UsageType.yaml - responses: - '200': - description: The requested ProvisioningPolicyDto was successfully retrieved. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - - # Get Provisioning Policy by UsageType - - try { - Get-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - - # Below is a request that includes all optional parameters - # Get-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-provisioning-policy - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto - from sailpoint.v2025.models.usage_type import UsageType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. - usage_type = sailpoint.v2025.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - try: - # Get Provisioning Policy by UsageType - - results = SourcesApi(api_client).get_provisioning_policy(source_id=source_id, usage_type=usage_type) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_provisioning_policy(source_id, usage_type) - print("The response of SourcesApi->get_provisioning_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) - put: - operationId: putProvisioningPolicy - tags: - - Sources - summary: Update Provisioning Policy by UsageType - description: |- - This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. - Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. - Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. - security: - - userAuth: - - idn:provisioning-policy:manage - - idn:provisioning-policy-source-admin-operations:manage - - applicationAuth: - - idn:provisioning-policy:manage - - idn:provisioning-policy-source-admin-operations:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source ID. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: usageType - required: true - description: |- - The type of provisioning policy usage. - In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. - These are the common usage types: - CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. - UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. - ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. - DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. - You can use these four usage types for all your provisioning policy needs. - example: CREATE - schema: - $ref: '#/components/schemas/ProvisioningPolicy/properties/usageType' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UsageType.yaml - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml - responses: - '200': - description: The ProvisioningPolicyDto was successfully replaced. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $ProvisioningPolicyDto = @" - { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } - "@ - - # Update Provisioning Policy by UsageType - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Send-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#put-provisioning-policy - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto - from sailpoint.v2025.models.usage_type import UsageType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. - usage_type = sailpoint.v2025.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - provisioning_policy_dto = '''{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - }''' # ProvisioningPolicyDto | - try: - # Update Provisioning Policy by UsageType - new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) - results = SourcesApi(api_client).put_provisioning_policy(source_id=source_id, usage_type=usage_type, provisioning_policy_dto=new_provisioning_policy_dto) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, new_provisioning_policy_dto) - print("The response of SourcesApi->put_provisioning_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) - patch: - operationId: updateProvisioningPolicy - tags: - - Sources - summary: Partial update of Provisioning Policy - description: |- - This API selectively updates an existing Provisioning Policy using a JSONPatch payload. - Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. - Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. - security: - - userAuth: - - idn:provisioning-policy:update - - applicationAuth: - - idn:provisioning-policy:update - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: usageType - required: true - description: |- - The type of provisioning policy usage. - In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. - These are the common usage types: - CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. - UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. - ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. - DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. - You can use these four usage types for all your provisioning policy needs. - example: CREATE - schema: - $ref: '#/components/schemas/ProvisioningPolicy/properties/usageType' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UsageType.yaml - requestBody: - required: true - description: The JSONPatch payload used to update the schema. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - examples: - add-field: - summary: Add a field to the beginning of the list - value: - - op: add - path: /fields/0 - value: - name: email - transform: - type: identityAttribute - attributes: - name: email - attributes: {} - isRequired: false - type: string - isMultiValued: false - responses: - '200': - description: The ProvisioningPolicyDto was successfully updated. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Partial update of Provisioning Policy - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-provisioning-policy - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto - from sailpoint.v2025.models.usage_type import UsageType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - usage_type = sailpoint.v2025.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - json_patch_operation = '''[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. - try: - # Partial update of Provisioning Policy - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SourcesApi(api_client).update_provisioning_policy(source_id=source_id, usage_type=usage_type, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, new_json_patch_operation) - print("The response of SourcesApi->update_provisioning_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) - delete: - operationId: deleteProvisioningPolicy - tags: - - Sources - summary: Delete Provisioning Policy by UsageType - description: Deletes the provisioning policy with the specified usage on an application. - security: - - userAuth: - - idn:provisioning-policy:manage - - applicationAuth: - - idn:provisioning-policy:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source ID. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: usageType - required: true - description: |- - The type of provisioning policy usage. - In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. - These are the common usage types: - CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. - UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. - ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. - DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. - You can use these four usage types for all your provisioning policy needs. - example: CREATE - schema: - $ref: '#/components/schemas/ProvisioningPolicy/properties/usageType' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UsageType.yaml - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - - # Delete Provisioning Policy by UsageType - - try { - Remove-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - - # Below is a request that includes all optional parameters - # Remove-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#delete-provisioning-policy - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.usage_type import UsageType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. - usage_type = sailpoint.v2025.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - try: - # Delete Provisioning Policy by UsageType - - SourcesApi(api_client).delete_provisioning_policy(source_id=source_id, usage_type=usage_type) - # Below is a request that includes all optional parameters - # SourcesApi(api_client).delete_provisioning_policy(source_id, usage_type) - except Exception as e: - print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) - /sources/{sourceId}/provisioning-policies/bulk-update: - post: - operationId: updateProvisioningPoliciesInBulk - tags: - - Sources - summary: Bulk Update Provisioning Policies - description: This end-point updates a list of provisioning policies on the specified source in IdentityNow. - security: - - userAuth: - - idn:provisioning-policy:manage - - applicationAuth: - - idn:provisioning-policy:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml - responses: - '200': - description: A list of the ProvisioningPolicyDto was successfully replaced. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-provisioning-policies-in-bulk - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ProvisioningPolicyDto = @"{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - }"@ - - - # Bulk Update Provisioning Policies - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-V2025ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Update-V2025ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProvisioningPoliciesInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-provisioning-policies-in-bulk - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - provisioning_policy_dto = '''[sailpoint.v2025.ProvisioningPolicyDto()]''' # List[ProvisioningPolicyDto] | - try: - # Bulk Update Provisioning Policies - new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) - results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) - print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - /sources/{sourceId}/schemas: - get: - operationId: getSourceSchemas - security: - - userAuth: - - idn:source-schema:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Sources - summary: List Schemas on Source - description: Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: Source ID. - example: 2c9180835d191a86015d28455b4a2329 - - in: query - name: include-types - required: false - schema: - type: string - enum: - - group - - user - description: |- - If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. - Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - example: group - - in: query - name: include-names - required: false - schema: - type: string - description: A comma-separated list of schema names to filter result. - example: account - responses: - '200': - description: The schemas were successfully retrieved. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The id of the Schema. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - description: The name of the Schema. - example: account - nativeObjectType: - type: string - description: The name of the object type on the native system that the schema represents. - example: User - identityAttribute: - type: string - description: The name of the attribute used to calculate the unique identifier for an object in the schema. - example: sAMAccountName - displayAttribute: - type: string - description: The name of the attribute used to calculate the display value for an object in the schema. - example: distinguishedName - hierarchyAttribute: - type: string - nullable: true - description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - example: memberOf - includePermissions: - type: boolean - description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. - example: false - features: - $ref: '#/components/schemas/Source/properties/features' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SourceFeature.yaml - configuration: - type: object - description: Holds any extra configuration data that the schema may require. - example: - groupMemberAttribute: member - attributes: - type: array - description: The attribute definitions which form the schema. - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: sAMAccountName - type: - type: string - enum: - - STRING - - LONG - - INT - - BOOLEAN - description: The underlying type of the value which an AttributeDefinition represents. - example: STRING - schema: - description: A reference to the schema on the source to the attribute values map to. - type: object - nullable: true - properties: - type: - description: The type of object being referenced - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: The object ID this reference applies to. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: The human-readable display name of the object. - example: group - description: - type: string - description: A human-readable description of the attribute. - example: SAM Account Name - isMulti: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - example: false - default: false - isEntitlement: - type: boolean - description: Flag indicating whether or not the attribute is an entitlement. - example: false - default: false - isGroup: - type: boolean - description: | - Flag indicating whether or not the attribute represents a group. - This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - example: false - default: false - example: - - name: sAMAccountName - type: STRING - isMultiValued: false - isEntitlement: false - isGroup: false - - name: memberOf - type: STRING - schema: - type: CONNECTOR_SCHEMA - id: 2c9180887671ff8c01767b4671fc7d60 - name: group - description: Group membership - isMultiValued: true - isEntitlement: true - isGroup: true - created: - type: string - description: The date the Schema was created. - format: date-time - example: '2019-12-24T22:32:58.104Z' - modified: - type: string - nullable: true - description: The date the Schema was last modified. - format: date-time - example: '2019-12-31T20:22:28.104Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schemas - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) - $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) - - # List Schemas on Source - - try { - Get-V2025SourceSchemas -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchemas" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-schemas - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - include_types = 'group' # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) - include_names = 'account' # str | A comma-separated list of schema names to filter result. (optional) # str | A comma-separated list of schema names to filter result. (optional) - try: - # List Schemas on Source - - results = SourcesApi(api_client).get_source_schemas(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) - print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - post: - operationId: createSourceSchema - security: - - userAuth: - - idn:source-schema:create - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - tags: - - Sources - summary: Create Schema on Source - description: | - Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: Source ID. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml - responses: - '201': - description: The schema was successfully created on the specified source. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Schema = @" - { - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" - } - "@ - - # Create Schema on Source - - try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - New-V2025SourceSchema -SourceId $SourceId -Schema $Result - - # Below is a request that includes all optional parameters - # New-V2025SourceSchema -SourceId $SourceId -Schema $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#create-source-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - model_schema = '''sailpoint.v2025.ModelSchema()''' # ModelSchema | - try: - # Create Schema on Source - new_model_schema = ModelSchema.from_json(model_schema) - results = SourcesApi(api_client).create_source_schema(source_id=source_id, model_schema=new_model_schema) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).create_source_schema(source_id, new_model_schema) - print("The response of SourcesApi->create_source_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) - /sources/{sourceId}/schedules: - get: - operationId: getSourceSchedules - security: - - userAuth: - - idn:sources:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Sources - summary: List Schedules on Source - description: | - Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). - :::info - This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. - - For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. - - **Days of the week are represented as 1-7 (Sunday-Saturday).** - ::: - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: Source ID. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: The schedules were successfully retrieved. - content: - application/json: - schema: - type: array - items: - type: object - required: - - type - - cronExpression - properties: - type: - type: string - enum: - - ACCOUNT_AGGREGATION - - GROUP_AGGREGATION - description: The type of the Schedule. - example: ACCOUNT_AGGREGATION - cronExpression: - type: string - description: The cron expression of the schedule. - example: 0 0 5,13,21 * * ? - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schedules - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # List Schedules on Source - - try { - Get-V2025SourceSchedules -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025SourceSchedules -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchedules" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-schedules - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.schedule1 import Schedule1 - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - try: - # List Schedules on Source - - results = SourcesApi(api_client).get_source_schedules(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_schedules(source_id) - print("The response of SourcesApi->get_source_schedules:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) - post: - operationId: createSourceSchedule - security: - - userAuth: - - idn:sources:update - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Sources - summary: Create Schedule on Source - description: | - Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: Source ID. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1schedules/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/sources/Schedule.yaml - responses: - '201': - description: The schedule was successfully created on the specified source. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1schedules/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/sources/Schedule.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Schedule1 = @" - - "@ - - # Create Schedule on Source - - try { - $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 - New-V2025SourceSchedule -SourceId $SourceId -Schedule1 $Result - - # Below is a request that includes all optional parameters - # New-V2025SourceSchedule -SourceId $SourceId -Schedule1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#create-source-schedule - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.schedule1 import Schedule1 - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - schedule1 = '''sailpoint.v2025.Schedule1()''' # Schedule1 | - try: - # Create Schedule on Source - new_schedule1 = Schedule1.from_json(schedule1) - results = SourcesApi(api_client).create_source_schedule(source_id=source_id, schedule1=new_schedule1) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).create_source_schedule(source_id, new_schedule1) - print("The response of SourcesApi->create_source_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->create_source_schedule: %s\n" % e) - /sources/{sourceId}/schedules/{scheduleType}: - get: - operationId: getSourceSchedule - security: - - userAuth: - - idn:sources:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Sources - summary: Get Source Schedule by Type - description: | - Get the source schedule by type in Identity Security Cloud (ISC). - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: scheduleType - schema: - type: string - enum: - - ACCOUNT_AGGREGATION - - GROUP_AGGREGATION - required: true - description: The Schedule type. - example: ACCOUNT_AGGREGATION - responses: - '200': - description: The requested Schedule was successfully retrieved. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1schedules/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/sources/Schedule.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - - # Get Source Schedule by Type - - try { - Get-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - - # Below is a request that includes all optional parameters - # Get-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-schedule - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.schedule1 import Schedule1 - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. - try: - # Get Source Schedule by Type - - results = SourcesApi(api_client).get_source_schedule(source_id=source_id, schedule_type=schedule_type) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_schedule(source_id, schedule_type) - print("The response of SourcesApi->get_source_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_schedule: %s\n" % e) - patch: - operationId: updateSourceSchedule - security: - - userAuth: - - idn:sources:update - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Sources - summary: Update Source Schedule (Partial) - description: | - Use this API to selectively update an existing Schedule using a JSONPatch payload. - - The following schedule fields are immutable and cannot be updated: - - - type - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: scheduleType - schema: - type: string - enum: - - ACCOUNT_AGGREGATION - - GROUP_AGGREGATION - required: true - description: The Schedule type. - example: ACCOUNT_AGGREGATION - requestBody: - required: true - description: The JSONPatch payload used to update the schedule. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - examples: - add-attribute: - summary: Replace an attribute of the schedule - value: - - op: replace - path: /cronExpression - value: 0 0 6 * * ? - responses: - '200': - description: The Schedule was successfully updated. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1schedules/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/sources/Schedule.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source Schedule (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-source-schedule - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.schedule1 import Schedule1 - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. - json_patch_operation = '''[{op=replace, path=/cronExpression, value=0 0 6 * * ?}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. - try: - # Update Source Schedule (Partial) - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SourcesApi(api_client).update_source_schedule(source_id=source_id, schedule_type=schedule_type, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_source_schedule(source_id, schedule_type, new_json_patch_operation) - print("The response of SourcesApi->update_source_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_source_schedule: %s\n" % e) - delete: - operationId: deleteSourceSchedule - security: - - userAuth: - - idn:sources:update - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Sources - summary: Delete Source Schedule by type. - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: scheduleType - schema: - type: string - enum: - - ACCOUNT_AGGREGATION - - GROUP_AGGREGATION - required: true - description: The Schedule type. - example: ACCOUNT_AGGREGATION - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - - # Delete Source Schedule by type. - - try { - Remove-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - - # Below is a request that includes all optional parameters - # Remove-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceSchedule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#delete-source-schedule - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. - try: - # Delete Source Schedule by type. - - SourcesApi(api_client).delete_source_schedule(source_id=source_id, schedule_type=schedule_type) - # Below is a request that includes all optional parameters - # SourcesApi(api_client).delete_source_schedule(source_id, schedule_type) - except Exception as e: - print("Exception when calling SourcesApi->delete_source_schedule: %s\n" % e) - /sources/{sourceId}/schemas/{schemaId}: - get: - operationId: getSourceSchema - tags: - - Sources - summary: Get Source Schema by ID - description: | - Get the Source Schema by ID in IdentityNow. - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: schemaId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getSourceSchemas - description: The Schema id. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: The requested Schema was successfully retrieved. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - - # Get Source Schema by ID - - try { - Get-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Get-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. - try: - # Get Source Schema by ID - - results = SourcesApi(api_client).get_source_schema(source_id=source_id, schema_id=schema_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_schema(source_id, schema_id) - print("The response of SourcesApi->get_source_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) - put: - operationId: putSourceSchema - tags: - - Sources - summary: Update Source Schema (Full) - description: | - This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. - - * id - * name - * created - * modified - - Any attempt to modify these fields will result in an error response with a status code of 400. - - > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: schemaId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getSourceSchemas - description: The Schema id. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml - responses: - '200': - description: The Schema was successfully replaced. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $Schema = @" - { - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" - } - "@ - - # Update Source Schema (Full) - - try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result - - # Below is a request that includes all optional parameters - # Send-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SourceSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#put-source-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. - model_schema = '''sailpoint.v2025.ModelSchema()''' # ModelSchema | - try: - # Update Source Schema (Full) - new_model_schema = ModelSchema.from_json(model_schema) - results = SourcesApi(api_client).put_source_schema(source_id=source_id, schema_id=schema_id, model_schema=new_model_schema) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema) - print("The response of SourcesApi->put_source_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) - patch: - operationId: updateSourceSchema - tags: - - Sources - summary: Update Source Schema (Partial) - description: | - Use this API to selectively update an existing Schema using a JSONPatch payload. - - The following schema fields are immutable and cannot be updated: - - - id - - name - - created - - modified - - - To switch an account attribute to a group entitlement, you need to have the following in place: - - - `isEntitlement: true` - - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: - ```json - { - "name": "groups", - "type": "STRING", - "schema": { - "type": "CONNECTOR_SCHEMA", - "id": "2c9180887671ff8c01767b4671fc7d60", - "name": "group" - }, - "description": "The groups, roles etc. that reference account group objects", - "isMulti": true, - "isEntitlement": true, - "isGroup": true - } - ``` - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: schemaId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getSourceSchemas - description: The Schema id. - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - description: The JSONPatch payload used to update the schema. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - examples: - add-attribute: - summary: Add an attribute to the end of the list - value: - - op: add - path: /attributes/- - value: - name: location - type: STRING - schema: null - description: Employee location - isMulti: false - isEntitlement: false - isGroup: false - responses: - '200': - description: The Schema was successfully updated. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source Schema (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-source-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. - json_patch_operation = '''[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. - try: - # Update Source Schema (Partial) - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SourcesApi(api_client).update_source_schema(source_id=source_id, schema_id=schema_id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_source_schema(source_id, schema_id, new_json_patch_operation) - print("The response of SourcesApi->update_source_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) - delete: - operationId: deleteSourceSchema - tags: - - Sources - summary: Delete Source Schema by ID - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - - in: path - name: schemaId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getSourceSchemas - description: The Schema id. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - - # Delete Source Schema by ID - - try { - Remove-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Remove-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#delete-source-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. - try: - # Delete Source Schema by ID - - SourcesApi(api_client).delete_source_schema(source_id=source_id, schema_id=schema_id) - # Below is a request that includes all optional parameters - # SourcesApi(api_client).delete_source_schema(source_id, schema_id) - except Exception as e: - print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) - /sources/{sourceId}/source-health: - get: - operationId: getSourceHealth - security: - - userAuth: - - idn:sources:read - tags: - - Sources - summary: Fetches source health by id - description: This endpoint fetches source health by source's id - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: Fetched source health successfully - content: - application/json: - schema: - type: object - description: Dto for source health data - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - type: - 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 - name: - type: string - description: the name of the source - example: Source1234 - org: - type: string - description: source's org - example: denali-cjh - isAuthoritative: - type: boolean - example: false - description: Is the source authoritative - isCluster: - type: boolean - example: false - description: Is the source in a cluster - hostname: - type: string - example: megapod-useast1-secret-hostname.sailpoint.com - description: source's hostname - pod: - type: string - description: source's pod - example: megapod-useast1 - iqServiceVersion: - type: string - nullable: true - description: The version of the iqService - example: iqVersion123 - status: - type: string - enum: - - SOURCE_STATE_ERROR_CLUSTER - - SOURCE_STATE_ERROR_SOURCE - - SOURCE_STATE_ERROR_VA - - SOURCE_STATE_FAILURE_CLUSTER - - SOURCE_STATE_FAILURE_SOURCE - - SOURCE_STATE_HEALTHY - - SOURCE_STATE_UNCHECKED_CLUSTER - - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES - - SOURCE_STATE_UNCHECKED_SOURCE - - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS - - SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT - description: connection test result - example: SOURCE_STATE_UNCHECKED_SOURCE - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-health - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - - # Fetches source health by id - - try { - Get-V2025SourceHealth -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025SourceHealth -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceHealth" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-health - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_health_dto import SourceHealthDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - try: - # Fetches source health by id - - results = SourcesApi(api_client).get_source_health(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_health(source_id) - print("The response of SourcesApi->get_source_health:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_health: %s\n" % e) - /sources/{id}/schemas/accounts: - get: - tags: - - Sources - summary: Downloads source accounts schema template - description: |- - This API downloads the CSV schema that defines the account attributes on a source. - >**NOTE: This API is designated only for Delimited File sources.** - operationId: getAccountsSchema - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - responses: - '200': - description: Successfully downloaded the file - content: - text/csv: - example: id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:source-schema:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-accounts-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - - # Downloads source accounts schema template - - try { - Get-V2025AccountsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccountsSchema -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountsSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-accounts-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id - try: - # Downloads source accounts schema template - - SourcesApi(api_client).get_accounts_schema(id=id) - # Below is a request that includes all optional parameters - # SourcesApi(api_client).get_accounts_schema(id) - except Exception as e: - print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) - post: - tags: - - Sources - summary: Uploads source accounts schema template - description: |- - This API uploads a source schema template file to configure a source's account attributes. - - To retrieve the file to modify and upload, log into Identity Now. - - Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** - - >**NOTE: This API is designated only for Delimited File sources.** - operationId: importAccountsSchema - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - responses: - '200': - description: Successfully uploaded the file - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:source-schema:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-accounts-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $File = # System.IO.FileInfo | (optional) - - # Uploads source accounts schema template - - try { - Import-V2025AccountsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Import-V2025AccountsSchema -Id $Id -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025AccountsSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#import-accounts-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id - file = None # bytearray | (optional) # bytearray | (optional) - try: - # Uploads source accounts schema template - - results = SourcesApi(api_client).import_accounts_schema(id=id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_accounts_schema(id, file) - print("The response of SourcesApi->import_accounts_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) - /sources/{id}/schemas/entitlements: - get: - tags: - - Sources - summary: Downloads source entitlements schema template - description: |- - This API downloads the CSV schema that defines the entitlement attributes on a source. - - >**NOTE: This API is designated only for Delimited File sources.** - operationId: getEntitlementsSchema - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: query - name: schemaName - schema: - type: string - description: Name of entitlement schema - example: '?schemaName=group' - responses: - '200': - description: Successfully downloaded the file - content: - text/csv: - example: id,name,displayName,created,description,modified,entitlements,groups,permissions - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:source-schema:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-entitlements-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) - - # Downloads source entitlements schema template - - try { - Get-V2025EntitlementsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementsSchema -Id $Id -SchemaName $SchemaName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementsSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-entitlements-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id - schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) - try: - # Downloads source entitlements schema template - - SourcesApi(api_client).get_entitlements_schema(id=id) - # Below is a request that includes all optional parameters - # SourcesApi(api_client).get_entitlements_schema(id, schema_name) - except Exception as e: - print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) - post: - tags: - - Sources - summary: Uploads source entitlements schema template - description: |- - This API uploads a source schema template file to configure a source's entitlement attributes. - - To retrieve the file to modify and upload, log into Identity Now. - - Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** - - >**NOTE: This API is designated only for Delimited File sources.** - operationId: importEntitlementsSchema - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: query - name: schemaName - schema: - type: string - description: Name of entitlement schema - example: '?schemaName=group' - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - responses: - '200': - description: Successfully uploaded the file - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:source-schema:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-entitlements-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) - $File = # System.IO.FileInfo | (optional) - - # Uploads source entitlements schema template - - try { - Import-V2025EntitlementsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Import-V2025EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#import-entitlements-schema - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.model_schema import ModelSchema - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id - schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) - file = None # bytearray | (optional) # bytearray | (optional) - try: - # Uploads source entitlements schema template - - results = SourcesApi(api_client).import_entitlements_schema(id=id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_entitlements_schema(id, schema_name, file) - print("The response of SourcesApi->import_entitlements_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) - /sources/{sourceId}/upload-connector-file: - post: - operationId: importConnectorFile - security: - - userAuth: - - idn:sources-admin:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Sources - summary: Upload connector file to source - parameters: - - in: path - name: sourceId - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The Source id. - example: 2c9180835d191a86015d28455b4a2329 - description: This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - responses: - '200': - description: Uploaded the file successfully and sent all post-upload events - content: - application/json: - schema: - $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-connector-file - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $File = # System.IO.FileInfo | (optional) - - # Upload connector file to source - - try { - Import-V2025ConnectorFile -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Import-V2025ConnectorFile -SourceId $SourceId -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025ConnectorFile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#import-connector-file - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source import Source - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - file = None # bytearray | (optional) # bytearray | (optional) - try: - # Upload connector file to source - - results = SourcesApi(api_client).import_connector_file(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_connector_file(source_id, file) - print("The response of SourcesApi->import_connector_file:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) - /sources/{sourceId}/connections: - get: - operationId: getSourceConnections - security: - - userAuth: - - idn:sources:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Sources - summary: Get Source Connections by ID - description: Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: Source ID. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: Source Connections object. - content: - application/json: - schema: - type: object - properties: - identityProfiles: - type: array - description: The IdentityProfile attached to this source - items: - type: object - properties: - id: - type: string - description: ID of the IdentityProfile this reference applies - example: 76cfddb62818416f816bc494410f46c4 - name: - type: string - description: Human-readable display name of the IdentityProfile to which this reference applies - example: ODS-Identity-Profile - identityCount: - type: integer - format: int64 - description: The Number of Identities managed by this IdentityProfile - example: 100 - credentialProfiles: - type: array - description: Name of the CredentialProfile attached to this source - items: - type: string - example: - - Profile ODS - sourceAttributes: - type: array - description: The attributes attached to this source - items: - type: string - example: - - sAMAccountName - - mail - - sn - - givenName - - displayName - - employeeNumber - - manager - - telephoneNumber - mappingProfiles: - type: array - description: The profiles attached to this source - example: - - ODS-AD-Profile - - ODS-Profile2 - items: - type: string - dependentCustomTransforms: - example: - - id: 61190eae-290b-4335-aeb8-7335f1fd99cb - name: Split Transform - type: split - attributes: - delimiter: '-' - index: 1 - input: - attributes: - sourceName: Example CSV Source - attributeName: last_name - type: accountAttribute - internal: false - description: A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. - type: array - items: - $ref: '#/paths/~1transforms/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TransformRead.yaml - dependentApps: - type: array - items: - type: object - properties: - cloudAppId: - type: string - description: Id of the connected Application - example: 9e3cdd80edf84f119327df8bbd5bb5ac - description: - type: string - description: Description of the connected Application - example: This is a Sailpoint application - enabled: - type: boolean - description: Is the Application enabled - example: true - default: true - provisionRequestEnabled: - type: boolean - description: Is Provisioning enabled for connected Application - example: true - default: true - accountSource: - type: object - description: The Account Source of the connected Application - properties: - useForPasswordManagement: - type: boolean - description: Use this Account Source for password management - example: false - default: false - passwordPolicies: - type: array - description: A list of Password Policies for this Account Source - items: - type: object - properties: - type: - type: string - description: DTO type - example: PASSWORD_POLICY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: Policy ODS - launcherCount: - type: integer - format: int64 - description: The amount of launchers for connected Application (long type) - example: 100 - matchAllAccount: - type: boolean - description: Is Provisioning enabled for connected Application - example: true - default: false - owner: - type: array - description: The owner of the connected Application - items: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml - appCenterEnabled: - type: boolean - description: Is App Center enabled for connected Application - example: false - default: false - missingDependents: - type: array - items: - type: object - properties: - dependencyType: - type: string - enum: - - identityProfiles - - credentialProfiles - - mappingProfiles - - sourceAttributes - - dependantCustomTransforms - - dependantApps - description: The type of dependency type that is missing in the SourceConnections - example: dependantApps - reason: - type: string - description: The reason why this dependency is missing - example: If there was an error retrieving any dependencies, it would lbe listed here - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-connections - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Get Source Connections by ID - - try { - Get-V2025SourceConnections -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025SourceConnections -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceConnections" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-connections - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_connections_dto import SourceConnectionsDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - try: - # Get Source Connections by ID - - results = SourcesApi(api_client).get_source_connections(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_connections(source_id) - print("The response of SourcesApi->get_source_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_connections: %s\n" % e) - /sources/{id}/correlation-config: - get: - operationId: getCorrelationConfig - tags: - - Sources - summary: Get Source Correlation Configuration - security: - - userAuth: - - idn:sources:read - - idn:sources:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - description: This API returns the existing correlation configuration for a source specified by the given ID. - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The source id - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: Correlation configuration for a source - content: - application/json: - schema: - type: object - description: Source configuration information that is used by correlation process. - properties: - id: - type: string - nullable: true - description: The ID of the correlation configuration. - example: 2c9180835d191a86015d28455b4a2329 - name: - type: string - nullable: true - description: The name of the correlation configuration. - example: Source [source] Account Correlation - attributeAssignments: - type: array - nullable: true - description: The list of attribute assignments of the correlation configuration. - items: - type: object - description: The attribute assignment of the correlation configuration. - properties: - property: - type: string - description: The property of the attribute assignment. - example: first_name - value: - type: string - description: The value of the attribute assignment. - example: firstName - operation: - type: string - description: The operation of the attribute assignment. - enum: - - EQ - example: EQ - complex: - type: boolean - description: Whether or not the it's a complex attribute assignment. - default: false - example: false - ignoreCase: - type: boolean - description: Whether or not the attribute assignment should ignore case. - default: false - example: false - matchMode: - type: string - description: The match mode of the attribute assignment. - enum: - - ANYWHERE - - START - - END - example: ANYWHERE - filterString: - type: string - description: The filter string of the attribute assignment. - example: first_name == "John" - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-correlation-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - - # Get Source Correlation Configuration - - try { - Get-V2025CorrelationConfig -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CorrelationConfig -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CorrelationConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-correlation-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.correlation_config import CorrelationConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - try: - # Get Source Correlation Configuration - - results = SourcesApi(api_client).get_correlation_config(id=id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_correlation_config(id) - print("The response of SourcesApi->get_correlation_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) - put: - operationId: putCorrelationConfig - tags: - - Sources - summary: Update Source Correlation Configuration - security: - - userAuth: - - idn:sources:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - description: Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The source id - example: 2c9180835d191a86015d28455b4a2329 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7Bid%7D~1correlation-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CorrelationConfig.yaml - responses: - '200': - description: Updated correlation configuration for a source - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7Bid%7D~1correlation-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CorrelationConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-correlation-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $CorrelationConfig = @" - { - "attributeAssignments" : [ { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - }, { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - } ], - "name" : "Source [source] Account Correlation", - "id" : "2c9180835d191a86015d28455b4a2329" - } - "@ - - # Update Source Correlation Configuration - - try { - $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig - Send-V2025CorrelationConfig -Id $Id -CorrelationConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025CorrelationConfig -Id $Id -CorrelationConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025CorrelationConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#put-correlation-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.correlation_config import CorrelationConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - correlation_config = '''{ - "attributeAssignments" : [ { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - }, { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - } ], - "name" : "Source [source] Account Correlation", - "id" : "2c9180835d191a86015d28455b4a2329" - }''' # CorrelationConfig | - try: - # Update Source Correlation Configuration - new_correlation_config = CorrelationConfig.from_json(correlation_config) - results = SourcesApi(api_client).put_correlation_config(id=id, correlation_config=new_correlation_config) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).put_correlation_config(id, new_correlation_config) - print("The response of SourcesApi->put_correlation_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) - /sources/{sourceId}/password-policies: - patch: - operationId: updatePasswordPolicyHolders - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - ROLE_SUBADMIN - tags: - - Sources - summary: Update Password Policy - description: | - This API can be used to set up or update Password Policy in IdentityNow for the specified Source. - Source must support PASSWORD feature. - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The Source id - example: 8c190e6787aa4ed9a90bd9d5344523fb - requestBody: - required: true - content: - application/json: - schema: - type: array - description: List of PasswordPolicyHoldersDto - items: - type: object - properties: - policyId: - type: string - description: The password policy Id. - example: 2c91808e7d976f3b017d9f5ceae440c8 - policyName: - type: string - description: The name of the password policy. - example: PasswordPolicy Example - selectors: - type: object - properties: - identityAttr: - description: Attributes of PasswordPolicyHoldersDto - type: array - items: - type: object - properties: - name: - description: Attribute's name - type: string - example: Country - value: - description: Attribute's value - type: string - example: Canada - example: - - policyId: 2c91808e7d976f3b017d9f5ceae440c8 - policyName: Default - selectors: null - - policyId: 2c91808e7d976f3b017d9f5ceae440c8 - policyName: PasswordPolicy Example - selectors: - identityAttr: - - name: displayName - value: Robert - - name: lastname - value: Case - responses: - '200': - description: Updated Password Policies - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1password-policies/patch/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordPolicyHoldersDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:sources:update - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-password-policy-holders - source: | - $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $PasswordPolicyHoldersDtoInner = @""@ - - - # Update Password Policy - - try { - $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner - Update-V2025PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PasswordPolicyHolders" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-password-policy-holders - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_policy_holders_dto_inner import PasswordPolicyHoldersDtoInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id - password_policy_holders_dto_inner = '''[sailpoint.v2025.PasswordPolicyHoldersDtoInner()]''' # List[PasswordPolicyHoldersDtoInner] | - try: - # Update Password Policy - new_password_policy_holders_dto_inner = PasswordPolicyHoldersDtoInner.from_json(password_policy_holders_dto_inner) - results = SourcesApi(api_client).update_password_policy_holders(source_id=source_id, password_policy_holders_dto_inner=new_password_policy_holders_dto_inner) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) - print("The response of SourcesApi->update_password_policy_holders:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) - /sources/{sourceId}/connector/check-connection: - post: - operationId: testSourceConnection - tags: - - Sources - summary: Check connection for source connector. - description: This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - security: - - userAuth: - - idn:source-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The ID of the Source. - example: cef3ee201db947c5912551015ba0c679 - responses: - '200': - description: The result of checking connection to the source connector with response from it. - content: - application/json: - schema: - type: object - title: Status Response - description: Response model for connection check, configuration test and ping of source connectors. - properties: - id: - type: string - description: ID of the source - example: 2c91808568c529c60168cca6f90c1313 - readOnly: true - name: - type: string - description: Name of the source - example: ODS-AD-Test [source-999999] - readOnly: true - status: - type: string - enum: - - SUCCESS - - FAILURE - description: The status of the health check. - example: SUCCESS - readOnly: true - elapsedMillis: - type: integer - description: The number of milliseconds spent on the entire request. - example: 1000 - readOnly: true - details: - type: object - description: | - The document contains the results of the health check. - The schema of this document depends on the type of source used. - readOnly: true - example: - useTLSForIQService: false - IQService: - TLS Port: 0 - .NET CLR Version: 4.0.30319.42000 - SecondaryServiceStatus: Running - Port: 5050 - Host: AUTOMATION-AD - Name: IQService - IQServiceStatus: Running - SecondaryService: IQService-Instance1-Secondary - Version: IQService Sep-2020 - secondaryPort: 5051 - OS Architecture: AMD64 - Operating System: Microsoft Windows Server 2012 R2 Standard - highestDotNetVersion: 4.8 or later - Build Time: 09/22/2020 06:34 AM -0500 - IQServiceClientAuthEnabled: false - requestProcessedOn: 1/19/2021 1:47:14 PM - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#test-source-connection - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. - - # Check connection for source connector. - - try { - Test-V2025SourceConnection -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-V2025SourceConnection -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConnection" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#test-source-connection - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.status_response import StatusResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source. - try: - # Check connection for source connector. - - results = SourcesApi(api_client).test_source_connection(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).test_source_connection(source_id) - print("The response of SourcesApi->test_source_connection:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) - /sources/{sourceId}/connector/peek-resource-objects: - post: - operationId: searchResourceObjects - tags: - - Sources - summary: Peek source connector's resource objects - description: Retrieves a sample of data returned from account and group aggregation requests. - security: - - userAuth: - - idn:source-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The ID of the Source - example: cef3ee201db947c5912551015ba0c679 - requestBody: - required: true - content: - application/json: - schema: - type: object - title: Resource Objects Request - description: Request model for peek resource objects from source connectors. - properties: - objectType: - type: string - description: The type of resource objects to iterate over. - default: account - example: group - maxCount: - type: integer - description: The maximum number of resource objects to iterate over and return. - default: 25 - example: 100 - responses: - '200': - description: List of resource objects that was fetched from the source connector. - content: - application/json: - schema: - type: object - title: Resource Objects Response - description: Response model for peek resource objects from source connectors. - properties: - id: - type: string - description: ID of the source - example: 2c91808568c529c60168cca6f90c1313 - readOnly: true - name: - type: string - description: Name of the source - example: ODS-AD-Test [source-999999] - readOnly: true - objectCount: - type: integer - description: The number of objects that were fetched by the connector. - example: 25 - readOnly: true - elapsedMillis: - type: integer - description: The number of milliseconds spent on the entire request. - example: 1055 - readOnly: true - resourceObjects: - type: array - items: - type: object - title: Resource Object - description: Representation of the object which is returned from source connectors. - properties: - instance: - description: Identifier of the specific instance where this object resides. - type: string - readOnly: true - identity: - description: Native identity of the object in the Source. - type: string - example: CN=Aaron Carr,OU=test1,DC=test2,DC=test - readOnly: true - uuid: - description: Universal unique identifier of the object in the Source. - type: string - example: '{abf7bd9b-68b4-4d21-9b70-870c58ebf844}' - readOnly: true - previousIdentity: - description: Native identity that the object has previously. - type: string - readOnly: true - name: - description: Display name for this object. - type: string - example: Aaron Carr - readOnly: true - objectType: - description: Type of object. - type: string - example: account - readOnly: true - incomplete: - description: A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. - type: boolean - example: false - readOnly: true - incremental: - description: A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. - type: boolean - example: false - readOnly: true - delete: - description: A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. - type: boolean - example: false - readOnly: true - remove: - description: A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. - type: boolean - example: false - readOnly: true - missing: - description: A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain "groups". - type: array - items: - type: string - example: - - missFieldOne - - missFieldTwo - readOnly: true - attributes: - description: Attributes of this ResourceObject. - type: object - example: - telephoneNumber: 12-(345)678-9012 - mail: example@test.com - displayName: Aaron Carr - readOnly: true - finalUpdate: - description: In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. - type: boolean - example: false - readOnly: true - description: Fetched objects from the source connector. - readOnly: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#search-resource-objects - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - $ResourceObjectsRequest = @" - { - "maxCount" : 100, - "objectType" : "group" - } - "@ - - # Peek source connector's resource objects - - try { - $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest - Search-V2025ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result - - # Below is a request that includes all optional parameters - # Search-V2025ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025ResourceObjects" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#search-resource-objects - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.resource_objects_request import ResourceObjectsRequest - from sailpoint.v2025.models.resource_objects_response import ResourceObjectsResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source - resource_objects_request = '''{ - "maxCount" : 100, - "objectType" : "group" - }''' # ResourceObjectsRequest | - try: - # Peek source connector's resource objects - new_resource_objects_request = ResourceObjectsRequest.from_json(resource_objects_request) - results = SourcesApi(api_client).search_resource_objects(source_id=source_id, resource_objects_request=new_resource_objects_request) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).search_resource_objects(source_id, new_resource_objects_request) - print("The response of SourcesApi->search_resource_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->search_resource_objects: %s\n" % e) - /sources/{sourceId}/connector/ping-cluster: - post: - operationId: pingCluster - tags: - - Sources - summary: Ping cluster for source connector - description: This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - security: - - userAuth: - - idn:source-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The ID of the Source - example: cef3ee201db947c5912551015ba0c679 - responses: - '200': - description: The result of pinging connection with the source connector. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1connector~1check-connection/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/StatusResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#ping-cluster - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - - # Ping cluster for source connector - - try { - Ping-V2025Cluster -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Ping-V2025Cluster -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2025Cluster" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#ping-cluster - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.status_response import StatusResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source - try: - # Ping cluster for source connector - - results = SourcesApi(api_client).ping_cluster(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).ping_cluster(source_id) - print("The response of SourcesApi->ping_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) - /sources/{sourceId}/connector/test-configuration: - post: - operationId: testSourceConfiguration - tags: - - Sources - summary: Test configuration for source connector - description: This endpoint performs a more detailed validation of the source''s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - security: - - userAuth: - - idn:source-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The ID of the Source - example: cef3ee201db947c5912551015ba0c679 - responses: - '200': - description: The result of testing source connector configuration with response from it. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1connector~1check-connection/post/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/StatusResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#test-source-configuration - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - - # Test configuration for source connector - - try { - Test-V2025SourceConfiguration -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-V2025SourceConfiguration -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#test-source-configuration - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.status_response import StatusResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source - try: - # Test configuration for source connector - - results = SourcesApi(api_client).test_source_configuration(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).test_source_configuration(source_id) - print("The response of SourcesApi->test_source_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) - /sources/{id}/connectors/source-config: - get: - operationId: getSourceConfig - tags: - - Sources - summary: Gets source config with language-translations - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The Source id - example: cef3ee201db947c5912551015ba0c679 - - in: query - name: locale - schema: - type: string - enum: - - de - - false - - fi - - sv - - ru - - pt - - ko - - zh-TW - - en - - it - - fr - - zh-CN - - hu - - es - - cs - - ja - - pl - - da - - nl - description: The locale to apply to the config. If no viable locale is given, it will default to "en" - example: en - required: false - responses: - '200': - description: A Connector Detail object - content: - application/json: - schema: - $ref: '#/paths/~1connectors~1%7BscriptName%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ConnectorDetail.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-config - source: | - $Id = "cef3ee201db947c5912551015ba0c679" # String | The Source id - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Gets source config with language-translations - - try { - Get-V2025SourceConfig -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SourceConfig -Id $Id -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.connector_detail import ConnectorDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'cef3ee201db947c5912551015ba0c679' # str | The Source id # str | The Source id - locale = 'en' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) - try: - # Gets source config with language-translations - - results = SourcesApi(api_client).get_source_config(id=id) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_config(id, locale) - print("The response of SourcesApi->get_source_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_config: %s\n" % e) - /tagged-objects: - get: - operationId: listTaggedObjects - security: - - userAuth: - - idn:tag:read - - idn:tag:manage - tags: - - Tagged Objects - summary: List Tagged Objects - description: |- - This API returns a list of all tagged objects. - - Any authenticated token may be used to call this API. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **objectRef.id**: *eq, in* - - **objectRef.type**: *eq, in* - - **tagName**: *eq, in* - example: tagName eq "BU_FINANCE" - required: false - responses: - '200': - description: List of all tagged objects. - content: - application/json: - schema: - type: array - items: - type: object - description: Tagged object. - properties: - objectRef: - type: object - properties: - type: - type: string - enum: - - ACCESS_PROFILE - - APPLICATION - - CAMPAIGN - - ENTITLEMENT - - IDENTITY - - ROLE - - SOD_POLICY - - SOURCE - example: IDENTITY - description: DTO type - id: - type: string - description: ID of the object this reference applies to - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - nullable: true - description: Human-readable display name of the object this reference applies to - example: William Wilson - tags: - type: array - items: - type: string - description: Labels to be applied to an Object - example: - - BU_FINANCE - - PCI - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#list-tagged-objects - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) - - # List Tagged Objects - - try { - Get-V2025TaggedObjects - - # Below is a request that includes all optional parameters - # Get-V2025TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObjects" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#list-tagged-objects - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tagged_object import TaggedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'tagName eq \"BU_FINANCE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) - try: - # List Tagged Objects - - results = TaggedObjectsApi(api_client).list_tagged_objects() - # Below is a request that includes all optional parameters - # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) - print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - post: - operationId: setTagToObject - security: - - userAuth: - - idn:tag:manage - tags: - - Tagged Objects - summary: Add Tag to Object - description: |- - This adds a tag to an object. - - Any authenticated token may be used to call this API. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObject.yaml - responses: - '201': - description: Created. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#set-tag-to-object - source: | - $TaggedObject = @" - { - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Add Tag to Object - - try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-V2025TagToObject -TaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-V2025TagToObject -TaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TagToObject" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#set-tag-to-object - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tagged_object import TaggedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - tagged_object = '''{ - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - }''' # TaggedObject | - try: - # Add Tag to Object - new_tagged_object = TaggedObject.from_json(tagged_object) - TaggedObjectsApi(api_client).set_tag_to_object(tagged_object=new_tagged_object) - # Below is a request that includes all optional parameters - # TaggedObjectsApi(api_client).set_tag_to_object(new_tagged_object) - except Exception as e: - print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) - /tagged-objects/{type}: - get: - operationId: listTaggedObjectsByType - security: - - userAuth: - - idn:tag:read - - idn:tag:manage - tags: - - Tagged Objects - summary: List Tagged Objects by Type - description: |- - This API returns a list of all tagged objects by type. - - Any authenticated token may be used to call this API. - parameters: - - in: path - name: type - schema: - type: string - enum: - - ACCESS_PROFILE - - APPLICATION - - CAMPAIGN - - ENTITLEMENT - - IDENTITY - - ROLE - - SOD_POLICY - - SOURCE - required: true - description: The type of tagged object to retrieve. - example: ROLE - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **objectRef.id**: *eq* - - **objectRef.type**: *eq* - example: objectRef.id eq "2c91808568c529c60168cca6f90c1313" - required: false - responses: - '200': - description: List of all tagged objects for specified type. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObject.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#list-tagged-objects-by-type - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) - - # List Tagged Objects by Type - - try { - Get-V2025TaggedObjectsByType -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObjectsByType" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#list-tagged-objects-by-type - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tagged_object import TaggedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'ROLE' # str | The type of tagged object to retrieve. # str | The type of tagged object to retrieve. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'objectRef.id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) - try: - # List Tagged Objects by Type - - results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type=type) - # Below is a request that includes all optional parameters - # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) - print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - /tagged-objects/{type}/{id}: - get: - operationId: getTaggedObject - security: - - userAuth: - - idn:tag:read - - idn:tag:manage - tags: - - Tagged Objects - summary: Get Tagged Object - description: This gets a tagged object for the specified type. - parameters: - - in: path - name: type - schema: - type: string - enum: - - ACCESS_PROFILE - - APPLICATION - - CAMPAIGN - - ENTITLEMENT - - IDENTITY - - ROLE - - SOD_POLICY - - SOURCE - required: true - description: The type of tagged object to retrieve. - example: ROLE - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listTaggedObjects - description: The ID of the object reference to retrieve. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Tagged object by type and ID. - content: - application/json: - schema: - $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObject.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#get-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - - # Get Tagged Object - - try { - Get-V2025TaggedObject -Type $Type -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025TaggedObject -Type $Type -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObject" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#get-tagged-object - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tagged_object import TaggedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'ROLE' # str | The type of tagged object to retrieve. # str | The type of tagged object to retrieve. - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. - try: - # Get Tagged Object - - results = TaggedObjectsApi(api_client).get_tagged_object(type=type, id=id) - # Below is a request that includes all optional parameters - # results = TaggedObjectsApi(api_client).get_tagged_object(type, id) - print("The response of TaggedObjectsApi->get_tagged_object:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) - put: - operationId: putTaggedObject - security: - - userAuth: - - idn:tag:manage - tags: - - Tagged Objects - summary: Update Tagged Object - description: This updates a tagged object for the specified type. - parameters: - - in: path - name: type - schema: - type: string - enum: - - ACCESS_PROFILE - - APPLICATION - - CAMPAIGN - - ENTITLEMENT - - IDENTITY - - ROLE - - SOD_POLICY - - SOURCE - required: true - description: The type of tagged object to update. - example: ROLE - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listTaggedObjects - description: The ID of the object reference to update. - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObject.yaml - responses: - '200': - description: Tagged object by type and ID. - content: - application/json: - schema: - $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObject.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#put-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. - $TaggedObject = @" - { - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Update Tagged Object - - try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-V2025TaggedObject -Type $Type -Id $Id -TaggedObject $Result - - # Below is a request that includes all optional parameters - # Send-V2025TaggedObject -Type $Type -Id $Id -TaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TaggedObject" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#put-tagged-object - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tagged_object import TaggedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'ROLE' # str | The type of tagged object to update. # str | The type of tagged object to update. - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to update. # str | The ID of the object reference to update. - tagged_object = '''{ - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - }''' # TaggedObject | - try: - # Update Tagged Object - new_tagged_object = TaggedObject.from_json(tagged_object) - results = TaggedObjectsApi(api_client).put_tagged_object(type=type, id=id, tagged_object=new_tagged_object) - # Below is a request that includes all optional parameters - # results = TaggedObjectsApi(api_client).put_tagged_object(type, id, new_tagged_object) - print("The response of TaggedObjectsApi->put_tagged_object:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) - delete: - operationId: deleteTaggedObject - security: - - userAuth: - - idn:tag:manage - tags: - - Tagged Objects - summary: Delete Object Tags - description: Delete all tags from a tagged object. - parameters: - - in: path - name: type - schema: - type: string - enum: - - ACCESS_PROFILE - - APPLICATION - - CAMPAIGN - - ENTITLEMENT - - IDENTITY - - ROLE - - SOD_POLICY - - SOURCE - required: true - description: The type of object to delete tags from. - example: ROLE - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listTaggedObjects - description: The ID of the object to delete tags from. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: No content. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#delete-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. - - # Delete Object Tags - - try { - Remove-V2025TaggedObject -Type $Type -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025TaggedObject -Type $Type -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TaggedObject" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#delete-tagged-object - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'ROLE' # str | The type of object to delete tags from. # str | The type of object to delete tags from. - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object to delete tags from. # str | The ID of the object to delete tags from. - try: - # Delete Object Tags - - TaggedObjectsApi(api_client).delete_tagged_object(type=type, id=id) - # Below is a request that includes all optional parameters - # TaggedObjectsApi(api_client).delete_tagged_object(type, id) - except Exception as e: - print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) - /tagged-objects/bulk-add: - post: - operationId: setTagsToManyObjects - security: - - userAuth: - - idn:tag:manage - - applicationAuth: - - idn:tag:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - - REPORT_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Tagged Objects - summary: Tag Multiple Objects - description: This API adds tags to multiple objects. - requestBody: - required: true - description: Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - content: - application/json: - schema: - type: object - properties: - objectRefs: - type: array - items: - $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items/properties/objectRef' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObjectDto.yaml - tags: - type: array - items: - type: string - description: Label to be applied to an Object - example: - - BU_FINANCE - - PCI - operation: - type: string - enum: - - APPEND - - MERGE - default: APPEND - description: |- - If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. - - If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. - example: MERGE - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: array - items: - type: object - properties: - objectRefs: - type: array - items: - $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items/properties/objectRef' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObjectDto.yaml - tags: - type: array - items: - type: string - description: Label to be applied to an Object - example: - - BU_FINANCE - - PCI - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#set-tags-to-many-objects - source: | - $BulkAddTaggedObject = @" - { - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "operation" : "MERGE", - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Tag Multiple Objects - - try { - $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject - Set-V2025TagsToManyObjects -BulkAddTaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-V2025TagsToManyObjects -BulkAddTaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TagsToManyObjects" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#set-tags-to-many-objects - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.bulk_add_tagged_object import BulkAddTaggedObject - from sailpoint.v2025.models.bulk_tagged_object_response import BulkTaggedObjectResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - bulk_add_tagged_object = '''{ - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "operation" : "MERGE", - "tags" : [ "BU_FINANCE", "PCI" ] - }''' # BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - try: - # Tag Multiple Objects - new_bulk_add_tagged_object = BulkAddTaggedObject.from_json(bulk_add_tagged_object) - results = TaggedObjectsApi(api_client).set_tags_to_many_objects(bulk_add_tagged_object=new_bulk_add_tagged_object) - # Below is a request that includes all optional parameters - # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) - print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) - /tagged-objects/bulk-remove: - post: - operationId: deleteTagsToManyObject - security: - - userAuth: - - idn:tag:manage - - applicationAuth: - - idn:tag:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - - REPORT_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - tags: - - Tagged Objects - summary: Remove Tags from Multiple Objects - description: This API removes tags from multiple objects. - requestBody: - description: Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - required: true - content: - application/json: - schema: - type: object - properties: - objectRefs: - type: array - items: - $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items/properties/objectRef' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObjectDto.yaml - tags: - type: array - items: - type: string - description: Label to be applied to an Object - example: - - BU_FINANCE - - PCI - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#delete-tags-to-many-object - source: | - $BulkRemoveTaggedObject = @" - { - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Remove Tags from Multiple Objects - - try { - $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject - Remove-V2025TagsToManyObject -BulkRemoveTaggedObject $Result - - # Below is a request that includes all optional parameters - # Remove-V2025TagsToManyObject -BulkRemoveTaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TagsToManyObject" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tagged-objects#delete-tags-to-many-object - source: | - from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.bulk_remove_tagged_object import BulkRemoveTaggedObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - bulk_remove_tagged_object = '''{ - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "tags" : [ "BU_FINANCE", "PCI" ] - }''' # BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - try: - # Remove Tags from Multiple Objects - new_bulk_remove_tagged_object = BulkRemoveTaggedObject.from_json(bulk_remove_tagged_object) - TaggedObjectsApi(api_client).delete_tags_to_many_object(bulk_remove_tagged_object=new_bulk_remove_tagged_object) - # Below is a request that includes all optional parameters - # TaggedObjectsApi(api_client).delete_tags_to_many_object(new_bulk_remove_tagged_object) - except Exception as e: - print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) - /transforms: - get: - tags: - - Transforms - summary: List transforms - description: Gets a list of all saved transform objects. - operationId: listTransforms - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: name - in: query - description: Name of the transform to retrieve from the list. - required: false - style: form - schema: - type: string - example: ExampleTransformName123 - - name: filters - in: query - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **internal**: *eq* - - **name**: *eq, sw* - required: false - style: form - explode: true - example: name eq "Uppercase" - schema: - type: string - responses: - '200': - description: A list of transforms matching the given criteria. - content: - application/json: - schema: - type: array - items: - allOf: - - $ref: '#/paths/~1transforms/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Transform.yaml - - type: object - required: - - id - - internal - properties: - id: - type: string - description: Unique ID of this transform - example: 2cd78adghjkja34jh2b1hkjhasuecd - internal: - type: boolean - description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform - example: false - default: false - example: - - id: 2cd78adghjkja34jh2b1hkjhasuecd - name: Timestamp To Date - type: dateFormat - attributes: - inputFormat: MMM-dd-yyyy, HH:mm:ss.SSS - outputFormat: yyyy/dd/MM - internal: false - - id: 2lkas8dhj4bkuakja77giih7l4ashh - name: PrefixSubstring - type: substring - attributes: - begin: 0 - end: 3 - internal: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:transform:read - - idn:transform:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#list-transforms - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) - $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) - - # List transforms - - try { - Get-V2025Transforms - - # Below is a request that includes all optional parameters - # Get-V2025Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Transforms" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/transforms#list-transforms - source: | - from sailpoint.v2025.api.transforms_api import TransformsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.transform_read import TransformRead - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - name = 'ExampleTransformName123' # str | Name of the transform to retrieve from the list. (optional) # str | Name of the transform to retrieve from the list. (optional) - filters = 'name eq \"Uppercase\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) - try: - # List transforms - - results = TransformsApi(api_client).list_transforms() - # Below is a request that includes all optional parameters - # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) - print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - post: - tags: - - Transforms - summary: Create transform - description: Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - operationId: createTransform - requestBody: - required: true - description: The transform to be created. - content: - application/json: - schema: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - minLength: 1 - maxLength: 50 - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - - displayName - - rfc5646 - example: dateFormat - externalDocs: - description: Transform Operations - url: https://developer.sailpoint.com/idn/docs/transforms/operations - attributes: - nullable: true - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/AccountAttribute.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Base64Decode.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Base64Encode.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Concatenation.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/4' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Conditional.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/5' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/DateCompare.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/DateFormat.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/7' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/DateMath.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/8' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/DecomposeDiacriticalMarks.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/9' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/E164phone.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/10' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/FirstValid.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/11' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Rule.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/12' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/IdentityAttribute.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/13' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/IndexOf.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/14' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/ISO3166.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/15' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/LeftPad.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/16' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Lookup.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/17' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Lower.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/18' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/NameNormalizer.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/19' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RandomAlphaNumeric.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/20' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RandomNumeric.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/21' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Reference.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/22' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/ReplaceAll.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/23' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Replace.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/24' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RightPad.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/25' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Split.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/26' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Static.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/27' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Substring.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/28' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Trim.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/29' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Upper.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/30' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/UUIDGenerator.yaml - example: - name: Timestamp To Date - type: dateFormat - attributes: - inputFormat: MMM dd yyyy, HH:mm:ss.SSS - outputFormat: yyyy/dd/MM - responses: - '201': - description: Indicates the transform was successfully created and returns its representation. - content: - application/json: - schema: - $ref: '#/paths/~1transforms/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TransformRead.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:transform:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#create-transform - source: | - $Transform = @" - { - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" - } - "@ - - # Create transform - - try { - $Result = ConvertFrom-JsonToTransform -Json $Transform - New-V2025Transform -Transform $Result - - # Below is a request that includes all optional parameters - # New-V2025Transform -Transform $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Transform" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/transforms#create-transform - source: | - from sailpoint.v2025.api.transforms_api import TransformsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.transform import Transform - from sailpoint.v2025.models.transform_read import TransformRead - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - transform = '''{ - "name" : "Timestamp To Date", - "attributes" : "{}", - "type" : "dateFormat" - }''' # Transform | The transform to be created. - try: - # Create transform - new_transform = Transform.from_json(transform) - results = TransformsApi(api_client).create_transform(transform=new_transform) - # Below is a request that includes all optional parameters - # results = TransformsApi(api_client).create_transform(new_transform) - print("The response of TransformsApi->create_transform:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TransformsApi->create_transform: %s\n" % e) - /transforms/{id}: - get: - tags: - - Transforms - summary: Transform by ID - description: This API returns the transform specified by the given ID. - operationId: getTransform - parameters: - - name: id - in: path - description: ID of the transform to retrieve - required: true - x-sailpoint-resource-operation-id: listTransforms - style: simple - explode: false - example: 2cd78adghjkja34jh2b1hkjhasuecd - schema: - type: string - responses: - '200': - description: Transform with the given ID - content: - application/json: - schema: - $ref: '#/paths/~1transforms/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TransformRead.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:transform:read - - idn:transform:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#get-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve - - # Transform by ID - - try { - Get-V2025Transform -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Transform -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Transform" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/transforms#get-transform - source: | - from sailpoint.v2025.api.transforms_api import TransformsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.transform_read import TransformRead - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve - try: - # Transform by ID - - results = TransformsApi(api_client).get_transform(id=id) - # Below is a request that includes all optional parameters - # results = TransformsApi(api_client).get_transform(id) - print("The response of TransformsApi->get_transform:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TransformsApi->get_transform: %s\n" % e) - put: - tags: - - Transforms - summary: Update a transform - description: Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. - operationId: updateTransform - parameters: - - name: id - in: path - description: ID of the transform to update - required: true - x-sailpoint-resource-operation-id: listTransforms - style: simple - explode: false - schema: - type: string - example: 2cd78adghjkja34jh2b1hkjhasuecd - requestBody: - description: The updated transform object. Must include "name", "type", and "attributes" fields, but "name" and "type" must not be modified. - content: - application/json: - schema: - $ref: '#/paths/~1transforms/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Transform.yaml - example: - name: Timestamp To Date - type: dateFormat - attributes: - inputFormat: MMM-dd-yyyy, HH:mm:ss.SSS - outputFormat: yyyy/dd/MM - responses: - '200': - description: Indicates the transform was successfully updated and returns its new representation. - content: - application/json: - schema: - $ref: '#/paths/~1transforms/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TransformRead.yaml - example: - id: 2cd78adghjkja34jh2b1hkjhasuecd - name: Timestamp To Date - type: dateFormat - attributes: - inputFormat: MMM-dd-yyyy, HH:mm:ss.SSS - outputFormat: yyyy/dd/MM - internal: false - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:transform:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#update-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update - $Transform = @" - { - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" - } - "@ - - # Update a transform - - try { - Update-V2025Transform -Id $Id - - # Below is a request that includes all optional parameters - # Update-V2025Transform -Id $Id -Transform $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Transform" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/transforms#update-transform - source: | - from sailpoint.v2025.api.transforms_api import TransformsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.transform import Transform - from sailpoint.v2025.models.transform_read import TransformRead - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to update # str | ID of the transform to update - transform = '''{ - "name" : "Timestamp To Date", - "attributes" : "{}", - "type" : "dateFormat" - }''' # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) - try: - # Update a transform - - results = TransformsApi(api_client).update_transform(id=id) - # Below is a request that includes all optional parameters - # results = TransformsApi(api_client).update_transform(id, new_transform) - print("The response of TransformsApi->update_transform:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TransformsApi->update_transform: %s\n" % e) - delete: - tags: - - Transforms - summary: Delete a transform - description: Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - operationId: deleteTransform - parameters: - - name: id - in: path - description: ID of the transform to delete - required: true - x-sailpoint-resource-operation-id: listTransforms - style: simple - explode: false - schema: - type: string - example: 2cd78adghjkja34jh2b1hkjhasuecd - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:transform:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#delete-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete - - # Delete a transform - - try { - Remove-V2025Transform -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Transform -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Transform" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/transforms#delete-transform - source: | - from sailpoint.v2025.api.transforms_api import TransformsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete - try: - # Delete a transform - - TransformsApi(api_client).delete_transform(id=id) - # Below is a request that includes all optional parameters - # TransformsApi(api_client).delete_transform(id) - except Exception as e: - print("Exception when calling TransformsApi->delete_transform: %s\n" % e) - /work-items: - get: - operationId: listWorkItems - tags: - - Work Items - summary: List Work Items - description: This gets a collection of work items belonging to either the specified user(admin required), or the current user. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: ownerId - schema: - type: string - description: ID of the work item owner. - required: false - example: 1211bcaa32112bcef6122adb21cef1ac - responses: - '200': - description: List of work items - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - nullable: true - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - nullable: true - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - nullable: true - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - description: Time when the work item was created - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: Time when the work item was last updated - nullable: true - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - $ref: '#/components/schemas/WorkItems/properties/state' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItemStateManualWorkItems.yaml - type: - $ref: '#/components/schemas/WorkItems/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItemTypeManualWorkItems.yaml - remediationItems: - type: array - nullable: true - items: - $ref: '#/components/schemas/WorkItems/properties/remediationItems/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RemediationItemDetails.yaml - description: A list of remediation items - approvalItems: - type: array - nullable: true - items: - $ref: '#/components/schemas/WorkItems/properties/approvalItems/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalItemDetails.yaml - description: A list of items that need to be approved - name: - type: string - description: The work item name - example: Account Create - nullable: true - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - description: The time at which the work item completed - nullable: true - numItems: - type: integer - format: int32 - description: The number of items in the work item - example: 19 - nullable: true - form: - allOf: - - $ref: '#/components/schemas/WorkItems/properties/form/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/FormDetails.yaml - - nullable: true - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - description: An array of errors that ocurred during the work item - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#list-work-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # List Work Items - - try { - Get-V2025WorkItems - - # Below is a request that includes all optional parameters - # Get-V2025WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#list-work-items - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # List Work Items - - results = WorkItemsApi(api_client).list_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) - print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - /work-items/completed: - get: - operationId: getCompletedWorkItems - tags: - - Work Items - summary: Completed Work Items - description: This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - parameters: - - in: query - name: ownerId - schema: - type: string - description: The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - required: false - example: 1211bcaa32112bcef6122adb21cef1ac - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - responses: - '200': - description: List of completed work items. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Completed Work Items - - try { - Get-V2025CompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-V2025CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompletedWorkItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-completed-work-items - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Completed Work Items - - results = WorkItemsApi(api_client).get_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) - print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - /work-items/count: - get: - operationId: getCountWorkItems - tags: - - Work Items - summary: Count Work Items - description: This gets a count of work items belonging to either the specified user(admin required), or the current user. - parameters: - - in: query - name: ownerId - schema: - type: string - description: ID of the work item owner. - required: false - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: List of work items - content: - application/json: - schema: - type: object - properties: - count: - type: integer - description: The count of work items - example: 29 - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-count-work-items - source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - - # Count Work Items - - try { - Get-V2025CountWorkItems - - # Below is a request that includes all optional parameters - # Get-V2025CountWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CountWorkItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-count-work-items - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Work Items - - results = WorkItemsApi(api_client).get_count_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_work_items(owner_id) - print("The response of WorkItemsApi->get_count_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) - /work-items/completed/count: - get: - operationId: getCountCompletedWorkItems - tags: - - Work Items - summary: Count Completed Work Items - description: This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - parameters: - - in: query - name: ownerId - schema: - type: string - description: ID of the work item owner. - required: false - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of work items - content: - application/json: - schema: - $ref: '#/paths/~1work-items~1count/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItemsCount.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-count-completed-work-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - - # Count Completed Work Items - - try { - Get-V2025CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CountCompletedWorkItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-count-completed-work-items - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Completed Work Items - - results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental, owner_id) - print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) - /work-items/summary: - get: - operationId: getWorkItemsSummary - tags: - - Work Items - summary: Work Items Summary - description: This gets a summary of work items belonging to either the specified user(admin required), or the current user. - parameters: - - in: query - name: ownerId - schema: - type: string - description: ID of the work item owner. - required: false - example: 1211bcaa32112bcef6122adb21cef1ac - responses: - '200': - description: List of work items - content: - application/json: - schema: - type: object - properties: - open: - type: integer - description: The count of open work items - example: 29 - completed: - type: integer - description: The count of completed work items - example: 1 - total: - type: integer - description: The count of total work items - example: 30 - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-work-items-summary - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Work Items Summary - - try { - Get-V2025WorkItemsSummary - - # Below is a request that includes all optional parameters - # Get-V2025WorkItemsSummary -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItemsSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-work-items-summary - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items_summary import WorkItemsSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Work Items Summary - - results = WorkItemsApi(api_client).get_work_items_summary() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) - print("The response of WorkItemsApi->get_work_items_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) - /work-items/{id}: - get: - operationId: getWorkItem - tags: - - Work Items - summary: Get a Work Item - description: This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listWorkItems - description: ID of the work item. - example: 2c9180835d191a86015d28455b4a2329 - responses: - '200': - description: The work item with the given ID. - content: - application/json: - schema: - $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-work-item - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - - # Get a Work Item - - try { - Get-V2025WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkItem -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-work-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. - try: - # Get a Work Item - - results = WorkItemsApi(api_client).get_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_item(id) - print("The response of WorkItemsApi->get_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) - post: - operationId: completeWorkItem - tags: - - Work Items - summary: Complete a Work Item - description: This API completes a work item. Either an admin, or the owning/current user must make this request. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listWorkItems - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - description: Body is the request payload to create form definition request - content: - application/json: - schema: - type: string - nullable: true - responses: - '200': - description: A WorkItems object - content: - application/json: - schema: - $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#complete-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) - - # Complete a Work Item - - try { - Complete-V2025WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Complete-V2025WorkItem -Id $Id -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025WorkItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#complete-work-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) - try: - # Complete a Work Item - - results = WorkItemsApi(api_client).complete_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).complete_work_item(id, new_body) - print("The response of WorkItemsApi->complete_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) - /work-items/{id}/approve/{approvalItemId}: - post: - operationId: approveApprovalItem - tags: - - Work Items - summary: Approve an Approval Item - description: This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listWorkItems - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: approvalItemId - schema: - type: string - required: true - description: The ID of the approval item. - example: 1211bcaa32112bcef6122adb21cef1ac - responses: - '200': - description: A work items details object. - content: - application/json: - schema: - $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#approve-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Approve an Approval Item - - try { - Approve-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Approve-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025ApprovalItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#approve-approval-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Approve an Approval Item - - results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->approve_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) - /work-items/{id}/reject/{approvalItemId}: - post: - operationId: rejectApprovalItem - tags: - - Work Items - summary: Reject an Approval Item - description: This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listWorkItems - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: approvalItemId - schema: - type: string - required: true - description: The ID of the approval item. - example: 1211bcaa32112bcef6122adb21cef1ac - responses: - '200': - description: A work items details object. - content: - application/json: - schema: - $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#reject-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Reject an Approval Item - - try { - Deny-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Deny-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025ApprovalItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#reject-approval-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Reject an Approval Item - - results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->reject_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) - /work-items/bulk-approve/{id}: - post: - operationId: approveApprovalItemsInBulk - tags: - - Work Items - summary: Bulk approve Approval Items - description: This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listWorkItems - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: A work items details object. - content: - application/json: - schema: - $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#approve-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk approve Approval Items - - try { - Approve-V2025ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Approve-V2025ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#approve-approval-items-in-bulk - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk approve Approval Items - - results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) - print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) - /work-items/bulk-reject/{id}: - post: - operationId: rejectApprovalItemsInBulk - tags: - - Work Items - summary: Bulk reject Approval Items - description: This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listWorkItems - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: A work items details object. - content: - application/json: - schema: - $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#reject-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk reject Approval Items - - try { - Deny-V2025ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Deny-V2025ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#reject-approval-items-in-bulk - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk reject Approval Items - - results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) - print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) - /work-items/{id}/submit-account-selection: - post: - operationId: submitAccountSelection - tags: - - Work Items - summary: Submit Account Selections - description: This API submits account selections. Either an admin, or the owning/current user must make this request. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listWorkItems - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: true - example: - fieldName: fieldValue - description: Account Selection Data map, keyed on fieldName - responses: - '200': - description: A work items details object. - content: - application/json: - schema: - $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#submit-account-selection - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - - # Submit Account Selections - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-V2025AccountSelection -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Submit-V2025AccountSelection -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025AccountSelection" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#submit-account-selection - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName - try: - # Submit Account Selections - new_request_body = RequestBody.from_json(request_body) - results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) - print("The response of WorkItemsApi->submit_account_selection:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) - /workflows: - get: - operationId: listWorkflows - tags: - - Workflows - summary: List Workflows - description: List all workflows in the tenant. - security: - - userAuth: - - sp:workflow:read - responses: - '200': - description: List of workflows - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - properties: - id: - type: string - description: Workflow ID. This is a UUID generated upon creation. - example: d201c5e9-d37b-4aff-af14-66414f39d569 - executionCount: - type: integer - format: int32 - description: The number of times this workflow has been executed. - example: 2 - failureCount: - type: integer - format: int32 - description: The number of times this workflow has failed during execution. - example: 0 - created: - type: string - format: date-time - description: The date and time the workflow was created. - example: '2022-01-10T16:06:16.636381447Z' - modified: - type: string - format: date-time - description: The date and time the workflow was modified. - example: '2023-12-05T15:18:27.699Z' - modifiedBy: - type: object - properties: - type: - type: string - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity ID - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of identity. - example: Thomas Edison - creator: - type: object - description: Workflow creator's identity. - properties: - type: - type: string - description: Workflow creator's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Workflow creator's identity ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Workflow creator's display name. - example: Michael Michaels - - $ref: '#/paths/~1workflows/post/requestBody/content/application~1json/schema/allOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowBody.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2025Workflows - - # Below is a request that includes all optional parameters - # Get-V2025Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - post: - operationId: createWorkflow - tags: - - Workflows - summary: Create Workflow - description: Create a new workflow with the desired trigger and steps specified in the request body. - security: - - userAuth: - - sp:workflow:manage - requestBody: - required: true - content: - application/json: - schema: - allOf: - - required: - - name - - type: object - properties: - name: - type: string - description: The name of the workflow - example: Send Email - owner: - type: object - description: The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. - properties: - type: - type: string - enum: - - IDENTITY - example: IDENTITY - description: The type of object that is referenced - id: - type: string - description: The unique ID of the object - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: The name of the object - example: William Wilson - description: - type: string - description: Description of what the workflow accomplishes - example: Send an email to the identity who's attributes changed. - definition: - type: object - description: The map of steps that the workflow will execute. - properties: - start: - type: string - description: The name of the starting step. - example: Send Email Test - steps: - type: object - description: One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. - additionalProperties: true - example: - Send Email: - actionId: sp:send-email - attributes: - body: This is a test - from: sailpoint@sailpoint.com - recipientId.$: $.identity.id - subject: test - nextStep: success - selectResult: null - type: ACTION - success: - type: success - enabled: - type: boolean - description: Enable or disable the workflow. Workflows cannot be created in an enabled state. - default: false - example: false - trigger: - type: object - description: The trigger that starts the workflow - required: - - type - - attributes - properties: - type: - type: string - enum: - - EVENT - - EXTERNAL - - SCHEDULED - - '' - example: EVENT - description: The trigger type - displayName: - type: string - nullable: true - attributes: - nullable: true - anyOf: - - title: Event Trigger Attributes - type: object - description: Attributes related to an IdentityNow ETS event - additionalProperties: false - required: - - id - properties: - id: - type: string - description: The unique ID of the trigger - example: idn:identity-attributes-changed - nullable: true - filter.$: - type: string - description: JSON path expression that will limit which events the trigger will fire on - example: $.changes[?(@.attribute == 'manager')] - nullable: true - description: - type: string - description: Description of the event trigger - example: Triggered when an identity's manager attribute changes - nullable: true - attributeToFilter: - type: string - description: The attribute to filter on - example: LifecycleState - nullable: true - formDefinitionId: - type: string - description: Form definition's unique identifier. - example: Admin_Access_Request_Form - nullable: true - - title: External Trigger Attributes - type: object - description: Attributes related to an external trigger - additionalProperties: false - properties: - name: - type: string - description: A unique name for the external trigger - example: search-and-notify - nullable: true - description: - type: string - description: Additional context about the external trigger - example: Run a search and notify the results - nullable: true - clientId: - type: string - description: OAuth Client ID to authenticate with this trigger - example: 87e239b2-b85b-4bde-b9a7-55bf304ddcdc - nullable: true - url: - type: string - description: URL to invoke this workflow - example: https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d - nullable: true - - title: Scheduled Trigger Attributes - type: object - description: Attributes related to a scheduled trigger - additionalProperties: false - required: - - frequency - properties: - frequency: - type: string - description: Frequency of execution - example: daily - enum: - - daily - - weekly - - monthly - - yearly - - cronSchedule - - null - nullable: true - timeZone: - type: string - description: Time zone identifier - example: America/Chicago - nullable: true - cronString: - type: string - description: A valid CRON expression - externalDocs: - description: CRON expression editor - url: https://crontab.guru/ - example: 0 9 * * 1 - nullable: true - weeklyDays: - type: array - items: - type: string - example: Monday - description: Scheduled days of the week for execution - nullable: true - weeklyTimes: - type: array - items: - type: string - example: Monday - description: Scheduled execution times - nullable: true - yearlyTimes: - type: array - items: - type: string - example: '1969-12-31T09:00:00.000Z' - description: Scheduled execution times - nullable: true - description: Workflow Trigger Attributes. - examples: - Event Trigger: - description: Workflow initiated by an event trigger - value: - name: Send Email - owner: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: William Wilson - description: Send an email to the identity who's attributes changed. - definition: - start: Send Email Test - steps: - Send Email: - actionId: sp:send-email - attributes: - body: This is a test - from: sailpoint@sailpoint.com - recipientId.$: $.identity.id - subject: test - nextStep: success - selectResult: null - type: action - success: - type: success - enabled: false - trigger: - type: EVENT - attributes: - id: idn:identity-attributes-changed - filter: $.changes[?(@.attribute == 'manager')] - Scheduled Trigger: - description: Workflow initiated by a scheduled trigger - value: - name: Send Email - owner: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: William Wilson - description: Send an email to the identity who's attributes changed. - definition: - start: Send Email Test - steps: - Send Email: - actionId: sp:send-email - attributes: - body: This is a test - from: sailpoint@sailpoint.com - recipientId.$: $.identity.id - subject: test - nextStep: success - selectResult: null - type: action - success: - type: success - enabled: false - trigger: - type: SCHEDULED - attributes: - cronString: 0 * */3 */5 * - External Trigger: - description: Workflow initiated by an external trigger - value: - name: Send Email - owner: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: William Wilson - description: Send an email to the identity whose attributes changed. - definition: - start: Send Email Test - steps: - Send Email: - actionId: sp:send-email - attributes: - body: This is a test - from: sailpoint@sailpoint.com - recipientId.$: $.identity.id - subject: test - nextStep: success - selectResult: null - type: action - success: - type: success - enabled: false - trigger: - type: EXTERNAL - attributes: - name: search-and-notify - description: Run a search and notify the results - responses: - '200': - description: The Workflow object - content: - application/json: - schema: - $ref: '#/paths/~1workflows/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/Workflow.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2025Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) - /workflows/{id}: - get: - operationId: getWorkflow - tags: - - Workflows - summary: Get Workflow By Id - description: Get a single workflow by id. - security: - - userAuth: - - sp:workflow:read - parameters: - - name: id - in: path - description: Id of the workflow - required: true - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - responses: - '200': - description: The workflow object - content: - application/json: - schema: - $ref: '#/paths/~1workflows/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/Workflow.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) - put: - operationId: putWorkflow - tags: - - Workflows - summary: Update Workflow - description: Perform a full update of a workflow. The updated workflow object is returned in the response. - security: - - userAuth: - - sp:workflow:manage - parameters: - - name: id - in: path - description: Id of the Workflow - required: true - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1workflows/post/requestBody/content/application~1json/schema/allOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowBody.yaml - responses: - '200': - description: The Workflow object - content: - application/json: - schema: - $ref: '#/paths/~1workflows/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/Workflow.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2025Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2025Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.v2025.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) - patch: - operationId: patchWorkflow - tags: - - Workflows - summary: Patch Workflow - description: Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - security: - - userAuth: - - sp:workflow:manage - parameters: - - name: id - in: path - description: Id of the Workflow - required: true - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - requestBody: - required: true - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - examples: - Update all patchable fields: - description: Demonstrate how to update each patchable field in one PATCH request. - value: - - op: replace - path: /name - value: Send Email - - op: replace - path: /owner - value: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - name: William Wilson - - op: replace - path: /description - value: Send an email to the identity who's attributes changed. - - op: replace - path: /enabled - value: false - - op: replace - path: /definition - value: - start: Send Email Test - steps: - Send Email: - actionId: sp:send-email - attributes: - body: This is a test - from: sailpoint@sailpoint.com - recipientId.$: $.identity.id - subject: test - nextStep: success - selectResult: null - type: action - success: - type: success - - op: replace - path: /trigger - value: - type: EVENT - attributes: - id: idn:identity-attributes-changed - responses: - '200': - description: The Workflow object - content: - application/json: - schema: - $ref: '#/paths/~1workflows/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/Workflow.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) - delete: - operationId: deleteWorkflow - tags: - - Workflows - summary: Delete Workflow By Id - description: Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - security: - - userAuth: - - sp:workflow:manage - parameters: - - name: id - in: path - description: Id of the Workflow - required: true - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) - /workflows/{id}/test: - post: - operationId: testWorkflow - tags: - - Workflows - summary: Test Workflow By Id - description: |- - Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. - This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. - **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - security: - - userAuth: - - sp:workflow-execute:external - parameters: - - name: id - in: path - description: Id of the workflow - required: true - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - input - properties: - input: - type: object - description: The test input for the workflow. - examples: - Identity Attributes Changed: - description: Identity Attributes Changed Trigger Input - value: - input: - identity: - id: ee769173319b41d19ccec6cea52f237b - name: john.doe - type: IDENTITY - changes: - - attribute: department - oldValue: sales - newValue: marketing - - attribute: manager - oldValue: - id: ee769173319b41d19ccec6c235423237b - name: nice.guy - type: IDENTITY - newValue: - id: ee769173319b41d19ccec6c235423236c - name: mean.guy - type: IDENTITY - - attribute: email - oldValue: john.doe@hotmail.com - newValue: john.doe@gmail.com - responses: - '200': - description: The Workflow object - content: - application/json: - schema: - type: object - properties: - workflowExecutionId: - type: string - description: The workflow execution id - example: 0e11cefa-96e7-4b67-90d0-065bc1da5753 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - /workflows/{id}/executions: - get: - operationId: getWorkflowExecutions - tags: - - Workflows - summary: List Workflow Executions - description: |- - Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: - 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. - 2. Get your workflow ID from the response. - 3. You can then do either of the following: - - - Filter to find relevant workflow executions. - For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` - - - Paginate through results with the `offset` parameter. - For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. - Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - security: - - userAuth: - - sp:workflow:read - parameters: - - name: id - in: path - description: Workflow ID. - required: true - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **start_time**: *eq, lt, le, gt, ge* - - **status**: *eq* - example: status eq "Failed" - required: false - responses: - '200': - description: List of workflow executions for the specified workflow. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Workflow execution ID. - example: b393f4e2-4785-4d7f-ab27-3a6b8ded4c81 - workflowId: - type: string - description: Workflow ID. - example: d201c5d9-d37b-4a2f-af14-66414f39d568 - requestId: - type: string - description: Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. - example: 41e12a74fa7b4a6a98ae47887b64acdb - startTime: - type: string - format: date-time - description: Date/time when the workflow started. - example: '2022-02-07T20:13:29.356648026Z' - closeTime: - type: string - format: date-time - description: Date/time when the workflow ended. - example: '2022-02-07T20:13:31.682410165Z' - status: - description: Workflow execution status. - type: string - enum: - - Completed - - Failed - - Canceled - - Running - example: Completed - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2025WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - /workflow-executions/{id}: - get: - operationId: getWorkflowExecution - tags: - - Workflows - summary: Get Workflow Execution - description: Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. - security: - - userAuth: - - sp:workflow:read - parameters: - - name: id - in: path - description: Workflow execution ID. - required: true - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - responses: - '200': - description: Workflow execution. - content: - application/json: - schema: - items: - $ref: '#/paths/~1workflows~1%7Bid%7D~1executions/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowExecution.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) - /workflow-executions/{id}/history: - get: - operationId: getWorkflowExecutionHistory - tags: - - Workflows - summary: Get Workflow Execution History - description: Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - security: - - userAuth: - - sp:workflow:read - parameters: - - name: id - in: path - description: Id of the workflow execution - required: true - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - responses: - '200': - description: List of workflow execution events for the given workflow execution - content: - application/json: - schema: - type: array - items: - type: object - properties: - type: - type: string - description: The type of event - enum: - - WorkflowExecutionScheduled - - WorkflowExecutionStarted - - WorkflowExecutionCompleted - - WorkflowExecutionFailed - - WorkflowTaskScheduled - - WorkflowTaskStarted - - WorkflowTaskCompleted - - WorkflowTaskFailed - - ActivityTaskScheduled - - ActivityTaskStarted - - ActivityTaskCompleted - - ActivityTaskFailed - - StartChildWorkflowExecutionInitiated - - ChildWorkflowExecutionStarted - - ChildWorkflowExecutionCompleted - - ChildWorkflowExecutionFailed - example: WorkflowTaskScheduled - timestamp: - type: string - format: date-time - description: The date-time when the event occurred - example: '2022-02-07T20:13:31.640618296Z' - attributes: - type: object - description: Additional attributes associated with the event - example: {} - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2025WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - /workflow-executions/{id}/cancel: - post: - operationId: cancelWorkflowExecution - tags: - - Workflows - summary: Cancel Workflow Execution by ID - description: Use this API to cancel a running workflow execution. - security: - - userAuth: - - sp:workflow-execute:external - parameters: - - name: id - in: path - description: The workflow execution ID - required: true - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) - /workflow-library: - get: - operationId: listCompleteWorkflowLibrary - tags: - - Workflows - summary: List Complete Workflow Library - description: This lists all triggers, actions, and operators in the library - externalDocs: - description: Additional documentation for workflows - url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - security: - - userAuth: - - sp:workflow:read - responses: - '200': - description: List of workflow steps - content: - application/json: - schema: - type: array - items: - anyOf: - - title: Workflow Action - type: object - properties: - id: - type: string - description: Action ID. This is a static namespaced ID for the action - example: sp:create-campaign - name: - type: string - description: Action Name - example: Create Certification Campaign - type: - type: string - description: Action type - example: ACTION - description: - type: string - description: Action Description - example: Generates a certification campaign. - formFields: - nullable: true - type: array - description: One or more inputs that the action accepts - items: - type: object - properties: - description: - type: string - description: Description of the form field - example: First value to compare - helpText: - type: string - description: Describes the form field in the UI - example: The name to give to this certification campaign. - label: - type: string - description: A human readable name for this form field in the UI - example: Campaign Name - name: - type: string - description: The name of the input attribute - example: name - required: - type: boolean - description: Denotes if this field is a required attribute - example: false - default: false - type: - description: The type of the form field - type: string - nullable: true - enum: - - text - - textarea - - boolean - - email - - url - - number - - json - - checkbox - - jsonpath - - select - - multiType - - duration - - toggle - - formPicker - - identityPicker - - governanceGroupPicker - - string - - object - - array - - secret - - keyValuePairs - - emailPicker - - advancedToggle - - variableCreator - - htmlEditor - example: text - exampleOutput: - oneOf: - - type: object - description: Example output - - type: array - items: - type: object - deprecated: - type: boolean - deprecatedBy: - type: string - format: date-time - versionNumber: - type: integer - description: Version number - isSimulationEnabled: - type: boolean - isDynamicSchema: - type: boolean - description: Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - example: false - default: false - outputSchema: - type: object - description: Defines the output schema, if any, that this action produces. - example: - definitions: {} - properties: - autoRevokeAllowed: - $id: '#sp:create-campaign/autoRevokeAllowed' - default: true - examples: - - false - title: autoRevokeAllowed - type: boolean - deadline: - $id: '#sp:create-campaign/deadline' - default: '' - examples: - - '2020-12-25T06:00:00.468Z' - format: date-time - pattern: ^.*$ - title: deadline - type: string - description: - $id: '#sp:create-campaign/description' - default: '' - examples: - - A review of everyone's access by their manager. - pattern: ^.*$ - title: description - type: string - emailNotificationEnabled: - $id: '#sp:create-campaign/emailNotificationEnabled' - default: true - examples: - - false - title: emailNotificationEnabled - type: boolean - filter: - $id: '#sp:create-campaign/filter' - properties: - id: - $id: '#sp:create-campaign/filter/id' - default: '' - examples: - - e0adaae69852e8fe8b8a3d48e5ce757c - pattern: ^.*$ - title: id - type: string - type: - $id: '#sp:create-campaign/filter/type' - default: '' - examples: - - CAMPAIGN_FILTER - pattern: ^.*$ - title: type - type: string - title: filter - type: object - id: - $id: '#sp:create-campaign/id' - default: '' - examples: - - 2c918086719eec070171a7e3355a360a - pattern: ^.*$ - title: id - type: string - name: - $id: '#sp:create-campaign/name' - default: '' - examples: - - Manager Review - pattern: ^.*$ - title: name - type: string - recommendationsEnabled: - $id: '#sp:create-campaign/recommendationsEnabled' - default: true - examples: - - false - title: recommendationEnabled - type: boolean - type: - $id: '#sp:create-campaign/type' - default: '' - examples: - - MANAGER - pattern: ^.*$ - title: type - type: string - title: sp:create-campaign - type: object - - title: Workflow Trigger - type: object - properties: - id: - type: string - description: Trigger ID. This is a static namespaced ID for the trigger. - example: idn:identity-attributes-changed - type: - description: Trigger type - type: string - enum: - - EVENT - - SCHEDULED - - EXTERNAL - example: EVENT - deprecated: - type: boolean - deprecatedBy: - type: string - format: date-time - isSimulationEnabled: - type: boolean - outputSchema: - type: object - description: Example output schema - name: - type: string - description: Trigger Name - example: Identity Attributes Changed - description: - type: string - description: Trigger Description - example: One or more identity attributes changed. - isDynamicSchema: - type: boolean - description: Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - example: false - default: false - inputExample: - type: object - description: Example trigger payload if applicable - nullable: true - externalDocs: - description: List of triggers and their input schemas - url: https://developer.sailpoint.com/idn/docs/event-triggers/available - example: - changes: - - attribute: department - newValue: marketing - oldValue: sales - - attribute: manager - newValue: - id: ee769173319b41d19ccec6c235423236c - name: mean.guy - type: IDENTITY - oldValue: - id: ee769173319b41d19ccec6c235423237b - name: nice.guy - type: IDENTITY - - attribute: email - newValue: john.doe@gmail.com - oldValue: john.doe@hotmail.com - identity: - id: ee769173319b41d19ccec6cea52f237b - name: john.doe - type: IDENTITY - formFields: - type: array - nullable: true - description: One or more inputs that the trigger accepts - example: [] - items: - $ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/0/properties/formFields/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowLibraryFormFields.yaml - - title: Workflow Operator - type: object - properties: - id: - type: string - description: Operator ID. - example: sp:compare-boolean - name: - type: string - description: Operator friendly name - example: Compare Boolean Values - type: - description: Operator type - type: string - example: OPERATOR - description: - type: string - description: Description of the operator - example: Compare two boolean values and decide what happens based on the result. - isDynamicSchema: - type: boolean - description: Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - example: false - deprecated: - type: boolean - deprecatedBy: - type: string - format: date-time - isSimulationEnabled: - type: boolean - formFields: - type: array - nullable: true - description: One or more inputs that the operator accepts - items: - $ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/0/properties/formFields/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowLibraryFormFields.yaml - example: - - description: Enter the JSONPath to a value from the input to compare to Variable B. - helpText: '' - label: Variable A - name: variableA.$ - required: true - type: text - - helpText: Select an operation. - label: Operation - name: operator - options: - - label: Equals - value: BooleanEquals - required: true - type: select - - description: Enter the JSONPath to a value from the input to compare to Variable A. - helpText: '' - label: Variable B - name: variableB.$ - required: false - type: text - - description: Enter True or False. - helpText: '' - label: Variable B - name: variableB - required: false - type: text - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-V2025CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - /workflow-library/actions: - get: - operationId: listWorkflowLibraryActions - tags: - - Workflows - summary: List Workflow Library Actions - description: This lists the workflow actions available to you. - externalDocs: - description: Additional documentation for each action - url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#actions - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - in: query - name: filters - required: false - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq* - example: id eq "sp:create-campaign" - security: - - userAuth: - - sp:workflow:read - responses: - '200': - description: List of workflow actions - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowLibraryAction.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-V2025WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - /workflow-library/triggers: - get: - operationId: listWorkflowLibraryTriggers - tags: - - Workflows - summary: List Workflow Library Triggers - description: This lists the workflow triggers available to you - externalDocs: - description: Additional documentation for each trigger - url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#triggers - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - in: query - name: filters - required: false - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq* - example: id eq "idn:identity-attributes-changed" - security: - - userAuth: - - sp:workflow:read - responses: - '200': - description: List of workflow triggers - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowLibraryTrigger.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-V2025WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - /workflow-library/operators: - get: - operationId: listWorkflowLibraryOperators - tags: - - Workflows - summary: List Workflow Library Operators - description: This lists the workflow operators available to you - security: - - userAuth: - - sp:workflow:read - responses: - '200': - description: List of workflow operators - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowLibraryOperator.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2025WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - /workflows/{id}/external/oauth-clients: - post: - operationId: createWorkflowExternalTrigger - tags: - - Workflows - summary: Generate External Trigger OAuth Client - description: Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - security: - - userAuth: - - sp:workflow:manage - parameters: - - name: id - in: path - description: Id of the workflow - required: true - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - responses: - '200': - description: The OAuth Client object - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: OAuth client ID for the trigger. This is a UUID generated upon creation. - example: 1a58c03a6bf64dc2876f6988c6e2c7b7 - secret: - type: string - description: OAuthClient secret. - example: 00cc24a7fe810fe06a7cb38bc168ae104d703c7abb296f9944dc68e69ddb578b - url: - type: string - description: URL for the external trigger to invoke - example: https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2025WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) - /workflows/execute/external/{id}: - post: - operationId: createExternalExecuteWorkflow - tags: - - Workflows - summary: Execute Workflow via External Trigger - description: This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - security: - - userAuth: - - sp:workflow-execute:external - parameters: - - name: id - in: path - description: Id of the workflow - required: true - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - input: - type: object - description: The input for the workflow - example: - customAttribute1: value1 - customAttribute2: value2 - responses: - '200': - description: The Workflow object - content: - application/json: - schema: - type: object - properties: - workflowExecutionId: - type: string - description: The workflow execution id - example: 0e11cefa-96e7-4b67-90d0-065bc1da5753 - message: - type: string - description: An error message if any errors occurred - example: Workflow was not executed externally. Check enabled flag on workflow definition - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) - /workflows/execute/external/{id}/test: - post: - operationId: testExternalExecuteWorkflow - tags: - - Workflows - summary: Test Workflow via External Trigger - description: Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - security: - - userAuth: - - sp:workflow-execute:external - parameters: - - name: id - in: path - description: Id of the workflow - required: true - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - input: - type: object - description: The test input for the workflow - example: - test: hello world - responses: - '200': - description: Responds with the test input - content: - application/json: - schema: - type: object - properties: - payload: - type: object - description: The input that was received - example: - test: hello world - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) - /source-usages/{sourceId}/status: - get: - tags: - - Source Usages - summary: Finds status of source usage - description: This API returns the status of the source usage insights setup by IDN source ID. - operationId: getStatusBySourceId - parameters: - - name: sourceId - in: path - description: ID of IDN source - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - example: 2c9180835d191a86015d28455b4a2329 - security: - - userAuth: - - idn:accounts:read - responses: - '200': - description: Status of the source usage insights setup by IDN source ID. - content: - application/json: - schema: - type: object - properties: - status: - type: string - description: |- - Source Usage Status. Acceptable values are: - - COMPLETE - - This status means that an activity data source has been setup and usage insights are available for the source. - - INCOMPLETE - - This status means that an activity data source has not been setup and usage insights are not available for the source. - example: COMPLETE - enum: - - COMPLETE - - INCOMPLETE - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-V2025StatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025StatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) - /source-usages/{sourceId}/summaries: - get: - tags: - - Source Usages - summary: Returns source usage insights - description: This API returns a summary of source usage insights for past 12 months. - operationId: getUsagesBySourceId - parameters: - - name: sourceId - in: path - description: ID of IDN source - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - example: 2c9180835d191a86015d28455b4a2329 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **date** - example: '-date' - security: - - userAuth: - - idn:accounts:read - responses: - '200': - description: Summary of source usage insights for past 12 months. - content: - application/json: - schema: - type: array - items: - type: object - properties: - date: - type: string - format: date - description: The first day of the month for which activity is aggregated. - example: '2023-04-21' - count: - type: number - format: float - description: The average number of days that accounts were active within this source, for the month. - example: 10.45 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-V2025UsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - /account-usages/{accountId}/summaries: - get: - tags: - - Account Usages - summary: Returns account usage insights - description: This API returns a summary of account usage insights for past 12 months. - operationId: getUsagesByAccountId - parameters: - - name: accountId - in: path - description: ID of IDN account - required: true - x-sailpoint-resource-operation-id: listAccounts - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **date** - example: '-date' - security: - - userAuth: - - idn:accounts:read - responses: - '200': - description: Summary of account usage insights for past 12 months. - content: - application/json: - schema: - type: array - items: - type: object - properties: - date: - type: string - format: date - description: The first day of the month for which activity is aggregated. - example: '2023-04-21' - count: - type: integer - format: int64 - description: The number of days within the month that the account was active in a source. - example: 10 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2025UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2025.api.account_usages_api import AccountUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - /identity-profiles/identity-preview: - post: - operationId: generateIdentityPreview - tags: - - Identity Profiles - summary: Generate Identity Profile Preview - description: This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied. - requestBody: - description: Identity Preview request body. - required: true - content: - application/json: - schema: - type: object - properties: - identityId: - type: string - format: uuid - example: 2c9180857893f12901789445619b0366 - description: The Identity id - identityAttributeConfig: - $ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityAttributeConfig' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityAttributeConfig.yaml - responses: - '200': - description: Object representing the preview object with all of the identity attributes using the current mappings. - content: - application/json: - schema: - type: object - properties: - identity: - type: object - description: Identity's basic details. - properties: - type: - type: string - description: Identity's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Identity's display name. - example: Michael Michaels - previewAttributes: - type: array - items: - type: object - properties: - name: - type: string - description: Name of the attribute that is being previewed. - example: email - value: - type: string - description: Value that was derived during the preview. - example: email@mail.com - previousValue: - type: string - description: The value of the attribute before the preview. - example: oldEmail@mail.com - errorMessages: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/errorMessages/items' - description: A list of errors that may have been encountered. - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorMessageDtoList.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#generate-identity-preview - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityPreviewRequest = @" - { - "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - } - } - "@ - - # Generate Identity Profile Preview - - try { - $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityPreview" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-profiles#generate-identity-preview - source: | - from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_preview_request import IdentityPreviewRequest - from sailpoint.v2025.models.identity_preview_response import IdentityPreviewResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_preview_request = '''{ - "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - } - }''' # IdentityPreviewRequest | Identity Preview request body. - try: - # Generate Identity Profile Preview - new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request) - results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental=x_sail_point_experimental, identity_preview_request=new_identity_preview_request) - # Below is a request that includes all optional parameters - # results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental, new_identity_preview_request) - print("The response of IdentityProfilesApi->generate_identity_preview:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityProfilesApi->generate_identity_preview: %s\n" % e) - /work-items/{id}/forward: - post: - operationId: forwardWorkItem - tags: - - Work Items - summary: Forward a Work Item - description: This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listWorkItems - description: The ID of the work item - example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - targetOwnerId - - comment - properties: - targetOwnerId: - type: string - description: The ID of the identity to forward this work item to. - example: 2c9180835d2e5168015d32f890ca1581 - comment: - type: string - description: Comments to send to the target owner - example: I'm going on vacation. - sendNotifications: - type: boolean - description: If true, send a notification to the target owner. - default: true - example: true - responses: - '200': - description: Success, but no data is returned. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#forward-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ - - # Forward a Work Item - - try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-V2025ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ForwardWorkItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#forward-work-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_item_forward import WorkItemForward - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - work_item_forward = '''{ - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - }''' # WorkItemForward | - try: - # Forward a Work Item - new_work_item_forward = WorkItemForward.from_json(work_item_forward) - WorkItemsApi(api_client).forward_work_item(id=id, x_sail_point_experimental=x_sail_point_experimental, work_item_forward=new_work_item_forward) - # Below is a request that includes all optional parameters - # WorkItemsApi(api_client).forward_work_item(id, x_sail_point_experimental, new_work_item_forward) - except Exception as e: - print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) - /accounts/search-attribute-config: - post: - operationId: createSearchAttributeConfig - tags: - - Search Attribute Configuration - summary: Create Extended Search Attributes - security: - - userAuth: - - idn:account-config:create - x-sailpoint-userLevels: - - ORG_ADMIN - description: |- - Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. - >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: Name of the new attribute - example: newMailAttribute - displayName: - type: string - description: The display name of the new attribute - example: New Mail Attribute - applicationAttributes: - type: object - description: Map of application id and their associated attribute. - example: - 2c91808b79fd2422017a0b35d30f3968: employeeNumber - 2c91808b79fd2422017a0b36008f396b: employeeNumber - example: - name: newMailAttribute - displayName: New Mail Attribute - applicationAttributes: - 2c9180866166b5b0016167c32ef31a66: mail - 2c9180866166b5b0016167c32ef31a67: mail - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#create-search-attribute-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ - - # Create Extended Search Attributes - - try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SearchAttributeConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#create-search-attribute-config - source: | - from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - search_attribute_config = '''{ - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - }''' # SearchAttributeConfig | - try: - # Create Extended Search Attributes - new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) - results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental=x_sail_point_experimental, search_attribute_config=new_search_attribute_config) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental, new_search_attribute_config) - print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) - get: - operationId: getSearchAttributeConfig - tags: - - Search Attribute Configuration - summary: List Extended Search Attributes - security: - - userAuth: - - idn:account-config:read - x-sailpoint-userLevels: - - ORG_ADMIN - description: Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of attribute configurations in ISC. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1accounts~1search-attribute-config/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SearchAttributeConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#get-search-attribute-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Extended Search Attributes - - try { - Get-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SearchAttributeConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#get-search-attribute-config - source: | - from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Extended Search Attributes - - results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental, limit, offset) - print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - /accounts/search-attribute-config/{name}: - get: - operationId: getSingleSearchAttributeConfig - tags: - - Search Attribute Configuration - summary: Get Extended Search Attribute - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: Get an extended attribute configuration by name. - parameters: - - name: name - in: path - description: Name of the extended search attribute configuration to get. - required: true - schema: - type: string - example: newMailAttribute - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Specific attribute configuration in IdentityNow. - content: - application/json: - schema: - $ref: '#/paths/~1accounts~1search-attribute-config/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SearchAttributeConfig.yaml - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Extended Search Attribute - - try { - Get-V2025SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SingleSearchAttributeConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Extended Search Attribute - - results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name, x_sail_point_experimental) - print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) - delete: - operationId: deleteSearchAttributeConfig - tags: - - Search Attribute Configuration - summary: Delete Extended Search Attribute - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: Delete an extended attribute configuration by name. - parameters: - - name: name - in: path - description: Name of the extended search attribute configuration to delete. - required: true - schema: - type: string - example: newMailAttribute - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#delete-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Extended Search Attribute - - try { - Remove-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SearchAttributeConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#delete-search-attribute-config - source: | - from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete Extended Search Attribute - - SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) - patch: - operationId: patchSearchAttributeConfig - tags: - - Search Attribute Configuration - summary: Update Extended Search Attribute - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: |- - Update an existing search attribute configuration. - You can patch these fields: - * name * displayName * applicationAttributes - parameters: - - name: name - in: path - description: Name of the search attribute configuration to patch. - required: true - schema: - type: string - example: promotedMailAttribute - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /name - value: newAttributeName - - op: replace - path: /displayName - value: new attribute display name - - op: add - path: /applicationAttributes - value: - 2c91808b79fd2422017a0b35d30f3968: employeeNumber - required: true - responses: - '200': - description: Responds with the search attribute configuration as updated. - content: - application/json: - schema: - $ref: '#/paths/~1accounts~1search-attribute-config/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SearchAttributeConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#patch-search-attribute-config - source: | - $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Extended Search Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SearchAttributeConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#patch-search-attribute-config - source: | - from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | - try: - # Update Extended Search Attribute - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, x_sail_point_experimental, new_json_patch_operation) - print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) - /access-model-metadata/attributes: - get: - summary: List Access Model Metadata Attributes - description: Get a list of Access Model Metadata Attributes - tags: - - Access Model Metadata - operationId: listAccessModelMetadataAttribute - security: - - userAuth: - - idn:access-model-metadata:read - parameters: - - in: query - name: filters - schema: - type: string - example: name eq "Privacy" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **name**: *eq* - - **type**: *eq* - - **status**: *eq* - - **objectTypes**: *eq* - - Supported composite operators: *and* - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: OK - content: - application/json: - schema: - type: array - items: - type: object - properties: - key: - type: string - description: Technical name of the Attribute. This is unique and cannot be changed after creation. - example: iscPrivacy - name: - type: string - description: The display name of the key. - example: Privacy - multiselect: - type: boolean - default: false - description: Indicates whether the attribute can have multiple values. - example: false - status: - type: string - description: The status of the Attribute. - example: active - type: - type: string - description: The type of the Attribute. This can be either "custom" or "governance". - example: governance - objectTypes: - type: array - items: - type: string - nullable: true - description: An array of object types this attributes values can be applied to. Possible values are "all" or "entitlement". Value "all" means this attribute can be used with all object types that are supported. - example: - - entitlement - description: - type: string - description: The description of the Attribute. - example: Specifies the level of privacy associated with an access item. - values: - type: array - nullable: true - items: - $ref: '#/paths/~1access-model-metadata~1attributes~1%7Bkey%7D~1values/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/gov-attributes/AttributeValueDTO.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) - - # List Access Model Metadata Attributes - - try { - Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-model-metadata#list-access-model-metadata-attribute - source: | - from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.attribute_dto import AttributeDTO - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'name eq \"Privacy\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) - try: - # List Access Model Metadata Attributes - - results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters) - print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) - /access-model-metadata/attributes/{key}: - get: - summary: Get Access Model Metadata Attribute - description: Get single Access Model Metadata Attribute - tags: - - Access Model Metadata - operationId: getAccessModelMetadataAttribute - security: - - userAuth: - - idn:access-model-metadata:read - parameters: - - name: key - in: path - required: true - x-sailpoint-resource-operation-id: listAccessModelMetadataAttribute - schema: - type: string - description: Technical name of the Attribute. - example: iscPrivacy - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/paths/~1access-model-metadata~1attributes/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/gov-attributes/AttributeDTO.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#get-access-model-metadata-attribute - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Model Metadata Attribute - - try { - Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-model-metadata#get-access-model-metadata-attribute - source: | - from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.attribute_dto import AttributeDTO - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Access Model Metadata Attribute - - results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key=key, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key, x_sail_point_experimental) - print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) - /access-model-metadata/attributes/{key}/values: - get: - summary: List Access Model Metadata Values - description: Get a list of Access Model Metadata Attribute Values - tags: - - Access Model Metadata - operationId: listAccessModelMetadataAttributeValue - security: - - userAuth: - - idn:access-model-metadata:read - parameters: - - name: key - in: path - required: true - x-sailpoint-resource-operation-id: listAccessModelMetadataAttribute - schema: - type: string - description: Technical name of the Attribute. - example: iscPrivacy - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: OK - content: - application/json: - schema: - type: array - items: - type: object - properties: - value: - type: string - description: Technical name of the Attribute value. This is unique and cannot be changed after creation. - example: public - name: - type: string - description: The display name of the Attribute value. - example: Public - status: - type: string - description: The status of the Attribute value. - example: active - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute-value - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Access Model Metadata Values - - try { - Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-model-metadata#list-access-model-metadata-attribute-value - source: | - from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.attribute_value_dto import AttributeValueDTO - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List Access Model Metadata Values - - results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental) - print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) - /access-model-metadata/attributes/{key}/values/{value}: - get: - summary: Get Access Model Metadata Value - description: Get single Access Model Metadata Attribute Value - tags: - - Access Model Metadata - operationId: getAccessModelMetadataAttributeValue - security: - - userAuth: - - idn:access-model-metadata:read - parameters: - - name: key - in: path - required: true - x-sailpoint-resource-operation-id: listAccessModelMetadataAttribute - schema: - type: string - description: Technical name of the Attribute. - example: iscPrivacy - - name: value - in: path - required: true - x-sailpoint-resource-operation-id: listAccessModelMetadataAttributeValue - schema: - type: string - description: Technical name of the Attribute value. - example: public - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/paths/~1access-model-metadata~1attributes~1%7Bkey%7D~1values/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/gov-attributes/AttributeValueDTO.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#get-access-model-metadata-attribute-value - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $Value = "public" # String | Technical name of the Attribute value. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Model Metadata Value - - try { - Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-model-metadata#get-access-model-metadata-attribute-value - source: | - from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.attribute_value_dto import AttributeValueDTO - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - value = 'public' # str | Technical name of the Attribute value. # str | Technical name of the Attribute value. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Access Model Metadata Value - - results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key=key, value=value, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental) - print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) - /access-profiles/bulk-update-requestable: - post: - operationId: updateAccessProfilesInBulk - summary: Update Access Profile(s) requestable field. - tags: - - Access Profiles - description: |- - This API initiates a bulk update of field requestable for one or more Access Profiles. - - > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** - list of the response.Requestable field of these Access Profiles marked as **true** or **false**. - - > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. - A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - requestBody: - required: true - content: - application/json: - schema: - description: List of Access profiles to be updated. - type: array - items: - type: object - description: Access Profile's basic details. - properties: - id: - type: string - description: Access Profile ID. - example: 464ae7bf-791e-49fd-b746-06a2e4a8 - requestable: - type: boolean - description: Access Profile is requestable or not. - example: false - example: - - id: 464ae7bf-791e-49fd-b746-06a2e4a8 - requestable: false - required: - - id - - requestable - example: - - id: 464ae7bf-791e-49fd-b746-06a2e4a89635 - requestable: false - responses: - '207': - description: List of updated and not updated Access Profiles. - content: - application/json: - schema: - description: Access Profile Bulk update response. - type: array - items: - type: object - properties: - id: - description: Identifier of Access Profile in bulk update request. - type: string - example: 2c7180a46faadee4016fb4e018c20642 - requestable: - description: Access Profile requestable or not. - type: boolean - example: false - status: - description: | - - The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. - - > 201 - Access profile is updated successfully. - - > 404 - Access profile not found. - type: string - example: '201' - description: - description: | - Human readable status description and containing additional context information about success or failures etc. - type: string - example: | - - > Access profile is updated successfully. - - > Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found. - required: - - id - - requestable - - status - example: - - id: 464ae7bf-791e-49fd-b746-06a2e4a8 - status: '201' - requestable: false - description: Access Profile updated successfully. - example: - - id: 464ae7bf-791e-49fd-b746-06a2e4a89635 - status: '201' - requestable: false - description: Access Profile updated successfully. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '412': - description: Precondition Failed - Returned in response if API/Feature not enabled for an organization. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' API/Feature not enabled for your organization.' - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:access-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#update-access-profiles-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ - - - # Update Access Profile(s) requestable field. - - try { - $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner - Update-V2025AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AccessProfilesInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-profiles#update-access-profiles-in-bulk - source: | - from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile_bulk_update_request_inner import AccessProfileBulkUpdateRequestInner - from sailpoint.v2025.models.access_profile_update_item import AccessProfileUpdateItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_profile_bulk_update_request_inner = '''[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]''' # List[AccessProfileBulkUpdateRequestInner] | - try: - # Update Access Profile(s) requestable field. - new_access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner.from_json(access_profile_bulk_update_request_inner) - results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental=x_sail_point_experimental, access_profile_bulk_update_request_inner=new_access_profile_bulk_update_request_inner) - # Below is a request that includes all optional parameters - # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner) - print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) - /access-requests/close: - post: - operationId: closeAccessRequest - tags: - - Access Requests - summary: Close Access Request - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: | - This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). - - To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. - - To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). - - Input the IDs from either source. - - To track the status of endpoint requests, navigate to Search and use this query: name:"Close Identity Requests". Search will include "Close Identity Requests Started" audits when requests are initiated and "Close Identity Requests Completed" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. - - This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - requestBody: - required: true - content: - application/json: - schema: - type: object - description: Request body payload for close access requests endpoint. - required: - - accessRequestIds - properties: - accessRequestIds: - type: array - description: Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. - items: - type: string - example: - - 2c90ad2a70ace7d50170acf22ca90010 - message: - type: string - description: Reason for closing the access request. Displayed under Warnings in IdentityNow. - default: The IdentityNow Administrator manually closed this request. - example: The IdentityNow Administrator manually closed this request. - executionStatus: - type: string - enum: - - Terminated - - Completed - description: The request's provisioning status. Displayed as Stage in IdentityNow. - default: Terminated - example: Terminated - completionStatus: - type: string - enum: - - Success - - Incomplete - - Failure - description: The request's overall status. Displayed as Status in IdentityNow. - default: Failure - example: Failure - example: - accessRequestIds: - - 2c90ad2a70ace7d50170acf22ca90010 - executionStatus: Terminated - completionStatus: Failure - message: The IdentityNow Administrator manually closed this request. - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#close-access-request - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CloseAccessRequest = @" - { - "executionStatus" : "Terminated", - "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "completionStatus" : "Failure", - "message" : "The IdentityNow Administrator manually closed this request." - } - "@ - - # Close Access Request - - try { - $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest - Close-V2025AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result - - # Below is a request that includes all optional parameters - # Close-V2025AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2025AccessRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-requests#close-access-request - source: | - from sailpoint.v2025.api.access_requests_api import AccessRequestsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.close_access_request import CloseAccessRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - close_access_request = '''{ - "executionStatus" : "Terminated", - "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "completionStatus" : "Failure", - "message" : "The IdentityNow Administrator manually closed this request." - }''' # CloseAccessRequest | - try: - # Close Access Request - new_close_access_request = CloseAccessRequest.from_json(close_access_request) - results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental=x_sail_point_experimental, close_access_request=new_close_access_request) - # Below is a request that includes all optional parameters - # results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental, new_close_access_request) - print("The response of AccessRequestsApi->close_access_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) - /ai-access-request-recommendations: - get: - operationId: getAccessRequestRecommendations - tags: - - IAI Access Request Recommendations - security: - - userAuth: - - iai:access-request-recommender:read - x-sailpoint-userLevels: - - Any - summary: Identity Access Request Recommendations - description: This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - parameters: - - in: query - name: identity-id - description: Get access request recommendations for an identityId. *me* indicates the current user. - schema: - type: string - default: me - required: false - example: 2c91808570313110017040b06f344ec9 - - in: query - name: limit - description: Max number of results to return. - required: false - schema: - type: integer - format: int32 - minimum: 0 - maximum: 15 - default: 15 - example: 15 - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: include-translation-messages - description: If *true* it will populate a list of translation messages in the response. - schema: - type: boolean - default: false - required: false - example: false - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **access.name**: *co* - - **access.type**: *eq, in* - - **access.description**: *co, eq, in* - required: false - example: access.name co "admin" - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **access.name, access.type** - - By default the recommendations are sorted by highest confidence first. - required: false - example: access.name - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of access request recommendations for the identityId - content: - application/json: - schema: - type: array - items: - type: object - properties: - identityId: - type: string - format: UUID - description: Identity ID for the recommendation - example: 2c91808570313110017040b06f344ec9 - access: - type: object - properties: - id: - type: string - format: UUID - description: ID of access item being recommended. - example: 2c9180835d2e5168015d32f890ca1581 - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - description: The type of access item. - example: ACCESS_PROFILE - name: - type: string - description: Name of the access item - example: Employee-database-read-write - description: - type: string - description: Description of the access item - example: This item grants an employee read and write access to the database - ignored: - type: boolean - example: true - description: Whether or not the identity has already chosen to ignore this recommendation. - requested: - type: boolean - example: true - description: Whether or not the identity has already chosen to request this recommendation. - viewed: - type: boolean - example: true - description: Whether or not the identity reportedly viewed this recommendation. - messages: - type: array - items: - type: object - properties: - interpretation: - type: string - description: Information about why the access item was recommended. - example: 95% of your peers have this access. - translationMessages: - description: The list of translation messages - type: array - example: - - key: recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH - values: - - '75' - - department - items: - type: object - properties: - key: - type: string - description: The key of the translation message - example: recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH - values: - type: array - description: The values corresponding to the translation messages - items: - type: string - example: - - '75' - - department - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") - $Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) - $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) - - # Identity Access Request Recommendations - - try { - Get-V2025AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_item_detail import AccessRequestRecommendationItemDetail - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_id = 'me' # str | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to 'me') # str | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to 'me') - limit = 15 # int | Max number of results to return. (optional) (default to 15) # int | Max number of results to return. (optional) (default to 15) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - include_translation_messages = False # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to False) # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to False) - filters = 'access.name co \"admin\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) - try: - # Identity Access Request Recommendations - - results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) - /ai-access-request-recommendations/config: - get: - operationId: getAccessRequestRecommendationsConfig - tags: - - IAI Access Request Recommendations - security: - - userAuth: - - iai:configuration:read - x-sailpoint-userLevels: - - ORG_ADMIN - summary: Get Access Request Recommendations config - description: This API returns the configurations for Access Request Recommender for the tenant. - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Configurations for Access Request Recommender for the tenant. - content: - application/json: - schema: - type: object - properties: - scoreThreshold: - type: number - format: float - description: The value that internal calculations need to exceed for recommendations to be made. - example: 0.5 - startDateAttribute: - type: string - description: Use to map an attribute name for determining identities' start date. - example: startDate - restrictionAttribute: - type: string - description: Use to only give recommendations based on this attribute. - example: location - moverAttribute: - type: string - description: Use to map an attribute name for determining whether identities are movers. - example: isMover - joinerAttribute: - type: string - description: Use to map an attribute name for determining whether identities are joiners. - example: isJoiner - useRestrictionAttribute: - type: boolean - description: Use only the attribute named in restrictionAttribute to make recommendations. - example: true - default: false - required: - - scoreThreshold - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Request Recommendations config - - try { - Get-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-config - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Access Request Recommendations config - - results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_config(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_config(x_sail_point_experimental) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config: %s\n" % e) - put: - operationId: setAccessRequestRecommendationsConfig - tags: - - IAI Access Request Recommendations - security: - - userAuth: - - iai:configuration:update - x-sailpoint-userLevels: - - ORG_ADMIN - summary: Update Access Request Recommendations config - description: This API updates the configurations for Access Request Recommender for the tenant. - requestBody: - description: The desired configurations for Access Request Recommender for the tenant. - required: true - content: - application/json: - schema: - $ref: '#/paths/~1ai-access-request-recommendations~1config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationConfigDto.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Successfully updated configurations for Access Request Recommender for the tenant. - content: - application/json: - schema: - $ref: '#/paths/~1ai-access-request-recommendations~1config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationConfigDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#set-access-request-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationConfigDto = @" - { - "scoreThreshold" : 0.5, - "startDateAttribute" : "startDate", - "restrictionAttribute" : "location", - "moverAttribute" : "isMover", - "joinerAttribute" : "isJoiner", - "useRestrictionAttribute" : true - } - "@ - - # Update Access Request Recommendations config - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto - Set-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result - - # Below is a request that includes all optional parameters - # Set-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025AccessRequestRecommendationsConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#set-access-request-recommendations-config - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_request_recommendation_config_dto = '''{ - "scoreThreshold" : 0.5, - "startDateAttribute" : "startDate", - "restrictionAttribute" : "location", - "moverAttribute" : "isMover", - "joinerAttribute" : "isJoiner", - "useRestrictionAttribute" : true - }''' # AccessRequestRecommendationConfigDto | The desired configurations for Access Request Recommender for the tenant. - try: - # Update Access Request Recommendations config - new_access_request_recommendation_config_dto = AccessRequestRecommendationConfigDto.from_json(access_request_recommendation_config_dto) - results = IAIAccessRequestRecommendationsApi(api_client).set_access_request_recommendations_config(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_config_dto=new_access_request_recommendation_config_dto) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).set_access_request_recommendations_config(x_sail_point_experimental, new_access_request_recommendation_config_dto) - print("The response of IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config: %s\n" % e) - /ai-access-request-recommendations/ignored-items: - post: - operationId: addAccessRequestRecommendationsIgnoredItem - tags: - - IAI Access Request Recommendations - security: - - userAuth: - - iai:access-request-recommender:manage - x-sailpoint-userLevels: - - Any - summary: Ignore Access Request Recommendation - description: This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - requestBody: - description: The recommended access item to ignore for an identity. - required: true - content: - application/json: - schema: - type: object - properties: - identityId: - type: string - format: UUID - description: The identity ID taking the action. - example: 2c91808570313110017040b06f344ec9 - access: - type: object - properties: - id: - type: string - format: UUID - description: ID of access item being recommended. - example: 2c9180835d2e5168015d32f890ca1581 - type: - $ref: '#/paths/~1ai-access-request-recommendations/get/responses/200/content/application~1json/schema/items/properties/access/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItemType.yaml - required: - - identityId - - access - responses: - '201': - description: Recommendation successfully stored as ignored. - content: - application/json: - schema: - type: object - properties: - identityId: - type: string - format: UUID - description: The identity ID taking the action. - example: 2c91808570313110017040b06f344ec9 - access: - $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/requestBody/content/application~1json/schema/properties/access' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItem.yaml - timestamp: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Ignore Access Request Recommendation - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2025AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2025AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsIgnoredItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_request_recommendation_action_item_dto = '''{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - }''' # AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. - try: - # Ignore Access Request Recommendation - new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) - results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) - get: - operationId: getAccessRequestRecommendationsIgnoredItems - tags: - - IAI Access Request Recommendations - security: - - userAuth: - - iai:access-request-recommender:manage - x-sailpoint-userLevels: - - Any - summary: List Ignored Access Request Recommendations - description: This API returns the list of ignored access request recommendations. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **access.id**: *eq, in* - - **access.type**: *eq, in* - - **identityId**: *eq, in* - required: false - example: identityId eq "2c9180846b0a0583016b299f210c1314" - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** - required: false - example: access.id - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Returns list of ignored access request recommendations. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Ignored Access Request Recommendations - - try { - Get-V2025AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsIgnoredItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'identityId eq \"2c9180846b0a0583016b299f210c1314\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - sorters = 'access.id' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - try: - # List Ignored Access Request Recommendations - - results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) - /ai-access-request-recommendations/requested-items: - post: - operationId: addAccessRequestRecommendationsRequestedItem - tags: - - IAI Access Request Recommendations - security: - - userAuth: - - iai:access-request-recommender:manage - x-sailpoint-userLevels: - - Any - summary: Accept Access Request Recommendation - description: This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - requestBody: - description: The recommended access item that was requested for an identity. - required: true - content: - application/json: - schema: - $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemDto.yaml - responses: - '201': - description: Notification successfully acknowledged. - content: - application/json: - schema: - $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Accept Access Request Recommendation - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2025AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2025AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsRequestedItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_request_recommendation_action_item_dto = '''{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - }''' # AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. - try: - # Accept Access Request Recommendation - new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) - results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) - get: - operationId: getAccessRequestRecommendationsRequestedItems - tags: - - IAI Access Request Recommendations - security: - - userAuth: - - iai:access-request-recommender:manage - x-sailpoint-userLevels: - - Any - summary: List Accepted Access Request Recommendations - description: This API returns a list of requested access request recommendations. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **access.id**: *eq, in* - - **access.type**: *eq, in* - - **identityId**: *eq, in* - required: false - example: access.id eq "2c9180846b0a0583016b299f210c1314" - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** - required: false - example: access.id - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Returns the list of requested access request recommendations. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Accepted Access Request Recommendations - - try { - Get-V2025AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsRequestedItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"2c9180846b0a0583016b299f210c1314\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - sorters = 'access.id' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - try: - # List Accepted Access Request Recommendations - - results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) - /ai-access-request-recommendations/viewed-items: - post: - operationId: addAccessRequestRecommendationsViewedItem - tags: - - IAI Access Request Recommendations - security: - - userAuth: - - iai:access-request-recommender:manage - x-sailpoint-userLevels: - - Any - summary: Mark Viewed Access Request Recommendations - description: This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - requestBody: - description: The recommended access that was viewed for an identity. - required: true - content: - application/json: - schema: - $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemDto.yaml - responses: - '201': - description: Recommendation successfully stored as viewed. - content: - application/json: - schema: - $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Mark Viewed Access Request Recommendations - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2025AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2025AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsViewedItem" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_request_recommendation_action_item_dto = '''{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - }''' # AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. - try: - # Mark Viewed Access Request Recommendations - new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) - results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) - get: - operationId: getAccessRequestRecommendationsViewedItems - tags: - - IAI Access Request Recommendations - security: - - userAuth: - - iai:access-request-recommender:read - x-sailpoint-userLevels: - - Any - summary: List Viewed Access Request Recommendations - description: This API returns the list of viewed access request recommendations. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **access.id**: *eq, in* - - **access.type**: *eq, in* - - **identityId**: *eq, in* - required: false - example: access.id eq "2c9180846b0a0583016b299f210c1314" - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** - required: false - example: access.id - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Returns list of viewed access request recommendations. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Viewed Access Request Recommendations - - try { - Get-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsViewedItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"2c9180846b0a0583016b299f210c1314\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - sorters = 'access.id' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - try: - # List Viewed Access Request Recommendations - - results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) - /ai-access-request-recommendations/viewed-items/bulk-create: - post: - operationId: addAccessRequestRecommendationsViewedItems - tags: - - IAI Access Request Recommendations - security: - - userAuth: - - iai:access-request-recommender:manage - x-sailpoint-userLevels: - - Any - summary: Bulk Mark Viewed Access Request Recommendations - description: This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - requestBody: - description: The recommended access items that were viewed for an identity. - required: true - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemDto.yaml - responses: - '201': - description: Recommendations successfully stored as viewed. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @"{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - }"@ - - - # Bulk Mark Viewed Access Request Recommendations - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsViewedItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items - source: | - from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto - from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_request_recommendation_action_item_dto = '''[sailpoint.v2025.AccessRequestRecommendationActionItemDto()]''' # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. - try: - # Bulk Mark Viewed Access Request Recommendations - new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) - results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) - # Below is a request that includes all optional parameters - # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) - /accounts/{id}/remove: - post: - operationId: deleteAccountAsync - summary: Remove Account - tags: - - Accounts - description: | - Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. - - This endpoint is good for: - * Removing accounts that no longer exist on the source. - * Removing accounts that won't be aggregated following updates to the source configuration. - * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listAccounts - description: The account id - example: c350d6aa4f104c61b062cb632421ad10 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '202': - description: Accepted. Returns task result details of removal request. - content: - application/json: - schema: - $ref: '#/paths/~1roles~1bulk-delete/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskResultDto.yaml - example: - type: TASK_RESULT - id: 464ae7bf791e49fdb74606a2e4a89635 - name: null - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:accounts:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#delete-account-async - source: | - $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Remove Account - - try { - Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccountAsync" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#delete-account-async - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_result_dto import TaskResultDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Remove Account - - results = AccountsApi(api_client).delete_account_async(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).delete_account_async(id, x_sail_point_experimental) - print("The response of AccountsApi->delete_account_async:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) - /identities-accounts/{id}/enable: - post: - operationId: enableAccountForIdentity - tags: - - Accounts - summary: Enable IDN Account for Identity - description: This API submits a task to enable IDN account for a single identity. - externalDocs: - description: Learn more about enabling identities here - url: https://documentation.sailpoint.com/saas/help/common/users/user_access.html#enabling-user-identities - security: - - userAuth: - - idn:accounts-state:manage - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentities - description: The identity id. - example: 2c91808384203c2d018437e631158309 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-account-for-identity - source: | - $Id = "2c91808384203c2d018437e631158309" # String | The identity id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Enable IDN Account for Identity - - try { - Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025AccountForIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#enable-account-for-identity - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Enable IDN Account for Identity - - results = AccountsApi(api_client).enable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).enable_account_for_identity(id, x_sail_point_experimental) - print("The response of AccountsApi->enable_account_for_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) - /identities-accounts/{id}/disable: - post: - operationId: disableAccountForIdentity - tags: - - Accounts - summary: Disable IDN Account for Identity - description: This API submits a task to disable IDN account for a single identity. - externalDocs: - description: Learn more about disabling identities here - url: https://documentation.sailpoint.com/saas/help/common/users/user_access.html#disabling-user-identities - security: - - userAuth: - - idn:accounts-state:manage - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentities - description: The identity id. - example: 2c91808384203c2d018437e631158309 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-account-for-identity - source: | - $Id = "2c91808384203c2d018437e631158309" # String | The identity id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Disable IDN Account for Identity - - try { - Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025AccountForIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#disable-account-for-identity - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Disable IDN Account for Identity - - results = AccountsApi(api_client).disable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).disable_account_for_identity(id, x_sail_point_experimental) - print("The response of AccountsApi->disable_account_for_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) - /identities-accounts/enable: - post: - operationId: enableAccountsForIdentities - tags: - - Accounts - summary: Enable IDN Accounts for Identities - description: This API submits tasks to enable IDN account for each identity provided in the request body. - externalDocs: - description: Learn more about enabling identities here - url: https://documentation.sailpoint.com/saas/help/common/users/user_access.html#enabling-user-identities - security: - - userAuth: - - idn:accounts-state:manage - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - identityIds: - description: The ids of the identities for which enable/disable accounts. - type: array - items: - type: string - example: - - 2c91808384203c2d018437e631158308 - - 2c9180858082150f0180893dbaf553fe - responses: - '207': - description: Bulk response details. - content: - application/json: - schema: - type: array - items: - type: object - description: Bulk response object. - properties: - id: - type: string - description: Identifier of bulk request item. - example: 2c9180858082150f0180893dbaf553fe - statusCode: - type: integer - format: int32 - description: Response status value. - example: 404 - message: - type: string - description: Status containing additional context information about failures. - example: Referenced identity "2c9180858082150f0180893dbaf553fe" was not found. - example: - - id: 2c9180858082150f0180893dbaf553fe - statusCode: 404 - message: Referenced identity "2c9180858082150f0180893dbaf553fe" was not found. - - id: 2c91808384203c2d018437e631158308 - statusCode: 202 - message: null - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-accounts-for-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentitiesAccountsBulkRequest = @" - { - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - } - "@ - - # Enable IDN Accounts for Identities - - try { - $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Enable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - - # Below is a request that includes all optional parameters - # Enable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025AccountsForIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#enable-accounts-for-identities - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse - from sailpoint.v2025.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identities_accounts_bulk_request = '''{ - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - }''' # IdentitiesAccountsBulkRequest | - try: - # Enable IDN Accounts for Identities - new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request) - results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) - print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) - /identities-accounts/disable: - post: - operationId: disableAccountsForIdentities - tags: - - Accounts - summary: Disable IDN Accounts for Identities - description: This API submits tasks to disable IDN account for each identity provided in the request body. - externalDocs: - description: Learn more about disabling identities here - url: https://documentation.sailpoint.com/saas/help/common/users/user_access.html#disabling-user-identities - security: - - userAuth: - - idn:accounts-state:manage - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1identities-accounts~1enable/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentitiesAccountsBulkRequest.yaml - responses: - '207': - description: Bulk response details. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1identities-accounts~1enable/post/responses/207/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BulkIdentitiesAccountsResponse.yaml - example: - - id: 2c9180858082150f0180893dbaf553fe - statusCode: 404 - message: Referenced identity "2c9180858082150f0180893dbaf553fe" was not found. - - id: 2c91808384203c2d018437e631158308 - statusCode: 202 - message: null - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-accounts-for-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentitiesAccountsBulkRequest = @" - { - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - } - "@ - - # Disable IDN Accounts for Identities - - try { - $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Disable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - - # Below is a request that includes all optional parameters - # Disable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025AccountsForIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/accounts#disable-accounts-for-identities - source: | - from sailpoint.v2025.api.accounts_api import AccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse - from sailpoint.v2025.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identities_accounts_bulk_request = '''{ - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - }''' # IdentitiesAccountsBulkRequest | - try: - # Disable IDN Accounts for Identities - new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request) - results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request) - # Below is a request that includes all optional parameters - # results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) - print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) - /account-aggregations/{id}/status: - get: - operationId: getAccountAggregationStatus - tags: - - Account Aggregations - summary: In-progress Account Aggregation status - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - description: |- - This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. - - Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. - - Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. - - *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* - required to call this API. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getTaskStatusList - description: The account aggregation id - example: 2c91808477a6b0c60177a81146b8110b - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: An account aggregation status object - content: - application/json: - schema: - type: object - properties: - start: - type: string - format: date-time - nullable: true - example: '2021-01-31T14:30:05.104Z' - description: When the aggregation started. - status: - type: string - enum: - - STARTED - - ACCOUNTS_COLLECTED - - COMPLETED - - CANCELLED - - RETRIED - - TERMINATED - - NOT_FOUND - example: ACCOUNTS_COLLECTED - description: | - STARTED - Aggregation started, but source account iteration has not completed. - - ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. - - COMPLETED - Aggregation completed (*possibly with errors*). - - CANCELLED - Aggregation cancelled by user. - - RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. - - TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. - totalAccounts: - type: integer - example: 520 - description: The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - processedAccounts: - type: integer - example: 150 - description: The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-aggregations#get-account-aggregation-status - source: | - $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # In-progress Account Aggregation status - - try { - Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountAggregationStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-aggregations#get-account-aggregation-status - source: | - from sailpoint.v2025.api.account_aggregations_api import AccountAggregationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_aggregation_status import AccountAggregationStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # In-progress Account Aggregation status - - results = AccountAggregationsApi(api_client).get_account_aggregation_status(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AccountAggregationsApi(api_client).get_account_aggregation_status(id, x_sail_point_experimental) - print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) - /auth-profiles: - get: - operationId: getProfileConfigList - tags: - - Auth Profile - summary: Get list of Auth Profiles - description: This API returns a list of auth profiles. - security: - - userAuth: - - sp:auth-profile:read - responses: - '200': - description: List of Auth Profiles - content: - application/json: - schema: - type: array - items: - type: object - properties: - tenant: - type: string - description: Tenant name. - example: test-tenant - id: - type: string - description: Identity ID. - example: 2c91808458ae7a4f0158b1bbf8af0628 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#get-profile-config-list - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get list of Auth Profiles - - try { - Get-V2025ProfileConfigList -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ProfileConfigList -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProfileConfigList" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/auth-profile#get-profile-config-list - source: | - from sailpoint.v2025.api.auth_profile_api import AuthProfileApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.auth_profile_summary import AuthProfileSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get list of Auth Profiles - - results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental) - print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) - /auth-profiles/{id}: - get: - operationId: getProfileConfig - tags: - - Auth Profile - summary: Get Auth Profile - description: This API returns auth profile information. - security: - - userAuth: - - sp:auth-profile:read - responses: - '200': - description: Auth Profile - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: Authentication Profile name. - example: EndToEnd-Profile - offNetwork: - type: boolean - description: Use it to block access from off network. - default: false - example: true - untrustedGeography: - type: boolean - description: Use it to block access from untrusted geoographies. - default: false - example: true - applicationId: - type: string - nullable: true - description: Application ID. - example: 2c91808458ae7a4f0158b1bbf8af0628 - applicationName: - type: string - nullable: true - description: Application name. - example: EndToEnd-Source - type: - type: string - enum: - - BLOCK - - MFA - - NON_PTA - - PTA - description: Type of the Authentication Profile. - example: PTA - strongAuthLogin: - type: boolean - description: Use it to enable strong authentication. - default: false - example: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - - name: id - in: path - description: ID of the Auth Profile to patch. - required: true - x-sailpoint-resource-operation-id: getProfileConfigList - schema: - type: string - example: 2c91808a7813090a017814121919ecca - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#get-profile-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - - # Get Auth Profile - - try { - Get-V2025ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProfileConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/auth-profile#get-profile-config - source: | - from sailpoint.v2025.api.auth_profile_api import AuthProfileApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.auth_profile import AuthProfile - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. - try: - # Get Auth Profile - - results = AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental=x_sail_point_experimental, id=id) - # Below is a request that includes all optional parameters - # results = AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental, id) - print("The response of AuthProfileApi->get_profile_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) - patch: - operationId: patchProfileConfig - tags: - - Auth Profile - summary: Patch a specified Auth Profile - description: |- - This API updates an existing Auth Profile. The following fields are patchable: - **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - parameters: - - name: id - in: path - description: ID of the Auth Profile to patch. - required: true - x-sailpoint-resource-operation-id: getProfileConfigList - schema: - type: string - example: 2c91808a7813090a017814121919ecca - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - required: true - responses: - '200': - description: Responds with the Auth Profile as updated. - content: - application/json: - schema: - $ref: '#/paths/~1auth-profiles~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AuthProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:auth-profile:update - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#patch-profile-config - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Auth Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProfileConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/auth-profile#patch-profile-config - source: | - from sailpoint.v2025.api.auth_profile_api import AuthProfileApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.auth_profile import AuthProfile - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | - try: - # Patch a specified Auth Profile - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = AuthProfileApi(api_client).patch_profile_config(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = AuthProfileApi(api_client).patch_profile_config(id, x_sail_point_experimental, new_json_patch_operation) - print("The response of AuthProfileApi->patch_profile_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) - /custom-password-instructions: - post: - operationId: createCustomPasswordInstructions - tags: - - Custom Password Instructions - summary: Create Custom Password Instructions - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: This API creates the custom password instructions for the specified page ID. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - pageId: - type: string - example: change-password:enter-password - description: The page ID that represents the page for forget user name, reset password and unlock account flow. - enum: - - change-password:enter-password - - change-password:finish - - flow-selection:select - - forget-username:user-email - - mfa:enter-code - - mfa:enter-kba - - mfa:select - - reset-password:enter-password - - reset-password:enter-username - - reset-password:finish - - unlock-account:enter-username - - unlock-account:finish - pageContent: - type: string - example: Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter. - description: | - The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. - If the customization text includes a link, like `
...` clicking on this will open the link on the current browser page. - If you want your link to be redirected to a different page, please redirect it to "_blank" like this: `link`. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target. - locale: - type: string - example: en - description: The locale for the custom instructions, a BCP47 language tag. The default value is \"default\". - example: - pageId: reset-password:enter-password - pageContent: See company password policies for details by clicking here - responses: - '200': - description: Reference to the custom password instructions. - content: - application/json: - schema: - $ref: '#/paths/~1custom-password-instructions/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CustomPasswordInstruction.yaml - example: - pageId: reset-password:enter-password - locale: default - pageContent: See company password policies for details by clicking here - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#create-custom-password-instructions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CustomPasswordInstruction = @" - { - "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", - "pageId" : "change-password:enter-password", - "locale" : "en" - } - "@ - - # Create Custom Password Instructions - - try { - $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction - New-V2025CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result - - # Below is a request that includes all optional parameters - # New-V2025CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CustomPasswordInstructions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-password-instructions#create-custom-password-instructions - source: | - from sailpoint.v2025.api.custom_password_instructions_api import CustomPasswordInstructionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.custom_password_instruction import CustomPasswordInstruction - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - custom_password_instruction = '''{ - "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", - "pageId" : "change-password:enter-password", - "locale" : "en" - }''' # CustomPasswordInstruction | - try: - # Create Custom Password Instructions - new_custom_password_instruction = CustomPasswordInstruction.from_json(custom_password_instruction) - results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental=x_sail_point_experimental, custom_password_instruction=new_custom_password_instruction) - # Below is a request that includes all optional parameters - # results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental, new_custom_password_instruction) - print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) - /custom-password-instructions/{pageId}: - get: - operationId: getCustomPasswordInstructions - tags: - - Custom Password Instructions - summary: Get Custom Password Instructions by Page ID - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: This API returns the custom password instructions for the specified page ID. - parameters: - - in: path - name: pageId - schema: - type: string - enum: - - change-password:enter-password - - change-password:finish - - flow-selection:select - - forget-username:user-email - - mfa:enter-code - - mfa:enter-kba - - mfa:select - - reset-password:enter-password - - reset-password:enter-username - - reset-password:finish - - unlock-account:enter-username - - unlock-account:finish - required: true - description: The page ID of custom password instructions to query. - example: mfa:select - - in: query - name: locale - schema: - type: string - description: The locale for the custom instructions, a BCP47 language tag. The default value is \"default\". - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Reference to the custom password instructions. - content: - application/json: - schema: - $ref: '#/paths/~1custom-password-instructions/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CustomPasswordInstruction.yaml - example: - pageId: reset-password:enter-password - locale: default - pageContent: See company password policies for details by clicking here - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#get-custom-password-instructions - source: | - $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - - # Get Custom Password Instructions by Page ID - - try { - Get-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomPasswordInstructions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-password-instructions#get-custom-password-instructions - source: | - from sailpoint.v2025.api.custom_password_instructions_api import CustomPasswordInstructionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.custom_password_instruction import CustomPasswordInstruction - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) - try: - # Get Custom Password Instructions by Page ID - - results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id=page_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id, x_sail_point_experimental, locale) - print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) - delete: - operationId: deleteCustomPasswordInstructions - tags: - - Custom Password Instructions - summary: Delete Custom Password Instructions by page ID - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: This API delete the custom password instructions for the specified page ID. - parameters: - - in: path - name: pageId - schema: - type: string - enum: - - change-password:enter-password - - change-password:finish - - flow-selection:select - - forget-username:user-email - - mfa:enter-code - - mfa:enter-kba - - mfa:select - - reset-password:enter-password - - reset-password:enter-username - - reset-password:finish - - unlock-account:enter-username - - unlock-account:finish - required: true - description: The page ID of custom password instructions to delete. - example: mfa:select - - in: query - name: locale - schema: - type: string - description: The locale for the custom instructions, a BCP47 language tag. The default value is \"default\". - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#delete-custom-password-instructions - source: | - $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - - # Delete Custom Password Instructions by page ID - - try { - Remove-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CustomPasswordInstructions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-password-instructions#delete-custom-password-instructions - source: | - from sailpoint.v2025.api.custom_password_instructions_api import CustomPasswordInstructionsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) - try: - # Delete Custom Password Instructions by page ID - - CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id=page_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id, x_sail_point_experimental, locale) - except Exception as e: - print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e) - /entitlements: - get: - operationId: listEntitlements - tags: - - Entitlements - summary: Gets a list of entitlements. - security: - - userAuth: - - idn:entitlement:read - - idn:entitlement:manage - description: |- - This API returns a list of entitlements. - - This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). - - Any authenticated token can call this API. - parameters: - - in: query - name: account-id - schema: - type: string - description: The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). - example: ef38f94347e94562b5bb8424a56397d8 - required: false - - in: query - name: segmented-for-identity - schema: - type: string - description: |- - If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. - Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. - example: me - required: false - - in: query - name: for-segment-ids - schema: - type: string - format: comma-separated - description: |- - If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. - Cannot be specified with the **account-id** or **segmented-for-identity** param(s). - example: 041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649 - required: false - - in: query - name: include-unsegmented - schema: - type: boolean - default: true - description: Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - example: true - required: false - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** - example: name,-modified - required: false - style: form - explode: true - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, in, sw* - - **type**: *eq, in* - - **attribute**: *eq, in* - - **value**: *eq, in, sw* - - **source.id**: *eq, in* - - **requestable**: *eq* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **owner.id**: *eq, in* - example: attribute eq "memberOf" - required: false - style: form - explode: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of entitlements - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlements - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) - $SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) - $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) - $IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - - # Gets a list of entitlements. - - try { - Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#list-entitlements - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) - segmented_for_identity = 'me' # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) - for_segment_ids = '041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649' # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) - include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to True) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) - filters = 'attribute eq \"memberOf\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - try: - # Gets a list of entitlements. - - results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) - print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) - /entitlements/{id}: - get: - operationId: getEntitlement - tags: - - Entitlements - summary: Get an entitlement - description: This API returns an entitlement by its ID. - security: - - userAuth: - - idn:entitlement:read - - idn:entitlement:manage - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listEntitlements - description: The entitlement ID - example: 2c91808874ff91550175097daaec161c - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: An entitlement - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml - example: - sourceSchemaObjectType: group - attribute: memberOf - attributes: - GroupType: Security - sAMAccountName: LauncherTest1 - GroupScope: Global - objectguid: '{01a6e70b-9705-4155-a5c6-492a9bcc8c64}' - objectSid: S-1-5-21-3585869415-1648031554-2909195034-1633 - cn: LauncherTest1 - msDS-PrincipalName: AUTOMATIONAD\LauncherTest1 - value: CN=LauncherTest1,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local - description: some description - privileged: false - cloudGoverned: false - source: - type: SOURCE - id: 2c9180877504c40e0175097d5ce707c8 - name: EndToEnd-ADSource - owner: - id: 2c9180858315595501831958427e5424 - name: Addie Smith - type: IDENTITY - segments: - - 1d126fe0-45e2-4aea-bc64-a07e9344ef26 - manuallyUpdatedFields: - DISPLAY_NAME: true - DESCRIPTION: true - id: 2c91808c74ff913f0175097daa9d59cd - name: LauncherTest1 - created: '2020-10-08T18:33:52.029Z' - modified: '2021-01-19T16:53:35.707Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get an entitlement - - try { - Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlement" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#get-entitlement - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get an entitlement - - results = EntitlementsApi(api_client).get_entitlement(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).get_entitlement(id, x_sail_point_experimental) - print("The response of EntitlementsApi->get_entitlement:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) - patch: - operationId: patchEntitlement - tags: - - Entitlements - summary: Patch an entitlement - description: |- - This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - - The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** - - When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - security: - - userAuth: - - idn:entitlement:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - parameters: - - name: id - in: path - description: ID of the entitlement to patch - required: true - x-sailpoint-resource-operation-id: listEntitlements - schema: - type: string - example: 2c91808a7813090a017814121e121518 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /requestable - value: true - examples: - Make an entitlement requestable and privileged in one call: - description: This example shows how multiple fields may be updated with a single patch call. - value: - - op: replace - path: /requestable - value: true - - op: replace - path: /privileged - value: true - Assign an entitlement to a segment: - description: This example shows how to use patch to assign an entitlement to a segment by adding the segment's ID to the entitlement's segments array. - value: - - op: add - path: /segments/- - value: f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - Assign an owner to an entitlement: - description: This example shows how to use patch to assign an owner to an entitlement by adding the owner's info to the entitlement. - value: - - op: add - path: /owner - value: - type: IDENTITY - id: 2c9180858315595501831958427e5424 - Replace an owner for an entitlement: - description: This example shows how to use patch to replace an entitlement's owner by replacing the owner's info to the entitlement. - value: - - op: replace - path: /owner - value: - type: IDENTITY - id: 2c9180858315595501831958427e5424 - Set entitlement manually updated fields: - description: 'This example shows how to set an entitlement''s manually updated fields values with patch request. Values for all manually updateable fields must be specified in the request. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION.' - value: - - op: replace - path: /manuallyUpdatedFields - value: - DISPLAY_NAME: true - DESCRIPTION: true - Add the description for an entitlement: - description: This example shows how to use patch to add a description for the entitlement. - value: - - op: add - path: /description - value: new description for the entitlement - Update the name for an entitlement: - description: This example shows how to use patch to update an entitlement's name. - value: - - op: replace - path: /name - value: entitlement new name - responses: - '200': - description: Responds with the entitlement as updated. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#patch-entitlement - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch an entitlement - - try { - Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Entitlement" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#patch-entitlement - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional) - try: - # Patch an entitlement - - results = EntitlementsApi(api_client).patch_entitlement(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).patch_entitlement(id, x_sail_point_experimental, new_json_patch_operation) - print("The response of EntitlementsApi->patch_entitlement:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) - /entitlements/{id}/parents: - get: - operationId: listEntitlementParents - tags: - - Entitlements - summary: List of entitlements parents - description: This API returns a list of all parent entitlements of a given entitlement. - security: - - userAuth: - - idn:entitlement:read - - idn:entitlement:manage - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listEntitlements - description: Entitlement Id - example: 2c91808c74ff913f0175097daa9d59cd - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** - example: name,-modified - required: false - style: form - explode: true - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, in, sw* - - **type**: *eq, in* - - **attribute**: *eq, in* - - **value**: *eq, in, sw* - - **source.id**: *eq, in* - - **requestable**: *eq* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - example: attribute eq "memberOf" - required: false - style: form - explode: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of entitlements parents from an entitlement - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml - example: - - sourceSchemaObjectType: group - attribute: memberOf - attributes: - GroupType: Security - sAMAccountName: LauncherTest1 - GroupScope: Global - objectguid: '{01a6e70b-9705-4155-a5c6-492a9bcc8c64}' - objectSid: S-1-5-21-3585869415-1648031554-2909195034-1633 - cn: LauncherTest1 - msDS-PrincipalName: AUTOMATIONAD\LauncherTest1 - value: CN=LauncherTest1,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local - description: some description - privileged: false - cloudGoverned: false - source: - type: SOURCE - id: 2c9180877504c40e0175097d5ce707c8 - name: EndToEnd-ADSource - owner: - id: 2a2fdacca5e345f18bf7970cfbb8fec2 - name: identity 1 - type: IDENTITY - segments: - - 1d126fe0-45e2-4aea-bc64-a07e9344ef26 - manuallyUpdatedFields: - DISPLAY_NAME: true - DESCRIPTION: true - id: 2c91808c74ff913f0175097daa9d59cd - name: LauncherTest1 - created: '2020-10-08T18:33:52.029Z' - modified: '2021-01-19T16:53:35.707Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-parents - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List of entitlements parents - - try { - Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementParents" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#list-entitlement-parents - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - filters = 'attribute eq \"memberOf\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - try: - # List of entitlements parents - - results = EntitlementsApi(api_client).list_entitlement_parents(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) - print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) - /entitlements/{id}/children: - get: - operationId: listEntitlementChildren - tags: - - Entitlements - summary: List of entitlements children - description: This API returns a list of all child entitlements of a given entitlement. - security: - - userAuth: - - idn:entitlement:read - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listEntitlements - description: Entitlement Id - example: 2c91808874ff91550175097daaec161c - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** - example: name,-modified - required: false - style: form - explode: true - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, in, sw* - - **type**: *eq, in* - - **attribute**: *eq, in* - - **value**: *eq, in, sw* - - **source.id**: *eq, in* - - **requestable**: *eq* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - example: attribute eq "memberOf" - required: false - style: form - explode: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of entitlements children from an entitlement - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml - example: - - sourceSchemaObjectType: group - attribute: memberOf - attributes: - GroupType: Security - sAMAccountName: LauncherTest1 - GroupScope: Global - objectguid: '{01a6e70b-9705-4155-a5c6-492a9bcc8c64}' - objectSid: S-1-5-21-3585869415-1648031554-2909195034-1633 - cn: LauncherTest1 - msDS-PrincipalName: AUTOMATIONAD\LauncherTest1 - value: CN=LauncherTest1,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local - description: some description - privileged: false - cloudGoverned: false - source: - type: SOURCE - id: 2c9180877504c40e0175097d5ce707c8 - name: EndToEnd-ADSource - owner: - id: 2a2fdacca5e345f18bf7970cfbb8fec2 - name: identity 1 - type: IDENTITY - segments: - - 1d126fe0-45e2-4aea-bc64-a07e9344ef26 - manuallyUpdatedFields: - DISPLAY_NAME: true - DESCRIPTION: true - id: 2c91808c74ff913f0175097daa9d59cd - name: LauncherTest1 - created: '2020-10-08T18:33:52.029Z' - modified: '2021-01-19T16:53:35.707Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-children - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List of entitlements children - - try { - Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChildren" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#list-entitlement-children - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - filters = 'attribute eq \"memberOf\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - try: - # List of entitlements children - - results = EntitlementsApi(api_client).list_entitlement_children(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) - print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) - /entitlements/bulk-update: - post: - operationId: updateEntitlementsInBulk - tags: - - Entitlements - summary: Bulk update an entitlement list - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: | - "This API applies an update to every entitlement of the list.\n\nThe\ - \ number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch\ - \ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\ - \ allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"\ - value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\"\ - : boolean }**`" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - entitlementIds: - type: array - description: List of entitlement ids to update - maxItems: 50 - items: - type: string - example: - - 2c91808a7624751a01762f19d665220d - - 2c91808a7624751a01762f19d67c220e - - 2c91808a7624751a01762f19d692220f - jsonPatch: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /privileged - value: false - - op: replace - path: /requestable - value: false - example: - entitlementIds: - - 2c91808a7624751a01762f19d665220d - - 2c91808a7624751a01762f19d67c220e - - 2c91808a7624751a01762f19d692220f - jsonPatch: - - op: replace - path: /privileged - value: false - - op: replace - path: /requestable - value: false - required: - - entitlementIds - - jsonPatch - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#update-entitlements-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $EntitlementBulkUpdateRequest = @" - { - "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/privileged", - "value" : false - }, { - "op" : "replace", - "path" : "/requestable", - "value" : false - } ] - } - "@ - - # Bulk update an entitlement list - - try { - $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest - Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#update-entitlements-in-bulk - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement_bulk_update_request import EntitlementBulkUpdateRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - entitlement_bulk_update_request = '''{ - "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/privileged", - "value" : false - }, { - "op" : "replace", - "path" : "/requestable", - "value" : false - } ] - }''' # EntitlementBulkUpdateRequest | - try: - # Bulk update an entitlement list - new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest.from_json(entitlement_bulk_update_request) - EntitlementsApi(api_client).update_entitlements_in_bulk(x_sail_point_experimental=x_sail_point_experimental, entitlement_bulk_update_request=new_entitlement_bulk_update_request) - # Below is a request that includes all optional parameters - # EntitlementsApi(api_client).update_entitlements_in_bulk(x_sail_point_experimental, new_entitlement_bulk_update_request) - except Exception as e: - print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) - /entitlements/{id}/entitlement-request-config: - get: - operationId: getEntitlementRequestConfig - tags: - - Entitlements - summary: Get Entitlement Request Config - description: This API returns the entitlement request config for a specified entitlement. - security: - - userAuth: - - idn:entitlement:read - - idn:entitlement:manage - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listEntitlements - description: Entitlement Id - example: 2c91808874ff91550175097daaec161c - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: An Entitlement Request Config - content: - application/json: - schema: - type: object - properties: - allowEntitlementRequest: - type: boolean - description: If this is true, entitlement requests are allowed. - default: false - example: true - requestCommentsRequired: - type: boolean - description: If this is true, comments are required to submit entitlement requests. - default: false - example: false - deniedCommentsRequired: - type: boolean - description: If this is true, comments are required to reject entitlement requests. - default: false - example: false - grantRequestApprovalSchemes: - type: string - description: | - Approval schemes for granting entitlement request. This can be empty if no approval is needed. - Multiple schemes must be comma-separated. The valid schemes are "entitlementOwner", "sourceOwner", "manager" and "`workgroup:{id}`". - You can use multiple governance groups (workgroups). - default: sourceOwner - nullable: true - example: entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584 - example: - accessRequestConfig: - requestCommentRequired: true - denialCommentRequired: true - approvalSchemes: - - approverType: ENTITLEMENT_OWNER - approverId: null - - approverType: SOURCE_OWNER - approverId: null - - approverType: MANAGER - approverId: null - - approverType: GOVERNANCE_GROUP - approverId: 46c79819-a69f-49a2-becb-12c971ae66c6 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement-request-config - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Entitlement Request Config - - try { - Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementRequestConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#get-entitlement-request-config - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement_request_config import EntitlementRequestConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Entitlement Request Config - - results = EntitlementsApi(api_client).get_entitlement_request_config(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).get_entitlement_request_config(id, x_sail_point_experimental) - print("The response of EntitlementsApi->get_entitlement_request_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) - put: - operationId: putEntitlementRequestConfig - tags: - - Entitlements - summary: Replace Entitlement Request Config - description: This API replaces the entitlement request config for a specified entitlement. - security: - - userAuth: - - idn:entitlement:manage - parameters: - - name: id - in: path - description: Entitlement ID - required: true - x-sailpoint-resource-operation-id: listEntitlements - schema: - type: string - example: 2c91808a7813090a017814121e121518 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1entitlements~1%7Bid%7D~1entitlement-request-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EntitlementRequestConfig.yaml - responses: - '200': - description: Responds with the entitlement request config as updated. - content: - application/json: - schema: - $ref: '#/paths/~1entitlements~1%7Bid%7D~1entitlement-request-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EntitlementRequestConfig.yaml - example: - accessRequestConfig: - requestCommentRequired: true - denialCommentRequired: true - approvalSchemes: - - approverType: ENTITLEMENT_OWNER - approverId: null - - approverType: SOURCE_OWNER - approverId: null - - approverType: MANAGER - approverId: null - - approverType: GOVERNANCE_GROUP - approverId: 46c79819-a69f-49a2-becb-12c971ae66c6 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#put-entitlement-request-config - source: | - $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $EntitlementRequestConfig = @" - { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - } - "@ - - # Replace Entitlement Request Config - - try { - $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig - Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025EntitlementRequestConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#put-entitlement-request-config - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement_request_config import EntitlementRequestConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - entitlement_request_config = '''{ - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - }''' # EntitlementRequestConfig | - try: - # Replace Entitlement Request Config - new_entitlement_request_config = EntitlementRequestConfig.from_json(entitlement_request_config) - results = EntitlementsApi(api_client).put_entitlement_request_config(id=id, x_sail_point_experimental=x_sail_point_experimental, entitlement_request_config=new_entitlement_request_config) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).put_entitlement_request_config(id, x_sail_point_experimental, new_entitlement_request_config) - print("The response of EntitlementsApi->put_entitlement_request_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) - /entitlements/reset/sources/{id}: - post: - operationId: resetSourceEntitlements - tags: - - Entitlements - summary: Reset Source Entitlements - description: |- - Remove all entitlements from a specific source. - To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - parameters: - - name: id - in: path - description: ID of source for the entitlement reset - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - example: 2c91808a7813090a017814121919ecca - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '202': - description: Entitlement source reset task result - content: - application/json: - schema: - type: object - properties: - type: - type: string - description: The DTO type - example: TASK_RESULT - id: - type: string - description: The task ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: Entitlement Source Reset - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:entitlement:update - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#reset-source-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Reset Source Entitlements - - try { - Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025SourceEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#reset-source-entitlements - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement_source_reset_base_reference_dto import EntitlementSourceResetBaseReferenceDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Reset Source Entitlements - - results = EntitlementsApi(api_client).reset_source_entitlements(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).reset_source_entitlements(id, x_sail_point_experimental) - print("The response of EntitlementsApi->reset_source_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) - /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}: - post: - summary: Add metadata to an entitlement. - description: Add single Access Model Metadata to an entitlement. - tags: - - Entitlements - operationId: createAccessModelMetadataForEntitlement - security: - - userAuth: - - idn:entitlement:update - parameters: - - name: id - in: path - required: true - x-sailpoint-resource-operation-id: listEntitlements - schema: - type: string - description: The entitlement id. - example: 2c91808c74ff913f0175097daa9d59cd - - name: attributeKey - in: path - required: true - x-sailpoint-resource-operation-id: listAccessModelMetadataAttribute - schema: - type: string - description: Technical name of the Attribute. - example: iscPrivacy - - name: attributeValue - in: path - required: true - x-sailpoint-resource-operation-id: listAccessModelMetadataAttributeValue - schema: - type: string - description: Technical name of the Attribute Value. - example: public - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#create-access-model-metadata-for-entitlement - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Add metadata to an entitlement. - - try { - New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessModelMetadataForEntitlement" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#create-access-model-metadata-for-entitlement - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. - attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Add metadata to an entitlement. - - results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental) - print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) - delete: - summary: Remove metadata from an entitlement. - description: Remove single Access Model Metadata from an entitlement. - tags: - - Entitlements - operationId: deleteAccessModelMetadataFromEntitlement - security: - - userAuth: - - idn:entitlement:delete - parameters: - - name: id - in: path - required: true - x-sailpoint-resource-operation-id: listEntitlements - schema: - type: string - description: The entitlement id. - example: 2c91808c74ff913f0175097daa9d59cd - - name: attributeKey - in: path - required: true - x-sailpoint-resource-operation-id: listAccessModelMetadataAttribute - schema: - type: string - description: Technical name of the Attribute. - example: iscPrivacy - - name: attributeValue - in: path - required: true - x-sailpoint-resource-operation-id: listAccessModelMetadataAttributeValue - schema: - type: string - description: Technical name of the Attribute Value. - example: public - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: OK - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#delete-access-model-metadata-from-entitlement - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Remove metadata from an entitlement. - - try { - Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessModelMetadataFromEntitlement" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#delete-access-model-metadata-from-entitlement - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. - attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Remove metadata from an entitlement. - - EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental) - except Exception as e: - print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e) - /entitlements/aggregate/sources/{id}: - post: - tags: - - Entitlements - summary: Aggregate Entitlements - deprecated: true - operationId: importEntitlementsBySource - description: |- - Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). - - If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. - - If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: Source Id - example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - content: - multipart/form-data: - schema: - type: object - properties: - csvFile: - type: string - format: binary - description: The CSV file containing the source entitlements to aggregate. - responses: - '202': - description: Aggregate Entitlements Task - content: - application/json: - schema: - type: object - properties: - id: - description: System-generated unique ID of the task this taskStatus represents - type: string - example: ef38f94347e94562b5bb8424a56397d8 - type: - description: Type of task this task represents - type: string - example: QUARTZ - uniqueName: - description: The name of the task - type: string - example: Cloud Group Aggregation - description: - description: The description of the task - type: string - example: Aggregate from the specified application - launcher: - description: The user who initiated the task - type: string - example: John Doe - created: - description: The creation date of the task - type: string - format: date-time - example: '2020-07-11T21:23:15.000Z' - returns: - description: Return values from the task - type: array - items: - type: object - properties: - displayLabel: - description: The display label for the return value - type: string - example: TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS - attributeName: - description: The attribute name for the return value - type: string - example: applications - example: - - displayLabel: TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS - attributeName: applications - - displayLabel: TASK_OUT_ACCOUNT_GROUP_AGGREGATION_TOTAL - attributeName: total - - displayLabel: TASK_OUT_ACCOUNT_GROUP_AGGREGATION_CREATED - attributeName: groupsCreated - - displayLabel: TASK_OUT_ACCOUNT_GROUP_AGGREGATION_UPDATED - attributeName: groupsUpdated - - displayLabel: TASK_OUT_ACCOUNT_GROUP_AGGREGATION_DELETED - attributeName: groupsDeleted - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:entitlements:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#import-entitlements-by-source - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) - - # Aggregate Entitlements - - try { - Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsBySource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/entitlements#import-entitlements-by-source - source: | - from sailpoint.v2025.api.entitlements_api import EntitlementsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.load_entitlement_task import LoadEntitlementTask - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - csv_file = None # bytearray | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional) - try: - # Aggregate Entitlements - - results = EntitlementsApi(api_client).import_entitlements_by_source(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = EntitlementsApi(api_client).import_entitlements_by_source(id, x_sail_point_experimental, csv_file) - print("The response of EntitlementsApi->import_entitlements_by_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) - /generate-password-reset-token/digit: - post: - operationId: createDigitToken - security: - - userAuth: - - idn:password-digit-token:create - summary: Generate a digit token - tags: - - Password Management - description: This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create". - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - userId - properties: - userId: - type: string - description: The uid of the user requested for digit token - example: Abby.Smith - length: - type: integer - description: The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. - example: 8 - durationMinutes: - type: integer - description: The time to live for the digit token in minutes. The default value is 5 minutes. - example: 5 - example: - userId: Abby.Smith - length: 8 - durationMinutes: 5 - responses: - '200': - description: The digit token for password management. - content: - application/json: - schema: - type: object - properties: - digitToken: - type: string - description: The digit token for password management - example: 9087713 - requestId: - type: string - description: The reference ID of the digit token generation request - example: e1267ecd-fcd9-4c73-9c55-12555efad136 - example: - digitToken: 9087713 - requestId: e1267ecd-fcd9-4c73-9c55-12555efad136 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-management#create-digit-token - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $PasswordDigitTokenReset = @" - { - "durationMinutes" : 5, - "length" : 8, - "userId" : "Abby.Smith" - } - "@ - - # Generate a digit token - - try { - $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset - New-V2025DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result - - # Below is a request that includes all optional parameters - # New-V2025DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DigitToken" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/password-management#create-digit-token - source: | - from sailpoint.v2025.api.password_management_api import PasswordManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.password_digit_token import PasswordDigitToken - from sailpoint.v2025.models.password_digit_token_reset import PasswordDigitTokenReset - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - password_digit_token_reset = '''{ - "durationMinutes" : 5, - "length" : 8, - "userId" : "Abby.Smith" - }''' # PasswordDigitTokenReset | - try: - # Generate a digit token - new_password_digit_token_reset = PasswordDigitTokenReset.from_json(password_digit_token_reset) - results = PasswordManagementApi(api_client).create_digit_token(x_sail_point_experimental=x_sail_point_experimental, password_digit_token_reset=new_password_digit_token_reset) - # Below is a request that includes all optional parameters - # results = PasswordManagementApi(api_client).create_digit_token(x_sail_point_experimental, new_password_digit_token_reset) - print("The response of PasswordManagementApi->create_digit_token:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) - /historical-identities: - get: - operationId: listHistoricalIdentities - summary: Lists all the identities - description: This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' - security: - - userAuth: - - idn:identity-history:read - tags: - - Identity History - parameters: - - in: query - name: starts-with-query - schema: - type: string - description: This param is used for starts-with search for first, last and display name of the identity - example: Ada - - in: query - name: is-deleted - schema: - type: boolean - description: Indicates if we want to only list down deleted identities or not. - example: true - - in: query - name: is-active - schema: - type: boolean - description: Indicates if we want to only list active or inactive identities. - example: true - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of identities for the customer. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: the identity ID - example: bc693f07e7b645539626c25954c58554 - displayName: - type: string - description: the display name of the identity - example: Adam Zampa - firstName: - type: string - nullable: true - description: the first name of the identity - example: Adam - lastName: - type: string - nullable: true - description: the last name of the identity - example: Zampa - active: - type: boolean - default: true - description: indicates if an identity is active or not - example: true - deletedDate: - type: string - nullable: true - description: the date when the identity was deleted - example: '2007-03-01T13:00:00.000Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-historical-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) - $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) - $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # Lists all the identities - - try { - Get-V2025HistoricalIdentities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025HistoricalIdentities -XSailPointExperimental $XSailPointExperimental -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#list-historical-identities - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_list_item import IdentityListItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - starts_with_query = 'Ada' # str | This param is used for starts-with search for first, last and display name of the identity (optional) # str | This param is used for starts-with search for first, last and display name of the identity (optional) - is_deleted = true # bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional) - is_active = true # bool | Indicates if we want to only list active or inactive identities. (optional) # bool | Indicates if we want to only list active or inactive identities. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # Lists all the identities - - results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset) - print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) - /historical-identities/{id}: - get: - operationId: getHistoricalIdentity - tags: - - Identity History - summary: Get latest snapshot of identity - description: This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' - security: - - userAuth: - - idn:identity-history:read - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listHistoricalIdentities - description: The identity id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The identity object. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: the identity ID - example: bc693f07e7b645539626c25954c58554 - displayName: - type: string - description: the display name of the identity - example: Adam Zampa - snapshot: - type: string - description: the date when the identity record was created - example: '2007-03-01T13:00:00.000Z' - deletedDate: - type: string - description: the date when the identity was deleted - example: '2007-03-01T13:00:00.000Z' - accessItemCount: - type: object - description: A map containing the count of each access item - example: - app: 0 - role: 2 - entitlement: 4 - accessProfile: 3 - account: 1 - additionalProperties: - type: integer - format: int32 - attributes: - type: object - description: A map containing the identity attributes - additionalProperties: true - example: - jobTitle: HR Manager - location: NYC - firstname: Adam - lastname: Zampa - department: HR - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-historical-identity - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get latest snapshot of identity - - try { - Get-V2025HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#get-historical-identity - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_history_response import IdentityHistoryResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get latest snapshot of identity - - results = IdentityHistoryApi(api_client).get_historical_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).get_historical_identity(id, x_sail_point_experimental) - print("The response of IdentityHistoryApi->get_historical_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) - /historical-identities/{id}/access-items: - get: - operationId: listIdentityAccessItems - tags: - - Identity History - summary: List Access Items by Identity - security: - - userAuth: - - idn:identity-history:read - x-sailpoint-userLevels: - - ORG_ADMIN - - HELPDESK - - REPORT_ADMIN - description: | - This method retrieves a list of access item for the identity filtered by the access item type - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listHistoricalIdentities - description: The identity id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: query - name: type - schema: - type: string - required: false - description: The type of access item for the identity. If not provided, it defaults to account - example: account - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - responses: - '200': - description: The list of access items. - content: - application/json: - schema: - type: array - items: - oneOf: - - type: object - properties: - accessType: - type: string - example: accessProfile - description: the access item type. accessProfile in this case - id: - type: string - example: 2c918087763e69d901763e72e97f006f - description: the access item id - name: - type: string - example: sample - description: the access profile name - sourceName: - type: string - example: DataScienceDataset - description: the name of the source - sourceId: - type: string - example: 2793o32dwd - description: the id of the source - description: - type: string - example: AccessProfile - Workday/Citizenship access - description: the description for the access profile - displayName: - type: string - example: Dr. Arden Rogahn MD - description: the display name of the identity - entitlementCount: - type: string - example: 12 - description: the number of entitlements the access profile will create - appDisplayName: - type: string - example: AppName - description: the name of - removeDate: - type: string - example: '2024-07-01T06:00:00.000Z' - description: the date the access profile is no longer assigned to the specified identity - standalone: - type: boolean - example: false - description: indicates whether the access profile is standalone - revocable: - type: boolean - example: true - description: indicates whether the access profile is - required: - - standalone - - revocable - - type: object - properties: - accessType: - type: string - example: account - description: the access item type. account in this case - id: - type: string - example: 2c918087763e69d901763e72e97f006f - description: the access item id - nativeIdentity: - type: string - example: dr.arden.ogahn.d - description: the native identifier used to uniquely identify an acccount - sourceName: - type: string - example: DataScienceDataset - description: the name of the source - sourceId: - type: string - example: 2793o32dwd - description: the id of the source - entitlementCount: - type: string - example: 12 - description: the number of entitlements the account will create - displayName: - type: string - example: Dr. Arden Rogahn MD - description: the display name of the identity - - type: object - properties: - accessType: - type: string - example: app - description: the access item type. entitlement in this case - id: - type: string - example: 2c918087763e69d901763e72e97f006f - description: the access item id - displayName: - type: string - example: Display Name - description: the access item display name - sourceName: - type: string - example: appName - description: the associated source name if it exists - appRoleId: - type: string - example: 2c918087763e69d901763e72e97f006f - description: the app role id - - type: object - properties: - accessType: - type: string - example: entitlement - description: the access item type. entitlement in this case - id: - type: string - example: 2c918087763e69d901763e72e97f006f - description: the access item id - attribute: - type: string - example: groups - description: the entitlement attribute - value: - type: string - example: Upward mobility access - description: the associated value - entitlementType: - type: string - example: entitlement - description: the type of entitlement - sourceName: - type: string - example: DataScienceDataset - description: the name of the source - sourceId: - type: string - example: 2793o32dwd - description: the id of the source - description: - type: string - example: Entitlement - Workday/Citizenship access - description: the description for the entitlment - displayName: - type: string - example: Dr. Arden Rogahn MD - description: the display name of the identity - standalone: - type: boolean - example: true - description: indicates whether the entitlement is standalone - privileged: - type: boolean - example: false - description: indicates whether the entitlement is privileged - cloudGoverned: - type: boolean - example: true - description: indicates whether the entitlement is cloud governed - required: - - standalone - - privileged - - cloudGoverned - - type: object - properties: - accessType: - type: string - example: role - description: the access item type. role in this case - id: - type: string - example: 2c918087763e69d901763e72e97f006f - description: the access item id - displayName: - type: string - example: sample - description: the role display name - description: - type: string - example: Role - Workday/Citizenship access - description: the description for the role - sourceName: - type: string - example: Source Name - description: the associated source name if it exists - removeDate: - type: string - example: '2024-07-01T06:00:00.000Z' - description: the date the role is no longer assigned to the specified identity - revocable: - type: boolean - example: true - description: indicates whether the role is revocable - required: - - revocable - examples: - Access Profile: - description: An access profile response - value: - - accessType: accessProfile - id: 2c918087763e69d901763e72e97f006f - name: sample - sourceName: DataScienceDataset - sourceId: 2793o32dwd - description: AccessProfile - Workday/Citizenship access - displayName: Dr. Arden Rogahn MD - entitlementCount: 12 - appDisplayName: AppName - Account: - description: An account response - value: - - accessType: account - id: 2c918087763e69d901763e72e97f006f - nativeIdentity: dr.arden.ogahn.d - sourceName: DataScienceDataset - sourceId: 2793o32dwd - entitlementCount: 12 - displayName: Dr. Arden Rogahn MD - App: - description: An app response - value: - - accessType: app - id: 2c918087763e69d901763e72e97f006f - name: appName - Entitlement: - description: An entitlement event - value: - - accessType: entitlement - id: 2c918087763e69d901763e72e97f006f - attribute: groups - value: Upward mobility access - type: group - sourceName: DataScienceDataset - sourceId: 2793o32dwd - description: Entitlement - Workday/Citizenship access - displayName: Dr. Arden Rogahn MD - Role: - description: A role response - value: - - accessType: role - id: 2c918087763e69d901763e72e97f006f - name: sample - description: Role - Workday/Citizenship access - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-access-items - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Access Items by Identity - - try { - Get-V2025IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental -Type $Type -Limit $Limit -Count $Count -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#list-identity-access-items - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account (optional) # str | The type of access item for the identity. If not provided, it defaults to account (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Access Items by Identity - - results = IdentityHistoryApi(api_client).list_identity_access_items(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) - print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) - /historical-identities/{id}/snapshots: - get: - operationId: listIdentitySnapshots - tags: - - Identity History - summary: Lists all the snapshots for the identity - description: 'This method retrieves all the snapshots for the identity Requires authorization scope of ''idn:identity-history:read'' ' - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listHistoricalIdentities - description: The identity id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: query - name: start - schema: - type: string - description: The specified start date - example: '2007-03-01T13:00:00Z' - - in: query - name: interval - schema: - type: string - enum: - - day - - month - description: The interval indicating the range in day or month for the specified interval-name - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: A list of identity summary for each snapshot. - content: - application/json: - schema: - type: array - items: - type: object - properties: - snapshot: - type: string - description: the date when the identity record was created - example: '2007-03-01T13:00:00.000Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-snapshots - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) - $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Lists all the snapshots for the identity - - try { - Get-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshots" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#list-identity-snapshots - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - start = '2007-03-01T13:00:00Z' # str | The specified start date (optional) # str | The specified start date (optional) - interval = 'interval_example' # str | The interval indicating the range in day or month for the specified interval-name (optional) # str | The interval indicating the range in day or month for the specified interval-name (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Lists all the snapshots for the identity - - results = IdentityHistoryApi(api_client).list_identity_snapshots(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) - print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) - /historical-identities/{id}/snapshot-summary: - get: - operationId: getIdentitySnapshotSummary - tags: - - Identity History - summary: Gets the summary for the event count for a specific identity - description: 'This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of ''idn:identity-history:read'' ' - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listHistoricalIdentities - description: The identity id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: query - name: before - schema: - type: string - description: The date before which snapshot summary is required - example: '2007-03-01T13:00:00Z' - - in: query - name: interval - schema: - type: string - enum: - - day - - month - description: The interval indicating day or month. Defaults to month if not specified - - in: query - name: time-zone - schema: - type: string - description: The time zone. Defaults to UTC if not provided - example: UTC - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: A summary list of identity changes in date histogram format. - content: - application/json: - schema: - type: array - items: - type: object - properties: - name: - type: string - description: the name of metric - value: - type: number - description: the value associated to the metric - example: - name: '2021-04-01T00:00:00.000Z' - value: 2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-snapshot-summary - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) - $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) - $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets the summary for the event count for a specific identity - - try { - Get-V2025IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshotSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#get-identity-snapshot-summary - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.metric_response import MetricResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - before = '2007-03-01T13:00:00Z' # str | The date before which snapshot summary is required (optional) # str | The date before which snapshot summary is required (optional) - interval = 'interval_example' # str | The interval indicating day or month. Defaults to month if not specified (optional) # str | The interval indicating day or month. Defaults to month if not specified (optional) - time_zone = 'UTC' # str | The time zone. Defaults to UTC if not provided (optional) # str | The time zone. Defaults to UTC if not provided (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Gets the summary for the event count for a specific identity - - results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count) - print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) - /historical-identities/{id}/snapshots/{date}: - get: - operationId: getIdentitySnapshot - tags: - - Identity History - summary: Gets an identity snapshot at a given date - description: 'This method retrieves a specified identity snapshot at a given date Requires authorization scope of ''idn:identity-history:read'' ' - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listHistoricalIdentities - description: The identity id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: path - name: date - schema: - type: string - description: The specified date - example: '2007-03-01T13:00:00Z' - required: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The identity object. - content: - application/json: - schema: - $ref: '#/paths/~1historical-identities~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityHistoryResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-snapshot - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Date = "2007-03-01T13:00:00Z" # String | The specified date - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Gets an identity snapshot at a given date - - try { - Get-V2025IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshot" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#get-identity-snapshot - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_history_response import IdentityHistoryResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Gets an identity snapshot at a given date - - results = IdentityHistoryApi(api_client).get_identity_snapshot(id=id, var_date=var_date, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date, x_sail_point_experimental) - print("The response of IdentityHistoryApi->get_identity_snapshot:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) - /historical-identities/{id}/snapshots/{date}/access-items: - get: - operationId: listIdentitySnapshotAccessItems - tags: - - Identity History - summary: Gets the list of identity access items at a given date filterd by item type - description: 'This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of ''idn:identity-history:read'' ' - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listHistoricalIdentities - description: The identity id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: path - name: date - schema: - type: string - required: true - description: The specified date - example: '2007-03-01T13:00:00Z' - - in: query - name: type - schema: - type: string - description: The access item type - example: account - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The identity object. - content: - application/json: - schema: - type: array - items: - oneOf: - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAccessProfileResponse.yaml - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAccountResponse.yaml - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAppResponse.yaml - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemEntitlementResponse.yaml - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/4' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemRoleResponse.yaml - examples: - Access Item AccessProfile Response: - description: An access profile response - value: - - type: accessProfile - id: 2c918087763e69d901763e72e97f006f - name: sample - sourceName: DataScienceDataset - sourceId: 2793o32dwd - description: AccessProfile - Workday/Citizenship access - displayName: Dr. Arden Rogahn MD - entitlementCount: 12 - appDisplayName: AppName - Access Item Account Response: - description: An account response - value: - - type: account - id: 2c918087763e69d901763e72e97f006f - nativeIdentity: dr.arden.ogahn.d - sourceName: DataScienceDataset - sourceId: 2793o32dwd - entitlementCount: 12 - displayName: Dr. Arden Rogahn MD - Access Item App Response: - description: An app response - value: - - type: app - id: 2c918087763e69d901763e72e97f006f - name: appName - Access Item Entitlement Response: - description: An entitlement event - value: - - type: entitlement - id: 2c918087763e69d901763e72e97f006f - attribute: groups - value: Upward mobility access - entitlementType: entitlement - sourceName: DataScienceDataset - sourceId: 2793o32dwd - description: Entitlement - Workday/Citizenship access - displayName: Dr. Arden Rogahn MD - Access Item Role Response: - description: A role response - value: - - type: role - id: 2c918087763e69d901763e72e97f006f - name: sample - description: Role - Workday/Citizenship access - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-snapshot-access-items - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Date = "2007-03-01T13:00:00Z" # String | The specified date - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "account" # String | The access item type (optional) - - # Gets the list of identity access items at a given date filterd by item type - - try { - Get-V2025IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshotAccessItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#list-identity-snapshot-access-items - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - type = 'account' # str | The access item type (optional) # str | The access item type (optional) - try: - # Gets the list of identity access items at a given date filterd by item type - - results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id=id, var_date=var_date, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) - print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) - /common-access: - get: - operationId: getCommonAccess - summary: Get a paginated list of common access - tags: - - IAI Common Access - description: This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **status**: *eq, sw* - - **reviewedByUser** *eq* - - **access.id**: *eq, sw* - - **access.type**: *eq* - - **access.name**: *sw, eq* - - **access.description**: *sw, eq* - example: access.type eq "ROLE" - required: false - style: form - explode: true - schema: - type: string - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **access.name, status** - - By default the common access items are sorted by name, ascending. - example: access.name - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of common access for a customer. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Unique ID of the common access item - example: 555ab47a-0d32-4813-906f-adf3567de6a4 - access: - type: object - properties: - id: - type: string - description: Common access ID - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - description: The type of access item. - name: - type: string - description: Common access name - description: - type: string - description: Common access description - nullable: true - ownerName: - type: string - description: Common access owner name - ownerId: - type: string - description: Common access owner ID - status: - type: string - description: CONFIRMED or DENIED - commonAccessType: - type: string - example: UNSET - lastUpdated: - type: string - readOnly: true - format: date-time - reviewedByUser: - type: boolean - description: true if user has confirmed or denied status - lastReviewed: - type: string - readOnly: true - format: date-time - nullable: true - createdByUser: - type: boolean - default: false - example: false - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#get-common-access - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.type eq "ROLE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) - - # Get a paginated list of common access - - try { - Get-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CommonAccess" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-common-access#get-common-access - source: | - from sailpoint.v2025.api.iai_common_access_api import IAICommonAccessApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.common_access_response import CommonAccessResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.type eq \"ROLE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) - try: - # Get a paginated list of common access - - results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) - print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) - post: - operationId: createCommonAccess - summary: Create common access items - tags: - - IAI Common Access - description: This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - access: - $ref: '#/paths/~1common-access/get/responses/200/content/application~1json/schema/items/properties/access' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommonAccessItemAccess.yaml - status: - type: string - enum: - - CONFIRMED - - DENIED - description: State of common access item. - responses: - '202': - description: Returns details of the common access classification request. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: Common Access Item ID - access: - $ref: '#/paths/~1common-access/get/responses/200/content/application~1json/schema/items/properties/access' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommonAccessItemAccess.yaml - status: - $ref: '#/paths/~1common-access/post/requestBody/content/application~1json/schema/properties/status' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommonAccessItemState.yaml - lastUpdated: - type: string - reviewedByUser: - type: boolean - lastReviewed: - type: string - createdByUser: - type: string - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#create-common-access - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CommonAccessItemRequest = @" - { - "access" : { - "ownerName" : "ownerName", - "name" : "name", - "description" : "description", - "id" : "id", - "type" : "ACCESS_PROFILE", - "ownerId" : "ownerId" - }, - "status" : "CONFIRMED" - } - "@ - - # Create common access items - - try { - $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest - New-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CommonAccess" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-common-access#create-common-access - source: | - from sailpoint.v2025.api.iai_common_access_api import IAICommonAccessApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.common_access_item_request import CommonAccessItemRequest - from sailpoint.v2025.models.common_access_item_response import CommonAccessItemResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - common_access_item_request = '''{ - "access" : { - "ownerName" : "ownerName", - "name" : "name", - "description" : "description", - "id" : "id", - "type" : "ACCESS_PROFILE", - "ownerId" : "ownerId" - }, - "status" : "CONFIRMED" - }''' # CommonAccessItemRequest | - try: - # Create common access items - new_common_access_item_request = CommonAccessItemRequest.from_json(common_access_item_request) - results = IAICommonAccessApi(api_client).create_common_access(x_sail_point_experimental=x_sail_point_experimental, common_access_item_request=new_common_access_item_request) - # Below is a request that includes all optional parameters - # results = IAICommonAccessApi(api_client).create_common_access(x_sail_point_experimental, new_common_access_item_request) - print("The response of IAICommonAccessApi->create_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) - /common-access/update-status: - post: - operationId: updateCommonAccessStatusInBulk - summary: Bulk update common access status - tags: - - IAI Common Access - description: This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - requestBody: - description: Confirm or deny in bulk the common access ids that are (or aren't) common access - required: true - content: - application/json: - schema: - type: array - items: - type: object - properties: - confirmedIds: - description: List of confirmed common access ids. - type: array - items: - type: string - format: uuid - deniedIds: - description: List of denied common access ids. - type: array - items: - type: string - format: uuid - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#update-common-access-status-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CommonAccessIDStatus = @"{ - "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], - "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] - }"@ - - - # Bulk update common access status - - try { - $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus - Update-V2025CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result - - # Below is a request that includes all optional parameters - # Update-V2025CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CommonAccessStatusInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-common-access#update-common-access-status-in-bulk - source: | - from sailpoint.v2025.api.iai_common_access_api import IAICommonAccessApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.common_access_id_status import CommonAccessIDStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - common_access_id_status = '''[sailpoint.v2025.CommonAccessIDStatus()]''' # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access - try: - # Bulk update common access status - new_common_access_id_status = CommonAccessIdStatus.from_json(common_access_id_status) - results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(x_sail_point_experimental=x_sail_point_experimental, common_access_id_status=new_common_access_id_status) - # Below is a request that includes all optional parameters - # results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(x_sail_point_experimental, new_common_access_id_status) - print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) - /historical-identities/{id}/events: - get: - operationId: getHistoricalIdentityEvents - tags: - - Identity History - summary: Lists all events for the given identity - description: 'This method retrieves all access events for the identity Requires authorization scope of ''idn:identity-history:read'' ' - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listHistoricalIdentities - description: The identity id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: query - name: from - schema: - type: string - description: The optional instant until which access events are returned - example: '2024-03-01T13:00:00Z' - - in: query - name: eventTypes - schema: - type: array - items: - type: string - description: An optional list of event types to return. If null or empty, all events are returned - example: - - AccessAddedEvent - - AccessRemovedEvent - - in: query - name: accessItemTypes - schema: - type: array - items: - type: string - description: An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - example: - - entitlement - - account - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The list of events for the identity - content: - application/json: - schema: - type: array - items: - anyOf: - - type: object - properties: - accessItem: - type: object - oneOf: - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAccessProfileResponse.yaml - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAccountResponse.yaml - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAppResponse.yaml - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemEntitlementResponse.yaml - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/4' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemRoleResponse.yaml - example: - id: 8c190e6787aa4ed9a90bd9d5344523fb - accessType: account - nativeIdentity: 127999 - sourceName: JDBC Entitlements Source - entitlementCount: 0 - displayName: Sample Name - identityId: - type: string - description: the identity id - example: 8c190e6787aa4ed9a90bd9d5344523fb - eventType: - type: string - description: the event type - example: AccessItemAssociated - dt: - type: string - description: the date of event - example: '2019-03-08T22:37:33.901Z' - governanceEvent: - type: object - properties: - name: - type: string - description: The name of the governance event, such as the certification name or access request ID. - example: Manager Certification for Jon Snow - dt: - type: string - description: The date that the certification or access request was completed. - example: '2019-03-08T22:37:33.901Z' - type: - type: string - enum: - - certification - - accessRequest - description: The type of governance event. - example: certification - governanceId: - type: string - description: The ID of the instance that caused the event - either the certification ID or access request ID. - example: 2c91808a77ff216301782327a50f09bf - owners: - type: array - description: The owners of the governance event (the certifiers or approvers) - items: - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1events/get/responses/200/content/application~1json/schema/items/anyOf/4/properties/certifiers/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml - example: - - id: 8a80828f643d484f01643e14202e206f - displayName: John Snow - reviewers: - type: array - description: The owners of the governance event (the certifiers or approvers), this field should be preferred over owners - items: - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1events/get/responses/200/content/application~1json/schema/items/anyOf/4/properties/certifiers/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml - example: - - id: 8a80828f643d484f01643e14202e206f - displayName: John Snow - decisionMaker: - description: The decision maker - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1events/get/responses/200/content/application~1json/schema/items/anyOf/4/properties/certifiers/items' - example: - id: 8a80828f643d484f01643e14202e206f - displayName: John Snow - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml - - type: object - properties: - accessItem: - type: object - oneOf: - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAccessProfileResponse.yaml - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAccountResponse.yaml - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAppResponse.yaml - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemEntitlementResponse.yaml - - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/4' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemRoleResponse.yaml - example: - id: 8c190e6787aa4ed9a90bd9d5344523fb - accessType: account - nativeIdentity: 127999 - sourceName: JDBC Entitlements Source - entitlementCount: 0 - displayName: Sample Name - identityId: - type: string - description: the identity id - example: 8c190e6787aa4ed9a90bd9d5344523fb - eventType: - type: string - description: the event type - example: AccessItemRemoved - dt: - type: string - description: the date of event - example: '2019-03-08T22:37:33.901Z' - governanceEvent: - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1events/get/responses/200/content/application~1json/schema/items/anyOf/0/properties/governanceEvent' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CorrelatedGovernanceEvent.yaml - - type: object - properties: - changes: - type: array - items: - type: object - properties: - name: - type: string - description: the attribute name - previousValue: - type: string - description: the old value of attribute - newValue: - type: string - description: the new value of attribute - example: - name: firstname - previousValue: adam - newValue: zampa - eventType: - type: string - description: the event type - identityId: - type: string - description: the identity id - dt: - type: string - description: the date of event - example: - attributeChanges: - name: firstname - previousValue: adam - newValue: zampa - eventType: AttributesChanged - identityId: 8a80828f643d484f01643e14202e206f - dt: '2019-03-08T22:37:33.901Z' - - type: object - properties: - accessRequest: - type: object - properties: - requesterId: - type: string - example: 2c91808a77ff216301782327a50f09bf - description: the requester Id - requesterName: - type: string - example: Bing C - description: the requesterName - items: - type: array - example: - - operation: Add - accessItemType: role - name: Role-1 - decision: APPROVED - description: The role descrition - sourceId: 8a80828f643d484f01643e14202e206f - sourceName: Source1 - approvalInfos: - - name: John Snow - id: 8a80828f643d484f01643e14202e2000 - status: Approved - items: - type: object - properties: - operation: - type: string - example: Add - description: the access request item operation - accessItemType: - type: string - example: role - description: the access item type - name: - type: string - example: Role-1 - description: the name of access request item - decision: - type: string - example: APPROVED - enum: - - APPROVED - - REJECTED - description: the final decision for the access request - description: - type: string - example: The role descrition - description: the description of access request item - sourceId: - type: string - example: 8a80828f643d484f01643e14202e206f - description: the source id - sourceName: - type: string - example: Source1 - description: the source Name - approvalInfos: - type: array - example: - - name: John Snow - id: 8a80828f643d484f01643e14202e2000 - status: Approved - items: - type: object - properties: - id: - type: string - example: 8a80828f643d484f01643e14202e2000 - description: the id of approver - name: - type: string - example: John Snow - description: the name of approver - status: - type: string - example: Approved - description: the status of the approval request - identityId: - type: string - example: 8a80828f643d484f01643e14202e206f - description: the identity id - eventType: - type: string - example: AccessRequested - description: the event type - dt: - type: string - example: '2019-03-08T22:37:33.901Z' - description: the date of event - - type: object - properties: - certificationId: - type: string - description: the id of the certification item - example: 2c91808a77ff216301782327a50f09bf - certificationName: - type: string - description: the certification item name - example: Cert name - signedDate: - type: string - description: the date ceritification was signed - example: '2019-03-08T22:37:33.901Z' - certifiers: - type: array - description: this field is deprecated and may go away - items: - type: object - properties: - id: - type: string - description: the id of the certifier - example: 8a80828f643d484f01643e14202e206f - displayName: - type: string - description: the name of the certifier - example: John Snow - example: - - id: 8a80828f643d484f01643e14202e206f - displayName: John Snow - reviewers: - type: array - description: The list of identities who review this certification - items: - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1events/get/responses/200/content/application~1json/schema/items/anyOf/4/properties/certifiers/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml - example: - - id: 8a80828f643d484f01643e14202e206f - displayName: John Snow - signer: - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1events/get/responses/200/content/application~1json/schema/items/anyOf/4/properties/certifiers/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml - eventType: - type: string - description: the event type - example: IdentityCertified - dt: - type: string - description: the date of event - example: '2019-03-08T22:37:33.901Z' - - type: object - properties: - eventType: - type: string - description: the event type - identityId: - type: string - description: the identity id - dt: - type: string - description: the date of event - account: - type: object - properties: - id: - type: string - description: the ID of the account in the database - nativeIdentity: - type: string - description: the native identifier of the account - displayName: - type: string - description: the display name of the account - sourceId: - type: string - description: the ID of the source for this account - sourceName: - type: string - description: the name of the source for this account - entitlementCount: - type: integer - description: the number of entitlements on this account - accessType: - type: string - description: this value is always "account" - statusChange: - type: object - properties: - previousStatus: - type: string - description: the previous status of the account - enum: - - enabled - - disabled - - locked - newStatus: - type: string - description: the new status of the account - enum: - - enabled - - disabled - - locked - example: - account: - id: 2c91808a77ff216301782327a50f09bf - nativeIdentity: 127999 - displayName: Sample Name - sourceId: 8a80828f643d484f01643e14202e206f - sourceName: JDBC Entitlements Source - entitlementCount: 0 - accessType: account - statusChange: - previousStatus: enabled - newStatus: disabled - eventType: AccountStatusChanged - identityId: 8a80828f643d484f01643e14202e206f - date: '2019-03-08T22:37:33.901Z' - examples: - AccessItemAssociated: - description: An Access item associated event - value: - - accessItem: - id: 8c190e6787aa4ed9a90bd9d5344523fb - accessType: account - nativeIdentity: 127999 - sourceName: JDBC Entitlements Source - entitlementCount: 0 - displayName: Sample Name - eventType: AccessItemAssociated - identityId: 8a80828f643d484f01643e14202e206f - dt: '2019-03-08T22:37:33.901Z' - governanceEvent: - name: Access Request 58 - dt: '2019-03-08T22:37:33.901Z' - type: accessRequest - governanceId: 2c91808a77ff216301782327a50f09e1 - owners: - - id: bc693f07e7b645539626c25954c58554 - displayName: Jon Snow - reviewers: - - id: bc693f07e7b645539626c25954c58554 - displayName: Jon Snow - decisionMaker: - id: bc693f07e7b645539626c25954c58554 - displayName: Jon Snow - AccessItemRemoved: - description: An Access item removed event - value: - - accessItem: - id: 8c190e6787aa4ed9a90bd9d5344523fb - accessType: account - nativeIdentity: 127999 - sourceName: JDBC Entitlements Source - entitlementCount: 0 - displayName: Sample Name - eventType: AccessItemRemoved - identityId: 8a80828f643d484f01643e14202e206f - dt: '2019-03-08T22:37:33.901Z' - governanceEvent: - name: Manager Certification for Jon Snow - dt: '2019-03-08T22:37:33.901Z' - type: certification - governanceId: 2c91808a77ff216301782327a50f09bf - owners: - - id: bc693f07e7b645539626c25954c58554 - displayName: Jon Snow - reviewers: - - id: bc693f07e7b645539626c25954c58554 - displayName: Jon Snow - decisionMaker: - id: bc693f07e7b645539626c25954c58554 - displayName: Jon Snow - AttributesChanged: - description: An attribute changed event - value: - - attributeChanges: - - name: firstname - previousValue: adam - newValue: zampa - eventType: AttributesChanged - identityId: 8a80828f643d484f01643e14202e206f - dt: '2019-03-08T22:37:33.901Z' - AccessRequested: - description: An access requested event - value: - accessRequest: - requesterId: 2c91808a77ff216301782327a50f09bf - requestName: Bing C - items: - - operation: Add - accessItemType: role - name: Role-1 - decision: APPROVED - description: The role descrition - sourceId: 8a80828f643d484f01643e14202e206f - sourceName: Source1 - approvalInfos: - - name: John Snow - id: 8a80828f643d484f01643e14202e2000 - status: Approved - eventType: AccessRequested - identityId: 8a80828f643d484f01643e14202e206f - dt: '2019-03-08T22:37:33.901Z' - IdentityCertified: - description: An identity certified event - value: - - certification: - id: 2c91808a77ff216301782327a50f09bf - name: Cert name - signedDate: '2019-03-08T22:37:33.901Z' - certifiers: - - id: 8a80828f643d484f01643e14202e206f - displayName: John Snow - reviewers: - - id: 8a80828f643d484f01643e14202e206f - displayName: Daenerys Targaryen - signer: - id: 8a80828f643d484f01643e14202e206f - displayName: Tyrion Lannister - eventType: IdentityCertified - identityId: 8a80828f643d484f01643e14202e206f - dt: '2019-03-08T22:37:33.901Z' - AccountStatusChanged: - description: An account status changed event - value: - - account: - id: 2c91808a77ff216301782327a50f09bf - nativeIdentity: 127999 - displayName: Sample Name - sourceId: 8a80828f643d484f01643e14202e206f - sourceName: JDBC Entitlements Source - entitlementCount: 0 - accessType: account - statusChange: - previousStatus: ENABLED - newStatus: DISABLED - eventType: AccountStatusChanged - identityId: 8a80828f643d484f01643e14202e206f - dt: '2019-03-08T22:37:33.901Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-historical-identity-events - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) - $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) - - $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ - $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - $AccessItemTypes = @"[entitlement, account]"@ - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Lists all events for the given identity - - try { - Get-V2025HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentityEvents" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#get-historical-identity-events - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - var_from = '2024-03-01T13:00:00Z' # str | The optional instant until which access events are returned (optional) # str | The optional instant until which access events are returned (optional) - event_types = '''['[AccessAddedEvent, AccessRemovedEvent]']''' # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional) - access_item_types = '''['[entitlement, account]']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Lists all events for the given identity - - results = IdentityHistoryApi(api_client).get_historical_identity_events(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count) - print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) - /historical-identities/{id}/start-date: - get: - operationId: getIdentityStartDate - tags: - - Identity History - summary: Gets the start date of the identity - description: 'This method retrieves start date of the identity Requires authorization scope of ''idn:identity-history:read'' ' - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listHistoricalIdentities - description: The identity id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The start date of the identity - content: - application/json: - schema: - type: string - example: '2017-03-01T13:00:00.000Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-start-date - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Gets the start date of the identity - - try { - Get-V2025IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityStartDate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#get-identity-start-date - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Gets the start date of the identity - - results = IdentityHistoryApi(api_client).get_identity_start_date(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).get_identity_start_date(id, x_sail_point_experimental) - print("The response of IdentityHistoryApi->get_identity_start_date:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) - /historical-identities/{id}/compare: - get: - operationId: compareIdentitySnapshots - tags: - - Identity History - summary: Gets a difference of count for each access item types for the given identity between 2 snapshots - description: 'This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of ''idn:identity-history:read'' ' - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listHistoricalIdentities - description: The identity id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: query - name: snapshot1 - schema: - type: string - description: The snapshot 1 of identity - example: '2007-03-01T13:00:00Z' - - in: query - name: snapshot2 - schema: - type: string - description: The snapshot 2 of identity - example: '2008-03-01T13:00:00Z' - - in: query - name: accessItemTypes - schema: - type: array - items: - type: string - description: 'An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned ' - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: A IdentityCompare object with difference details for each access item type - content: - application/json: - schema: - type: array - items: - type: object - properties: - accessItemDiff: - type: object - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - additionalProperties: - type: object - example: - accessItemDiff: - role: - accessAdded: 2 - accessRemoved: 3 - entitlement: - accessAdded: 4 - accessRemoved: 0 - accessProfile: - accessAdded: 0 - accessRemoved: 1 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#compare-identity-snapshots - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) - $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) - $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets a difference of count for each access item types for the given identity between 2 snapshots - - try { - Compare-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Compare-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2025IdentitySnapshots" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#compare-identity-snapshots - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_compare_response import IdentityCompareResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - snapshot1 = '2007-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional) - snapshot2 = '2008-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (optional) - access_item_types = '''['access_item_types_example']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Gets a difference of count for each access item types for the given identity between 2 snapshots - - results = IdentityHistoryApi(api_client).compare_identity_snapshots(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count) - print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) - /historical-identities/{id}/compare/{access-type}: - get: - operationId: compareIdentitySnapshotsAccessType - tags: - - Identity History - summary: Gets a list of differences of specific accessType for the given identity between 2 snapshots - description: 'This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of ''idn:identity-history:read'' ' - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listHistoricalIdentities - description: The identity id - example: 8c190e6787aa4ed9a90bd9d5344523fb - - in: path - name: accessType - schema: - type: string - enum: - - accessProfile - - account - - app - - entitlement - - role - required: true - description: The specific type which needs to be compared - example: role - - in: query - name: access-associated - schema: - type: boolean - description: Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - example: '2007-03-01T13:00:00Z' - - in: query - name: snapshot1 - schema: - type: string - description: The snapshot 1 of identity - example: '2008-03-01T13:00:00Z' - - in: query - name: snapshot2 - schema: - type: string - description: The snapshot 2 of identity - example: '2009-03-01T13:00:00Z' - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: A list of events for the identity - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: the id of the access item - eventType: - type: string - enum: - - ADD - - REMOVE - displayName: - type: string - description: the display name of the access item - sourceName: - type: string - description: the source name of the access item - example: - id: 2c91808c7726345b017726a0a2fb013b - eventType: ADD - displayName: Test - sourceName: Source - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#compare-identity-snapshots-access-type - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $AccessType = "accessProfile" # String | The specific type which needs to be compared - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) - $Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) - $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets a list of differences of specific accessType for the given identity between 2 snapshots - - try { - Compare-V2025IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Compare-V2025IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2025IdentitySnapshotsAccessType" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-history#compare-identity-snapshots-access-type - source: | - from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_item_diff import AccessItemDiff - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id - access_type = 'role' # str | The specific type which needs to be compared # str | The specific type which needs to be compared - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - access_associated = 2007-03-01T13:00:00Z # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) - snapshot1 = '2008-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional) - snapshot2 = '2009-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Gets a list of differences of specific accessType for the given identity between 2 snapshots - - results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id=id, access_type=access_type, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count) - print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) - /identities/{identityId}/synchronize-attributes: - post: - operationId: synchronizeAttributesForIdentity - tags: - - Identities - summary: Attribute synchronization for single identity. - security: - - userAuth: [] - - applicationAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - parameters: - - in: path - name: identityId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentities - description: The Identity id - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '202': - description: An Identity Sync job - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: Job ID. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - status: - type: string - description: The job status. - enum: - - QUEUED - - IN_PROGRESS - - SUCCESS - - ERROR - example: IN_PROGRESS - payload: - type: object - properties: - type: - type: string - description: Payload type. - example: SYNCHRONIZE_IDENTITY_ATTRIBUTES - dataJson: - type: string - description: Payload type. - example: '{"identityId":"2c918083746f642c01746f990884012a"}' - required: - - type - - dataJson - required: - - id - - status - - payload - example: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3dfc - status: IN_PROGRESS - payload: - type: SYNCHRONIZE_IDENTITY_ATTRIBUTES - dataJson: '{"identityId":"2c918083746f642c01746f990884012a"}' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#synchronize-attributes-for-identity - source: | - $IdentityId = "MyIdentityId" # String | The Identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Attribute synchronization for single identity. - - try { - Sync-V2025hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Sync-V2025hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025hronizeAttributesForIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#synchronize-attributes-for-identity - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_sync_job import IdentitySyncJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Attribute synchronization for single identity. - - results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id, x_sail_point_experimental) - print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) - /identities/{identityId}/ownership: - get: - operationId: getIdentityOwnershipDetails - summary: Get ownership details - tags: - - Identities - description: |- - Use this API to return an identity's owned objects that will cause problems for deleting the identity. - Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. - For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects. - security: - - userAuth: - - idn:identity:read - parameters: - - in: path - name: identityId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentities - description: Identity ID. - example: ff8081814d2a8036014d701f3fbf53fa - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Identity's ownership association details. - content: - application/json: - schema: - type: object - properties: - associationDetails: - type: array - description: list of all the resource associations for the identity - items: - type: object - properties: - associationType: - type: string - description: association type with the identity - example: ROLE_OWNER - entities: - type: array - description: the specific resource this identity has ownership on - items: - type: object - properties: - identityEntity: - type: object - properties: - id: - type: string - description: id of the resource to which the identity is associated - example: 031034e97f094a4096c1be53f75f6b91 - name: - type: string - description: name of the resource to which the identity is associated - example: Gaston.800ddf9640a - type: - type: string - description: type of the resource to which the identity is associated - example: CAMPAIGN_CAMPAIGNER - example: - id: b660a232f05b4e04812ca974b3011e0f - name: Gaston.800ddf9640a - type: ROLE - example: - associationDetails: - associationType: ROLE_OWNER - entities: - - id: b660a232f05b4e04812ca974b3011e0f - name: Gaston.800ddf9640a - type: ROLE - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#get-identity-ownership-details - source: | - $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get ownership details - - try { - Get-V2025IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOwnershipDetails" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#get-identity-ownership-details - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_ownership_association_details import IdentityOwnershipAssociationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get ownership details - - results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id, x_sail_point_experimental) - print("The response of IdentitiesApi->get_identity_ownership_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) - /identities: - get: - operationId: listIdentities - tags: - - Identities - summary: List Identities - description: This API returns a list of identities. - security: - - userAuth: - - idn:identity:read - - idn:identity:manage - parameters: - - in: query - name: filters - schema: - type: string - required: false - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **alias**: *eq, sw* - - **firstname**: *eq, sw* - - **lastname**: *eq, sw* - - **email**: *eq, sw* - - **cloudStatus**: *eq* - - **processingState**: *eq* - - **correlated**: *eq* - - **protected**: *eq* - example: id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false - - in: query - name: sorters - schema: - type: string - format: comma-separated - required: false - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, alias, cloudStatus** - example: name,-cloudStatus - - in: query - name: defaultFilter - schema: - type: string - enum: - - CORRELATED_ONLY - - NONE - default: CORRELATED_ONLY - required: false - description: |- - Adds additional filter to filters query parameter. - - CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. - - NONE does not add any and returns all identities that satisfy filters query parameter. - example: NONE - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of identities. - content: - application/json: - schema: - type: array - items: - type: object - title: IdentityDto - required: - - name - properties: - id: - description: System-generated unique ID of the identity - type: string - example: 01f04e428c484542a241dc89c303b178 - readOnly: true - name: - description: The identity's name is equivalent to its Display Name attribute. - type: string - example: Walter White - created: - description: Creation date of the identity - type: string - format: date-time - readOnly: true - example: '2023-01-03T21:16:22.432Z' - modified: - description: Last modification date of the identity - type: string - format: date-time - readOnly: true - example: '2023-01-03T21:16:22.432Z' - alias: - type: string - description: The identity's alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. - example: walter.white - emailAddress: - type: string - description: The email address of the identity - example: walter.white@example.com - nullable: true - processingState: - type: string - nullable: true - description: The processing state of the identity - enum: - - ERROR - - OK - - null - example: ERROR - identityStatus: - type: string - description: The identity's status in the system - enum: - - UNREGISTERED - - REGISTERED - - PENDING - - WARNING - - DISABLED - - ACTIVE - - DEACTIVATED - - TERMINATED - - ERROR - - LOCKED - example: LOCKED - managerRef: - type: object - description: Identity's manager - nullable: true - properties: - type: - type: string - description: DTO type of identity's manager - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity's manager - example: 2c4180a46faadee4016fb4e018c20626 - name: - type: string - description: Human-readable display name of identity's manager - example: Robert Robinson - isManager: - type: boolean - description: Whether this identity is a manager of another identity - default: false - example: true - lastRefresh: - type: string - format: date-time - description: The last time the identity was refreshed by the system - example: '2020-11-22T15:42:31.123Z' - attributes: - type: object - description: A map with the identity attributes for the identity - example: - uid: '86754' - firstname: Walter - cloudStatus: UNREGISTERED - displayName: Walter White - identificationNumber: '86754' - lastSyncDate: 1470348809380 - email: walter.white@example.com - lastname: White - lifecycleState: - allOf: - - type: object - properties: - stateName: - type: string - description: The name of the lifecycle state - example: active - manuallyUpdated: - type: boolean - description: Whether the lifecycle state has been manually or automatically set - example: true - required: - - stateName - - manuallyUpdated - - nullable: true - description: Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#list-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) - $Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) - $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Identities - - try { - Get-V2025Identities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Identities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Identities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#list-identities - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity import Identity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'id eq \"6c9079b270a266a60170a2779fcb0006\" or correlated eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) - sorters = 'name,-cloudStatus' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) - default_filter = CORRELATED_ONLY # str | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to CORRELATED_ONLY) # str | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to CORRELATED_ONLY) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Identities - - results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) - print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) - /identities/{id}: - get: - operationId: getIdentity - tags: - - Identities - summary: Identity Details - description: This API returns a single identity using the Identity ID. - security: - - userAuth: - - idn:identity:read - - idn:identity:manage - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentities - description: Identity Id - example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: An identity object - content: - application/json: - schema: - $ref: '#/paths/~1identities/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Identity.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#get-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Identity Details - - try { - Get-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Identity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#get-identity - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity import Identity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Identity Details - - results = IdentitiesApi(api_client).get_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).get_identity(id, x_sail_point_experimental) - print("The response of IdentitiesApi->get_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) - delete: - operationId: deleteIdentity - tags: - - Identities - summary: Delete identity - description: The API returns successful response if the requested identity was deleted. - security: - - userAuth: - - idn:identity:delete - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentities - description: Identity Id - example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - description: Client Error - Returned if the request is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted. - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: any additional context information of the http call result - example: Identity cannot be deleted as it is owner of following resources - associationDetails: - type: array - description: list of all the resource associations for the identity - items: - type: object - properties: - associationType: - type: string - description: association type with the identity - example: CAMPAIGN_OWNER - entities: - type: array - description: the specific resource this identity has ownership on - items: - $ref: '#/paths/~1identities~1%7BidentityId%7D~1ownership/get/responses/200/content/application~1json/schema/properties/associationDetails/items/properties/entities/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityEntities.yaml - example: - id: b660a232f05b4e04812ca974b3011e0f - name: Gaston.800ddf9640a - type: CAMPAIGN_CAMPAIGNER - example: - message: Identity is the owner of following resources - associationDetails: - associationType: CAMPAIGN_OWNER - entities: - - id: b660a232f05b4e04812ca974b3011e0f - name: Gaston.800ddf9640a - type: CAMPAIGN_CAMPAIGNER - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#delete-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete identity - - try { - Remove-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Identity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#delete-identity - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete identity - - IdentitiesApi(api_client).delete_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # IdentitiesApi(api_client).delete_identity(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) - /identities/invite: - post: - operationId: startIdentitiesInvite - tags: - - Identities - summary: Invite identities to register - description: | - This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. - - This task will send an invitation email only for unregistered identities. - - The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - externalDocs: - description: Learn more about inviting identities here - url: https://documentation.sailpoint.com/saas/help/common/users/inviting_users.html - x-sailpoint-userLevels: - - ORG_ADMIN - - HELPDESK - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - ids: - description: The list of Identities IDs to invite - required when 'uninvited' is false - type: array - items: - type: string - nullable: true - example: - - 2b568c65bc3c4c57a43bd97e3a8e55 - - 2c9180867769897d01776ed5f125512f - uninvited: - description: indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when 'ids' is empty. - type: boolean - default: false - example: false - responses: - '202': - description: Responds with an initial TaskStatus for the executed task - content: - application/json: - schema: - description: Details and current status of a specific task - required: - - id - - type - - uniqueName - - description - - parentName - - attributes - - created - - modified - - launched - - launcher - - completed - - completionStatus - - messages - - progress - - percentComplete - - returns - type: object - properties: - id: - description: System-generated unique ID of the task this TaskStatus represents - type: string - example: id12345 - type: - description: Type of task this TaskStatus represents - type: string - enum: - - QUARTZ - - QPOC - - QUEUED_TASK - example: QUARTZ - uniqueName: - description: Name of the task this TaskStatus represents - type: string - example: Big Task - description: - description: Description of the task this TaskStatus represents - type: string - example: A Really Big Task - parentName: - description: Name of the parent of the task this TaskStatus represents - nullable: true - type: string - example: Parent Task - launcher: - description: Service to execute the task this TaskStatus represents - type: string - example: sweep - target: - type: object - nullable: true - properties: - id: - description: Target ID - type: string - example: c6dc37bf508149b28ce5b7d90ca4bbf9 - type: - description: Target type - type: string - nullable: true - enum: - - APPLICATION - - IDENTITY - - null - example: APPLICATION - name: - description: Target name - type: string - example: Active Directory [source] - created: - description: Creation date of the task this TaskStatus represents - type: string - format: date-time - example: '2020-07-11T21:23:15.000Z' - modified: - description: Last modification date of the task this TaskStatus represents - type: string - format: date-time - example: '2020-07-11T21:23:15.000Z' - launched: - description: Launch date of the task this TaskStatus represents - nullable: true - type: string - format: date-time - example: '2020-07-11T21:23:15.000Z' - completed: - description: Completion date of the task this TaskStatus represents - nullable: true - type: string - format: date-time - example: '2020-07-11T21:23:15.000Z' - completionStatus: - description: Completion status of the task this TaskStatus represents - type: string - nullable: true - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMPERROR - - null - example: SUCCESS - messages: - description: Messages associated with the task this TaskStatus represents - type: array - items: - description: TaskStatus Message - required: - - key - - localizedText - - type - - parameters - type: object - properties: - type: - description: Type of the message - type: string - enum: - - INFO - - WARN - - ERROR - example: INFO - localizedText: - type: object - nullable: true - description: Localized error message to indicate a failed invocation or error if any. - required: - - locale - - message - properties: - locale: - description: Message locale - type: string - example: An error has occurred! - message: - description: Message text - type: string - example: Error has occurred! - key: - description: Key of the message - type: string - example: akey - parameters: - description: Message parameters for internationalization - nullable: true - type: array - items: - anyOf: - - type: object - - type: string - example: - - name: value - returns: - description: Return values from the task this TaskStatus represents - type: array - items: - description: Task return details - required: - - name - - attributeName - type: object - properties: - name: - description: Display name of the TaskReturnDetails - type: string - example: label - attributeName: - description: Attribute the TaskReturnDetails is for - type: string - example: identityCount - attributes: - description: Attributes of the task this TaskStatus represents - type: object - additionalProperties: true - example: - identityCount: 0 - progress: - description: Current progress of the task this TaskStatus represents - nullable: true - type: string - example: Started - percentComplete: - description: Current percentage completion of the task this TaskStatus represents - type: integer - example: 100 - taskDefinitionSummary: - description: Definition of a type of task, used to invoke tasks - required: - - arguments - - description - - executor - - id - - uniqueName - - parentName - type: object - properties: - id: - description: System-generated unique ID of the TaskDefinition - type: string - example: 2c91808475b4334b0175e1dff64b63c5 - uniqueName: - description: Name of the TaskDefinition - type: string - example: Cloud Account Aggregation - description: - nullable: true - description: Description of the TaskDefinition - type: string - example: Aggregates from the specified application. - parentName: - description: Name of the parent of the TaskDefinition - type: string - example: Cloud Account Aggregation - executor: - description: Executor of the TaskDefinition - nullable: true - type: string - example: sailpoint.task.ServiceTaskExecutor - arguments: - description: Formal parameters of the TaskDefinition, without values - type: object - additionalProperties: true - example: - mantisExecutor: com.sailpoint.mantis.sources.task.AccountAggregationTask - eventClassesCsv: sailpoint.thunderbolt.events.AggregationEvents - serviceClass: sailpoint.thunderbolt.service.AggregationService - serviceMethod: accountAggregationTask - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#start-identities-invite - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $InviteIdentitiesRequest = @" - { - "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], - "uninvited" : false - } - "@ - - # Invite identities to register - - try { - $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest - Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result - - # Below is a request that includes all optional parameters - # Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentitiesInvite" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#start-identities-invite - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.invite_identities_request import InviteIdentitiesRequest - from sailpoint.v2025.models.task_status import TaskStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - invite_identities_request = '''{ - "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], - "uninvited" : false - }''' # InviteIdentitiesRequest | - try: - # Invite identities to register - new_invite_identities_request = InviteIdentitiesRequest.from_json(invite_identities_request) - results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental=x_sail_point_experimental, invite_identities_request=new_invite_identities_request) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental, new_invite_identities_request) - print("The response of IdentitiesApi->start_identities_invite:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) - /identities/{id}/verification/account/send: - post: - operationId: sendIdentityVerificationAccountToken - tags: - - Identities - summary: Send password reset email - description: | - This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - x-sailpoint-userLevels: - - ORG_ADMIN - - HELPDESK - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - - in: path - name: id - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: listIdentities - description: Identity ID - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - sourceName: - description: The source name where identity account password should be reset - type: string - nullable: true - example: Active Directory Source - via: - description: The method to send notification - type: string - enum: - - EMAIL_WORK - - EMAIL_PERSONAL - - LINK_WORK - - LINK_PERSONAL - example: EMAIL_WORK - required: - - via - responses: - '200': - description: The email was successfully sent - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#send-identity-verification-account-token - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - $SendAccountVerificationRequest = @" - { - "sourceName" : "Active Directory Source", - "via" : "EMAIL_WORK" - } - "@ - - # Send password reset email - - try { - $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest - Send-V2025IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2025IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025IdentityVerificationAccountToken" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#send-identity-verification-account-token - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.send_account_verification_request import SendAccountVerificationRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID - send_account_verification_request = '''{ - "sourceName" : "Active Directory Source", - "via" : "EMAIL_WORK" - }''' # SendAccountVerificationRequest | - try: - # Send password reset email - new_send_account_verification_request = SendAccountVerificationRequest.from_json(send_account_verification_request) - IdentitiesApi(api_client).send_identity_verification_account_token(x_sail_point_experimental=x_sail_point_experimental, id=id, send_account_verification_request=new_send_account_verification_request) - # Below is a request that includes all optional parameters - # IdentitiesApi(api_client).send_identity_verification_account_token(x_sail_point_experimental, id, new_send_account_verification_request) - except Exception as e: - print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) - /identities/process: - post: - operationId: startIdentityProcessing - tags: - - Identities - summary: Process a list of identityIds - description: |- - This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. - - This endpoint will perform the following tasks: - 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change). - 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. - 3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health). - 4. Recalculate manager relationships. - 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - externalDocs: - description: Learn more about manually processing identities here - url: https://documentation.sailpoint.com/saas/help/setup/identity_processing.html - security: - - userAuth: - - idn:identity:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - HELPDESK - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - identityIds: - type: array - minItems: 1 - maxItems: 250 - description: List of up to 250 identity IDs to process. - items: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - description: Object containing the DTO type TASK_RESULT and the job id for the task - content: - application/json: - schema: - type: object - properties: - type: - type: string - description: the type of response reference - example: TASK_RESULT - id: - type: string - description: the task ID - example: 78733556-9ea3-4f59-bf69-e5cd92b011b4 - name: - type: string - description: the task name (not used in this endpoint, always null) - example: 'null' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#start-identity-processing - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ProcessIdentitiesRequest = @" - { - "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] - } - "@ - - # Process a list of identityIds - - try { - $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest - Start-V2025IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result - - # Below is a request that includes all optional parameters - # Start-V2025IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentityProcessing" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#start-identity-processing - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.process_identities_request import ProcessIdentitiesRequest - from sailpoint.v2025.models.task_result_response import TaskResultResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - process_identities_request = '''{ - "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] - }''' # ProcessIdentitiesRequest | - try: - # Process a list of identityIds - new_process_identities_request = ProcessIdentitiesRequest.from_json(process_identities_request) - results = IdentitiesApi(api_client).start_identity_processing(x_sail_point_experimental=x_sail_point_experimental, process_identities_request=new_process_identities_request) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).start_identity_processing(x_sail_point_experimental, new_process_identities_request) - print("The response of IdentitiesApi->start_identity_processing:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) - /identities/{id}/reset: - post: - operationId: resetIdentity - tags: - - Identities - summary: Reset an identity - description: Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - security: - - userAuth: - - idn:identity:update - parameters: - - in: path - name: identityId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentities - description: Identity Id - example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '202': - description: Accepted. The reset request accepted and is in progress. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#reset-identity - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Reset an identity - - try { - Reset-V2025Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Reset-V2025Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025Identity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#reset-identity - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Reset an identity - - IdentitiesApi(api_client).reset_identity(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # IdentitiesApi(api_client).reset_identity(identity_id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) - /identities/{identityId}/role-assignments: - get: - operationId: getRoleAssignments - tags: - - Identities - summary: List role assignments - description: This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - security: - - userAuth: - - idn:identity:read - parameters: - - in: path - name: identityId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentities - description: Identity Id to get the role assignments for - example: ef38f94347e94562b5bb8424a56397d8 - - in: query - name: roleId - schema: - type: string - required: false - description: Role Id to filter the role assignments with - example: e7697a1e96d04db1ac7b0f4544915d2c - - in: query - name: roleName - schema: - type: string - required: false - description: Role name to filter the role assignments with - example: Engineer - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: A role assignment object - content: - application/json: - schema: - type: array - items: - anyOf: - - type: object - properties: - id: - type: string - description: Assignment Id - example: 1cbb0705b38c4226b1334eadd8874086 - role: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - description: Role Id and Name related to this assignment - example: - id: e7697a1e96d04db1ac7b0f4544915d2c - type: ROLE - name: Engineer - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml - - type: object - properties: - id: - type: string - description: Assignment Id - example: 1cbb0705b38c4226b1334eadd8874086 - role: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - description: Role Id and Name related to this assignment - example: - id: e7697a1e96d04db1ac7b0f4544915d2c - type: ROLE - name: Engineer - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml - comments: - type: string - nullable: true - description: Comments added by the user when the assignment was made - example: I'm a new Engineer and need this role to do my work - assignmentSource: - type: string - description: Source describing how this assignment was made - example: UI - assigner: - type: object - description: The identity that performed the assignment. This could be blank or system - properties: - type: - type: string - enum: - - IDENTITY - - UNKNOWN - description: Object type - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - nullable: true - description: Human-readable display name of the object to which this reference applies - example: William Wilson - assignedDimensions: - type: array - description: Dimensions assigned related to this role - example: - - id: 1acc8ffe5fcf457090de28bee2af36ee - type: DIMENSION - name: Northeast region - items: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml - assignmentContext: - allOf: - - type: object - properties: - requested: - type: object - properties: - contextAttributes: - type: array - items: - type: object - properties: - attribute: - type: string - description: The name of the attribute - example: location - value: - oneOf: - - type: string - example: Austin - - type: array - items: - type: string - example: - - Austin - - Houston - - Dallas - description: The value of the attribute. This can be either a string or a multi-valued string - example: Austin - derived: - type: boolean - description: True if the attribute was derived. - default: false - example: false - matched: - type: array - items: - type: object - properties: - roleRef: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - description: Role Id and Name related to this match - example: - id: e7697a1e96d04db1ac7b0f4544915d2c - type: DIMENSION - name: Engineer - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml - matchedAttributes: - type: array - items: - $ref: '#/paths/~1identities~1%7BidentityId%7D~1role-assignments/get/responses/200/content/application~1json/schema/items/anyOf/1/properties/assignmentContext/allOf/0/properties/requested/properties/contextAttributes/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ContextAttributeDto.yaml - computedDate: - type: string - description: Date that the assignment will was evaluated - example: Wed Feb 14 10:58:42 - - nullable: true - description: The context around the role assignment - example: - requested: - contextAttributes: - - attribute: department - value: Engineering - derived: false - matched: - - id: e7697a1e96d04db1ac7b0f4544915d2c - type: DIMENSION - name: Engineer - computedDate: Wed Feb 14 10:58:42 - accountTargets: - type: array - items: - type: object - properties: - source: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - description: Source Id and Name related to this assignment - example: - id: d18b74853739439986501ad180b27db6 - type: SOURCE - name: Active Directory - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml - accountInfo: - type: object - properties: - nativeIdentity: - type: string - description: The unique ID of the account generated by the source system - example: CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com - displayName: - type: string - description: Display name for this account - example: Abby.Smith - uuid: - type: string - description: UUID associated with this account - example: '{ad9fc391-246d-40af-b248-b6556a2b7c01}' - roleName: - type: string - description: Specific role name for this target if using multiple accounts - example: Marketing - removeDate: - type: string - nullable: true - description: Date that the assignment will be removed - example: Wed Feb 14 10:58:42 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#get-role-assignments - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) - $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) - - # List role assignments - - try { - Get-V2025RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -RoleId $RoleId -RoleName $RoleName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignments" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#get-role-assignments - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_role_assignments200_response_inner import GetRoleAssignments200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - role_id = 'e7697a1e96d04db1ac7b0f4544915d2c' # str | Role Id to filter the role assignments with (optional) # str | Role Id to filter the role assignments with (optional) - role_name = 'Engineer' # str | Role name to filter the role assignments with (optional) # str | Role name to filter the role assignments with (optional) - try: - # List role assignments - - results = IdentitiesApi(api_client).get_role_assignments(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) - print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) - /identities/{identityId}/role-assignments/{assignmentId}: - get: - operationId: getRoleAssignment - tags: - - Identities - summary: Role assignment details - security: - - userAuth: - - idn:identity:read - parameters: - - in: path - name: identityId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listIdentities - description: Identity Id - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: assignmentId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleAssignments - description: Assignment Id - example: 1cbb0705b38c4226b1334eadd8874086 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: A role assignment object - content: - application/json: - schema: - $ref: '#/paths/~1identities~1%7BidentityId%7D~1role-assignments/get/responses/200/content/application~1json/schema/items/anyOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleAssignmentDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#get-role-assignment - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Role assignment details - - try { - Get-V2025RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identities#get-role-assignment - source: | - from sailpoint.v2025.api.identities_api import IdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_assignment_dto import RoleAssignmentDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id - assignment_id = '1cbb0705b38c4226b1334eadd8874086' # str | Assignment Id # str | Assignment Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Role assignment details - - results = IdentitiesApi(api_client).get_role_assignment(identity_id=identity_id, assignment_id=assignment_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id, x_sail_point_experimental) - print("The response of IdentitiesApi->get_role_assignment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) - /identity-attributes: - get: - operationId: listIdentityAttributes - tags: - - Identity Attributes - summary: List Identity Attributes - description: Use this API to get a collection of identity attributes. - security: - - userAuth: - - idn:identity-profile-attribute-list:read - parameters: - - in: query - name: includeSystem - schema: - type: boolean - default: false - description: Include 'system' attributes in the response. - required: false - example: false - - in: query - name: includeSilent - schema: - type: boolean - default: false - description: Include 'silent' attributes in the response. - required: false - example: false - - in: query - name: searchableOnly - schema: - type: boolean - default: false - description: Include only 'searchable' attributes in the response. - required: false - example: false - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of identity attributes. - content: - application/json: - schema: - type: array - items: - type: object - required: - - name - properties: - name: - type: string - description: Identity attribute's technical name. - example: costCenter - displayName: - type: string - description: Identity attribute's business-friendly name. - example: Cost Center - standard: - type: boolean - description: Indicates whether the attribute is 'standard' or 'default'. - default: false - example: false - type: - type: string - description: Identity attribute's type. - nullable: true - example: string - multi: - type: boolean - description: Indicates whether the identity attribute is multi-valued. - default: false - example: false - searchable: - type: boolean - description: Indicates whether the identity attribute is searchable. - default: false - example: false - system: - type: boolean - description: Indicates whether the identity attribute is 'system', meaning that it doesn't have a source and isn't configurable. - default: false - example: false - sources: - description: Identity attribute's list of sources - this specifies how the rule's value is derived. - type: array - items: - type: object - properties: - type: - type: string - description: Attribute mapping type. - example: rule - properties: - type: object - description: Attribute mapping properties. - example: - ruleType: IdentityAttribute - ruleName: Cloud Promote Identity Attribute - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#list-identity-attributes - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) - $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) - $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Identity Attributes - - try { - Get-V2025IdentityAttributes -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAttributes -XSailPointExperimental $XSailPointExperimental -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-attributes#list-identity-attributes - source: | - from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_attribute import IdentityAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - include_system = False # bool | Include 'system' attributes in the response. (optional) (default to False) # bool | Include 'system' attributes in the response. (optional) (default to False) - include_silent = False # bool | Include 'silent' attributes in the response. (optional) (default to False) # bool | Include 'silent' attributes in the response. (optional) (default to False) - searchable_only = False # bool | Include only 'searchable' attributes in the response. (optional) (default to False) # bool | Include only 'searchable' attributes in the response. (optional) (default to False) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Identity Attributes - - results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) - print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) - post: - operationId: createIdentityAttribute - tags: - - Identity Attributes - summary: Create Identity Attribute - description: Use this API to create a new identity attribute. - security: - - userAuth: - - idn:identity-profile-attribute:create - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1identity-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/identity-attributes/IdentityAttribute.yaml - responses: - '201': - description: The identity attribute was created successfully. - content: - application/json: - schema: - $ref: '#/paths/~1identity-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/identity-attributes/IdentityAttribute.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#create-identity-attribute - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityAttribute = @" - { - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - } - "@ - - # Create Identity Attribute - - try { - $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - New-V2025IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - - # Below is a request that includes all optional parameters - # New-V2025IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-attributes#create-identity-attribute - source: | - from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_attribute import IdentityAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_attribute = '''{ - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - }''' # IdentityAttribute | - try: - # Create Identity Attribute - new_identity_attribute = IdentityAttribute.from_json(identity_attribute) - results = IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental=x_sail_point_experimental, identity_attribute=new_identity_attribute) - # Below is a request that includes all optional parameters - # results = IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental, new_identity_attribute) - print("The response of IdentityAttributesApi->create_identity_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) - /identity-attributes/{name}: - get: - operationId: getIdentityAttribute - tags: - - Identity Attributes - summary: Get Identity Attribute - description: This gets an identity attribute for a given technical name. - security: - - userAuth: - - idn:identity-profile-attribute:read - parameters: - - in: path - name: name - schema: - type: string - description: The attribute's technical name. - required: true - x-sailpoint-resource-operation-id: listIdentityAttributes - example: displayName - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The identity attribute with the given name - content: - application/json: - schema: - $ref: '#/paths/~1identity-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/identity-attributes/IdentityAttribute.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#get-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Identity Attribute - - try { - Get-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-attributes#get-identity-attribute - source: | - from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_attribute import IdentityAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Identity Attribute - - results = IdentityAttributesApi(api_client).get_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IdentityAttributesApi(api_client).get_identity_attribute(name, x_sail_point_experimental) - print("The response of IdentityAttributesApi->get_identity_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) - put: - operationId: putIdentityAttribute - tags: - - Identity Attributes - summary: Update Identity Attribute - description: This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - security: - - userAuth: - - idn:identity-profile-attribute:create - parameters: - - in: path - name: name - schema: - type: string - description: The attribute's technical name. - required: true - x-sailpoint-resource-operation-id: listIdentityAttributes - example: displayName - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1identity-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/identity-attributes/IdentityAttribute.yaml - responses: - '200': - description: The identity attribute was updated successfully - content: - application/json: - schema: - $ref: '#/paths/~1identity-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/identity-attributes/IdentityAttribute.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#put-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityAttribute = @" - { - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - } - "@ - - # Update Identity Attribute - - try { - $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - Send-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - - # Below is a request that includes all optional parameters - # Send-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025IdentityAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-attributes#put-identity-attribute - source: | - from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_attribute import IdentityAttribute - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_attribute = '''{ - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - }''' # IdentityAttribute | - try: - # Update Identity Attribute - new_identity_attribute = IdentityAttribute.from_json(identity_attribute) - results = IdentityAttributesApi(api_client).put_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental, identity_attribute=new_identity_attribute) - # Below is a request that includes all optional parameters - # results = IdentityAttributesApi(api_client).put_identity_attribute(name, x_sail_point_experimental, new_identity_attribute) - print("The response of IdentityAttributesApi->put_identity_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) - delete: - operationId: deleteIdentityAttribute - tags: - - Identity Attributes - summary: Delete Identity Attribute - description: This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - security: - - userAuth: - - idn:identity-profile-attribute:delete - parameters: - - in: path - name: name - schema: - type: string - description: The attribute's technical name. - required: true - x-sailpoint-resource-operation-id: listIdentityAttributes - example: displayName - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#delete-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Identity Attribute - - try { - Remove-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityAttribute" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-attributes#delete-identity-attribute - source: | - from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete Identity Attribute - - IdentityAttributesApi(api_client).delete_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # IdentityAttributesApi(api_client).delete_identity_attribute(name, x_sail_point_experimental) - except Exception as e: - print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) - /identity-attributes/bulk-delete: - delete: - operationId: deleteIdentityAttributesInBulk - tags: - - Identity Attributes - summary: Bulk delete Identity Attributes - description: Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. - security: - - userAuth: - - idn:identity-profile-attribute-bulk:delete - requestBody: - required: true - content: - application/json: - schema: - type: object - description: Identity attribute IDs. - properties: - ids: - description: List of identity attributes' technical names. - type: array - items: - type: string - example: name - example: - - name - - displayName - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#delete-identity-attributes-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityAttributeNames = @" - { - "ids" : [ "name", "displayName" ] - } - "@ - - # Bulk delete Identity Attributes - - try { - $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames - Remove-V2025IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result - - # Below is a request that includes all optional parameters - # Remove-V2025IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityAttributesInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/identity-attributes#delete-identity-attributes-in-bulk - source: | - from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_attribute_names import IdentityAttributeNames - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_attribute_names = '''{ - "ids" : [ "name", "displayName" ] - }''' # IdentityAttributeNames | - try: - # Bulk delete Identity Attributes - new_identity_attribute_names = IdentityAttributeNames.from_json(identity_attribute_names) - IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental=x_sail_point_experimental, identity_attribute_names=new_identity_attribute_names) - # Below is a request that includes all optional parameters - # IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental, new_identity_attribute_names) - except Exception as e: - print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) - /mail-from-attributes: - put: - security: - - userAuth: - - sp:notification-mail-from-attributes:write - operationId: putMailFromAttributes - tags: - - Notifications - summary: Change MAIL FROM domain - description: Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - identity: - type: string - example: BobSmith@sailpoint.com - description: The identity or domain address - mailFromDomain: - type: string - example: example.sailpoint.com - description: The new MAIL FROM domain of the identity. Must be a subdomain of the identity. - description: MAIL FROM attributes for a domain / identity - example: - identity: BobSmith@sailpoint.com - mailFromDomain: example.sailpoint.com - responses: - '200': - description: MAIL FROM Attributes required to verify the change - content: - application/json: - schema: - type: object - properties: - identity: - type: string - example: bob.smith@sailpoint.com - description: The email identity - mailFromDomain: - type: string - example: foo.sailpoint.com - description: The name of a domain that an email identity uses as a custom MAIL FROM domain - mxRecord: - type: string - example: 10 feedback-smtp.us-east-1.amazonses.com - description: MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you - txtRecord: - type: string - example: v=spf1 include:amazonses.com ~all - description: TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain - mailFromDomainStatus: - type: string - enum: - - PENDING - - SUCCESS - - FAILED - example: PENDING - description: The current status of the MAIL FROM verification - description: MAIL FROM attributes for a domain / identity - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#put-mail-from-attributes - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MailFromAttributesDto = @" - { - "identity" : "BobSmith@sailpoint.com", - "mailFromDomain" : "example.sailpoint.com" - } - "@ - - # Change MAIL FROM domain - - try { - $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto - Send-V2025MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result - - # Below is a request that includes all optional parameters - # Send-V2025MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025MailFromAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#put-mail-from-attributes - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mail_from_attributes import MailFromAttributes - from sailpoint.v2025.models.mail_from_attributes_dto import MailFromAttributesDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - mail_from_attributes_dto = '''{ - "identity" : "BobSmith@sailpoint.com", - "mailFromDomain" : "example.sailpoint.com" - }''' # MailFromAttributesDto | - try: - # Change MAIL FROM domain - new_mail_from_attributes_dto = MailFromAttributesDto.from_json(mail_from_attributes_dto) - results = NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental=x_sail_point_experimental, mail_from_attributes_dto=new_mail_from_attributes_dto) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental, new_mail_from_attributes_dto) - print("The response of NotificationsApi->put_mail_from_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) - /mail-from-attributes/{identity}: - get: - security: - - userAuth: - - sp:notification-mail-from-attributes:read - operationId: getMailFromAttributes - tags: - - Notifications - summary: Get MAIL FROM Attributes - description: Retrieve MAIL FROM attributes for a given AWS SES identity. - parameters: - - in: query - name: id - required: true - schema: - type: string - description: Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - example: bobsmith@sailpoint.com - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: MAIL FROM Attributes object - content: - application/json: - schema: - $ref: '#/paths/~1mail-from-attributes/put/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MailFromAttributes.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-mail-from-attributes - source: | - $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get MAIL FROM Attributes - - try { - Get-V2025MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MailFromAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#get-mail-from-attributes - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mail_from_attributes import MailFromAttributes - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get MAIL FROM Attributes - - results = NotificationsApi(api_client).get_mail_from_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).get_mail_from_attributes(id, x_sail_point_experimental) - print("The response of NotificationsApi->get_mail_from_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) - /generic-approvals: - get: - security: - - userAuth: - - sp:approvals:read - operationId: getApprovals - tags: - - Approvals - summary: Get Approvals - description: |- - Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. "Mine" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. - Absence of all query parameters will will default to mine=true. - parameters: - - in: query - name: mine - schema: - type: boolean - description: Returns the list of approvals for the current caller - example: 'true' - - in: query - name: requesterId - schema: - type: string - description: Returns the list of approvals for a given requester ID - example: 17e633e7d57e481569df76323169deb6a - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **status**: *eq* - - **referenceType**: *eq* - example: filters=status eq PENDING - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of Approvals - content: - application/json: - schema: - type: array - items: - type: object - properties: - approvalId: - type: string - example: 38453251-6be2-5f8f-df93-5ce19e295837 - description: The Approval ID - approvers: - type: array - items: - type: object - properties: - id: - type: string - example: 85d173e7d57e496569df763231d6deb6a - description: The identity ID - type: - type: string - enum: - - IDENTITY - example: IDENTITY - description: Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc - name: - type: string - example: John Doe - description: Name of the identity - description: Identity Object - description: Object representation of an approver of an approval - createdDate: - type: string - example: '2023-04-12T23:20:50.520Z' - description: Date the approval was created - type: - type: string - example: ENTITLEMENT_DESCRIPTIONS - description: Type of approval - name: - type: array - items: - type: object - properties: - value: - type: string - example: Audit DB Access - description: Name of the approval - locale: - type: string - example: en_US - description: What locale the name of the approval is using - description: Approval Name Object - description: The name of the approval for a given locale - batchRequest: - type: object - properties: - batchId: - type: string - example: 38453251-6be2-5f8f-df93-5ce19e295837 - description: ID of the batch - batchSize: - type: integer - format: int64 - example: 100 - description: How many approvals are going to be in this batch. Defaults to 1 if not provided. - description: Batch properties if an approval is sent via batching. - description: - type: array - items: - type: object - properties: - value: - type: string - example: This access allows viewing and editing of workflow resource - description: The description of what the approval is asking for - locale: - type: string - example: en_US - description: What locale the description of the approval is using - description: The description of what the approval is asking for - description: The description of the approval for a given locale - priority: - type: string - enum: - - HIGH - - MEDIUM - - LOW - example: HIGH - description: The priority of the approval - requester: - $ref: '#/paths/~1generic-approvals/get/responses/200/content/application~1json/schema/items/properties/approvers/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalIdentity.yaml - comments: - type: array - items: - type: object - properties: - author: - $ref: '#/paths/~1generic-approvals/get/responses/200/content/application~1json/schema/items/properties/approvers/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalIdentity.yaml - comment: - type: string - example: Looks good - description: Comment to be left on an approval - createdDate: - type: string - example: '2023-04-12T23:20:50.520Z' - description: Date the comment was created - description: Comments Object - description: Object representation of a comment on the approval - approvedBy: - type: array - items: - $ref: '#/paths/~1generic-approvals/get/responses/200/content/application~1json/schema/items/properties/approvers/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalIdentity.yaml - description: Array of approvers who have approved the approval - rejectedBy: - type: array - items: - $ref: '#/paths/~1generic-approvals/get/responses/200/content/application~1json/schema/items/properties/approvers/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalIdentity.yaml - description: Array of approvers who have rejected the approval - completedDate: - type: string - example: '2023-04-12T23:20:50.520Z' - description: Date the approval was completed - approvalCriteria: - type: string - enum: - - SINGLE - - DOUBLE - - TRIPLE - - QUARTER - - HALF - - ALL - example: SINGLE - description: Criteria that needs to be met for an approval to be marked as approved - status: - type: string - enum: - - PENDING - - APPROVED - - REJECTED - example: PENDING - description: The current status of the approval - additionalAttributes: - type: string - example: '{ "llm_description": "generated description" }' - description: Json string representing additional attributes known about the object to be approved. - referenceData: - type: array - items: - type: object - properties: - id: - type: string - example: 64012350-8fd9-4f6c-a170-1fe123683899 - description: Id of the reference object - type: - type: string - example: AccessRequestId - description: What reference object does this ID correspond to - description: Reference objects related to the approval - description: Reference data related to the approval - description: Approval Object - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/approvals#get-approvals - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Mine = $true # Boolean | Returns the list of approvals for the current caller (optional) - $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID (optional) - $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) - - # Get Approvals - - try { - Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approvals" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/approvals#get-approvals - source: | - from sailpoint.v2025.api.approvals_api import ApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.approval import Approval - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - mine = true # bool | Returns the list of approvals for the current caller (optional) # bool | Returns the list of approvals for the current caller (optional) - requester_id = '17e633e7d57e481569df76323169deb6a' # str | Returns the list of approvals for a given requester ID (optional) # str | Returns the list of approvals for a given requester ID (optional) - filters = 'filters=status eq PENDING' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) - try: - # Get Approvals - - results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters) - print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) - /generic-approvals/{id}: - get: - security: - - userAuth: - - sp:approvals:read - operationId: getApproval - tags: - - Approvals - summary: Get an approval - description: Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: getApprovals - schema: - type: string - description: ID of the approval that is to be returned - example: 38453251-6be2-5f8f-df93-5ce19e295837 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Approval object - content: - application/json: - schema: - $ref: '#/paths/~1generic-approvals/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Approval.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/approvals#get-approval - source: | - $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that is to be returned - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get an approval - - try { - Get-V2025Approval -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Approval -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approval" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/approvals#get-approval - source: | - from sailpoint.v2025.api.approvals_api import ApprovalsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.approval import Approval - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get an approval - - results = ApprovalsApi(api_client).get_approval(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = ApprovalsApi(api_client).get_approval(id, x_sail_point_experimental) - print("The response of ApprovalsApi->get_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) - /machine-accounts: - get: - operationId: listMachineAccounts - tags: - - Machine Accounts - summary: Machine Accounts List - description: 'This returns a list of machine accounts. ' - security: - - userAuth: - - idn:mis-account:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - HELPDESK - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - example: identityId eq "2c9180858082150f0180893dbaf44201" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in, sw* - - **name**: *eq, in, sw* - - **nativeIdentity**: *eq, in, sw* - - **machineIdentity**: *eq, in, sw* - - **description**: *eq, in, sw* - - **ownerIdentity**: *eq, in, sw* - - **ownerIdentityId**: *eq, in, sw* - - **entitlements**: *eq* - - **accessType**: *eq, in, sw* - - **subType**: *eq, in, sw* - - **environment**: *eq, in, sw* - - **classificationMethod**: *eq, in, sw* - - **manuallyCorrelated**: *eq* - - **manuallyEdited**: *eq* - - **identity**: *eq, in, sw* - - **source**: *eq, in* - - **hasEntitlement**: *eq* - - **locked**: *eq* - - **connectorAttributes**: *eq* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: id,name - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of machine account objects - content: - application/json: - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Account/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - - type: object - required: - - nativeIdentity - - classificationMethod - - connectorAttributes - - manuallyEdited - - locked - - enabled - - hasEntitlements - - source - properties: - description: - type: string - description: A description of the machine account - nullable: true - example: Service account for Active Directory - nativeIdentity: - type: string - description: The unique ID of the machine account generated by the source system - example: '552775' - uuid: - type: string - description: The unique ID of the account as determined by the account schema - example: '{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}' - nullable: true - classificationMethod: - description: Classification Method - type: string - enum: - - SOURCE - - CRITERIA - - DISCOVERY - - MANUAL - example: SOURCE - machineIdentity: - description: The machine identity this account is associated with - example: - id: 1540e5a4-6c2e-4bf1-b88e-c08cae0696e9 - type: MACHINE_IDENTITY - name: SVC_ADService - ownerIdentity: - description: The identity who owns this account. - nullable: true - example: - id: 2c918084660f45d6016617daa9210584 - type: IDENTITY - name: Adam Kennedy - accessType: - type: string - example: direct - description: The connection type of the source this account is from - subtype: - type: string - nullable: true - example: null - description: The sub-type - environment: - type: string - nullable: true - example: TEST - description: Environment - attributes: - type: object - nullable: true - additionalProperties: true - description: Custom attributes specific to the machine account - example: - firstName: SailPoint - lastName: Support - displayName: SailPoint Support - connectorAttributes: - type: object - nullable: true - additionalProperties: true - description: The connector attributes for the account - example: - mail: machine-178@sailpoint.com - givenName: Support - displayName: SailPoint Support - manuallyCorrelated: - type: boolean - description: Indicates if the account has been manually correlated to an identity - default: false - example: true - manuallyEdited: - type: boolean - description: Indicates if the account has been manually edited - default: false - example: true - locked: - type: boolean - description: Indicates if the account is currently locked - example: false - enabled: - type: boolean - description: Indicates if the account is enabled - default: false - example: false - hasEntitlements: - type: boolean - description: Indicates if the account has entitlements - default: true - example: false - source: - description: The source this machine account belongs to. - example: - id: 8d3e0094e99445de98eef6c75e25jc04 - type: SOURCE - name: Active Directory - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#list-machine-accounts - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) - - # Machine Accounts List - - try { - Get-V2025MachineAccounts -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccounts" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-accounts#list-machine-accounts - source: | - from sailpoint.v2025.api.machine_accounts_api import MachineAccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_account import MachineAccount - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) - try: - # Machine Accounts List - - results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of MachineAccountsApi->list_machine_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) - /machine-accounts/{id}: - get: - operationId: getMachineAccount - tags: - - Machine Accounts - summary: Machine Account Details - description: 'Use this API to return the details for a single machine account by its ID. ' - security: - - userAuth: - - idn:mis-account:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - HELPDESK - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listMachineAccounts - description: Machine Account ID. - example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Machine Account object. - content: - application/json: - schema: - $ref: '#/paths/~1machine-accounts/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MachineAccount.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#get-machine-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Machine Account Details - - try { - Get-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccount" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-accounts#get-machine-account - source: | - from sailpoint.v2025.api.machine_accounts_api import MachineAccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_account import MachineAccount - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Machine Account Details - - results = MachineAccountsApi(api_client).get_machine_account(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = MachineAccountsApi(api_client).get_machine_account(id, x_sail_point_experimental) - print("The response of MachineAccountsApi->get_machine_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineAccountsApi->get_machine_account: %s\n" % e) - patch: - operationId: updateMachineAccount - tags: - - Machine Accounts - summary: Update a Machine Account - description: | - Use this API to update machine accounts details. - security: - - userAuth: - - idn:mis-account:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listMachineAccounts - description: Machine Account ID. - example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - description: |- - A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: - * description - * ownerIdentity - * subType - * accessType - * environment - * attributes - * classificationMethod - * manuallyEdited - * nativeIdentity - * uuid - * source - * manuallyCorrelated - * enabled - * locked - * hasEntitlements - * connectorAttributes - content: - application/json-patch+json: - schema: - type: array - items: - type: object - example: - Add machine identity attribute: - value: - - op: add - path: /environment - value: test - Replace machine identity attribute: - value: - - op: replace - path: /environment - value: test - Remove machine identity attribute: - value: - - op: remove - path: /environment - responses: - '200': - description: Updated Machine Account object. - content: - application/json: - schema: - $ref: '#/paths/~1machine-accounts/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MachineAccount.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#update-machine-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ - - - # Update a Machine Account - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MachineAccount" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-accounts#update-machine-account - source: | - from sailpoint.v2025.api.machine_accounts_api import MachineAccountsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_account import MachineAccount - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - try: - # Update a Machine Account - new_request_body = RequestBody.from_json(request_body) - results = MachineAccountsApi(api_client).update_machine_account(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = MachineAccountsApi(api_client).update_machine_account(id, x_sail_point_experimental, new_request_body) - print("The response of MachineAccountsApi->update_machine_account:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e) - /machine-identities: - get: - operationId: listMachineIdentities - tags: - - Machine Identities - summary: List Machine Identities - description: This API returns a list of machine identities. - security: - - userAuth: - - idn:mis-identity:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - HELPDESK - parameters: - - in: query - name: filters - required: false - schema: - type: string - example: identityId eq "2c9180858082150f0180893dbaf44201" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in, sw* - - **displayName**: *eq, in, sw* - - **cisIdentityId**: *eq, in, sw* - - **description**: *eq, in, sw* - - **businessApplication**: *eq, in, sw* - - **attributes**: *eq* - - **manuallyEdited**: *eq* - - in: query - name: sorters - schema: - type: string - format: comma-separated - required: false - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **businessApplication, name** - example: businessApplication - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - responses: - '200': - description: List of machine identities. - content: - application/json: - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Account/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - - type: object - title: MachineIdentityDto - required: - - businessApplication - properties: - businessApplication: - type: string - description: The business application that the identity represents - example: ADService - description: - type: string - description: Description of machine identity - example: '' - manuallyEdited: - type: boolean - description: Indicates if the machine identity has been manually edited - default: false - example: true - attributes: - type: object - description: A map of custom machine identity attributes - example: '{"Region":"EU"}' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#list-machine-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) - $Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Machine Identities - - try { - Get-V2025MachineIdentities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MachineIdentities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-identities#list-machine-identities - source: | - from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_identity import MachineIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) - sorters = 'businessApplication' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Machine Identities - - results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, filters, sorters, count, limit, offset) - print("The response of MachineIdentitiesApi->list_machine_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) - post: - operationId: createMachineIdentity - tags: - - Machine Identities - summary: Create Machine Identities - security: - - userAuth: - - idn:mis-identity:manage - x-sailpoint-userLevels: - - ORG_ADMIN - description: |- - Use this API to create a machine identity. - The maximum supported length for the description field is 2000 characters. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1machine-identities/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MachineIdentity.yaml - responses: - '200': - description: Machine Identity created. - content: - application/json: - schema: - $ref: '#/paths/~1machine-identities/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MachineIdentity.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#create-machine-identity - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MachineIdentity = @" - { - "created" : "2015-05-28T14:07:17Z", - "businessApplication" : "ADService", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "", - "attributes" : "{\"Region\":\"EU\"}", - "id" : "id12345", - "manuallyEdited" : true - } - "@ - - # Create Machine Identities - - try { - $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity - New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result - - # Below is a request that includes all optional parameters - # New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025MachineIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-identities#create-machine-identity - source: | - from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_identity import MachineIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - machine_identity = '''{ - "created" : "2015-05-28T14:07:17Z", - "businessApplication" : "ADService", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "", - "attributes" : "{\"Region\":\"EU\"}", - "id" : "id12345", - "manuallyEdited" : true - }''' # MachineIdentity | - try: - # Create Machine Identities - new_machine_identity = MachineIdentity.from_json(machine_identity) - results = MachineIdentitiesApi(api_client).create_machine_identity(x_sail_point_experimental=x_sail_point_experimental, machine_identity=new_machine_identity) - # Below is a request that includes all optional parameters - # results = MachineIdentitiesApi(api_client).create_machine_identity(x_sail_point_experimental, new_machine_identity) - print("The response of MachineIdentitiesApi->create_machine_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineIdentitiesApi->create_machine_identity: %s\n" % e) - /machine-identities/{id}: - get: - operationId: getMachineIdentity - tags: - - Machine Identities - summary: Machine Identity Details - description: This API returns a single machine identity using the Machine Identity ID. - security: - - userAuth: - - idn:mis-identity:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - HELPDESK - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listMachineIdentities - description: Machine Identity ID - example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: A machine identity object - content: - application/json: - schema: - $ref: '#/paths/~1machine-identities/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MachineIdentity.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#get-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Machine Identity Details - - try { - Get-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-identities#get-machine-identity - source: | - from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_identity import MachineIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Machine Identity Details - - results = MachineIdentitiesApi(api_client).get_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = MachineIdentitiesApi(api_client).get_machine_identity(id, x_sail_point_experimental) - print("The response of MachineIdentitiesApi->get_machine_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineIdentitiesApi->get_machine_identity: %s\n" % e) - patch: - operationId: updateMachineIdentity - tags: - - Machine Identities - summary: Update a Machine Identity - description: | - Use this API to update machine identity details. - security: - - userAuth: - - idn:mis-identity:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listMachineIdentities - description: Machine Identity ID. - example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - description: A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - content: - application/json-patch+json: - schema: - type: array - items: - type: object - example: - Add machine identity attribute: - value: - - op: add - path: /attributes/securityRisk - value: medium - Replace machine identity attribute: - value: - - op: replace - path: /attributes/securityRisk - value: medium - Remove machine identity attribute: - value: - - op: remove - path: /attributes/securityRisk - responses: - '200': - description: Updated Machine Identity object. - content: - application/json: - schema: - $ref: '#/paths/~1machine-identities/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MachineIdentity.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#update-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ - - - # Update a Machine Identity - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MachineIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-identities#update-machine-identity - source: | - from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.machine_identity import MachineIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - try: - # Update a Machine Identity - new_request_body = RequestBody.from_json(request_body) - results = MachineIdentitiesApi(api_client).update_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = MachineIdentitiesApi(api_client).update_machine_identity(id, x_sail_point_experimental, new_request_body) - print("The response of MachineIdentitiesApi->update_machine_identity:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MachineIdentitiesApi->update_machine_identity: %s\n" % e) - delete: - operationId: deleteMachineIdentity - tags: - - Machine Identities - summary: Delete machine identity - description: The API returns successful response if the requested machine identity was deleted. - security: - - userAuth: - - idn:mis-identity:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listMachineIdentities - description: Machine Identity ID - example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#delete-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete machine identity - - try { - Remove-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MachineIdentity" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/machine-identities#delete-machine-identity - source: | - from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete machine identity - - MachineIdentitiesApi(api_client).delete_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # MachineIdentitiesApi(api_client).delete_machine_identity(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling MachineIdentitiesApi->delete_machine_identity: %s\n" % e) - /notification-template-defaults: - get: - operationId: listNotificationTemplateDefaults - tags: - - Notifications - summary: List Notification Template Defaults - description: This lists the default templates used for notifications, such as emails from IdentityNow. - security: - - userAuth: - - idn:notification-template-defaults:read - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - in: query - name: filters - schema: - type: string - example: key eq "cloud_manual_work_item_summary" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **key**: *eq, in, sw* - - **medium**: *eq, sw* - - **locale**: *eq, sw* - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: A list of the default template objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - key: - type: string - example: cloud_manual_work_item_summary - description: The key of the default template - name: - type: string - example: Task Manager Subscription - description: The name of the default template - medium: - type: string - description: The message medium. More mediums may be added in the future. - enum: - - EMAIL - - PHONE - - SMS - - SLACK - - TEAMS - example: EMAIL - locale: - type: string - description: The locale for the message text, a BCP 47 language tag. - example: en - subject: - type: string - example: You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}. - description: The subject of the default template - nullable: true - header: - type: string - nullable: true - example: null - deprecated: true - description: The header value is now located within the body field. If included with non-null values, will result in a 400. - body: - type: string - example: Please go to the task manager - description: The body of the default template - footer: - type: string - nullable: true - example: null - deprecated: true - description: The footer value is now located within the body field. If included with non-null values, will result in a 400. - from: - type: string - example: $__global.emailFromAddress - description: The "From:" address of the default template - nullable: true - replyTo: - type: string - example: $__global.emailFromAddress - description: The "Reply To" field of the default template - nullable: true - description: - type: string - example: Daily digest - sent if number of outstanding tasks for task owner > 0 - description: The description of the default template - nullable: true - slackTemplate: - type: object - nullable: true - properties: - key: - type: string - nullable: true - text: - type: string - blocks: - type: string - nullable: true - attachments: - type: string - notificationType: - type: string - nullable: true - approvalId: - type: string - nullable: true - requestId: - type: string - nullable: true - requestedById: - type: string - nullable: true - isSubscription: - type: boolean - nullable: true - autoApprovalData: - type: object - nullable: true - properties: - isAutoApproved: - type: string - nullable: true - itemId: - type: string - nullable: true - itemType: - type: string - nullable: true - autoApprovalMessageJSON: - type: string - nullable: true - autoApprovalTitle: - type: string - nullable: true - customFields: - type: object - nullable: true - properties: - requestType: - type: string - nullable: true - containsDeny: - type: string - nullable: true - campaignId: - type: string - nullable: true - campaignStatus: - type: string - nullable: true - teamsTemplate: - type: object - nullable: true - properties: - key: - type: string - nullable: true - title: - type: string - nullable: true - text: - type: string - messageJSON: - type: string - nullable: true - isSubscription: - type: boolean - nullable: true - approvalId: - type: string - nullable: true - requestId: - type: string - nullable: true - requestedById: - type: string - nullable: true - notificationType: - type: string - nullable: true - autoApprovalData: - type: object - nullable: true - properties: - isAutoApproved: - type: string - nullable: true - itemId: - type: string - nullable: true - itemType: - type: string - nullable: true - autoApprovalMessageJSON: - type: string - nullable: true - autoApprovalTitle: - type: string - nullable: true - customFields: - type: object - nullable: true - properties: - requestType: - type: string - nullable: true - containsDeny: - type: string - nullable: true - campaignId: - type: string - nullable: true - campaignStatus: - type: string - nullable: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-template-defaults - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "key eq "cloud_manual_work_item_summary"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - - # List Notification Template Defaults - - try { - Get-V2025NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplateDefaults" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#list-notification-template-defaults - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.template_dto_default import TemplateDtoDefault - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'key eq \"cloud_manual_work_item_summary\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - try: - # List Notification Template Defaults - - results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) - print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) - /notification-templates: - get: - operationId: listNotificationTemplates - tags: - - Notifications - summary: List Notification Templates - description: This lists the templates that you have modified for your site. - security: - - userAuth: - - idn:notification-templates:read - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **key**: *eq, in, sw* - - **medium**: *eq, sw* - - **locale**: *eq, sw* - example: medium eq "EMAIL" - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: A list of template objects for your site - content: - application/json: - schema: - type: array - items: - type: object - properties: - key: - type: string - example: cloud_manual_work_item_summary - description: The key of the template - name: - type: string - example: Task Manager Subscription - description: The name of the Task Manager Subscription - medium: - type: string - description: The message medium. More mediums may be added in the future. - enum: - - EMAIL - - PHONE - - SMS - - SLACK - - TEAMS - example: EMAIL - locale: - type: string - description: The locale for the message text, a BCP 47 language tag. - example: en - subject: - type: string - example: You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}. - description: The subject line in the template - header: - type: string - nullable: true - example: null - deprecated: true - description: The header value is now located within the body field. If included with non-null values, will result in a 400. - body: - type: string - example: Please go to the task manager - description: The body in the template - footer: - type: string - nullable: true - example: null - deprecated: true - description: The footer value is now located within the body field. If included with non-null values, will result in a 400. - from: - type: string - example: $__global.emailFromAddress - description: The "From:" address in the template - replyTo: - type: string - example: $__global.emailFromAddress - description: The "Reply To" line in the template - description: - type: string - example: Daily digest - sent if number of outstanding tasks for task owner > 0 - description: The description in the template - id: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - description: This is auto-generated. - created: - type: string - format: date-time - description: The time when this template is created. This is auto-generated. - example: '2020-01-01T00:00:00.000000Z' - modified: - type: string - format: date-time - description: The time when this template was last modified. This is auto-generated. - example: '2020-01-01T00:00:00.000000Z' - slackTemplate: - type: string - nullable: true - teamsTemplate: - type: string - nullable: true - required: - - key - - medium - - locale - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-templates - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "medium eq "EMAIL"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - - # List Notification Templates - - try { - Get-V2025NotificationTemplates -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplates" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#list-notification-templates - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.template_dto import TemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'medium eq \"EMAIL\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - try: - # List Notification Templates - - results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) - print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) - post: - operationId: createNotificationTemplate - tags: - - Notifications - summary: Create Notification Template - description: |- - This creates a template for your site. - - You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - security: - - userAuth: - - idn:notification-templates:create - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1notification-templates/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TemplateDto.yaml - responses: - '200': - description: A template object for your site - content: - application/json: - schema: - $ref: '#/paths/~1notification-templates/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TemplateDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-notification-template - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TemplateDto = @" - { - "slackTemplate" : "slackTemplate", - "footer" : "footer", - "teamsTemplate" : "teamsTemplate", - "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", - "created" : "2020-01-01T00:00:00Z", - "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", - "medium" : "EMAIL", - "locale" : "en", - "body" : "Please go to the task manager", - "name" : "Task Manager Subscription", - "replyTo" : "$__global.emailFromAddress", - "header" : "header", - "modified" : "2020-01-01T00:00:00Z", - "from" : "$__global.emailFromAddress", - "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", - "key" : "cloud_manual_work_item_summary" - } - "@ - - # Create Notification Template - - try { - $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto - New-V2025NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result - - # Below is a request that includes all optional parameters - # New-V2025NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NotificationTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#create-notification-template - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.template_dto import TemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - template_dto = '''{ - "slackTemplate" : "slackTemplate", - "footer" : "footer", - "teamsTemplate" : "teamsTemplate", - "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", - "created" : "2020-01-01T00:00:00Z", - "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", - "medium" : "EMAIL", - "locale" : "en", - "body" : "Please go to the task manager", - "name" : "Task Manager Subscription", - "replyTo" : "$__global.emailFromAddress", - "header" : "header", - "modified" : "2020-01-01T00:00:00Z", - "from" : "$__global.emailFromAddress", - "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", - "key" : "cloud_manual_work_item_summary" - }''' # TemplateDto | - try: - # Create Notification Template - new_template_dto = TemplateDto.from_json(template_dto) - results = NotificationsApi(api_client).create_notification_template(x_sail_point_experimental=x_sail_point_experimental, template_dto=new_template_dto) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).create_notification_template(x_sail_point_experimental, new_template_dto) - print("The response of NotificationsApi->create_notification_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) - /notification-templates/{id}: - get: - operationId: getNotificationTemplate - tags: - - Notifications - summary: Get Notification Template By Id - description: This gets a template that you have modified for your site by Id. - parameters: - - name: id - in: path - description: Id of the Notification Template - required: true - x-sailpoint-resource-operation-id: listNotificationTemplates - style: simple - explode: false - schema: - type: string - example: c17bea3a-574d-453c-9e04-4365fbf5af0b - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: A template object for your site - content: - application/json: - schema: - $ref: '#/paths/~1notification-templates/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TemplateDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-notification-template - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Notification Template By Id - - try { - Get-V2025NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#get-notification-template - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.template_dto import TemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Notification Template By Id - - results = NotificationsApi(api_client).get_notification_template(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).get_notification_template(id, x_sail_point_experimental) - print("The response of NotificationsApi->get_notification_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) - /notification-templates/bulk-delete: - post: - operationId: deleteNotificationTemplatesInBulk - tags: - - Notifications - summary: Bulk Delete Notification Templates - description: This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. - security: - - userAuth: - - idn:notification-templates:delete - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - type: object - properties: - key: - type: string - example: cloud_manual_work_item_summary - medium: - type: string - enum: - - EMAIL - - PHONE - - SMS - example: EMAIL - locale: - type: string - description: The locale for the message text, a BCP 47 language tag. - example: en - required: - - key - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#delete-notification-templates-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TemplateBulkDeleteDto = @"{ - "medium" : "EMAIL", - "locale" : "en", - "key" : "cloud_manual_work_item_summary" - }"@ - - - # Bulk Delete Notification Templates - - try { - $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto - Remove-V2025NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result - - # Below is a request that includes all optional parameters - # Remove-V2025NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NotificationTemplatesInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#delete-notification-templates-in-bulk - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.template_bulk_delete_dto import TemplateBulkDeleteDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - template_bulk_delete_dto = '''[sailpoint.v2025.TemplateBulkDeleteDto()]''' # List[TemplateBulkDeleteDto] | - try: - # Bulk Delete Notification Templates - new_template_bulk_delete_dto = TemplateBulkDeleteDto.from_json(template_bulk_delete_dto) - NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental=x_sail_point_experimental, template_bulk_delete_dto=new_template_bulk_delete_dto) - # Below is a request that includes all optional parameters - # NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental, new_template_bulk_delete_dto) - except Exception as e: - print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) - /org-config: - get: - operationId: getOrgConfig - tags: - - Org Config - summary: Get Org Config Settings - security: - - userAuth: - - idn:org-configs:read - - idn:org-configs:manage - x-sailpoint-userLevels: - - ORG_ADMIN - description: Get the current organization's configuration settings, only external accessible properties. - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - description: DTO class for OrgConfig data accessible by customer external org admin ("ORG_ADMIN") users - properties: - orgName: - type: string - description: The name of the org. - example: acme-solar - timeZone: - type: string - description: The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones - example: America/Toronto - lcsChangeHonorsSourceEnableFeature: - type: boolean - description: Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. - example: false - armCustomerId: - type: string - description: ARM Customer ID - nullable: true - example: DE38E75A-5FF6-4A65-5DC7-08D64426B09E - armSapSystemIdMappings: - type: string - description: A list of IDN::sourceId to ARM::systemId mappings. - nullable: true - example: - - sourceId: 2c91808c791a94e501792388b0d62659 - systemId: '1556' - - sourceId: 2_2c91808c791a94e501792388b0d62659 - systemId: '2_1556' - - sourceId: 3_2c91808c791a94e501792388b0d62659 - systemId: '3_1556' - armAuth: - type: string - description: ARM authentication string - nullable: true - example: epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag== - armDb: - type: string - description: ARM database name - nullable: true - example: EU - armSsoUrl: - type: string - description: ARM SSO URL - nullable: true - example: https://your-arm-sso-url - iaiEnableCertificationRecommendations: - type: boolean - description: Flag to determine whether IAI Certification Recommendations are enabled for the current org - example: true - sodReportConfigs: - type: array - items: - type: object - properties: - columnName: - type: string - description: Name of column in report - example: SOD Business Name - required: - type: boolean - description: If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition. - example: true - default: false - included: - type: boolean - description: If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. - example: false - default: false - order: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. - example: 2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/org-config#get-org-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Org Config Settings - - try { - Get-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OrgConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/org-config#get-org-config - source: | - from sailpoint.v2025.api.org_config_api import OrgConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.org_config import OrgConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Org Config Settings - - results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental) - print("The response of OrgConfigApi->get_org_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) - patch: - operationId: patchOrgConfig - tags: - - Org Config - summary: Patch Org Config - security: - - userAuth: - - idn:org-configs:manage - x-sailpoint-userLevels: - - ORG_ADMIN - description: Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone. - requestBody: - description: A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /timeZone - value: America/Toronto - required: true - responses: - '200': - description: Successfully patched org config. - content: - application/json: - schema: - $ref: '#/paths/~1org-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/OrgConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/org-config#patch-org-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Org Config - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025OrgConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/org-config#patch-org-config - source: | - from sailpoint.v2025.api.org_config_api import OrgConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.org_config import OrgConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[{op=replace, path=/timeZone, value=America/Toronto}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - try: - # Patch Org Config - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental, new_json_patch_operation) - print("The response of OrgConfigApi->patch_org_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) - /org-config/valid-time-zones: - get: - operationId: getValidTimeZones - tags: - - Org Config - summary: Get Valid Time Zones - security: - - userAuth: - - idn:org-configs:read - - idn:org-configs-user:read - x-sailpoint-userLevels: - - ORG_ADMIN - description: List the valid time zones that can be set in organization configurations. - responses: - '200': - description: Request successful. - content: - application/json: - schema: - type: array - items: - type: string - example: - - Etc/GMT-6 - - Etc/GMT+8 - - EST - - America/Chicago - - America/Toronto - - Asia/Gaza - - Europe/Brussels - - Europe/Kiev - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - - $ref: '#/paths/~1connector-rules/get/parameters/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit50.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/org-config#get-valid-time-zones - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Get Valid Time Zones - - try { - Get-V2025ValidTimeZones -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ValidTimeZones" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/org-config#get-valid-time-zones - source: | - from sailpoint.v2025.api.org_config_api import OrgConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Get Valid Time Zones - - results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count) - print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) - /outlier-summaries: - get: - operationId: getIdentityOutlierSnapshots - tags: - - IAI Outliers - summary: IAI Identity Outliers Summary - description: This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - name: type - in: query - description: Type of the identity outliers snapshot to filter on - required: false - example: LOW_SIMILARITY - schema: - type: string - enum: - - LOW_SIMILARITY - - STRUCTURAL - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **snapshotDate**: *ge, le* - example: snapshotDate ge "2022-02-07T20:13:29.356648026Z" - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **snapshotDate** - example: snapshotDate - required: false - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers - headers: - X-Total-Count: - description: The total result count. - schema: - type: integer - content: - application/json: - schema: - type: array - items: - type: object - properties: - type: - type: string - enum: - - LOW_SIMILARITY - - STRUCTURAL - description: The type of outlier summary - example: LOW_SIMILARITY - snapshotDate: - type: string - format: date-time - description: The date the bulk outlier detection ran/snapshot was created - example: '2021-05-01T18:40:35.772Z' - totalOutliers: - type: integer - description: Total number of outliers for the customer making the request - example: 50 - totalIdentities: - type: integer - description: Total number of identities for the customer making the request - example: 5000 - totalIgnored: - type: integer - default: 0 - example: 0 - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - iai:outliers:read - - iai:outliers:manage - - applicationAuth: - - iai:outliers:read - - iai:outliers:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - REPORT_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-identity-outlier-snapshots - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) - $Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) - - # IAI Identity Outliers Summary - - try { - Get-V2025IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOutlierSnapshots" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-identity-outlier-snapshots - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.outlier_summary import OutlierSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) - filters = 'snapshotDate ge \"2022-02-07T20:13:29.356648026Z\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) - sorters = 'snapshotDate' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) - try: - # IAI Identity Outliers Summary - - results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) - print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) - /outlier-summaries/latest: - get: - operationId: getLatestIdentityOutlierSnapshots - tags: - - IAI Outliers - summary: IAI Identity Outliers Latest Summary - description: This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - parameters: - - name: type - in: query - description: Type of the identity outliers snapshot to filter on - required: false - example: LOW_SIMILARITY - schema: - type: string - enum: - - LOW_SIMILARITY - - STRUCTURAL - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. - content: - application/json: - schema: - type: array - items: - type: object - properties: - type: - type: string - enum: - - LOW_SIMILARITY - - STRUCTURAL - description: The type of outlier summary - example: LOW_SIMILARITY - snapshotDate: - type: string - format: date-time - description: The date the bulk outlier detection ran/snapshot was created - example: '2021-05-01T18:40:35.772Z' - totalOutliers: - type: integer - description: Total number of outliers for the customer making the request - example: 50 - totalIdentities: - type: integer - description: Total number of identities for the customer making the request - example: 5000 - totalIgnored: - type: integer - description: Total number of ignored outliers - example: 10 - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - iai:outliers:read - - iai:outliers:manage - - applicationAuth: - - iai:outliers:read - - iai:outliers:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - REPORT_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-latest-identity-outlier-snapshots - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - - # IAI Identity Outliers Latest Summary - - try { - Get-V2025LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LatestIdentityOutlierSnapshots" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-latest-identity-outlier-snapshots - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.latest_outlier_summary import LatestOutlierSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) - try: - # IAI Identity Outliers Latest Summary - - results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) - print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) - /outliers: - get: - operationId: getIdentityOutliers - tags: - - IAI Outliers - summary: IAI Get Identity Outliers - description: This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: type - in: query - description: Type of the identity outliers snapshot to filter on - required: false - schema: - type: string - enum: - - LOW_SIMILARITY - - STRUCTURAL - example: LOW_SIMILARITY - - in: query - name: filters - required: false - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **attributes**: *eq, sw, co, in* - - **firstDetectionDate**: *ge, le* - - **certStatus**: *eq* - - **ignored**: *eq* - - **score**: *ge, le* - example: attributes.displayName sw "John" and certStatus eq "false" - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **firstDetectionDate, attributes, score** - example: attributes.displayName,firstDetectionDate,-score - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns list of objects. Each object contains information about outliers. - headers: - X-Total-Count: - description: The total result count. - schema: - type: integer - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The identity's unique identifier for the outlier record - example: 5be33d3e-c54d-4ed7-af73-2380543e8283 - identityId: - type: string - description: The ID of the identity that is detected as an outlier - example: 5be33d3e-c54d-4ed7-af73-2380543e8283 - type: - type: string - enum: - - LOW_SIMILARITY - - STRUCTURAL - description: The type of outlier summary - example: LOW_SIMILARITY - firstDetectionDate: - type: string - format: date-time - description: The first date the outlier was detected - example: '2021-05-01T18:40:35.772Z' - latestDetectionDate: - type: string - format: date-time - description: The most recent date the outlier was detected - example: '2021-05-03T18:40:35.772Z' - ignored: - type: boolean - description: Flag whether or not the outlier has been ignored - example: false - attributes: - type: object - description: Object containing mapped identity attributes - example: - displayName: John Smith - jobTitle: Software Engineer - department: Engineering - score: - type: number - format: float - description: The outlier score determined by the detection engine ranging from 0..1 - example: 0.92 - unignoreType: - type: string - enum: - - MANUAL - - AUTOMATIC - - null - description: Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored - example: MANUAL - nullable: true - unignoreDate: - type: string - format: date-time - description: shows date when last time has been unignored outlier - example: '2021-06-01T18:40:35.772Z' - nullable: true - ignoreDate: - type: string - format: date-time - description: shows date when last time has been ignored outlier - example: '2021-06-01T18:40:35.772Z' - nullable: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - iai:outliers:read - - iai:outliers:manage - - applicationAuth: - - iai:outliers:read - - iai:outliers:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - REPORT_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-identity-outliers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) - $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) - - # IAI Get Identity Outliers - - try { - Get-V2025IdentityOutliers -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityOutliers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOutliers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-identity-outliers - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.outlier import Outlier - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) - filters = 'attributes.displayName sw \"John\" and certStatus eq \"false\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) - sorters = 'attributes.displayName,firstDetectionDate,-score' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) - try: - # IAI Get Identity Outliers - - results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) - print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) - /outliers/{outlierId}/contributing-features: - get: - operationId: getPeerGroupOutliersContributingFeatures - tags: - - IAI Outliers - summary: Get identity outlier's contibuting features - description: | - This API returns a list of contributing feature objects for a single outlier. - - The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: include-translation-messages - in: query - description: Whether or not to include translation messages object in returned response - required: false - schema: - type: string - example: include-translation-messages= - - in: path - example: 2c918085842e69ae018432d22ccb212f - name: outlierId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getIdentityOutliers - description: The outlier id - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: importance - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **importance** - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature. - headers: - X-Total-Count: - description: The total result count. - schema: - type: integer - accept-language: - description: The locale to use for translations for displayName and description text - schema: - type: string - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Contributing feature id - example: 66e38828-5017-47af-92ff-9844871352c5 - name: - type: string - description: The name of the feature - example: entitlement_count - valueType: - type: object - description: The data type of the value field - properties: - name: - type: string - enum: - - INTEGER - - FLOAT - description: The data type of the value field - example: INTEGER - ordinal: - description: The position of the value type - type: integer - format: int32 - minimum: 0 - maximum: 1 - example: 0 - value: - type: number - format: float - minimum: 0 - description: The feature value - example: 1 - importance: - type: number - format: float - description: The importance of the feature. This can also be a negative value - example: -0.15 - displayName: - type: string - description: The (translated if header is passed) displayName for the feature - example: Number of entitlements - description: - type: string - description: The (translated if header is passed) description for the feature - example: The total number of entitlements belonging to an identity - translationMessages: - type: object - nullable: true - properties: - displayName: - $ref: '#/paths/~1ai-access-request-recommendations/get/responses/200/content/application~1json/schema/items/properties/translationMessages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TranslationMessage.yaml - description: - $ref: '#/paths/~1ai-access-request-recommendations/get/responses/200/content/application~1json/schema/items/properties/translationMessages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TranslationMessage.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - iai:outliers:read - - iai:outliers:manage - - applicationAuth: - - iai:outliers:read - - iai:outliers:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - REPORT_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-peer-group-outliers-contributing-features - source: | - $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) - $Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) - - # Get identity outlier's contibuting features - - try { - Get-V2025PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PeerGroupOutliersContributingFeatures" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-peer-group-outliers-contributing-features - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.outlier_contributing_feature import OutlierContributingFeature - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - include_translation_messages = 'include-translation-messages=' # str | Whether or not to include translation messages object in returned response (optional) # str | Whether or not to include translation messages object in returned response (optional) - sorters = 'importance' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) - try: - # Get identity outlier's contibuting features - - results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id=outlier_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters) - print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) - /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items: - get: - operationId: listOutliersContributingFeatureAccessItems - tags: - - IAI Outliers - summary: Gets a list of access items associated with each identity outlier contributing feature - description: | - This API returns a list of the enriched access items associated with each feature filtered by the access item type. - - The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: path - name: outlierId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getIdentityOutliers - description: The outlier id - example: 2c918085842e69ae018432d22ccb212f - - in: path - name: contributingFeatureName - schema: - type: string - enum: - - radical_entitlement_count - - entitlement_count - - max_jaccard_similarity - - mean_max_bundle_concurrency - - single_entitlement_bundle_count - - peerless_score - required: true - description: The name of contributing feature - example: entitlement_count - - in: query - name: accessType - required: false - schema: - type: string - description: The type of access item for the identity outlier contributing feature. If not provided, it returns all. - example: ENTITLEMENT - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: displayName - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **displayName** - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The list of access items. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of the access item - example: 2c938083633d259901633d2623ec0375 - displayName: - type: string - description: the display name of the access item - example: Applied Research Access - description: - type: string - description: Description of the access item. - nullable: true - example: Access to research information, lab results, and schematics - accessType: - type: string - example: ENTITLEMENT - description: The type of the access item. - enum: - - ENTITLEMENT - - ACCESS_PROFILE - - ROLE - sourceName: - type: string - example: appName - description: the associated source name if it exists - extremelyRare: - type: boolean - default: false - example: true - description: rarest access - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - iai:outliers:read - - iai:outliers:manage - - applicationAuth: - - iai:outliers:read - - iai:outliers:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - REPORT_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#list-outliers-contributing-feature-access-items - source: | - $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id - $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) - $Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) - - # Gets a list of access items associated with each identity outlier contributing feature - - try { - Get-V2025OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OutliersContributingFeatureAccessItems" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#list-outliers-contributing-feature-access-items - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.outliers_contributing_feature_access_items import OutliersContributingFeatureAccessItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id - contributing_feature_name = 'entitlement_count' # str | The name of contributing feature # str | The name of contributing feature - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - access_type = 'ENTITLEMENT' # str | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) # str | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) - sorters = 'displayName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) - try: - # Gets a list of access items associated with each identity outlier contributing feature - - results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id=outlier_id, contributing_feature_name=contributing_feature_name, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters) - print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) - /outliers/ignore: - post: - operationId: ignoreIdentityOutliers - tags: - - IAI Outliers - summary: IAI Identity Outliers Ignore - description: This API receives a list of identity IDs in the request, changes the outliers to be ignored. - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - type: string - description: List of identity IDs to ignore from outlier listing - example: - - 897ef96559df40e1baa6bae6b53e7340 - - 2c918085837fbfb4018384420dac60c3 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - security: - - userAuth: - - iai:outliers:manage - - applicationAuth: - - iai:outliers:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - REPORT_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#ignore-identity-outliers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - - - # IAI Identity Outliers Ignore - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-V2025IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025IgnoreIdentityOutliers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#ignore-identity-outliers - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''['request_body_example']''' # List[str] | - try: - # IAI Identity Outliers Ignore - new_request_body = RequestBody.from_json(request_body) - IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental, new_request_body) - except Exception as e: - print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) - /outliers/unignore: - post: - operationId: unIgnoreIdentityOutliers - tags: - - IAI Outliers - summary: IAI Identity Outliers Unignore - description: This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - type: string - description: List of identity IDs to un-ignore from outlier listing - example: - - 897ef96559df40e1baa6bae6b53e7340 - - 2c918085837fbfb4018384420dac60c3 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - security: - - userAuth: - - iai:outliers:manage - - applicationAuth: - - iai:outliers:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - REPORT_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#un-ignore-identity-outliers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - - - # IAI Identity Outliers Unignore - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-V2025UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025UnIgnoreIdentityOutliers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#un-ignore-identity-outliers - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''['request_body_example']''' # List[str] | - try: - # IAI Identity Outliers Unignore - new_request_body = RequestBody.from_json(request_body) - IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental, new_request_body) - except Exception as e: - print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) - /outliers/export: - get: - operationId: exportOutliersZip - tags: - - IAI Outliers - summary: IAI Identity Outliers Export - description: | - This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. - - Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - parameters: - - name: type - in: query - description: Type of the identity outliers snapshot to filter on - required: false - example: LOW_SIMILARITY - schema: - type: string - enum: - - LOW_SIMILARITY - - STRUCTURAL - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns zip of two CSVs to download. One CSV for ignored outliers and the other for non-ignored outliers. - content: - application/zip: - schema: - type: string - format: binary - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - iai:outliers:read - - iai:outliers:manage - - applicationAuth: - - iai:outliers:read - - iai:outliers:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - REPORT_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#export-outliers-zip - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - - # IAI Identity Outliers Export - - try { - Export-V2025OutliersZip -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2025OutliersZip -XSailPointExperimental $XSailPointExperimental -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025OutliersZip" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#export-outliers-zip - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) - try: - # IAI Identity Outliers Export - - results = IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental, type) - print("The response of IAIOutliersApi->export_outliers_zip:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) - /outlier-feature-summaries/{outlierFeatureId}: - get: - operationId: getOutlierContributingFeatureSummary - tags: - - IAI Outliers - summary: Get identity outlier contibuting feature summary - description: | - This API returns a summary of a contributing feature for an identity outlier. - - The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - parameters: - - in: path - name: outlierFeatureId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPeerGroupOutliersContributingFeatures - description: Contributing feature id - example: 04654b66-7561-4090-94f9-abee0722a1af - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns selected contributing feature summary for an outlier. - headers: - accept-language: - description: The locale to use for translations - schema: - type: string - content: - application/json: - schema: - type: object - properties: - contributingFeatureName: - type: string - description: Contributing feature name - example: Rare Access - identityOutlierDisplayName: - type: string - description: Identity display name - example: John Smith - outlierFeatureDisplayValues: - type: array - items: - type: object - properties: - displayName: - type: string - example: Aliza Chris - description: display name - value: - type: string - example: 55 - description: value - valueType: - $ref: '#/paths/~1outliers~1%7BoutlierId%7D~1contributing-features/get/responses/200/content/application~1json/schema/items/properties/valueType' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/OutlierValueType - featureDefinition: - type: string - description: Definition of the feature - example: Identity total number of entitlements - featureExplanation: - type: string - description: Detailed explanation of the feature - example: An identity that has too much rare access has a higher change of becoming a security threat due to the unique access they possess - peerDisplayName: - type: string - nullable: true - description: outlier's peer identity display name - example: Mary Jane - peerIdentityId: - type: string - nullable: true - description: outlier's peer identity id - example: 9f9d5d53ad0e48fba7352f6da9f1b8gbg - accessItemReference: - type: object - description: Access Item reference - example: - displayName: All Rare Entitlements - searchPlaceholder: Search by name or description - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - iai:outliers:read - - iai:outliers:manage - - applicationAuth: - - iai:outliers:read - - iai:outliers:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - REPORT_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-outlier-contributing-feature-summary - source: | - $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get identity outlier contibuting feature summary - - try { - Get-V2025OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OutlierContributingFeatureSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-outlier-contributing-feature-summary - source: | - from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.outlier_feature_summary import OutlierFeatureSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get identity outlier contibuting feature summary - - results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id=outlier_feature_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental) - print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) - /peer-group-strategies/{strategy}/identity-outliers: - get: - operationId: getPeerGroupOutliers - tags: - - IAI Peer Group Strategies - summary: Identity Outliers List - deprecated: true - description: '-- Deprecated : See ''IAI Outliers'' This API will be used by Identity Governance systems to identify identities that are not included in an organization''s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned.' - parameters: - - in: path - name: strategy - schema: - type: string - enum: - - entitlement - required: true - description: The strategy used to create peer groups. Currently, 'entitlement' is supported. - example: entitlement - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of identities that are not included in peer groups. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: A unique identifier for the peer group member. - type: - type: string - description: The type of the peer group member. - peer_group_id: - type: string - description: The ID of the peer group. - attributes: - type: object - additionalProperties: - type: object - description: Arbitrary key-value pairs, belonging to the peer group member. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: [] - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-peer-group-strategies#get-peer-group-outliers - source: | - $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Identity Outliers List - - try { - Get-V2025PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PeerGroupOutliers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-peer-group-strategies#get-peer-group-outliers - source: | - from sailpoint.v2025.api.iai_peer_group_strategies_api import IAIPeerGroupStrategiesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.peer_group_member import PeerGroupMember - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Identity Outliers List - - results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy=strategy, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) - print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) - /notification-template-context: - get: - operationId: getNotificationsTemplateContext - tags: - - Notifications - summary: Get Notification Template Context - description: |- - The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes - that will be available per tenant (organization). - security: - - userAuth: - - idn:notification-templates:read - responses: - '200': - description: Notification template context attributes for a specific tenant. - content: - application/json: - schema: - type: object - properties: - attributes: - type: object - additionalProperties: true - description: A JSON object that stores the context. - example: - productUrl: https://test-org.identitysoon.com - brandingConfigs: - default: - narrowLogoURL: null - productName: SailPoint - standardLogoURL: null - navigationColor: 1.1e+65 - actionButtonColor: 20B2DE - emailFromAddress: null - activeLinkColor: 20B2DE - loginInformationalMessage: null - created: - type: string - description: When the global context was created - format: date-time - example: '2020-04-15T16:16:47.525Z' - modified: - type: string - description: When the global context was last modified - format: date-time - example: '2020-04-15T16:16:47.525Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-notifications-template-context - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Notification Template Context - - try { - Get-V2025NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationsTemplateContext" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#get-notifications-template-context - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.notification_template_context import NotificationTemplateContext - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Notification Template Context - - results = NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental) - print("The response of NotificationsApi->get_notifications_template_context:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) - /notification-preferences/{key}: - get: - operationId: listNotificationPreferences - tags: - - Notifications - summary: List Notification Preferences for tenant. - description: Returns a list of notification preferences for tenant. - security: - - userAuth: - - idn:notification-preferences:read - responses: - '200': - description: Return preference for the given notification key. - content: - application/json: - schema: - type: object - description: Maps an Identity's attribute key to a list of preferred notification mediums. - properties: - key: - type: string - description: The template notification key. - example: cloud_manual_work_item_summary - mediums: - type: array - description: List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. - items: - type: string - enum: - - EMAIL - - SMS - - PHONE - - SLACK - - TEAMS - example: - - EMAIL - modified: - type: string - description: Modified date of preference - format: date-time - example: '2020-05-15T14:37:06.909Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-preferences - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Notification Preferences for tenant. - - try { - Get-V2025NotificationPreferences -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationPreferences -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationPreferences" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#list-notification-preferences - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.preferences_dto import PreferencesDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List Notification Preferences for tenant. - - results = NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental) - print("The response of NotificationsApi->list_notification_preferences:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) - /reassignment-configurations/types: - get: - operationId: getReassignmentConfigTypes - tags: - - Work Reassignment - summary: List Reassignment Config Types - description: Gets a collection of types which are available in the Reassignment Configuration UI. - security: - - userAuth: - - idn:reassignment-configuration:read - responses: - '200': - description: List of Reassignment Configuration Types - content: - application/json: - schema: - type: array - items: - type: object - description: Type of Reassignment Configuration. - properties: - priority: - type: integer - example: 1 - internalName: - type: string - description: Enum list of valid work types that can be selected for a Reassignment Configuration - enum: - - accessRequests - - certifications - - manualTasks - example: accessRequests - internalNameCamel: - $ref: '#/paths/~1reassignment-configurations~1%7BidentityId%7D~1%7BconfigType%7D/delete/parameters/1/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigTypeEnum.yaml - displayName: - type: string - description: Human readable display name of the type to be shown on UI - example: Access Requests - description: - type: string - description: Description of the type of work to be reassigned, displayed by the UI. - example: Reassign Access Request Work Items for an identity - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-reassignment-config-types - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Reassignment Config Types - - try { - Get-V2025ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfigTypes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-reassignment-config-types - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.config_type import ConfigType - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List Reassignment Config Types - - results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) - /reassignment-configurations: - get: - operationId: listReassignmentConfigurations - tags: - - Work Reassignment - summary: List Reassignment Configurations - description: Gets all Reassignment configuration for the current org. - security: - - userAuth: - - idn:reassignment-configuration:read - responses: - '200': - description: A list of Reassignment Configurations for an org - content: - application/json: - schema: - type: array - items: - type: object - description: The response body of a Reassignment Configuration for a single identity - properties: - identity: - type: object - description: The definition of an Identity according to the Reassignment Configuration service - properties: - id: - type: string - description: The ID of the object - example: 2c91808380aa05580180aaaaf1940410 - name: - type: string - description: Human-readable display name of the object - example: William Wilson - configDetails: - type: array - description: Details of how work should be reassigned for an Identity - items: - type: object - description: The request body of Reassignment Configuration Details for a specific identity and config type - properties: - configType: - $ref: '#/paths/~1reassignment-configurations~1%7BidentityId%7D~1%7BconfigType%7D/delete/parameters/1/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigTypeEnum.yaml - targetIdentity: - $ref: '#/paths/~1reassignment-configurations/get/responses/200/content/application~1json/schema/items/properties/identity' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/Identity.yaml - startDate: - type: string - description: The date from which to start reassigning work items - format: date-time - example: '2022-07-21T11:13:12.345Z' - endDate: - type: string - description: The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. - format: date-time - example: '0001-01-01T00:00:00Z' - auditDetails: - $ref: '#/paths/~1reassignment-configurations~1tenant-config/get/responses/200/content/application~1json/schema/properties/auditDetails' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/AuditDetails.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#list-reassignment-configurations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Reassignment Configurations - - try { - Get-V2025ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfigurations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#list-reassignment-configurations - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.configuration_response import ConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List Reassignment Configurations - - results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) - print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) - post: - operationId: createReassignmentConfiguration - tags: - - Work Reassignment - summary: Create a Reassignment Configuration - description: Creates a new Reassignment Configuration for the specified identity. - security: - - userAuth: - - idn:reassignment-configuration:create - requestBody: - required: true - content: - application/json: - schema: - type: object - description: The request body for creation or update of a Reassignment Configuration for a single identity and work type - properties: - reassignedFromId: - type: string - description: The identity id to reassign an item from - example: 2c91808781a71ddb0181b9090b5c504e - reassignedToId: - type: string - description: The identity id to reassign an item to - example: 2c91808781a71ddb0181b9090b53504a - configType: - $ref: '#/paths/~1reassignment-configurations~1%7BidentityId%7D~1%7BconfigType%7D/delete/parameters/1/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigTypeEnum.yaml - startDate: - type: string - description: The date from which to start reassigning work items - format: date-time - example: '2022-07-21T11:13:12.345Z' - endDate: - type: string - description: The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. - format: date-time - nullable: true - example: '2022-07-30T17:00:00.000Z' - responses: - '201': - description: The newly created Reassignment Configuration object - content: - application/json: - schema: - type: object - description: The response body of a Reassignment Configuration for a single identity - properties: - identity: - $ref: '#/paths/~1reassignment-configurations/get/responses/200/content/application~1json/schema/items/properties/identity' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/Identity.yaml - configDetails: - type: array - description: Details of how work should be reassigned for an Identity - items: - $ref: '#/paths/~1reassignment-configurations/get/responses/200/content/application~1json/schema/items/properties/configDetails/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigurationDetailsResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#create-reassignment-configuration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - - # Create a Reassignment Configuration - - try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-V2025ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ReassignmentConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#create-reassignment-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.configuration_item_request import ConfigurationItemRequest - from sailpoint.v2025.models.configuration_item_response import ConfigurationItemResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - configuration_item_request = '''{ - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - }''' # ConfigurationItemRequest | - try: - # Create a Reassignment Configuration - new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) - results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental, new_configuration_item_request) - print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) - /reassignment-configurations/{identityId}: - get: - operationId: getReassignmentConfiguration - tags: - - Work Reassignment - summary: Get Reassignment Configuration - description: Gets the Reassignment Configuration for an identity. - security: - - userAuth: - - idn:reassignment-configuration:read - parameters: - - in: path - name: identityId - schema: - type: string - description: unique identity id - required: true - x-sailpoint-resource-operation-id: listIdentities - example: 2c91808781a71ddb0181b9090b5c504f - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Reassignment Configuration for an identity - content: - application/json: - schema: - $ref: '#/paths/~1reassignment-configurations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigurationResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Reassignment Configuration - - try { - Get-V2025ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-reassignment-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.configuration_response import ConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Reassignment Configuration - - results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id, x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) - put: - operationId: putReassignmentConfig - tags: - - Work Reassignment - summary: Update Reassignment Configuration - description: Replaces existing Reassignment configuration for an identity with the newly provided configuration. - security: - - userAuth: - - idn:reassignment-configuration:update - parameters: - - in: path - name: identityId - schema: - type: string - description: unique identity id - required: true - x-sailpoint-resource-operation-id: listIdentities - example: 2c91808781a71ddb0181b9090b5c504e - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1reassignment-configurations/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigurationItemRequest.yaml - responses: - '200': - description: Reassignment Configuration updated - content: - application/json: - schema: - $ref: '#/paths/~1reassignment-configurations/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigurationItemResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#put-reassignment-config - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - - # Update Reassignment Configuration - - try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-V2025ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2025ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ReassignmentConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#put-reassignment-config - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.configuration_item_request import ConfigurationItemRequest - from sailpoint.v2025.models.configuration_item_response import ConfigurationItemResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - configuration_item_request = '''{ - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - }''' # ConfigurationItemRequest | - try: - # Update Reassignment Configuration - new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) - results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id, x_sail_point_experimental, new_configuration_item_request) - print("The response of WorkReassignmentApi->put_reassignment_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) - /reassignment-configurations/{identityId}/{configType}: - delete: - operationId: deleteReassignmentConfiguration - tags: - - Work Reassignment - summary: Delete Reassignment Configuration - description: Deletes a single reassignment configuration for the specified identity - security: - - userAuth: - - idn:reassignment-configuration:delete - parameters: - - in: path - name: identityId - schema: - type: string - description: unique identity id - required: true - x-sailpoint-resource-operation-id: listIdentities - example: 2c91808781a71ddb0181b9090b5c504e - - in: path - name: configType - schema: - type: string - description: Enum list of valid work types that can be selected for a Reassignment Configuration - enum: - - ACCESS_REQUESTS - - CERTIFICATIONS - - MANUAL_TASKS - example: ACCESS_REQUESTS - required: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '204': - description: Reassignment Configuration deleted - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#delete-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Reassignment Configuration - - try { - Remove-V2025ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ReassignmentConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#delete-reassignment-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.config_type_enum import ConfigTypeEnum - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - config_type = sailpoint.v2025.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete Reassignment Configuration - - WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental) - except Exception as e: - print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) - /reassignment-configurations/{identityId}/evaluate/{configType}: - get: - operationId: getEvaluateReassignmentConfiguration - tags: - - Work Reassignment - summary: Evaluate Reassignment Configuration - description: Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - security: - - userAuth: - - idn:reassignment-configuration:evaluate - parameters: - - in: path - name: identityId - required: true - x-sailpoint-resource-operation-id: listIdentities - schema: - type: string - description: unique identity id - example: 2c91808781a71ddb0181b9090b5c504e - - in: path - name: configType - required: true - schema: - $ref: '#/paths/~1reassignment-configurations~1%7BidentityId%7D~1%7BconfigType%7D/delete/parameters/1/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigTypeEnum.yaml - description: Reassignment work type - example: accessRequests - - in: query - name: exclusionFilters - required: false - schema: - type: array - items: - type: string - description: 'Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments' - example: SELF_REVIEW_DELEGATION - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Evaluated Reassignment Configuration - content: - application/json: - schema: - type: array - items: - type: object - description: The response body for Evaluate Reassignment Configuration - properties: - reassignToId: - type: string - description: The Identity ID which should be the recipient of any work items sent to a specific identity & work type - example: 869320b6b6f34a169b6178b1a865e66f - lookupTrail: - type: array - description: List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration - items: - type: object - description: The definition of an Identity according to the Reassignment Configuration service - properties: - reassignedToId: - type: string - description: The ID of the Identity who work is reassigned to - example: 869320b6b6f34a169b6178b1a865e66f - reassignedFromId: - type: string - description: The ID of the Identity who work is reassigned from - example: 51948a8f306a4e7a9a6f8f5d032fa59e - reassignmentType: - type: string - description: Enum list containing types of Reassignment that can be found in the evaluate response. - enum: - - MANUAL_REASSIGNMENT, - - AUTOMATIC_REASSIGNMENT, - - AUTO_ESCALATION, - - SELF_REVIEW_DELEGATION - example: AUTOMATIC_REASSIGNMENT - examples: - empty: - summary: Evaluate response when no Reassignment Configuration is found - value: - reassignToId: 2c9180825a6c1adc015a71c9023f0818 - lookupTrail: [] - longTrail: - summary: Evaluate response when a long Reassignment trail is found - value: - reassignToId: 2c9180825a6c1adc015a71c9023f0818 - lookupTrail: - - reassignedToId: 2c918084575812550157589064f33b89 - reassignedFromId: 2c9180825a6c1adc015a71c9023f0818 - reassignmentType: AUTOMATIC_REASSIGNMENT - - reassignedToId: 073204941f3f49c0b3a3c49d1c17ef0e - reassignedFromId: 2c918084575812550157589064f33b89 - reassignmentType: AUTOMATIC_REASSIGNMENT - - reassignedToId: 31d9c631f5574571a935aaa48a6255df - reassignedFromId: 073204941f3f49c0b3a3c49d1c17ef0e - reassignmentType: AUTOMATIC_REASSIGNMENT - - reassignedToId: 279de502e5dc43f4854e1b96f57c578f - reassignedFromId: 31d9c631f5574571a935aaa48a6255df - reassignmentType: AUTOMATIC_REASSIGNMENT - selfReview: - summary: Evaluate response when a self-review is found and manager or org admin escalation is applied - value: - reassignToId: 2c9180825a6c1adc015a71c9023f0818 - lookupTrail: - - reassignedToId: 2c918084575812550157589064f33b89 - reassignedFromId: 2c9180825a6c1adc015a71c9023f0818 - reassignmentType: AUTOMATIC_REASSIGNMENT - - reassignedToId: 073204941f3f49c0b3a3c49d1c17ef0e - reassignedFromId: 2c918084575812550157589064f33b89 - reassignmentType: AUTOMATIC_REASSIGNMENT - - reassignedToId: 31d9c631f5574571a935aaa48a6255df - reassignedFromId: 073204941f3f49c0b3a3c49d1c17ef0e - reassignmentType: SELF_REVIEW_DELEGATION - - reassignedToId: 279de502e5dc43f4854e1b96f57c578f - reassignedFromId: 31d9c631f5574571a935aaa48a6255df - reassignmentType: AUTOMATIC_REASSIGNMENT - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-evaluate-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - - $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ - - # Evaluate Reassignment Configuration - - try { - Get-V2025EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EvaluateReassignmentConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-evaluate-reassignment-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.config_type_enum import ConfigTypeEnum - from sailpoint.v2025.models.evaluate_response import EvaluateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - config_type = sailpoint.v2025.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - exclusion_filters = '''['SELF_REVIEW_DELEGATION']''' # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - try: - # Evaluate Reassignment Configuration - - results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) - print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) - /reassignment-configurations/tenant-config: - get: - operationId: getTenantConfigConfiguration - tags: - - Work Reassignment - summary: Get Tenant-wide Reassignment Configuration settings - description: Gets the global Reassignment Configuration settings for the requestor's tenant. - security: - - userAuth: - - idn:reassignment-tenant-configuration:read - responses: - '200': - description: Tenant-wide Reassignment Configuration settings - content: - application/json: - schema: - type: object - description: Tenant-wide Reassignment Configuration settings - properties: - auditDetails: - type: object - description: Audit details for the reassignment configuration of an identity - properties: - created: - type: string - description: Initial date and time when the record was created - format: date-time - example: '2022-07-21T11:13:12.345Z' - createdBy: - $ref: '#/paths/~1reassignment-configurations/get/responses/200/content/application~1json/schema/items/properties/identity' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/Identity.yaml - modified: - type: string - description: Last modified date and time for the record - format: date-time - example: '2022-07-21T11:13:12.345Z' - modifiedBy: - $ref: '#/paths/~1reassignment-configurations/get/responses/200/content/application~1json/schema/items/properties/identity' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/Identity.yaml - configDetails: - type: object - description: Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) - properties: - disabled: - type: boolean - nullable: true - description: Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. - default: false - example: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-tenant-config-configuration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Tenant-wide Reassignment Configuration settings - - try { - Get-V2025TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantConfigConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-tenant-config-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tenant_configuration_response import TenantConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Tenant-wide Reassignment Configuration settings - - results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) - put: - operationId: putTenantConfiguration - tags: - - Work Reassignment - summary: Update Tenant-wide Reassignment Configuration settings - description: Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - security: - - userAuth: - - idn:reassignment-tenant-configuration:update - requestBody: - required: true - content: - application/json: - schema: - type: object - description: Tenant-wide Reassignment Configuration settings - properties: - configDetails: - $ref: '#/paths/~1reassignment-configurations~1tenant-config/get/responses/200/content/application~1json/schema/properties/configDetails' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/TenantConfigurationDetails.yaml - responses: - '200': - description: Tenant-wide Reassignment Configuration settings - content: - application/json: - schema: - $ref: '#/paths/~1reassignment-configurations~1tenant-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/TenantConfigurationResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#put-tenant-configuration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TenantConfigurationRequest = @" - { - "configDetails" : { - "disabled" : true - } - } - "@ - - # Update Tenant-wide Reassignment Configuration settings - - try { - $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-V2025TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2025TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TenantConfiguration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#put-tenant-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tenant_configuration_request import TenantConfigurationRequest - from sailpoint.v2025.models.tenant_configuration_response import TenantConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - tenant_configuration_request = '''{ - "configDetails" : { - "disabled" : true - } - }''' # TenantConfigurationRequest | - try: - # Update Tenant-wide Reassignment Configuration settings - new_tenant_configuration_request = TenantConfigurationRequest.from_json(tenant_configuration_request) - results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental=x_sail_point_experimental, tenant_configuration_request=new_tenant_configuration_request) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental, new_tenant_configuration_request) - print("The response of WorkReassignmentApi->put_tenant_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) - /recommendations/request: - post: - operationId: getRecommendations - summary: Returns Recommendation Based on Object - tags: - - IAI Recommendations - description: The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - requests: - type: array - items: - type: object - properties: - identityId: - type: string - description: The identity ID - example: 2c938083633d259901633d25c68c00fa - item: - type: object - properties: - id: - type: string - description: ID of the access item to retrieve the recommendation for. - example: 2c938083633d259901633d2623ec0375 - type: - type: string - example: ENTITLEMENT - description: Access item's type. - enum: - - ENTITLEMENT - - ACCESS_PROFILE - - ROLE - excludeInterpretations: - type: boolean - description: Exclude interpretations in the response if "true". Return interpretations in the response if this attribute is not specified. - default: 'false' - example: 'false' - includeTranslationMessages: - type: boolean - description: When set to true, the calling system uses the translated messages for the specified language - default: 'false' - example: 'false' - includeDebugInformation: - type: boolean - description: Returns the recommender calculations if set to true - default: 'false' - example: 'true' - prescribeMode: - type: boolean - description: When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. - default: 'false' - example: 'false' - responses: - '200': - description: The recommendations for a customer - content: - application/json: - schema: - type: object - properties: - response: - type: array - items: - type: object - properties: - request: - $ref: '#/paths/~1recommendations~1request/post/requestBody/content/application~1json/schema/properties/requests/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RecommendationRequest.yaml - recommendation: - type: string - example: 'YES' - description: The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system - enum: - - 'YES' - - 'NO' - - MAYBE - - NOT_FOUND - interpretations: - type: array - items: - type: string - description: The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ "Not approved in the last 6 months." ]. Interpretations will be translated using the client's locale as found in the Accept-Language header. If a translation for the client's locale cannot be found, the US English translation will be returned. - example: - - 75% of identities with the same department have this access. This information had a high impact on the overall score. - - 67% of identities with the same peer group have this access. This information had a low impact on the overall score. - - 42% of identities with the same location have this access. This information had a low impact on the overall score. - translationMessages: - type: array - example: - - key: recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH - values: - - '75' - - department - items: - $ref: '#/paths/~1ai-access-request-recommendations/get/responses/200/content/application~1json/schema/items/properties/translationMessages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TranslationMessage.yaml - description: The list of translation messages, if they have been requested. - recommenderCalculations: - properties: - identityId: - type: string - description: The ID of the identity - example: 2c91808457d8f3ab0157e3e62cb4213c - entitlementId: - type: string - description: The entitlement ID - example: 2c91809050db617d0150e0bf3215385e - recommendation: - type: string - description: The actual recommendation - example: 'YES' - overallWeightedScore: - type: number - description: The overall weighted score - featureWeightedScores: - type: object - description: The weighted score of each individual feature - additionalProperties: - type: number - threshold: - type: number - description: The configured value against which the overallWeightedScore is compared - identityAttributes: - type: object - description: The values for your configured features - additionalProperties: - type: object - properties: - value: - type: string - featureValues: - type: object - properties: - feature: - type: string - description: The type of feature - example: department - numerator: - type: integer - format: int32 - example: 14 - description: The number of identities that have access to the feature - denominator: - type: integer - format: int32 - example: 14 - description: The number of identities with the corresponding feature - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - iai:decisions:manage - x-sailpoint-userLevels: - - Any - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#get-recommendations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RecommendationRequestDto = @" - { - "prescribeMode" : false, - "excludeInterpretations" : false, - "requests" : [ { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - }, { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - } ], - "includeTranslationMessages" : false, - "includeDebugInformation" : true - } - "@ - - # Returns Recommendation Based on Object - - try { - $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto - Get-V2025Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result - - # Below is a request that includes all optional parameters - # Get-V2025Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Recommendations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-recommendations#get-recommendations - source: | - from sailpoint.v2025.api.iai_recommendations_api import IAIRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.recommendation_request_dto import RecommendationRequestDto - from sailpoint.v2025.models.recommendation_response_dto import RecommendationResponseDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - recommendation_request_dto = '''{ - "prescribeMode" : false, - "excludeInterpretations" : false, - "requests" : [ { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - }, { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - } ], - "includeTranslationMessages" : false, - "includeDebugInformation" : true - }''' # RecommendationRequestDto | - try: - # Returns Recommendation Based on Object - new_recommendation_request_dto = RecommendationRequestDto.from_json(recommendation_request_dto) - results = IAIRecommendationsApi(api_client).get_recommendations(x_sail_point_experimental=x_sail_point_experimental, recommendation_request_dto=new_recommendation_request_dto) - # Below is a request that includes all optional parameters - # results = IAIRecommendationsApi(api_client).get_recommendations(x_sail_point_experimental, new_recommendation_request_dto) - print("The response of IAIRecommendationsApi->get_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) - /recommendations/config: - get: - operationId: getRecommendationsConfig - summary: Get certification recommendation config values - tags: - - IAI Recommendations - description: Retrieves configuration attributes used by certification recommendations. - responses: - '200': - description: Cert recommendation configuration attributes - content: - application/json: - schema: - type: object - properties: - recommenderFeatures: - type: array - items: - type: string - description: List of identity attributes to use for calculating certification recommendations - example: - - jobTitle - - location - - peer_group - - department - - active - peerGroupPercentageThreshold: - type: number - description: The percent value that the recommendation calculation must surpass to produce a YES recommendation - minimum: 0 - maximum: 1 - format: float - example: 0.5 - runAutoSelectOnce: - type: boolean - description: If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run - default: false - example: false - onlyTuneThreshold: - type: boolean - description: If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run - default: false - example: false - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - iai:configuration:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#get-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get certification recommendation config values - - try { - Get-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RecommendationsConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-recommendations#get-recommendations-config - source: | - from sailpoint.v2025.api.iai_recommendations_api import IAIRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.recommendation_config_dto import RecommendationConfigDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get certification recommendation config values - - results = IAIRecommendationsApi(api_client).get_recommendations_config(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRecommendationsApi(api_client).get_recommendations_config(x_sail_point_experimental) - print("The response of IAIRecommendationsApi->get_recommendations_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) - put: - operationId: updateRecommendationsConfig - summary: Update certification recommendation config values - tags: - - IAI Recommendations - description: Updates configuration attributes used by certification recommendations. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1recommendations~1config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RecommendationConfigDto.yaml - responses: - '200': - description: Cert recommendation configuration attributes after update - content: - application/json: - schema: - $ref: '#/paths/~1recommendations~1config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RecommendationConfigDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - iai:configuration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#update-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RecommendationConfigDto = @" - { - "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], - "peerGroupPercentageThreshold" : 0.5, - "runAutoSelectOnce" : false, - "onlyTuneThreshold" : false - } - "@ - - # Update certification recommendation config values - - try { - $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto - Update-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result - - # Below is a request that includes all optional parameters - # Update-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RecommendationsConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-recommendations#update-recommendations-config - source: | - from sailpoint.v2025.api.iai_recommendations_api import IAIRecommendationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.recommendation_config_dto import RecommendationConfigDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - recommendation_config_dto = '''{ - "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], - "peerGroupPercentageThreshold" : 0.5, - "runAutoSelectOnce" : false, - "onlyTuneThreshold" : false - }''' # RecommendationConfigDto | - try: - # Update certification recommendation config values - new_recommendation_config_dto = RecommendationConfigDto.from_json(recommendation_config_dto) - results = IAIRecommendationsApi(api_client).update_recommendations_config(x_sail_point_experimental=x_sail_point_experimental, recommendation_config_dto=new_recommendation_config_dto) - # Below is a request that includes all optional parameters - # results = IAIRecommendationsApi(api_client).update_recommendations_config(x_sail_point_experimental, new_recommendation_config_dto) - print("The response of IAIRecommendationsApi->update_recommendations_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) - /role-insights/requests: - post: - operationId: createRoleInsightRequests - summary: Generate insights for roles - deprecated: true - tags: - - Role Insights - description: Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - responses: - '201': - description: Submitted a role insights generation request - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: Request Id for a role insight generation request - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - createdDate: - type: string - format: date-time - description: The date-time role insights request was created. - example: '2020-09-16T18:49:32.150Z' - lastGenerated: - type: string - format: date-time - description: The date-time role insights request was completed. - example: '2020-09-16T18:50:12.150Z' - numberOfUpdates: - type: integer - description: Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. - example: 0 - roleIds: - description: The role IDs that are in this request. - type: array - items: - type: string - status: - type: string - description: Request status - enum: - - CREATED - - IN PROGRESS - - COMPLETED - - FAILED - example: - id: c9aa02f7-86b0-4bc4-84bd-3116a6131e77 - createdDate: '2020-09-16T18:49:32.150Z' - lastGenerated: '2020-09-16T18:49:32.150Z' - numberOfUpdates: 0 - roleIds: - - 2c91808e720e94f8017253287c0a44f4 - - 2c918087723ac2800172532191540e03 - - 2c9180986e4c8592016e6b15eaef447c - status: CREATED - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#create-role-insight-requests - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Generate insights for roles - - try { - New-V2025RoleInsightRequests -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # New-V2025RoleInsightRequests -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025RoleInsightRequests" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#create-role-insight-requests - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insights_response import RoleInsightsResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Generate insights for roles - - results = RoleInsightsApi(api_client).create_role_insight_requests(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).create_role_insight_requests(x_sail_point_experimental) - print("The response of RoleInsightsApi->create_role_insight_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) - /role-insights/requests/{id}: - get: - operationId: getRoleInsightsRequests - summary: Returns metadata from prior request. - deprecated: true - tags: - - Role Insights - description: 'This endpoint returns details of a prior role insights request. ' - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleInsights - description: The role insights request id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns details of an earlier role insights request. - content: - application/json: - schema: - $ref: '#/paths/~1role-insights~1requests/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleInsightsResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-requests - source: | - $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Returns metadata from prior request. - - try { - Get-V2025RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsRequests" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights-requests - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insights_response import RoleInsightsResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Returns metadata from prior request. - - results = RoleInsightsApi(api_client).get_role_insights_requests(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_role_insights_requests(id, x_sail_point_experimental) - print("The response of RoleInsightsApi->get_role_insights_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) - /role-insights/summary: - get: - operationId: getRoleInsightsSummary - summary: Get role insights summary information - tags: - - Role Insights - description: This method returns high level summary information for role insights for a customer. - responses: - '200': - description: Succeeded. Returns high level counts. - content: - application/json: - schema: - type: object - properties: - numberOfUpdates: - type: integer - description: Total number of roles with updates - lastGenerated: - type: string - format: date-time - description: The date-time role insights were last found. - example: '2020-05-19T13:49:37.385Z' - entitlementsIncludedInRoles: - type: integer - description: The number of entitlements included in roles (vs free radicals). - example: 45 - totalNumberOfEntitlements: - type: integer - description: The total number of entitlements. - example: 250 - identitiesWithAccessViaRoles: - type: integer - description: The number of identities in roles vs. identities with just entitlements and not in roles. - example: 550 - totalNumberOfIdentities: - type: integer - description: The total number of identities. - example: 980 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-summary - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get role insights summary information - - try { - Get-V2025RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsSummary" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights-summary - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insights_summary import RoleInsightsSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get role insights summary information - - results = RoleInsightsApi(api_client).get_role_insights_summary(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_role_insights_summary(x_sail_point_experimental) - print("The response of RoleInsightsApi->get_role_insights_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) - /role-insights: - get: - operationId: getRoleInsights - summary: Get role insights - tags: - - Role Insights - description: This method returns detailed role insights for each role. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: sorters - in: query - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - example: numberOfUpdates - required: false - style: form - explode: true - schema: - type: string - - name: filters - in: query - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **name**: *sw* - - **ownerName**: *sw* - - **description**: *sw* - required: false - style: form - explode: true - example: name sw "John" - schema: - type: string - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of roles with information about insights for each role. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Insight id - example: 1467e61e-f284-439c-ba2d-c6cc11cf0941 - numberOfUpdates: - type: integer - description: Total number of updates for this role - example: 5 - createdDate: - type: string - format: date-time - description: The date-time insights were last created for this role. - modifiedDate: - type: string - format: date-time - nullable: true - description: The date-time insights were last modified for this role. - example: '2020-05-19T13:49:37.385Z' - role: - type: object - properties: - name: - type: string - description: Role name - example: Software Engineer - id: - type: string - description: Role id - example: 1467e61e-f284-439c-ba2d-c6cc11cf0941 - description: - type: string - description: Role description - example: Person who develops software - ownerName: - type: string - description: Role owner name - example: Bob - ownerId: - type: string - description: Role owner id - example: 1467e61e-f284-439c-ba2d-c6cc11cf0941 - insight: - type: object - properties: - type: - type: string - description: The number of identities in this role with the entitlement. - example: ADD - identitiesWithAccess: - type: integer - description: The number of identities in this role with the entitlement. - example: 850 - identitiesImpacted: - type: integer - description: The number of identities in this role that do not have the specified entitlement. - example: 150 - totalNumberOfIdentities: - type: integer - description: The total number of identities. - example: 1000 - impactedIdentityNames: - type: string - nullable: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) - $Filters = "name sw "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) - - # Get role insights - - try { - Get-V2025RoleInsights -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsights -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsights" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insight import RoleInsight - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'numberOfUpdates' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) - filters = 'name sw \"John\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) - try: - # Get role insights - - results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) - print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) - /role-insights/{insightId}: - get: - operationId: getRoleInsight - summary: Get a single role insight - tags: - - Role Insights - description: This endpoint gets role insights information for a role. - parameters: - - in: path - name: insightId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleInsights - description: The role insight id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns information about insights for a single role. - content: - application/json: - schema: - $ref: '#/paths/~1role-insights/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleInsight.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insight - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a single role insight - - try { - Get-V2025RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsight" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insight - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insight import RoleInsight - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a single role insight - - results = RoleInsightsApi(api_client).get_role_insight(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_role_insight(insight_id, x_sail_point_experimental) - print("The response of RoleInsightsApi->get_role_insight:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) - /role-insights/{insightId}/entitlement-changes: - get: - operationId: getRoleInsightsEntitlementsChanges - summary: Get entitlement insights for a role - tags: - - Role Insights - description: This endpoint returns entitlement insights for a role. - parameters: - - in: path - name: insightId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleInsights - description: The role insight id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: query - name: sorters - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **identitiesWithAccess, name** - required: false - style: form - explode: true - schema: - type: string - - in: query - name: filters - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **name**: *sw* - - **description**: *sw* - required: false - style: form - example: name sw "Admin" - explode: true - schema: - type: string - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of entitlements to be added for a role. - content: - application/json: - schema: - type: array - items: - type: object - properties: - name: - type: string - description: Name of the entitlement - example: Administrator - id: - type: string - description: Id of the entitlement - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - description: - type: string - nullable: true - description: Description for the entitlement - example: Full administrative access to IdentityNow - attribute: - type: string - description: Attribute for the entitlement - example: assignedGroups - value: - type: string - description: Attribute value for the entitlement - example: ORG_ADMIN - source: - type: string - description: Source or the application for the entitlement - example: IdentityNow - insight: - $ref: '#/paths/~1role-insights/get/responses/200/content/application~1json/schema/items/properties/insight' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleInsightsInsight.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-entitlements-changes - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) - $Filters = "name sw "Admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Get entitlement insights for a role - - try { - Get-V2025RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsEntitlementsChanges" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights-entitlements-changes - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insights_entitlement_changes import RoleInsightsEntitlementChanges - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) - filters = 'name sw \"Admin\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - try: - # Get entitlement insights for a role - - results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) - print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) - /role-insights/{insightId}/entitlement-changes/download: - get: - operationId: downloadRoleInsightsEntitlementsChanges - summary: Download entitlement insights for a role - tags: - - Role Insights - description: This endpoint returns the entitlement insights for a role. - parameters: - - in: path - name: insightId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleInsights - description: The role insight id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: query - name: sorters - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **identitiesWithAccess** - - The default sort is **identitiesWithAccess** in descending order. - required: false - example: identitiesWithAccess - style: form - explode: true - schema: - type: string - - in: query - name: filters - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **name**: *sw* - - **description**: *sw* - example: name sw "r" - required: false - style: form - explode: true - schema: - type: string - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a csv file containing a list of entitlements to be added for a role. - content: - text/csv: - schema: - type: string - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#download-role-insights-entitlements-changes - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) - $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Download entitlement insights for a role - - try { - Invoke-V2025DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Invoke-V2025DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025DownloadRoleInsightsEntitlementsChanges" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#download-role-insights-entitlements-changes - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'identitiesWithAccess' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) - filters = 'name sw \"r\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - try: - # Download entitlement insights for a role - - results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) - print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) - /role-insights/{insightId}/current-entitlements: - get: - operationId: getRoleInsightsCurrentEntitlements - summary: Get current entitlement for a role - tags: - - Role Insights - description: This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding. - parameters: - - in: path - name: insightId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleInsights - description: The role insight id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: query - name: filters - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **name**: *sw* - - **description**: *sw* - example: name sw "r" - required: false - style: form - explode: true - schema: - type: string - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of current or pre-existing entitlements for a role. - content: - application/json: - schema: - type: array - items: - type: object - properties: - name: - type: string - description: Name of the entitlement - example: Administrator - id: - type: string - description: Id of the entitlement - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - description: - type: string - description: Description for the entitlement - nullable: true - example: Full administrative access to IdentityNow - source: - type: string - description: Source or the application for the entitlement - example: IdentityNow - attribute: - type: string - description: Attribute for the entitlement - example: assignedGroups - value: - type: string - description: Attribute value for the entitlement - example: ORG_ADMIN - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-current-entitlements - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Get current entitlement for a role - - try { - Get-V2025RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsCurrentEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights-current-entitlements - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insights_entitlement import RoleInsightsEntitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'name sw \"r\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - try: - # Get current entitlement for a role - - results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) - print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) - /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities: - get: - operationId: getEntitlementChangesIdentities - summary: Get identities for a suggested entitlement (for a role) - tags: - - Role Insights - description: Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - parameters: - - in: path - name: insightId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleInsights - description: The role insight id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: entitlementId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listEntitlements - description: The entitlement id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: query - name: hasEntitlement - description: Identity has this entitlement or not - required: false - style: form - explode: true - schema: - type: boolean - default: false - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: sorters - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - example: name - required: false - style: form - explode: true - schema: - type: string - - in: query - name: filters - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **name**: *sw* - example: name sw "Jan" - required: false - style: form - explode: true - schema: - type: string - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of identities with or without the entitlement. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Id for identity - name: - type: string - description: Name for identity - attributes: - type: object - additionalProperties: - type: string - example: - id: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - name: Adam Smith - attributes: - department: Human Resources-tah-mgb-dnd - firstName: Adam - jobTitle: Sales Analyst - location: Mexico - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-entitlement-changes-identities - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "name sw "Jan"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - - # Get identities for a suggested entitlement (for a role) - - try { - Get-V2025EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChangesIdentities" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/role-insights#get-entitlement-changes-identities - source: | - from sailpoint.v2025.api.role_insights_api import RoleInsightsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_insights_identities import RoleInsightsIdentities - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id - entitlement_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The entitlement id # str | The entitlement id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - has_entitlement = False # bool | Identity has this entitlement or not (optional) (default to False) # bool | Identity has this entitlement or not (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'name sw \"Jan\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - try: - # Get identities for a suggested entitlement (for a role) - - results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id=insight_id, entitlement_id=entitlement_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters) - print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) - /role-mining-sessions: - post: - operationId: createRoleMiningSessions - summary: Create a role mining session - tags: - - IAI Role Mining - description: This submits a create role mining session request to the role mining application. - requestBody: - description: Role mining session parameters - required: true - content: - application/json: - schema: - type: object - properties: - scope: - type: object - properties: - identityIds: - type: array - items: - type: string - description: The list of identities for this role mining session. - example: - - 2c918090761a5aac0176215c46a62d58 - - 2c918090761a5aac01722015c46a62d42 - criteria: - type: string - description: The "search" criteria that produces the list of identities for this role mining session. - nullable: true - example: source.name:DataScienceDataset - attributeFilterCriteria: - type: array - items: - type: object - description: The filter criteria for this role mining session. - nullable: true - example: - displayName: - untranslated: 'Location: Miami' - ariaLabel: - untranslated: 'Location: Miami' - data: - displayName: - translateKey: IDN.IDENTITY_ATTRIBUTES.LOCATION - name: location - operator: EQUALS - values: - - Miami - pruneThreshold: - type: integer - description: The prune threshold to be used or null to calculate prescribedPruneThreshold - nullable: true - example: 50 - format: int32 - prescribedPruneThreshold: - type: integer - description: The calculated prescribedPruneThreshold - nullable: true - example: 10 - format: int32 - minNumIdentitiesInPotentialRole: - type: integer - description: Minimum number of identities in a potential role - nullable: true - example: 20 - format: int32 - potentialRoleCount: - type: integer - description: Number of potential roles - example: 0 - format: int32 - potentialRolesReadyCount: - type: integer - description: Number of potential roles ready - example: 0 - format: int32 - type: - type: string - description: Role type - enum: - - SPECIALIZED - - COMMON - example: SPECIALIZED - emailRecipientId: - type: string - description: The id of the user who will receive an email about the role mining session - nullable: true - example: 2c918090761a5aac0176215c46a62d58 - identityCount: - type: integer - description: Number of identities in the population which meet the search criteria or identity list provided - example: 0 - format: int32 - saved: - type: boolean - description: The session's saved status - default: false - example: true - name: - type: string - description: The session's saved name - nullable: true - example: Saved RM Session - 07/10 - responses: - '201': - description: Submitted a role mining session request - content: - application/json: - schema: - type: object - properties: - scope: - $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/scope' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionScope.yaml - minNumIdentitiesInPotentialRole: - type: integer - nullable: true - description: Minimum number of identities in a potential role - example: 20 - scopingMethod: - type: string - description: The scoping method of the role mining session - nullable: true - example: AUTO_RM - prescribedPruneThreshold: - type: integer - nullable: true - description: The computed (or prescribed) prune threshold for this session - example: 83 - pruneThreshold: - type: integer - nullable: true - description: The prune threshold to be used for this role mining session - example: 70 - potentialRoleCount: - type: integer - description: The number of potential roles - example: 8 - potentialRolesReadyCount: - type: integer - description: The number of potential roles which have completed processing - example: 4 - status: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1status/get/responses/200/content/application~1json/schema' - description: The role mining session status - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionStatus.yaml - emailRecipientId: - type: string - description: The id of the user who will receive an email about the role mining session - nullable: true - createdBy: - oneOf: - - type: object - properties: - id: - type: string - description: ID of the creator - example: 2c918090761a5aac0176215c46a62d58 - displayName: - type: string - description: The display name of the creator - example: Ashley.Pierce - - type: string - nullable: true - description: Workaround to support null - example: Dummy - description: The session created by details - identityCount: - type: integer - description: The number of identities - example: 39 - saved: - type: boolean - description: The session's saved status - default: false - example: true - name: - type: string - description: The session's saved name - nullable: true - example: Saved RM Session - 07/10 - dataFilePath: - type: string - description: The data file path of the role mining session - nullable: true - id: - type: string - description: Session Id for this role mining session - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - createdDate: - type: string - format: date-time - description: The date-time when this role mining session was created. - modifiedDate: - type: string - format: date-time - description: The date-time when this role mining session was completed. - type: - $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/RoleMiningRoleType.yaml - example: - scope: - identityIds: [] - criteria: source.name:DataScienceDataset - attributeFilterCriteria: null - scopingMethod: AUTO_RM - minNumIdentitiesInPotentialRole: 20 - pruneThreshold: 70 - prescribedPruneThreshold: 83 - potentialRoleCount: 8 - potentialRolesReadyCount: 4 - status: - state: POTENTIAL_ROLES_PROCESSING - type: SPECIALIZED - emailRecipientId: null - createdBy: null - identityCount: 0 - saved: false - name: null - dataFilePath: null - id: 602ba738-cf48-499b-a780-7b67b3fc1ecf - createdDate: '2021-09-08T16:11:05.348Z' - modifiedDate: '2021-09-08T16:11:05.348Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#create-role-mining-sessions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleMiningSessionDto = @" - { - "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", - "prescribedPruneThreshold" : 10, - "pruneThreshold" : 50, - "saved" : true, - "potentialRolesReadyCount" : 0, - "scope" : { - "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], - "attributeFilterCriteria" : { - "displayName" : { - "untranslated" : "Location: Miami" - }, - "ariaLabel" : { - "untranslated" : "Location: Miami" - }, - "data" : { - "displayName" : { - "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" - }, - "name" : "location", - "operator" : "EQUALS", - "values" : [ "Miami" ] - } - }, - "criteria" : "source.name:DataScienceDataset" - }, - "potentialRoleCount" : 0, - "name" : "Saved RM Session - 07/10", - "minNumIdentitiesInPotentialRole" : 20, - "identityCount" : 0, - "type" : "SPECIALIZED" - } - "@ - - # Create a role mining session - - try { - $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto - New-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result - - # Below is a request that includes all optional parameters - # New-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025RoleMiningSessions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#create-role-mining-sessions - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_session_dto import RoleMiningSessionDto - from sailpoint.v2025.models.role_mining_session_response import RoleMiningSessionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - role_mining_session_dto = '''{ - "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", - "prescribedPruneThreshold" : 10, - "pruneThreshold" : 50, - "saved" : true, - "potentialRolesReadyCount" : 0, - "scope" : { - "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], - "attributeFilterCriteria" : { - "displayName" : { - "untranslated" : "Location: Miami" - }, - "ariaLabel" : { - "untranslated" : "Location: Miami" - }, - "data" : { - "displayName" : { - "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" - }, - "name" : "location", - "operator" : "EQUALS", - "values" : [ "Miami" ] - } - }, - "criteria" : "source.name:DataScienceDataset" - }, - "potentialRoleCount" : 0, - "name" : "Saved RM Session - 07/10", - "minNumIdentitiesInPotentialRole" : 20, - "identityCount" : 0, - "type" : "SPECIALIZED" - }''' # RoleMiningSessionDto | Role mining session parameters - try: - # Create a role mining session - new_role_mining_session_dto = RoleMiningSessionDto.from_json(role_mining_session_dto) - results = IAIRoleMiningApi(api_client).create_role_mining_sessions(x_sail_point_experimental=x_sail_point_experimental, role_mining_session_dto=new_role_mining_session_dto) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).create_role_mining_sessions(x_sail_point_experimental, new_role_mining_session_dto) - print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) - get: - operationId: getRoleMiningSessions - summary: Retrieves all role mining sessions - tags: - - IAI Role Mining - description: Returns all role mining sessions that match the query parameters - parameters: - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **saved**: *eq* - - **name**: *eq, sw* - example: saved eq "true" and name sw "RM Session" - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **createdBy, createdDate** - example: createdBy,createdDate - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns all role mining sessions that match the query parameters. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-sessions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) - $Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all role mining sessions - - try { - Get-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSessions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-role-mining-sessions - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_session_dto import RoleMiningSessionDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'saved eq \"true\" and name sw \"RM Session\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) - sorters = 'createdBy,createdDate' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves all role mining sessions - - results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) - /role-mining-sessions/{sessionId}: - patch: - operationId: patchRoleMiningSession - summary: Patch a role mining session - tags: - - IAI Role Mining - description: The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id to be patched - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - description: Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /pruneThreshold - value: '83' - - op: replace - path: /minNumIdentitiesInPotentialRole - value: '10' - - op: replace - path: /saved - value: 'false' - - op: replace - path: /name - value: RM Session - 07/10/22 - - op: add - path: /name - value: RM Session - 07/10/22 - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-role-mining-session - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a role mining session - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RoleMiningSession" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#patch-role-mining-session - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}]''' # List[JsonPatchOperation] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - try: - # Patch a role mining session - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, x_sail_point_experimental, new_json_patch_operation) - print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) - get: - operationId: getRoleMiningSession - summary: Get a role mining session - tags: - - IAI Role Mining - description: The method retrieves a role mining session. - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id to be retrieved. - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Returns a role mining session - content: - application/json: - schema: - $ref: '#/paths/~1role-mining-sessions/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-session - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a role mining session - - try { - Get-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSession" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-role-mining-session - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_session_response import RoleMiningSessionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a role mining session - - results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->get_role_mining_session:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) - /role-mining-sessions/{sessionId}/status: - get: - operationId: getRoleMiningSessionStatus - summary: Get role mining session status state - tags: - - IAI Role Mining - description: This method returns a role mining session status for a customer. - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns session status - content: - application/json: - schema: - type: object - properties: - state: - type: string - description: Role mining session status - enum: - - CREATED - - UPDATED - - IDENTITIES_OBTAINED - - PRUNE_THRESHOLD_OBTAINED - - POTENTIAL_ROLES_PROCESSING - - POTENTIAL_ROLES_CREATED - example: CREATED - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-session-status - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get role mining session status state - - try { - Get-V2025RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSessionStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-role-mining-session-status - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_session_status import RoleMiningSessionStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get role mining session status state - - results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-role-summaries: - get: - operationId: getPotentialRoleSummaries - summary: Retrieves all potential role summaries - tags: - - IAI Role Mining - description: This method returns the potential role summaries for a role mining session. - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: query - name: sorters - required: false - style: form - explode: true - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **createdDate** - example: createdDate - - in: query - name: filters - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **createdById**: *eq, sw, co* - - **createdByName**: *eq, sw, co* - - **description**: *sw, co* - - **endDate**: *le, lt* - - **freshness**: *eq, ge, gt, le, lt* - - **name**: *eq, sw, co* - - **quality**: *eq, ge, gt, le, lt* - - **startDate**: *ge, gt* - - **saved**: *eq* - - **type**: *eq* - example: (createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true)) - required: false - style: form - explode: true - schema: - type: string - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of potential role summaries for a role mining session. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Id of the potential role - example: e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 - name: - type: string - description: Name of the potential role - example: Potential Role - e0cc5d - potentialRoleRef: - type: object - properties: - id: - type: string - description: Id of the potential role - example: e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 - name: - type: string - description: Name of the potential role - example: Potential Role - e0cc5d - identityCount: - type: integer - description: The number of identities in a potential role. - format: int32 - example: 25 - entitlementCount: - type: integer - description: The number of entitlements in a potential role. - format: int32 - example: 15 - identityGroupStatus: - type: string - description: The status for this identity group which can be "REQUESTED" or "OBTAINED" - example: OBTAINED - provisionState: - type: string - description: Provision state - enum: - - POTENTIAL - - PENDING - - COMPLETE - - FAILED - - null - example: POTENTIAL - roleId: - type: string - description: ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. - nullable: true - example: 2a4be6fbcf3c4e66b95a0c15ffd591 - density: - type: integer - description: The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. - format: int32 - example: 90 - freshness: - type: integer - description: The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. - format: int32 - example: 70 - quality: - type: integer - description: The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. - format: int32 - example: 80 - type: - $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/RoleMiningRoleType.yaml - createdBy: - oneOf: - - $ref: '#/paths/~1role-mining-sessions/post/responses/201/content/application~1json/schema/properties/createdBy/oneOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/EntityCreatedByDTO.yaml - - $ref: '#/paths/~1role-mining-sessions/post/responses/201/content/application~1json/schema/properties/createdBy/oneOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/NullableEntityCreatedByDTO.yaml - description: The potential role created by details - createdDate: - type: string - format: date-time - description: The date-time when this potential role was created. - saved: - type: boolean - description: The potential role's saved status - default: false - example: true - description: - type: string - nullable: true - description: Description of the potential role - session: - type: object - properties: - id: - type: string - description: The ID of the role mining session - example: 9f36f5e5-1e81-4eca-b087-548959d91c71 - name: - type: string - description: The session's saved name - nullable: true - example: Saved RM Session - 07/10 - minNumIdentitiesInPotentialRole: - type: integer - description: Minimum number of identities in a potential role - nullable: true - example: 20 - format: int32 - pruneThreshold: - type: integer - description: The prune threshold to be used or null to calculate prescribedPruneThreshold - nullable: true - example: 5 - format: int32 - saved: - type: boolean - default: true - description: The session's saved status - example: true - scope: - $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/scope' - description: The scope of identities for this role mining session - example: - identityIds: [] - criteria: source.name:DataScienceDataset - attributeFilterCriteria: - displayName: - untranslated: 'Location: Miami' - ariaLabel: - untranslated: 'Location: Miami' - data: - displayName: - translateKey: IDN.IDENTITY_ATTRIBUTES.LOCATION - name: location - operator: EQUALS - values: - - Miami - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionScope.yaml - type: - $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/type' - description: Role mining potential type - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/RoleMiningRoleType.yaml - state: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1status/get/responses/200/content/application~1json/schema/properties/state' - description: Role mining session state - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionState.yaml - scopingMethod: - type: string - description: The scoping method used in the current role mining session. - enum: - - MANUAL - - AUTO_RM - example: MANUAL - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-summaries - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) - $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all potential role summaries - - try { - Get-V2025PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleSummaries" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role-summaries - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'createdDate' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) - filters = '(createdByName co \"int\")and (createdById sw \"2c9180907\")and (type eq \"COMMON\")and ((name co \"entt\")or (saved eq true))' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves all potential role summaries - - results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}: - get: - operationId: getPotentialRole - summary: Retrieves a specific potential role - tags: - - IAI Role Mining - description: This method returns a specific potential role for a role mining session. - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of potential roles for a role mining session. - content: - application/json: - schema: - type: object - properties: - createdBy: - oneOf: - - $ref: '#/paths/~1role-mining-sessions/post/responses/201/content/application~1json/schema/properties/createdBy/oneOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/EntityCreatedByDTO.yaml - - $ref: '#/paths/~1role-mining-sessions/post/responses/201/content/application~1json/schema/properties/createdBy/oneOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/NullableEntityCreatedByDTO.yaml - description: The session created by details - density: - type: integer - description: The density of a potential role. - example: 75 - format: int32 - description: - type: string - nullable: true - description: The description of a potential role. - example: Potential Role for Accounting dept - entitlementCount: - type: integer - description: The number of entitlements in a potential role. - example: 25 - format: int32 - excludedEntitlements: - description: The list of entitlement ids to be excluded. - nullable: true - type: array - items: - type: string - example: - - 07a0b4e2 - - 13b4e2a0 - freshness: - type: integer - description: The freshness of a potential role. - example: 75 - format: int32 - identityCount: - type: integer - description: The number of identities in a potential role. - example: 25 - format: int32 - identityDistribution: - description: Identity attribute distribution. - nullable: true - type: array - items: - type: object - properties: - attributeName: - type: string - description: Id of the potential role - example: department - distribution: - type: array - items: - type: object - additionalProperties: true - example: - - attributeValue: NM Tier 3 - count: 6 - identityIds: - description: The list of ids in a potential role. - type: array - items: - type: string - example: - - 07a0b4e2 - - 13b4e2a0 - name: - type: string - description: Name of the potential role. - example: Saved Potential Role - 07/10 - provisionState: - allOf: - - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries/get/responses/200/content/application~1json/schema/items/properties/provisionState' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRoleProvisionState.yaml - - description: The provisioning state of a potential role. - nullable: true - quality: - type: integer - description: The quality of a potential role. - example: 100 - format: int32 - roleId: - type: string - nullable: true - description: The roleId of a potential role. - example: 07a0b4e2-7a76-44fa-bd0b-c64654b66519 - saved: - type: boolean - description: The potential role's saved status. - example: true - session: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries/get/responses/200/content/application~1json/schema/items/properties/session' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionParametersDto.yaml - type: - $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/RoleMiningRoleType.yaml - id: - type: string - description: Id of the potential role - example: e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 - createdDate: - type: string - format: date-time - description: The date-time when this potential role was created. - modifiedDate: - type: string - format: date-time - description: The date-time when this potential role was modified. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieves a specific potential role - - try { - Get-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentialRole - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Retrieves a specific potential role - - results = IAIRoleMiningApi(api_client).get_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->get_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) - patch: - operationId: patchPotentialRole - summary: Update a potential role - tags: - - IAI Role Mining - description: | - The method updates an existing potential role using. - - The following fields can be modified: - - * `description` - - * `name` - - * `saved` - - - >**NOTE: All other fields cannot be modified.** - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: The potential role summary id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json-patch+json: - schema: - type: array - items: - allOf: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - properties: - op: - type: string - description: The operation to be performed - enum: - - remove - - replace - example: replace - example: - - op: remove - path: /description - - op: replace - path: /description - value: Acct I - Potential Role - - op: remove - path: /saved - - op: replace - path: /saved - value: 'false' - - op: remove - path: /name - - op: replace - path: /name - value: Potential Role Accounting - responses: - '200': - description: Succeeded. Returns the potential role summary based on the potentialRoleId provided. - content: - application/json: - schema: - type: object - items: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries~1%7BpotentialRoleId%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRole.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ - - - # Update a potential role - - try { - $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#patch-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - patch_potential_role_request_inner = '''[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]''' # List[PatchPotentialRoleRequestInner] | - try: - # Update a potential role - new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner.from_json(patch_potential_role_request_inner) - results = IAIRoleMiningApi(api_client).patch_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental, patch_potential_role_request_inner=new_patch_potential_role_request_inner) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, new_patch_potential_role_request_inner) - print("The response of IAIRoleMiningApi->patch_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications: - get: - operationId: getPotentialRoleApplications - summary: Retrieves the applications of a potential role for a role mining session - tags: - - IAI Role Mining - description: This method returns the applications of a potential role for a role mining session. - parameters: - - in: query - name: filters - schema: - type: string - required: false - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **applicationName**: *sw* - example: applicationName sw "test" - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 62f28d91-7d9f-4d17-be15-666d5b41d77f - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of potential roles for a role mining session. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Id of the application - example: - id: 2c9180877212632a017228d5a796292b - name: - type: string - description: Name of the application - example: - name: Slack - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - iai:access-modeling:read - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-applications - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves the applications of a potential role for a role mining session - - try { - Get-V2025PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleApplications" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role-applications - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_application import RoleMiningPotentialRoleApplication - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '62f28d91-7d9f-4d17-be15-666d5b41d77f' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'applicationName sw \"test\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves the applications of a potential role for a role mining session - - results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements: - get: - operationId: getPotentialRoleEntitlements - summary: Retrieves the entitlements of a potential role for a role mining session - tags: - - IAI Role Mining - description: This method returns the entitlements of a potential role for a role mining session. - parameters: - - in: query - name: filters - schema: - type: string - required: false - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **entitlementRef.name**: *sw* - example: entitlementRef.name sw "test" - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 62f28d91-7d9f-4d17-be15-666d5b41d77f - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns the entitlements of a potential role for a role mining session. session. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Id of the entitlement - example: - id: 2c9180877212632a017228d5a796292c - name: - type: string - description: Name of the entitlement - example: - name: LauncherTest2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - iai:access-modeling:read - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-entitlements - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves the entitlements of a potential role for a role mining session - - try { - Get-V2025PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role-entitlements - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_entitlements import RoleMiningPotentialRoleEntitlements - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '62f28d91-7d9f-4d17-be15-666d5b41d77f' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - filters = 'entitlementRef.name sw \"test\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves the entitlements of a potential role for a role mining session - - results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities: - get: - operationId: getEntitlementsPotentialRole - summary: Retrieves entitlements for a potential role in a role mining session - tags: - - IAI Role Mining - description: This method returns entitlements for a potential role in a role mining session. - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: query - name: includeCommonAccess - description: Boolean determining whether common access entitlements will be included or not - example: true - required: false - style: form - explode: true - schema: - type: boolean - default: true - - in: query - name: sorters - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **popularity, entitlementName, applicationName** - - The default sort is **popularity** in descending order. - example: popularity - required: false - style: form - explode: true - schema: - type: string - - in: query - name: filters - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **applicationName**: *sw* - - **entitlementRef.name**: *sw* - example: applicationName sw "AD" - required: false - style: form - explode: true - schema: - type: string - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of entitlements for a potential role. - content: - application/json: - schema: - type: array - items: - type: object - properties: - entitlementRef: - type: object - properties: - id: - type: string - description: Id of the entitlement - example: 2c91808a7e95e6e0017e96e2086206c8 - name: - type: string - description: Name of the entitlement - example: App.entitlement.1 - description: - type: string - description: Description forthe entitlement - nullable: true - example: Entitlement 1 - attribute: - type: string - description: The entitlement attribute - example: groups - name: - type: string - description: Name of the entitlement - example: Add/modify/delete users - applicationName: - type: string - description: Application name of the entitlement - example: AppName - identityCount: - type: integer - description: The number of identities with this entitlement in a role. - format: int32 - example: 45 - popularity: - type: number - description: The % popularity of this entitlement in a role. - format: float - example: 65.2 - popularityInOrg: - type: number - description: The % popularity of this entitlement in the org. - format: float - example: 35.8 - sourceId: - type: string - description: The ID of the source/application. - example: 2c9180877620c1460176267f336a106f - activitySourceState: - type: string - description: The status of activity data for the source. Value is complete or notComplete. - nullable: true - example: complete - sourceUsagePercent: - type: number - description: The percentage of identities in the potential role that have usage of the source/application of this entitlement. - format: float - nullable: true - example: 65.6 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: [] - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) - $Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) - $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves entitlements for a potential role in a role mining session - - try { - Get-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-entitlements-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_entitlement import RoleMiningEntitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - include_common_access = True # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to True) # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to True) - sorters = 'popularity' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) - filters = 'applicationName sw \"AD\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves entitlements for a potential role in a role mining session - - results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution: - get: - operationId: getEntitlementDistributionPotentialRole - summary: Retrieves entitlement popularity distribution for a potential role in a role mining session - tags: - - IAI Role Mining - description: This method returns entitlement popularity distribution for a potential role in a role mining session. - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: query - name: includeCommonAccess - description: Boolean determining whether common access entitlements will be included or not - required: false - style: form - explode: true - schema: - type: boolean - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a map containing entitlement popularity distribution for a potential role. - content: - application/json: - schema: - type: object - additionalProperties: - type: integer - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-entitlement-distribution-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) - - # Retrieves entitlement popularity distribution for a potential role in a role mining session - - try { - Get-V2025EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementDistributionPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-entitlement-distribution-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - include_common_access = True # bool | Boolean determining whether common access entitlements will be included or not (optional) # bool | Boolean determining whether common access entitlements will be included or not (optional) - try: - # Retrieves entitlement popularity distribution for a potential role in a role mining session - - results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access) - print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements: - post: - operationId: updateEntitlementsPotentialRole - summary: Edit entitlements for a potential role to exclude some entitlements - tags: - - IAI Role Mining - description: This endpoint adds or removes entitlements from an exclusion list for a potential role. - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - description: Role mining session parameters - required: true - content: - application/json: - schema: - type: object - properties: - ids: - description: The list of entitlement ids to be edited - type: array - items: - type: string - exclude: - type: boolean - description: If true, add ids to be exclusion list. If false, remove ids from the exclusion list. - example: - ids: - - entId1 - - entId2 - exclude: true - responses: - '201': - description: Adds or removes entitlements from a potential role's entitlement exclusion list. - content: - application/json: - schema: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries~1%7BpotentialRoleId%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRole.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#update-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleMiningPotentialRoleEditEntitlements = @" - { - "ids" : [ "entId1", "entId2" ], - "exclude" : true - } - "@ - - # Edit entitlements for a potential role to exclude some entitlements - - try { - $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements - Update-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result - - # Below is a request that includes all optional parameters - # Update-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#update-entitlements-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentialRole - from sailpoint.v2025.models.role_mining_potential_role_edit_entitlements import RoleMiningPotentialRoleEditEntitlements - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - role_mining_potential_role_edit_entitlements = '''{ - "ids" : [ "entId1", "entId2" ], - "exclude" : true - }''' # RoleMiningPotentialRoleEditEntitlements | Role mining session parameters - try: - # Edit entitlements for a potential role to exclude some entitlements - new_role_mining_potential_role_edit_entitlements = RoleMiningPotentialRoleEditEntitlements.from_json(role_mining_potential_role_edit_entitlements) - results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental, role_mining_potential_role_edit_entitlements=new_role_mining_potential_role_edit_entitlements) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, new_role_mining_potential_role_edit_entitlements) - print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities: - get: - operationId: getIdentitiesPotentialRole - summary: Retrieves identities for a potential role in a role mining session - tags: - - IAI Role Mining - description: This method returns identities for a potential role in a role mining session. - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: query - name: sorters - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - required: false - style: form - explode: true - example: name - schema: - type: string - - in: query - name: filters - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **name**: *sw* - required: false - style: form - explode: true - schema: - type: string - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of identities for a potential role. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Id of the identity - example: 2c9180877212632a017228d5934525e6 - name: - type: string - description: Name of the identity - example: Allene Abernathy-Welch - attributes: - type: object - additionalProperties: - type: string - nullable: true - example: - jobTitle: SQL Developer - department: IT - location: NYC - firstName: Allene - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-identities-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves identities for a potential role in a role mining session - - try { - Get-V2025IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitiesPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-identities-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_identity import RoleMiningIdentity - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'filters_example' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves identities for a potential role in a role mining session - - results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export: - get: - operationId: exportRoleMiningPotentialRole - summary: Export (download) details for a potential role in a role mining session - tags: - - IAI Role Mining - description: This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. - content: - application/zip: - schema: - type: string - format: binary - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Export (download) details for a potential role in a role mining session - - try { - Export-V2025RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2025RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#export-role-mining-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Export (download) details for a potential role in a role mining session - - results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async: - post: - operationId: exportRoleMiningPotentialRoleAsync - summary: Asynchronously export details for a potential role in a role mining session and upload to S3 - tags: - - IAI Role Mining - description: This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 278359a6-04b7-4669-9468-924cf580964a - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - content: - application/json: - schema: - type: object - properties: - minEntitlementPopularity: - type: integer - description: The minimum popularity among identities in the role which an entitlement must have to be included in the report - example: 0 - includeCommonAccess: - type: boolean - description: If false, do not include entitlements that are highly popular among the entire orginization - example: true - example: - minEntitlementPopularity: 0 - includeCommonAccess: true - responses: - '202': - description: Job Submitted. Returns a reportId that can be used to download the zip once complete - content: - application/json: - schema: - allOf: - - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-roles~1%7BpotentialRoleId%7D~1export-async/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRoleExportRequest.yaml - - type: object - properties: - exportId: - type: string - format: uuid - description: ID used to reference this export - example: 0c6cdb76-1227-4aaf-af21-192dbdfbfa04 - status: - type: string - enum: - - QUEUED - - IN_PROGRESS - - SUCCESS - - ERROR - example: - exportId: 0c6cdb76-1227-4aaf-af21-192dbdfbfa04 - status: QUEUED - minEntitlementPopularity: 0 - includeCommonAccess: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role-async - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleMiningPotentialRoleExportRequest = @" - { - "minEntitlementPopularity" : 0, - "includeCommonAccess" : true - } - "@ - - # Asynchronously export details for a potential role in a role mining session and upload to S3 - - try { - Export-V2025RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2025RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleExportRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRoleAsync" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#export-role-mining-potential-role-async - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_export_request import RoleMiningPotentialRoleExportRequest - from sailpoint.v2025.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - role_mining_potential_role_export_request = '''{ - "minEntitlementPopularity" : 0, - "includeCommonAccess" : true - }''' # RoleMiningPotentialRoleExportRequest | (optional) - try: - # Asynchronously export details for a potential role in a role mining session and upload to S3 - - results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, new_role_mining_potential_role_export_request) - print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}: - get: - operationId: exportRoleMiningPotentialRoleStatus - summary: Retrieve status of a potential role export job - tags: - - IAI Role Mining - description: This endpoint retrieves information about the current status of a potential role export. - parameters: - - in: path - name: sessionId - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 278359a6-04b7-4669-9468-924cf580964a - - in: path - name: exportId - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: exportRoleMiningPotentialRoleAsync - description: The id of a previously run export job for this potential role - example: 4940ffd4-836f-48a3-b2b0-6d498c3fdf40 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Success. Returns the current status of this export - content: - application/json: - schema: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-roles~1%7BpotentialRoleId%7D~1export-async/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRoleExportResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role-status - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieve status of a potential role export job - - try { - Export-V2025RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2025RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRoleStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#export-role-mining-potential-role-status - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - export_id = '4940ffd4-836f-48a3-b2b0-6d498c3fdf40' # str | The id of a previously run export job for this potential role # str | The id of a previously run export job for this potential role - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Retrieve status of a potential role export job - - results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id=session_id, potential_role_id=potential_role_id, export_id=export_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download: - get: - operationId: downloadRoleMiningPotentialRoleZip - summary: Export (download) details for a potential role in a role mining session - tags: - - IAI Role Mining - description: This endpoint downloads a completed export of information for a potential role in a role mining session. - parameters: - - in: path - name: sessionId - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 278359a6-04b7-4669-9468-924cf580964a - - in: path - name: exportId - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: exportRoleMiningPotentialRoleAsync - description: The id of a previously run export job for this potential role - example: 4940ffd4-836f-48a3-b2b0-6d498c3fdf40 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. - content: - application/zip: - schema: - type: string - format: binary - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#download-role-mining-potential-role-zip - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Export (download) details for a potential role in a role mining session - - try { - Invoke-V2025DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Invoke-V2025DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025DownloadRoleMiningPotentialRoleZip" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#download-role-mining-potential-role-zip - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - export_id = '4940ffd4-836f-48a3-b2b0-6d498c3fdf40' # str | The id of a previously run export job for this potential role # str | The id of a previously run export job for this potential role - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Export (download) details for a potential role in a role mining session - - results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id=session_id, potential_role_id=potential_role_id, export_id=export_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id, potential_role_id, export_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision: - post: - operationId: createPotentialRoleProvisionRequest - summary: Create request to provision a potential role into an actual role. - tags: - - IAI Role Mining - description: This method starts a job to provision a potential role - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: query - name: min-entitlement-popularity - description: Minimum popularity required for an entitlement to be included in the provisioned role. - required: false - style: form - explode: true - schema: - type: integer - default: 0 - minimum: 0 - maximum: 100 - - in: query - name: include-common-access - description: Boolean determining whether common access entitlements will be included in the provisioned role. - required: false - style: form - explode: true - schema: - type: boolean - default: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - description: Required information to create a new role - content: - application/json: - schema: - type: object - properties: - roleName: - type: string - description: Name of the new role being created - example: Finance - Accounting - roleDescription: - type: string - description: Short description of the new role being created - example: General access for accounting department - ownerId: - type: string - description: ID of the identity that will own this role - example: 2b568c65bc3c4c57a43bd97e3a8e41 - includeIdentities: - type: boolean - description: When true, create access requests for the identities associated with the potential role - default: false - example: true - directlyAssignedEntitlements: - type: boolean - description: When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements - default: false - example: false - responses: - '202': - description: Accepted. Returns a potential role summary including the status of the provison request - content: - application/json: - schema: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRoleSummary.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#create-potential-role-provision-request - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) - $RoleMiningPotentialRoleProvisionRequest = @" - { - "includeIdentities" : true, - "roleName" : "Finance - Accounting", - "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", - "roleDescription" : "General access for accounting department", - "directlyAssignedEntitlements" : false - } - "@ - - # Create request to provision a potential role into an actual role. - - try { - New-V2025PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # New-V2025PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PotentialRoleProvisionRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#create-potential-role-provision-request - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_provision_request import RoleMiningPotentialRoleProvisionRequest - from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - min_entitlement_popularity = 0 # int | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) # int | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) - include_common_access = True # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to True) # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to True) - role_mining_potential_role_provision_request = '''{ - "includeIdentities" : true, - "roleName" : "Finance - Accounting", - "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", - "roleDescription" : "General access for accounting department", - "directlyAssignedEntitlements" : false - }''' # RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) - try: - # Create request to provision a potential role into an actual role. - - results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, min_entitlement_popularity, include_common_access, new_role_mining_potential_role_provision_request) - print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) - /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements: - get: - operationId: getExcludedEntitlementsPotentialRole - summary: Retrieves excluded entitlements for a potential role in a role mining session - tags: - - IAI Role Mining - description: This method returns excluded entitlements for a potential role in a role mining session. - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id in a role mining session - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: query - name: sorters - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **popularity** - example: populariity - required: false - style: form - explode: true - schema: - type: string - - in: query - name: filters - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **applicationName**: *sw* - - **entitlementRef.name**: *sw* - example: applicationName sw "AD" - required: false - style: form - explode: true - schema: - type: string - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of excluded entitlements for a potential roles. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-roles~1%7BpotentialRoleId%7D~1entitlement-popularities/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningEntitlement.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-excluded-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) - $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves excluded entitlements for a potential role in a role mining session - - try { - Get-V2025ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ExcludedEntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-excluded-entitlements-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_entitlement import RoleMiningEntitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'populariity' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) - filters = 'applicationName sw \"AD\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves excluded entitlements for a potential role in a role mining session - - results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) - /role-mining-potential-roles: - get: - operationId: getAllPotentialRoleSummaries - summary: Retrieves all potential role summaries - tags: - - IAI Role Mining - description: Returns all potential role summaries that match the query parameters - security: - - userAuth: [] - parameters: - - in: query - name: sorters - required: false - style: form - explode: true - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** - example: createdDate - - in: query - name: filters - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **createdById**: *eq, sw, co* - - **createdByName**: *eq, sw, co* - - **description**: *sw, co* - - **endDate**: *le, lt* - - **freshness**: *eq, ge, gt, le, lt* - - **name**: *eq, sw, co, ge, gt, le, lt* - - **quality**: *eq, ge, gt, le, lt* - - **startDate**: *ge, gt* - - **saved**: *eq* - - **type**: *eq, ge, gt, le, lt* - - **scopingMethod**: *eq* - - **sessionState**: *eq* - - **identityAttribute**: *co* - example: (createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true)) - required: false - style: form - explode: true - schema: - type: string - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns all potential role summaries that match the query parameters. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRoleSummary.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-all-potential-role-summaries - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) - $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all potential role summaries - - try { - Get-V2025AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllPotentialRoleSummaries" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-all-potential-role-summaries - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'createdDate' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) - filters = '(createdByName co \"int\") and (createdById sw \"2c9180907\") and (type eq \"COMMON\") and ((name co \"entt\") or (saved eq true))' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves all potential role summaries - - results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) - /role-mining-potential-roles/{potentialRoleId}: - get: - operationId: getRoleMiningPotentialRole - summary: Retrieves a specific potential role - tags: - - IAI Role Mining - description: This method returns a specific potential role. - security: - - userAuth: [] - parameters: - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of potential roles for a role mining session. - content: - application/json: - schema: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries~1%7BpotentialRoleId%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRole.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-potential-role - source: | - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieves a specific potential role - - try { - Get-V2025RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningPotentialRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-role-mining-potential-role - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentialRole - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Retrieves a specific potential role - - results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) - patch: - operationId: patchPotentialRole - summary: Update a potential role - tags: - - IAI Role Mining - description: | - The method updates an existing potential role using. - - The following fields can be modified: - - * `description` - - * `name` - - * `saved` - - - >**NOTE: All other fields cannot be modified.** - security: - - userAuth: [] - parameters: - - in: path - name: sessionId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getRoleMiningSessions - description: The role mining session id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: The potential role summary id - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json-patch+json: - schema: - type: array - items: - allOf: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - properties: - op: - type: string - description: The operation to be performed - enum: - - remove - - replace - example: replace - example: - - op: remove - path: /description - - op: replace - path: /description - value: Acct I - Potential Role - - op: remove - path: /saved - - op: replace - path: /saved - value: 'false' - - op: remove - path: /name - - op: replace - path: /name - value: Potential Role Accounting - responses: - '200': - description: Succeeded. Returns the potential role summary based on the potentialRoleId provided. - content: - application/json: - schema: - type: object - items: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries~1%7BpotentialRoleId%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRole.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-potential-role-0 - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ - - - # Update a potential role - - try { - $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2025PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PotentialRole0" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#patch-potential-role-0 - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id - potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - patch_potential_role_request_inner = '''[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]''' # List[PatchPotentialRoleRequestInner] | - try: - # Update a potential role - new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner.from_json(patch_potential_role_request_inner) - results = IAIRoleMiningApi(api_client).patch_potential_role_0(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental, patch_potential_role_request_inner=new_patch_potential_role_request_inner) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, new_patch_potential_role_request_inner) - print("The response of IAIRoleMiningApi->patch_potential_role_0:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->patch_potential_role_0: %s\n" % e) - /role-mining-potential-roles/saved: - get: - operationId: getSavedPotentialRoles - summary: Retrieves all saved potential roles - tags: - - IAI Role Mining - description: This method returns all saved potential roles (draft roles). - security: - - userAuth: [] - parameters: - - in: query - name: sorters - required: false - style: form - explode: true - schema: - type: string - format: comma-separated - description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified**' - example: modified - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of draft roles for a role mining session. - content: - application/json: - schema: - type: array - items: - type: object - properties: - name: - type: string - description: Name of the draft role - example: Saved RM Session - 07/10 - description: - type: string - description: Draft role description - example: Person who develops software - identityIds: - type: array - items: - type: string - description: The list of identities for this role mining session. - example: - - 2c918090761a5aac0176215c46a62d58 - - 2c918090761a5aac01722015c46a62d42 - entitlementIds: - type: array - items: - type: string - description: The list of entitlement ids for this role mining session. - example: - - 2c91808a7624751a01762f19d665220d - - 2c91808a7624751a01762f19d67c220e - excludedEntitlements: - type: array - description: The list of excluded entitlement ids. - items: - type: string - example: - - 07a0b4e2 - - 13b4e2a0 - modified: - type: string - format: date-time - description: Last modified date - example: '2020-09-16T18:49:32.150Z' - type: - $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/RoleMiningRoleType.yaml - id: - type: string - description: Id of the potential draft role - example: e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 - createdDate: - type: string - format: date-time - description: The date-time when this potential draft role was created. - modifiedDate: - type: string - format: date-time - description: The date-time when this potential draft role was modified. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-saved-potential-roles - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all saved potential roles - - try { - Get-V2025SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedPotentialRoles" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-saved-potential-roles - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_session_draft_role_dto import RoleMiningSessionDraftRoleDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves all saved potential roles - - results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) - /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage: - get: - operationId: getPotentialRoleSourceIdentityUsage - summary: Retrieves potential role source usage - tags: - - IAI Role Mining - description: This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - security: - - userAuth: [] - parameters: - - in: path - name: potentialRoleId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPotentialRoleSummaries - description: A potential role id - example: e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: A source id - example: 2c9180877620c1460176267f336a106f - - in: query - name: sorters - required: false - style: form - explode: true - schema: - type: string - format: comma-separated - description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount**' - example: '-usageCount' - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Succeeded. Returns a list of source usage for the identities in a potential role. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The identity ID - example: 2c918089762475180176267f894b54dc - displayName: - type: string - description: Display name for the identity - example: Kirk Koepp - email: - type: string - description: Email address for the identity - example: kirk.koepp@testmail.identitynow.com - usageCount: - type: integer - description: The number of days there has been usage of the source by the identity. - format: int32 - example: 25 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-source-identity-usage - source: | - $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id - $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves potential role source usage - - try { - Get-V2025PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleSourceIdentityUsage" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role-source-identity-usage - source: | - from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_mining_potential_role_source_usage import RoleMiningPotentialRoleSourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id - source_id = '2c9180877620c1460176267f336a106f' # str | A source id # str | A source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sorters = '-usageCount' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieves potential role source usage - - results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id=potential_role_id, source_id=source_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count) - print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) - /roles/{id}/entitlements: - get: - operationId: getRoleEntitlements - tags: - - Roles - summary: List Role's Entitlements - description: Get a list of entitlements associated with a specified role. - parameters: - - name: id - in: path - description: Containing role's ID. - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - example: 2c91808a7813090a017814121919ecca - - $ref: '#/paths/~1connector-rules/get/parameters/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit50.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **attribute**: *eq, sw* - - **value**: *eq, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **owner.id**: *eq, in* - - **source.id**: *eq, in* - example: attribute eq "memberOf" - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, attribute, value, created, modified** - example: name,-modified - required: false - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of Entitlements - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:read - - idn:role-unchecked:manage - - idn:role-checked:manage - - idn:role-checked:read - - applicationAuth: - - idn:role-unchecked:read - - idn:role-unchecked:manage - - idn:role-checked:manage - - idn:role-checked:read - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | Containing role's ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Role's Entitlements - - try { - Get-V2025RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleEntitlements" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#get-role-entitlements - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.entitlement import Entitlement - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'attribute eq \"memberOf\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - try: - # List Role's Entitlements - - results = RolesApi(api_client).get_role_entitlements(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) - /send-test-notification: - post: - operationId: sendTestNotification - tags: - - Notifications - summary: Send Test Notification - description: Send a Test Notification - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - key: - type: string - description: The template notification key. - example: cloud_manual_work_item_summary - medium: - type: string - description: The notification medium. Has to be one of the following enum values. - enum: - - EMAIL - - SLACK - - TEAMS - context: - type: object - description: A Json object that denotes the context specific to the template. - example: - key: cloud_manual_work_item_summary - medium: EMAIL - context: - numberOfPendingTasks: '4' - ownerId: 201327fda1c44704ac01181e963d463c - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#send-test-notification - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SendTestNotificationRequestDto = @" - { - "context" : "{}", - "medium" : "EMAIL", - "key" : "cloud_manual_work_item_summary" - } - "@ - - # Send Test Notification - - try { - $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto - Send-V2025TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result - - # Below is a request that includes all optional parameters - # Send-V2025TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TestNotification" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#send-test-notification - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.send_test_notification_request_dto import SendTestNotificationRequestDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - send_test_notification_request_dto = '''{ - "context" : "{}", - "medium" : "EMAIL", - "key" : "cloud_manual_work_item_summary" - }''' # SendTestNotificationRequestDto | - try: - # Send Test Notification - new_send_test_notification_request_dto = SendTestNotificationRequestDto.from_json(send_test_notification_request_dto) - NotificationsApi(api_client).send_test_notification(x_sail_point_experimental=x_sail_point_experimental, send_test_notification_request_dto=new_send_test_notification_request_dto) - # Below is a request that includes all optional parameters - # NotificationsApi(api_client).send_test_notification(x_sail_point_experimental, new_send_test_notification_request_dto) - except Exception as e: - print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) - /sim-integrations/{id}: - put: - tags: - - SIM Integrations - summary: Update an existing SIM integration - description: Update an existing SIM integration. - operationId: putSIMIntegration - requestBody: - description: The full DTO of the integration containing the updated model - content: - application/json: - schema: - type: object - title: Sim Integration Details - allOf: - - $ref: '#/components/schemas/Account/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - - type: object - properties: - description: - type: string - description: The description of the integration - example: Integration description - nullable: false - type: - type: string - description: The integration type - example: ServiceNow Service Desk - nullable: false - attributes: - type: object - description: The attributes map containing the credentials used to configure the integration. - nullable: true - example: '{"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"}' - sources: - type: array - description: The list of sources (managed resources) - items: - type: string - example: - - 2c9180835d191a86015d28455b4a2329 - - 2c5680835d191a85765d28455b4a9823 - nullable: false - cluster: - type: string - description: The cluster/proxy - example: xyzzy999 - nullable: false - statusMap: - type: object - description: Custom mapping between the integration result and the provisioning result - example: - closed_cancelled: Failed - closed_complete: Committed - closed_incomplete: Failed - closed_rejected: Failed - in_process: Queued - requested: Queued - request: - type: object - description: Request data to customize desc and body of the created ticket - example: - description: SailPoint Access Request, - req_description: The Service Request created by SailPoint ServiceNow Service Integration Module (SIM)., - req_short_description: SailPoint New Access Request Created from IdentityNow, - short_description: SailPoint Access Request $!plan.arguments.identityRequestId - beforeProvisioningRule: - description: Before provisioning rule of integration - properties: - type: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml - id: - type: string - description: ID of the rule - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Human-readable display name of the rule - example: Example Rule - required: true - parameters: - - name: id - in: path - description: The id of the integration. - schema: - type: string - example: 12345 - required: true - x-sailpoint-resource-operation-id: getSIMIntegrations - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: details of the updated integration - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-admin:create - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) - get: - tags: - - SIM Integrations - summary: Get a SIM integration details. - description: Get the details of a SIM integration. - operationId: getSIMIntegration - parameters: - - name: id - in: path - description: The id of the integration. - schema: - type: string - example: 12345 - required: true - x-sailpoint-resource-operation-id: getSIMIntegrations - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The DTO containing the details of the SIM integration - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-admin:read - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a SIM integration details. - - try { - Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a SIM integration details. - - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) - delete: - tags: - - SIM Integrations - summary: Delete a SIM integration - description: Get the details of a SIM integration. - operationId: deleteSIMIntegration - parameters: - - name: id - description: The id of the integration to delete. - in: path - schema: - type: string - example: 12345 - required: true - x-sailpoint-resource-operation-id: getSIMIntegrations - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: No content response - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-admin:write - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration - source: | - $Id = "12345" # String | The id of the integration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a SIM integration - - try { - Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) - patch: - tags: - - SIM Integrations - summary: Patch a SIM attribute. - description: Patch a SIM attribute given a JsonPatch object. - operationId: patchSIMAttributes - requestBody: - required: true - description: The JsonPatch object that describes the changes of SIM - content: - application/json-patch+json: - schema: - $ref: '#/paths/~1configuration-hub~1scheduled-actions~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatch.yaml - parameters: - - name: id - description: SIM integration id - in: path - schema: - type: string - example: 12345 - required: true - x-sailpoint-resource-operation-id: getSIMIntegrations - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The updated DTO containing the details of the SIM integration. - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-admin:write - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) - /sim-integrations/{id}/beforeProvisioningRule: - patch: - tags: - - SIM Integrations - summary: Patch a SIM beforeProvisioningRule attribute. - description: Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - operationId: patchBeforeProvisioningRule - requestBody: - required: true - description: The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - content: - application/json-patch+json: - schema: - $ref: '#/paths/~1configuration-hub~1scheduled-actions~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatch.yaml - parameters: - - name: id - in: path - description: SIM integration id - schema: - type: string - example: 12345 - required: true - x-sailpoint-resource-operation-id: getSIMIntegrations - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The updated DTO containing the details of the SIM integration. - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-admin:write - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) - /sim-integrations: - get: - tags: - - SIM Integrations - summary: List the existing SIM integrations. - description: List the existing SIM integrations. - operationId: getSIMIntegrations - responses: - '200': - description: The DTO containing the details of the SIM integration - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-admin:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) - post: - tags: - - SIM Integrations - summary: Create new SIM integration - description: Create a new SIM Integrations. - operationId: createSIMIntegration - requestBody: - description: DTO containing the details of the SIM integration - content: - application/json: - schema: - $ref: '#/paths/~1sim-integrations~1%7Bid%7D/put/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SimIntegrationDetails.yaml - required: true - responses: - '200': - description: details of the created integration - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:service-desk-admin:create - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) - /sp-config/export: - post: - operationId: exportSpConfig - security: - - userAuth: - - sp:config:read - - sp:config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - SP-Config - summary: Initiates configuration objects export job - description: |- - This post will export objects from the tenant to a JSON configuration file. - For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). - requestBody: - description: Export options control what will be included in the export. - required: true - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - excludeTypes: - description: Object type names to be excluded from an sp-config export command. - type: array - items: - type: string - enum: - - ACCESS_PROFILE - - ACCESS_REQUEST_CONFIG - - ATTR_SYNC_SOURCE_CONFIG - - AUTH_ORG - - CAMPAIGN_FILTER - - CONNECTOR_RULE - - FORM_DEFINITION - - GOVERNANCE_GROUP - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - LIFECYCLE_STATE - - NOTIFICATION_TEMPLATE - - PASSWORD_POLICY - - PASSWORD_SYNC_GROUP - - PUBLIC_IDENTITIES_CONFIG - - ROLE - - RULE - - SEGMENT - - SERVICE_DESK_INTEGRATION - - SOD_POLICY - - SOURCE - - TAG - - TRANSFORM - - TRIGGER_SUBSCRIPTION - - WORKFLOW - example: SOURCE - includeTypes: - description: Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - type: array - items: - type: string - enum: - - ACCESS_PROFILE - - ACCESS_REQUEST_CONFIG - - ATTR_SYNC_SOURCE_CONFIG - - AUTH_ORG - - CAMPAIGN_FILTER - - CONNECTOR_RULE - - FORM_DEFINITION - - GOVERNANCE_GROUP - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - LIFECYCLE_STATE - - NOTIFICATION_TEMPLATE - - PASSWORD_POLICY - - PASSWORD_SYNC_GROUP - - PUBLIC_IDENTITIES_CONFIG - - ROLE - - RULE - - SEGMENT - - SERVICE_DESK_INTEGRATION - - SOD_POLICY - - SOURCE - - TAG - - TRANSFORM - - TRIGGER_SUBSCRIPTION - - WORKFLOW - example: TRIGGER_SUBSCRIPTION - objectOptions: - description: Additional options targeting specific objects related to each item in the includeTypes field - type: object - additionalProperties: - $ref: '#/paths/~1sp-config~1import/post/requestBody/content/multipart~1form-data/schema/properties/options/properties/objectOptions/additionalProperties' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ObjectExportImportOptions.yaml - example: - TRIGGER_SUBSCRIPTION: - includedIds: - - be9e116d-08e1-49fc-ab7f-fa585e96c9e4 - includedNames: - - Test 2 - properties: - description: - type: string - description: Optional user defined description/name for export job. - example: Export Job 1 Test - examples: - Export all objects available: - description: Export all object types available in IDN. - value: - description: Export all available objects - excludeTypes: [] - includeTypes: - - ACCESS_PROFILE - - ACCESS_REQUEST_CONFIG - - ATTR_SYNC_SOURCE_CONFIG - - AUTH_ORG - - CAMPAIGN_FILTER - - CONNECTOR_RULE - - FORM_DEFINITION - - GOVERNANCE_GROUP - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - LIFECYCLE_STATE - - NOTIFICATION_TEMPLATE - - PASSWORD_POLICY - - PASSWORD_SYNC_GROUP - - PUBLIC_IDENTITIES_CONFIG - - ROLE - - RULE - - SEGMENT - - SERVICE_DESK_INTEGRATION - - SOD_POLICY - - SOURCE - - TAG - - TRANSFORM - - TRIGGER_SUBSCRIPTION - - WORKFLOW - objectOptions: {} - Export sources by ID: - description: Export only sources that match the IDs specified in the export options. - value: - description: Export sources by ID - excludeTypes: [] - includeTypes: - - SOURCE - objectOptions: - SOURCE: - includedIds: - - be9e116d-08e1-49fc-ab7f-fa585e96c9e4 - - be9p119e-90e1-49pk-ac9f-fa576e96c9e4 - includedNames: [] - Export transforms by name: - description: Export only transforms that match the names specified in the export options. - value: - description: Export transforms by name - excludeTypes: [] - includeTypes: - - TRANSFORM - objectOptions: - TRANSFORM: - includedIds: [] - includedNames: - - Remove Diacritical Marks - - Common - Location Lookup - Export trigger subscriptions triggers and transforms with custom options: - description: Export trigger subscriptions and transforms that match the export options. - value: - description: Export trigger subscriptions and transforms with custom filter options - excludeTypes: [] - includeTypes: - - TRANSFORM - - TRIGGER_SUBSCRIPTION - objectOptions: - TRANSFORM: - includedIds: [] - includedNames: - - Remove Diacritical Marks - - Common - Location Lookup - TRIGGER_SUBSCRIPTION: - includedIds: - - be9e116d-08e1-49fc-ab7f-fa585e96c9e4 - - be9p119e-90e1-49pk-ac9f-fa576e96c9e4 - includedNames: - - 'NGROK Test: fire and forget' - - Manager Certification - responses: - '202': - description: Export job accepted and queued for processing. - content: - application/json: - schema: - allOf: - - $ref: '#/paths/~1sp-config~1import/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SpConfigJob.yaml - - type: object - nullable: true - properties: - description: - type: string - description: Optional user defined description/name for export job. - example: ETS configuration objects from Acme-Solar sandbox - '400': - description: | - Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2025SpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2025SpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.export_payload import ExportPayload - from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) - /sp-config/export/{id}: - get: - operationId: getSpConfigExportStatus - security: - - userAuth: - - sp:config:read - - sp:config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - SP-Config - summary: Get export job status - description: |- - This gets the status of the export job identified by the `id` parameter. - The request will need one of the following security scopes: - - sp:config:read - sp:config:manage - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: exportSpConfig - description: The ID of the export job whose status will be returned. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Export job status successfully returned. - content: - application/json: - schema: - allOf: - - $ref: '#/paths/~1sp-config~1export/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SpConfigExportJob.yaml - - type: object - nullable: true - properties: - completed: - type: string - format: date-time - description: The time the job was completed. - example: '2021-05-11T22:23:16Z' - example: - jobId: 1e824aa0-4c6e-4f14-95e9-e7dc5234aa51 - status: COMPLETE - type: EXPORT - message: null - description: Export Job 1 Test - expiration: '2021-05-20T15:04:24Z' - created: '2021-05-13T15:04:24.112Z' - modified: '2021-05-13T15:04:27.363Z' - completed: '2021-05-13T15:04:27.358Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-V2025SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) - /sp-config/export/{id}/download: - get: - operationId: getSpConfigExport - security: - - userAuth: - - sp:config:read - - sp:config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - SP-Config - summary: Download export job result. - description: |- - This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. - The request will need one of the following security scopes: - - sp:config:read - sp:config:manage - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: exportSpConfig - description: The ID of the export job whose results will be downloaded. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Exported JSON objects. - content: - application/json: - schema: - type: object - title: Config Export Response Body - description: Response model for config export download response. - properties: - version: - type: integer - description: Current version of the export results object. - example: 1 - timestamp: - type: string - format: date-time - description: Time the export was completed. - example: '2021-05-11T22:23:16Z' - tenant: - type: string - description: Name of the tenant where this export originated. - example: sample-tenant - description: - type: string - description: Optional user defined description/name for export job. - example: Export Job 1 Test - options: - type: object - properties: - excludeTypes: - description: Object type names to be excluded from an sp-config export command. - type: array - items: - type: string - enum: - - ACCESS_PROFILE - - ACCESS_REQUEST_CONFIG - - ATTR_SYNC_SOURCE_CONFIG - - AUTH_ORG - - CAMPAIGN_FILTER - - CONNECTOR_RULE - - FORM_DEFINITION - - GOVERNANCE_GROUP - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - LIFECYCLE_STATE - - NOTIFICATION_TEMPLATE - - PASSWORD_POLICY - - PASSWORD_SYNC_GROUP - - PUBLIC_IDENTITIES_CONFIG - - ROLE - - RULE - - SEGMENT - - SERVICE_DESK_INTEGRATION - - SOD_POLICY - - SOURCE - - TAG - - TRANSFORM - - TRIGGER_SUBSCRIPTION - - WORKFLOW - example: SOURCE - includeTypes: - description: Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - type: array - items: - type: string - enum: - - ACCESS_PROFILE - - ACCESS_REQUEST_CONFIG - - ATTR_SYNC_SOURCE_CONFIG - - AUTH_ORG - - CAMPAIGN_FILTER - - CONNECTOR_RULE - - FORM_DEFINITION - - GOVERNANCE_GROUP - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - LIFECYCLE_STATE - - NOTIFICATION_TEMPLATE - - PASSWORD_POLICY - - PASSWORD_SYNC_GROUP - - PUBLIC_IDENTITIES_CONFIG - - ROLE - - RULE - - SEGMENT - - SERVICE_DESK_INTEGRATION - - SOD_POLICY - - SOURCE - - TAG - - TRANSFORM - - TRIGGER_SUBSCRIPTION - - WORKFLOW - example: TRIGGER_SUBSCRIPTION - objectOptions: - description: Additional options targeting specific objects related to each item in the includeTypes field - type: object - additionalProperties: - type: object - properties: - includedIds: - description: Object ids to be included in an import or export. - type: array - items: - type: string - example: be9e116d-08e1-49fc-ab7f-fa585e96c9e4 - includedNames: - description: Object names to be included in an import or export. - type: array - items: - type: string - example: Test Object - example: - TRIGGER_SUBSCRIPTION: - includedIds: - - be9e116d-08e1-49fc-ab7f-fa585e96c9e4 - includedNames: - - Test 2 - objects: - type: array - items: - type: object - title: Config Object for Export and Import - description: Config export and import format for individual object configurations. - properties: - version: - type: integer - description: Current version of configuration object. - example: 1 - self: - type: object - description: Self block for imported/exported object. - properties: - type: - type: string - description: Imported/exported object's DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. - enum: - - ACCESS_PROFILE - - ACCESS_REQUEST_CONFIG - - ATTR_SYNC_SOURCE_CONFIG - - AUTH_ORG - - CAMPAIGN_FILTER - - CONNECTOR_RULE - - FORM_DEFINITION - - GOVERNANCE_GROUP - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - LIFECYCLE_STATE - - NOTIFICATION_TEMPLATE - - PASSWORD_POLICY - - PASSWORD_SYNC_GROUP - - PUBLIC_IDENTITIES_CONFIG - - ROLE - - RULE - - SEGMENT - - SERVICE_DESK_INTEGRATION - - SOD_POLICY - - SOURCE - - TAG - - TRANSFORM - - TRIGGER_SUBSCRIPTION - - WORKFLOW - example: SOURCE - id: - type: string - description: Imported/exported object's ID. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Imported/exported object's display name. - example: HR Active Directory - object: - description: Object details. Format dependant on the object type. - additionalProperties: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-V2025SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) - /sp-config/import: - post: - operationId: importSpConfig - security: - - userAuth: - - sp:config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - SP-Config - summary: Initiates configuration objects import job - description: | - This post will import objects from a JSON configuration file into a tenant. - By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. - The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. - The backup can be skipped by setting "excludeBackup" to true in the import options. - If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded - using the `/sp-config/export/{exportJobId}/download` endpoint. - - You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. - - For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). - parameters: - - in: query - name: preview - schema: - type: boolean - default: false - required: false - description: | - This option is intended to give the user information about how an - import operation would proceed, without having any effect on the target tenant. - If this parameter is "true", no objects will be imported. Instead, the import - process will pre-process the import file and attempt to resolve references within - imported objects. The import result file will contain messages pertaining to - how specific references were resolved, any errors associated with the preprocessing, - and messages indicating which objects would be imported. - example: 'true' - requestBody: - description: "The form-data \"name\" attribute for the file content must be \"data\".\n\n__Example__\n\n data: \"config_export_0340b957-5caa-44f6-ada2-d3c4c5bd0b19.json\",\n options: {\n \"excludeTypes\": [],\n \"includeTypes\": [\"TRIGGER_SUBSCRIPTION\"],\n \"objectOptions\": {\n \"TRIGGER_SUBSCRIPTION\": {\n \"includedIds\": [ \"193446a1-c431-4326-8ba7-d6eebf922948\"],\n \"includedNames\":[]\n }\n },\n \"defaultReferences\": [\n {\n \"type\": \"TRIGGER_SUBSCRIPTION\",\n \"id\": \"be9e116d-08e1-49fc-ab7f-fa585e96c9e4\",\n \"name\": \"Test Trigger\"\n }\n ],\n \"excludeBackup\": false\n }\n\n__Sample Import File__\n\n {\n \t\"version\": 1,\n \t\"timestamp\": \"2021-05-10T15:19:23.425041-05:00\",\n \t\"tenant\": \"sampleTenant\",\n \t\"options\": {\n \t\t\"excludeTypes\": [],\n \t\t\"includeTypes\": [\"TRIGGER_SUBSCRIPTION\"],\n \t\t\"objectOptions\": null\n \t},\n \t\"objects\": [{\n \t\t\t\"version\": 1,\n \t\t\t\"self\": {\n \t\t\t\t\"type\": \"TRIGGER_SUBSCRIPTION\",\n \t\t\t\t\"name\": \"test trigger\",\n \t\t\t\t\"id\": \"193446a1-c431-4326-8ba7-d6eebf922948\"\n \t\t\t},\n \t\t\t\"object\": {\n \t\t\t\t\"type\": \"HTTP\",\n \t\t\t\t\"enabled\": true,\n \t\t\t\t\"httpConfig\": {\n \t\t\t\t\t\"url\": \"https://localhost\",\n \t\t\t\t\t\"httpAuthenticationType\": \"NO_AUTH\",\n \t\t\t\t\t\"basicAuthConfig\": null,\n \t\t\t\t\t\"bearerTokenAuthConfig\": null,\n \t\t\t\t\t\"httpDispatchMode\": \"SYNC\"\n \t\t\t\t},\n \t\t\t\t\"triggerName\": \"Access Request Submitted\",\n \t\t\t\t\"responseDeadline\": \"PT1H\",\n \t\t\t\t\"name\": \"test trigger\",\n \t\t\t\t\"triggerId\": \"idn:access-request-pre-approval\"\n \t\t\t}\n \t\t}\n \t]\n }\n" - required: true - content: - multipart/form-data: - schema: - type: object - properties: - data: - type: string - format: binary - description: JSON file containing the objects to be imported. - options: - type: object - properties: - excludeTypes: - description: Object type names to be excluded from an sp-config export command. - type: array - items: - type: string - enum: - - CONNECTOR_RULE - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - RULE - - SOURCE - - TRANSFORM - - TRIGGER_SUBSCRIPTION - example: SOURCE - includeTypes: - description: Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - type: array - items: - type: string - enum: - - CONNECTOR_RULE - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - RULE - - SOURCE - - TRANSFORM - - TRIGGER_SUBSCRIPTION - example: TRIGGER_SUBSCRIPTION - objectOptions: - description: Additional options targeting specific objects related to each item in the includeTypes field - type: object - additionalProperties: - type: object - properties: - includedIds: - description: Object ids to be included in an import or export. - type: array - items: - type: string - example: be9e116d-08e1-49fc-ab7f-fa585e96c9e4 - includedNames: - description: Object names to be included in an import or export. - type: array - items: - type: string - example: Test Object - example: - TRIGGER_SUBSCRIPTION: - includedIds: - - be9e116d-08e1-49fc-ab7f-fa585e96c9e4 - includedNames: - - Test 2 - defaultReferences: - description: List of object types that can be used to resolve references on import. - type: array - items: - type: string - enum: - - CONNECTOR_RULE - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - RULE - - SOURCE - - TRANSFORM - - TRIGGER_SUBSCRIPTION - example: TRIGGER_SUBSCRIPTION - excludeBackup: - description: By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. - type: boolean - default: false - example: 'false' - required: - - data - example: - data: config_export_0340b957-5caa-44f6-ada2-d3c4c5bd0b19.json - options: - excludeTypes: [] - includeTypes: - - TRIGGER_SUBSCRIPTION - objectOptions: - TRIGGER_SUBSCRIPTION: - includedIds: - - be9e116d-08e1-49fc-ab7f-fa585e96c9e4 - includedNames: - - Lori Test 2 - defaultReferences: - - type: TRIGGER_SUBSCRIPTION - id: be9e116d-08e1-49fc-ab7f-fa585e96c9e4 - name: Test Trigger - excludeBackup: false - responses: - '202': - description: Import job accepted and queued for processing. - content: - application/json: - schema: - type: object - properties: - jobId: - type: string - description: Unique id assigned to this job. - example: 3469b87d-48ca-439a-868f-2160001da8c1 - status: - type: string - description: Status of the job. - enum: - - NOT_STARTED - - IN_PROGRESS - - COMPLETE - - CANCELLED - - FAILED - example: COMPLETE - type: - type: string - description: Type of the job, either export or import. - enum: - - EXPORT - - IMPORT - example: IMPORT - expiration: - type: string - format: date-time - description: The time until which the artifacts will be available for download. - example: '2021-05-11T22:23:16Z' - created: - type: string - format: date-time - description: The time the job was started. - example: '2021-05-11T22:23:16Z' - modified: - type: string - format: date-time - description: The time of the last update to the job. - example: '2021-05-11T22:23:16Z' - required: - - jobId - - status - - type - - expiration - - created - - modified - '400': - description: | - Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2025SpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.import_options import ImportOptions - from sailpoint.v2025.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) - /sp-config/import/{id}: - get: - operationId: getSpConfigImportStatus - security: - - userAuth: - - sp:config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - SP-Config - summary: Get import job status - description: | - 'This gets the status of the import job identified by the `id` parameter. - - For more information about the object types that currently support import functionality, - refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).' - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: importSpConfig - description: The ID of the import job whose status will be returned. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Import job status successfully returned. - content: - application/json: - schema: - allOf: - - $ref: '#/paths/~1sp-config~1import/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SpConfigJob.yaml - - type: object - nullable: true - properties: - message: - type: string - description: This message contains additional information about the overall status of the job. - example: Download import results for details. - - type: object - nullable: true - properties: - completed: - type: string - format: date-time - description: The time the job was completed. - example: '2021-05-11T22:23:16Z' - example: - jobId: 4fb10503-1c49-4603-8f8d-886e1f6aa47b - status: COMPLETE - type: IMPORT - message: Download import results for details. - description: null - expiration: '2021-05-20T16:42:39Z' - created: '2021-05-13T16:42:39.333Z' - modified: '2021-05-13T16:42:40.71Z' - completed: '2021-05-13T16:42:40.705Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-V2025SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) - /sp-config/import/{id}/download: - get: - operationId: getSpConfigImport - security: - - userAuth: - - sp:config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - SP-Config - summary: Download import job result - description: |- - This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. - The request will need the following security scope: - - sp:config:manage - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: importSpConfig - description: The ID of the import job whose results will be downloaded. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Import results JSON object, containing detailed results of the import operation. - content: - application/json: - schema: - type: object - title: Config Import Response Body - description: Response Body for Config Import command. - properties: - results: - type: object - additionalProperties: - type: object - title: Import Object Response Body - description: Response model for import of a single object. - properties: - infos: - description: Informational messages returned from the target service on import. - type: array - items: - type: object - title: Config Import/Export Message - description: Message model for Config Import/Export. - properties: - key: - type: string - description: Message key. - example: UNKNOWN_REFERENCE_RESOLVER - text: - type: string - description: Message text. - example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]' - details: - type: object - description: Message details if any, in key:value pairs. - additionalProperties: - type: object - example: - details: message details - required: - - key - - text - - details - warnings: - description: Warning messages returned from the target service on import. - type: array - items: - $ref: '#/paths/~1sp-config~1import~1%7Bid%7D~1download/get/responses/200/content/application~1json/schema/properties/results/additionalProperties/properties/infos/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/beta/schemas/SpConfigMessage.yaml - errors: - description: Error messages returned from the target service on import. - type: array - items: - $ref: '#/paths/~1sp-config~1import~1%7Bid%7D~1download/get/responses/200/content/application~1json/schema/properties/results/additionalProperties/properties/infos/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/beta/schemas/SpConfigMessage.yaml - importedObjects: - description: References to objects that were created or updated by the import. - type: array - items: - type: object - description: Object created or updated by import. - properties: - type: - type: string - description: DTO type of object created or updated by import. - enum: - - CONNECTOR_RULE - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - RULE - - SOURCE - - TRANSFORM - - TRIGGER_SUBSCRIPTION - example: SOURCE - id: - type: string - description: ID of object created or updated by import. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Display name of object created or updated by import. - example: HR Active Directory - required: - - infos - - warnings - - errors - - importedObjects - description: The results of an object configuration import job. - example: - results: - TRIGGER_SUBSCRIPTION: - infos: - - key: IMPORT_PREVIEW - text: 'Object to be imported: [c953134c-2224-42f2-a84e-fa5cbb395904, Test 2]' - detail: null - - key: IMPORT_PREVIEW - text: 'Object to be imported: [be9e116d-08e1-49fc-ab7f-fa585e96c9e4, Test 1]' - detail: null - warnings: [] - errors: [] - importedObjects: [] - exportJobId: - type: string - description: If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. - example: be9e116d-08e1-49fc-ab7f-fa585e96c9e4 - required: - - results - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-V2025SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) - /sp-config/config-objects: - get: - operationId: listSpConfigObjects - security: - - userAuth: - - sp:config:read - - sp:config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - SP-Config - summary: Get config object details - description: This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import. - responses: - '200': - description: Object configurations returned successfully. - content: - application/json: - schema: - type: array - items: - title: Object Configuration Model - description: Response model for get object configuration. - type: object - properties: - objectType: - type: string - description: The object type this configuration is for. - example: TRIGGER_SUBSCRIPTION - referenceExtractors: - type: array - nullable: true - description: List of json paths within an exported object of this type that represent references that need to be resolved. - items: - type: string - example: - - $.owner - signatureRequired: - type: boolean - default: false - description: If true, this type of object will be JWS signed and cannot be modified before import. - example: false - alwaysResolveById: - type: boolean - default: false - description: Whether this object type has to be resolved always by ID - example: true - legacyObject: - type: boolean - default: false - description: Whether this is a legacy object - example: false - onePerTenant: - type: boolean - default: false - description: Whether there is only one object of this type - example: false - exportable: - type: boolean - default: false - description: Whether this object can be exported or it is just a reference object - example: true - rules: - type: object - title: Config Object Rules - description: Rules to be applied to the config object during draft process - properties: - takeFromTargetRules: - type: array - items: - type: object - title: Config Object Rule - description: Format of Config Hub Object Rules - properties: - path: - type: string - description: JSONPath expression denoting the path within the object where a value substitution should be applied - example: $.enabled - value: - anyOf: - - type: object - - type: array - - type: string - - type: number - - type: boolean - nullable: true - description: Value to be assigned at the jsonPath location within the object - modes: - type: array - description: Draft modes to which this rule will apply - items: - type: string - enum: - - RESTORE - - PROMOTE - - UPLOAD - example: - - RESTORE - - PROMOTE - defaultRules: - type: array - items: - $ref: '#/paths/~1sp-config~1config-objects/get/responses/200/content/application~1json/schema/items/properties/rules/properties/takeFromTargetRules/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SpConfigRule.yaml - editable: - type: boolean - default: false - description: Whether this object can be edited - example: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects - source: | - - # Get config object details - - try { - Get-V2025SpConfigObjects - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get config object details - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - /sources/{id}/attribute-sync-config: - get: - operationId: getSourceAttrSyncConfig - tags: - - Sources - summary: Attribute Sync Config - description: This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - security: - - userAuth: - - idn:attr-sync-source-config:read - - idn:attr-sync-source-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - HELPDESK - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The source id - example: 2c9180835d191a86015d28455b4a2329 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Attribute synchronization configuration for a source - content: - application/json: - schema: - type: object - description: Specification of attribute sync configuration for a source - required: - - source - - attributes - properties: - source: - type: object - description: Target source for attribute synchronization. - properties: - type: - type: string - description: DTO type of target source for attribute synchronization. - enum: - - SOURCE - example: SOURCE - id: - type: string - description: ID of target source for attribute synchronization. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - nullable: true - description: Human-readable name of target source for attribute synchronization. - example: HR Active Directory - attributes: - type: array - description: Attribute synchronization configuration for specific identity attributes in the context of a source - items: - type: object - description: Specification of source attribute sync mapping configuration for an identity attribute - required: - - name - - displayName - - enabled - - target - properties: - name: - type: string - description: Name of the identity attribute - example: email - displayName: - type: string - description: Display name of the identity attribute - example: Email - enabled: - type: boolean - description: Determines whether or not the attribute is enabled for synchronization - example: true - target: - type: string - description: Name of the source account attribute to which the identity attribute value will be synchronized if enabled - example: mail - example: - - name: email - displayName: Email - enabled: true - target: mail - - name: firstname - displayName: First Name - enabled: false - target: givenName - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-attr-sync-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Attribute Sync Config - - try { - Get-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceAttrSyncConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-attr-sync-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.attr_sync_source_config import AttrSyncSourceConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Attribute Sync Config - - results = SourcesApi(api_client).get_source_attr_sync_config(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_attr_sync_config(id, x_sail_point_experimental) - print("The response of SourcesApi->get_source_attr_sync_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) - put: - operationId: putSourceAttrSyncConfig - tags: - - Sources - summary: Update Attribute Sync Config - description: | - Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. - security: - - userAuth: - - idn:attr-sync-source-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The source id - example: 2c9180835d191a86015d28455b4a2329 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7Bid%7D~1attribute-sync-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AttrSyncSourceConfig.yaml - responses: - '200': - description: Updated attribute synchronization configuration for a source - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7Bid%7D~1attribute-sync-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AttrSyncSourceConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source-attr-sync-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AttrSyncSourceConfig = @" - { - "attributes" : [ { - "name" : "email", - "displayName" : "Email", - "enabled" : true, - "target" : "mail" - }, { - "name" : "firstname", - "displayName" : "First Name", - "enabled" : false, - "target" : "givenName" - } ], - "source" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - } - } - "@ - - # Update Attribute Sync Config - - try { - $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig - Send-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SourceAttrSyncConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#put-source-attr-sync-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.attr_sync_source_config import AttrSyncSourceConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - attr_sync_source_config = '''{ - "attributes" : [ { - "name" : "email", - "displayName" : "Email", - "enabled" : true, - "target" : "mail" - }, { - "name" : "firstname", - "displayName" : "First Name", - "enabled" : false, - "target" : "givenName" - } ], - "source" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - } - }''' # AttrSyncSourceConfig | - try: - # Update Attribute Sync Config - new_attr_sync_source_config = AttrSyncSourceConfig.from_json(attr_sync_source_config) - results = SourcesApi(api_client).put_source_attr_sync_config(id=id, x_sail_point_experimental=x_sail_point_experimental, attr_sync_source_config=new_attr_sync_source_config) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).put_source_attr_sync_config(id, x_sail_point_experimental, new_attr_sync_source_config) - print("The response of SourcesApi->put_source_attr_sync_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) - /sources/{sourceId}/native-change-detection-config: - get: - operationId: getNativeChangeDetectionConfig - tags: - - Sources - summary: Native Change Detection Configuration - security: - - userAuth: - - idn:sources:read - x-sailpoint-userLevels: - - ORG_ADMIN - description: This API returns the existing native change detection configuration for a source specified by the given ID. - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The source id - example: 2c9180835d191a86015d28455b4a2329 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Native change detection configuration for a source - content: - application/json: - schema: - type: object - description: Source configuration information for Native Change Detection that is read and used by account aggregation process. - properties: - enabled: - description: A flag indicating if Native Change Detection is enabled for a source. - type: boolean - example: true - default: false - operations: - type: array - description: Operation types for which Native Change Detection is enabled for a source. - items: - type: string - enum: - - ACCOUNT_UPDATED - - ACCOUNT_CREATED - - ACCOUNT_DELETED - example: - - ACCOUNT_UPDATED - - ACCOUNT_DELETED - allEntitlements: - description: A flag indicating that all entitlements participate in Native Change Detection. - type: boolean - example: false - default: false - allNonEntitlementAttributes: - description: A flag indicating that all non-entitlement account attributes participate in Native Change Detection. - type: boolean - example: false - default: false - selectedEntitlements: - description: If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. - type: array - items: - type: string - example: - - memberOf - - memberOfSharedMailbox - selectedNonEntitlementAttributes: - description: If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. - externalDocs: - description: Learn more about account attributes here. - url: https://documentation.sailpoint.com/saas/help/accounts/schema.html - type: array - items: - type: string - example: - - lastName - - phoneNumber - - objectType - - servicePrincipalName - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-native-change-detection-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Native Change Detection Configuration - - try { - Get-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-native-change-detection-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.native_change_detection_config import NativeChangeDetectionConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Native Change Detection Configuration - - results = SourcesApi(api_client).get_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_native_change_detection_config(id, x_sail_point_experimental) - print("The response of SourcesApi->get_native_change_detection_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) - put: - operationId: putNativeChangeDetectionConfig - tags: - - Sources - summary: Update Native Change Detection Configuration - security: - - userAuth: - - idn:sources:update - x-sailpoint-userLevels: - - ORG_ADMIN - description: Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The source id - example: 2c9180835d191a86015d28455b4a2329 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1native-change-detection-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/NativeChangeDetectionConfig.yaml - responses: - '200': - description: Updated native change detection configuration for a source - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1native-change-detection-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/NativeChangeDetectionConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-native-change-detection-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $NativeChangeDetectionConfig = @" - { - "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], - "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], - "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], - "allNonEntitlementAttributes" : false, - "allEntitlements" : false, - "enabled" : true - } - "@ - - # Update Native Change Detection Configuration - - try { - $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig - Send-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025NativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#put-native-change-detection-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.native_change_detection_config import NativeChangeDetectionConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - native_change_detection_config = '''{ - "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], - "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], - "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], - "allNonEntitlementAttributes" : false, - "allEntitlements" : false, - "enabled" : true - }''' # NativeChangeDetectionConfig | - try: - # Update Native Change Detection Configuration - new_native_change_detection_config = NativeChangeDetectionConfig.from_json(native_change_detection_config) - results = SourcesApi(api_client).put_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental, native_change_detection_config=new_native_change_detection_config) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).put_native_change_detection_config(id, x_sail_point_experimental, new_native_change_detection_config) - print("The response of SourcesApi->put_native_change_detection_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) - delete: - operationId: deleteNativeChangeDetectionConfig - tags: - - Sources - summary: Delete Native Change Detection Configuration - description: Deletes the native change detection configuration for the source specified by the given ID. - security: - - userAuth: - - idn:sources:update - - applicationAuth: - - idn:sources:update - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listSources - schema: - type: string - description: The source id - example: 2c9180835d191a86015d28455b4a2329 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-native-change-detection-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Native Change Detection Configuration - - try { - Remove-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#delete-native-change-detection-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete Native Change Detection Configuration - - SourcesApi(api_client).delete_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SourcesApi(api_client).delete_native_change_detection_config(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) - /sources/{id}/remove-accounts: - post: - operationId: deleteAccountsAsync - summary: Remove All Accounts in a Source - tags: - - Sources - description: | - Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. - - This endpoint is good for: - * Removing accounts that no longer exist on the source. - * Removing accounts that won't be aggregated following updates to the source configuration. - * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The source id - example: ebbf35756e1140699ce52b233121384a - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '202': - description: Accepted. Returns task result details of removal request. - content: - application/json: - schema: - $ref: '#/paths/~1roles~1bulk-delete/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskResultDto.yaml - example: - type: TASK_RESULT - id: 464ae7bf791e49fdb74606a2e4a89635 - name: null - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:accounts:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-accounts-async - source: | - $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Remove All Accounts in a Source - - try { - Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccountsAsync" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#delete-accounts-async - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_result_dto import TaskResultDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Remove All Accounts in a Source - - results = SourcesApi(api_client).delete_accounts_async(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).delete_accounts_async(id, x_sail_point_experimental) - print("The response of SourcesApi->delete_accounts_async:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) - /sources/{id}/synchronize-attributes: - post: - operationId: syncAttributesForSource - tags: - - Sources - summary: Synchronize single source attributes. - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - description: This end-point performs attribute synchronization for a selected source. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The Source id - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '202': - description: A Source Sync job - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: Job ID. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - status: - type: string - description: The job status. - enum: - - QUEUED - - IN_PROGRESS - - SUCCESS - - ERROR - example: IN_PROGRESS - payload: - type: object - properties: - type: - type: string - description: Payload type. - example: SYNCHRONIZE_SOURCE_ATTRIBUTES - dataJson: - type: string - description: Payload type. - example: '{"sourceId":"2c918083746f642c01746f990884012a"}' - required: - - type - - dataJson - required: - - id - - status - - payload - example: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - status: IN_PROGRESS - payload: - type: SYNCHRONIZE_SOURCE_ATTRIBUTES - dataJson: '{"sourceId":"2c918083746f642c01746f990884012a"}' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#sync-attributes-for-source - source: | - $Id = "MyId" # String | The Source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Synchronize single source attributes. - - try { - Sync-V2025AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Sync-V2025AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025AttributesForSource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#sync-attributes-for-source - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_sync_job import SourceSyncJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'id_example' # str | The Source id # str | The Source id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Synchronize single source attributes. - - results = SourcesApi(api_client).sync_attributes_for_source(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).sync_attributes_for_source(id, x_sail_point_experimental) - print("The response of SourcesApi->sync_attributes_for_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) - /sources/{id}/entitlement-request-config: - get: - security: - - userAuth: - - idn:sources:read - - idn:sources:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - operationId: getSourceEntitlementRequestConfig - summary: Get Source Entitlement Request Configuration - tags: - - Sources - description: |- - This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. - - Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - responses: - '200': - description: Source Entitlement Request Configuration Details. - content: - application/json: - schema: - type: object - description: Entitlement Request Configuration - properties: - accessRequestConfig: - type: object - properties: - approvalSchemes: - type: array - description: Ordered list of approval steps for the access request. Empty when no approval is required. - items: - type: object - properties: - approverType: - type: string - enum: - - ENTITLEMENT_OWNER - - SOURCE_OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - - **ENTITLEMENT_OWNER**: Owner of the associated Entitlement - - **SOURCE_OWNER**: Owner of the associated Source - - **MANAGER**: Manager of the Identity for whom the request is being made - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP - example: e3eab852-8315-467f-9de7-70eda97f63c8 - requestCommentRequired: - type: boolean - description: If the requester must provide a comment during access request. - default: false - example: true - denialCommentRequired: - type: boolean - description: If the reviewer must provide a comment when denying the access request. - default: false - example: false - examples: - Get default config: - description: The default config for a source should look like the following where the empty approvalSchemes indicates that no approvals are required. - value: - accessRequestConfig: - approvalSchemes: [] - requestCommentRequired: false - denialCommentRequired: false - Get config with one approval: - description: In case of a single approval, the config could look like the following. - value: - accessRequestConfig: - approvalSchemes: - - approverId: null - approverType: SOURCE_OWNER - requestCommentRequired: true - denialCommentRequired: false - Get config with multiple approvals: - description: In case of multiple levels of approvals the config could look like the following. In this scenario, access request review process should go through all the approvers sequentially. - value: - accessRequestConfig: - approvalSchemes: - - approverId: null - approverType: ENTITLEMENT_OWNER - - approverId: null - approverType: SOURCE_OWNER - - approverId: 95e538a3-30c1-433a-af05-4bed973bbc22 - approverType: GOVERNANCE_GROUP - requestCommentRequired: true - denialCommentRequired: false - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-entitlement-request-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Source Entitlement Request Configuration - - try { - Get-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#get-source-entitlement-request-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_entitlement_request_config import SourceEntitlementRequestConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Source Entitlement Request Configuration - - results = SourcesApi(api_client).get_source_entitlement_request_config(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).get_source_entitlement_request_config(x_sail_point_experimental) - print("The response of SourcesApi->get_source_entitlement_request_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) - put: - security: - - userAuth: - - idn:sources:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - operationId: updateSourceEntitlementRequestConfig - summary: Update Source Entitlement Request Configuration - tags: - - Sources - description: |- - This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. - - Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7Bid%7D~1entitlement-request-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SourceEntitlementRequestConfig.yaml - examples: - Set config with no approvals: - description: If no approvals are required, the following config can be set. - value: - accessRequestConfig: - approvalSchemes: [] - Set config with one approval: - description: In case of single approval the following config can be set. - value: - accessRequestConfig: - approvalSchemes: - - approverType: SOURCE_OWNER - requestCommentRequired: true - denialCommentRequired: false - Set config with multiple approvals: - description: In case of multiple levels of approvals the following config can be set. In this scenario, access request review process should go through all the approvers sequentially. - value: - accessRequestConfig: - approvalSchemes: - - approverType: ENTITLEMENT_OWNER - - approverType: SOURCE_OWNER - - approverType: GOVERNANCE_GROUP - approverId: 95e538a3-30c1-433a-af05-4bed973bbc22 - requestCommentRequired: true - denialCommentRequired: false - responses: - '200': - description: Source Entitlement Request Configuration Details. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7Bid%7D~1entitlement-request-config/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SourceEntitlementRequestConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-entitlement-request-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceEntitlementRequestConfig = @" - { - "accessRequestConfig" : { - "denialCommentRequired" : false, - "approvalSchemes" : [ { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - } ], - "requestCommentRequired" : true - } - } - "@ - - # Update Source Entitlement Request Configuration - - try { - $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Update-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#update-source-entitlement-request-config - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_entitlement_request_config import SourceEntitlementRequestConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - source_entitlement_request_config = '''{ - "accessRequestConfig" : { - "denialCommentRequired" : false, - "approvalSchemes" : [ { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - } ], - "requestCommentRequired" : true - } - }''' # SourceEntitlementRequestConfig | - try: - # Update Source Entitlement Request Configuration - new_source_entitlement_request_config = SourceEntitlementRequestConfig.from_json(source_entitlement_request_config) - results = SourcesApi(api_client).update_source_entitlement_request_config(x_sail_point_experimental=x_sail_point_experimental, source_entitlement_request_config=new_source_entitlement_request_config) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).update_source_entitlement_request_config(x_sail_point_experimental, new_source_entitlement_request_config) - print("The response of SourcesApi->update_source_entitlement_request_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) - /sources/{id}/load-accounts: - post: - tags: - - Sources - summary: Account Aggregation - operationId: importAccounts - description: |- - Starts an account aggregation on the specified source. - If the target source is a delimited file source, then the CSV file needs to be included in the request body. - You will also need to set the Content-Type header to `multipart/form-data`. - security: - - userAuth: - - idn:sources:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: Source Id - example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - description: The CSV file containing the source accounts to aggregate. - disableOptimization: - type: string - example: 'true' - description: Use this flag to reprocess every account whether or not the data has changed. - responses: - '202': - description: Aggregate Accounts Task - content: - application/json: - schema: - type: object - properties: - success: - type: boolean - description: The status of the result - default: 'true' - example: 'true' - task: - type: object - properties: - id: - description: System-generated unique ID of the task this taskStatus represents - type: string - example: ef38f94347e94562b5bb8424a56397d8 - type: - description: Type of task this task represents - type: string - example: QUARTZ - name: - description: The name of the aggregation process - type: string - example: Cloud Account Aggregation - description: - description: The description of the task - type: string - example: Aggregate from the specified application - launcher: - description: The user who initiated the task - type: string - example: John Doe - created: - type: string - description: The Task creation date - format: date-time - example: '2020-09-07T42:14:00.364Z' - launched: - type: string - nullable: true - format: date-time - description: The task start date - example: '2020-09-07T42:14:00.521Z' - completed: - type: string - nullable: true - format: date-time - description: The task completion date - example: '2020-09-07T42:14:01.137Z' - completionStatus: - type: string - nullable: true - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMP_ERROR - description: Task completion status. - example: Success - parentName: - type: string - nullable: true - description: Name of the parent task if exists. - example: Audit Report - messages: - type: array - description: List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - example: [] - items: - type: object - properties: - type: - type: string - description: Type of the message. - enum: - - INFO - - WARN - - ERROR - example: WARN - error: - type: boolean - default: false - description: Flag whether message is an error. - example: false - warning: - type: boolean - default: false - description: Flag whether message is a warning. - example: true - key: - type: string - description: Message string identifier. - example: This aggregation failed because the currently running aggregation must complete before the next one can start. - localizedText: - type: string - description: Message context with the locale based language. - example: This aggregation failed because the currently running aggregation must complete before the next one can start. - progress: - type: string - nullable: true - description: Current task state. - example: Initializing... - attributes: - type: object - description: Extra attributes map(dictionary) for the task. - properties: - appId: - description: The id of the source - type: string - example: c31386cb18bb403cbb6df4c86294ff82 - optimizedAggregation: - description: The indicator if the aggregation process was enabled/disabled for the aggregation job - type: string - example: enabled - additionalProperties: - type: object - returns: - type: array - description: Return values from the task - items: - type: object - properties: - displayLabel: - type: string - description: The display label of the return value - example: TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS - attributeName: - type: string - description: The attribute name of the return value - example: applications - example: - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS - attributeName: applications - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_TOTAL - attributeName: total - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_OPTIMIZED - attributeName: optimizedAggregation - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_IGNORED - attributeName: ignored - - displayLabel: TASK_OUT_UNCHANGED_ACCOUNTS - attributeName: optimized - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_CREATED - attributeName: created - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_UPDATED - attributeName: updated - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_DELETED - attributeName: deleted - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_MANAGER_CHANGES - attributeName: managerChanges - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_BUSINESS_ROLE_CHANGES - attributeName: detectedRoleChanges - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_EXCEPTION_CHANGES - attributeName: exceptionChanges - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_POLICIES - attributeName: policies - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_POLICY_VIOLATIONS - attributeName: policyViolations - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_POLICY_NOTIFICATIONS - attributeName: policyNotifications - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_SCORES_CHANGED - attributeName: scoresChanged - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_SNAPSHOTS_CREATED - attributeName: snapshotsCreated - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CREATED - attributeName: scopesCreated - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CORRELATED - attributeName: scopesCorrelated - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_SELECTED - attributeName: scopesSelected - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_DORMANT - attributeName: scopesDormant - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_UNSCOPED_IDENTITIES - attributeName: unscopedIdentities - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_CREATED - attributeName: certificationsCreated - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_DELETED - attributeName: certificationsDeleted - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS_GENERATED - attributeName: applicationsGenerated - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED - attributeName: managedAttributesCreated - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP - attributeName: managedAttributesCreatedByApplication - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_IDENTITYENTITLEMENTS_CREATED - attributeName: identityEntitlementsCreated - - displayLabel: TASK_OUT_ACCOUNT_AGGREGATION_GROUPS_CREATED - attributeName: groupsCreated - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-accounts - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) - $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) - - # Account Aggregation - - try { - Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025Accounts" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#import-accounts - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.load_accounts_task import LoadAccountsTask - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - file = None # bytearray | The CSV file containing the source accounts to aggregate. (optional) # bytearray | The CSV file containing the source accounts to aggregate. (optional) - disable_optimization = 'disable_optimization_example' # str | Use this flag to reprocess every account whether or not the data has changed. (optional) # str | Use this flag to reprocess every account whether or not the data has changed. (optional) - try: - # Account Aggregation - - results = SourcesApi(api_client).import_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_accounts(id, x_sail_point_experimental, file, disable_optimization) - print("The response of SourcesApi->import_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->import_accounts: %s\n" % e) - /sources/{id}/load-uncorrelated-accounts: - post: - tags: - - Sources - summary: Process Uncorrelated Accounts - operationId: importUncorrelatedAccounts - description: File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - security: - - userAuth: - - idn:sources:manage - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: Source Id - example: 75dbec1ebe154d5785da27b95e1dd5d7 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - responses: - '202': - description: Uncorrelated Accounts Task - content: - application/json: - schema: - type: object - properties: - success: - type: boolean - description: The status of the result - default: 'true' - example: 'true' - task: - type: object - properties: - id: - description: System-generated unique ID of the task this taskStatus represents - type: string - example: 90b83a6bb737489494794f84cd3a51e6 - type: - description: Type of task this task represents - type: string - example: QUARTZ - name: - description: The name of uncorrelated accounts process - type: string - example: Cloud Process Uncorrelated Accounts - description: - description: The description of the task - type: string - example: Processes uncorrelated accounts for the specified application. - launcher: - description: The user who initiated the task - type: string - example: John Doe - created: - type: string - description: The Task creation date - format: date-time - example: '2020-09-07T42:14:00.364Z' - launched: - type: string - nullable: true - format: date-time - description: The task start date - example: '2020-09-07T42:14:00.521Z' - completed: - type: string - nullable: true - format: date-time - description: The task completion date - example: '2020-09-07T42:14:01.137Z' - completionStatus: - type: string - nullable: true - enum: - - SUCCESS - - WARNING - - ERROR - - TERMINATED - - TEMP_ERROR - description: Task completion status. - example: Success - parentName: - type: string - nullable: true - description: Name of the parent task if exists. - example: Audit Report - messages: - type: array - description: List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - example: [] - items: - type: object - properties: - type: - type: string - description: Type of the message. - enum: - - INFO - - WARN - - ERROR - example: WARN - error: - type: boolean - default: false - description: Flag whether message is an error. - example: false - warning: - type: boolean - default: false - description: Flag whether message is a warning. - example: true - key: - type: string - description: Message string identifier. - example: This correlation failed because the currently running correlation must complete before the next one can start. - localizedText: - type: string - description: Message context with the locale based language. - example: This correlation failed because the currently running correlation must complete before the next one can start. - progress: - type: string - nullable: true - description: Current task state. - example: Initializing... - attributes: - type: object - description: Extra attributes map(dictionary) for the task. - properties: - qpocJobId: - description: The id of qpoc job - type: string - example: 5d303d46-fc51-48cd-9c6d-4e211e3ab63c - taskStartDelay: - description: the task start delay value - example: '' - returns: - description: Return values from the task - type: object - example: - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS - attributeName: applications - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_TOTAL - attributeName: total - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_IGNORED - attributeName: correlationFailures - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_FAILURES - attributeName: ignored - - displayLabel: TASK_OUT_UNCHANGED_ACCOUNTS - attributeName: optimized - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION__CREATED - attributeName: created - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_UPDATED - attributeName: updated - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_DELETED - attributeName: deleted - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_MANAGER_CHANGES - attributeName: managerChanges - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_BUSINESS_ROLE_CHANGES - attributeName: detectedRoleChanges - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_EXCEPTION_CHANGES - attributeName: exceptionChanges - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_POLICIES - attributeName: policies - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_POLICY_VIOLATIONS - attributeName: policyViolations - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_POLICY_NOTIFICATIONS - attributeName: policyNotifications - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_SCORES_CHANGED - attributeName: scoresChanged - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_SNAPSHOTS_CREATED - attributeName: snapshotsCreated - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CREATED - attributeName: scopesCreated - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CORRELATED - attributeName: scopesCorrelated - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_SCOPES_SELECTED - attributeName: scopesSelected - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_SCOPES_DORMANT - attributeName: scopesDormant - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_UNSCOPED_IDENTITIES - attributeName: unscopedIdentities - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_CREATED - attributeName: certificationsCreated - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_DELETED - attributeName: certificationsDeleted - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS_GENERATED - attributeName: applicationsGenerated - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED - attributeName: managedAttributesCreated - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP - attributeName: managedAttributesCreatedByApplication - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_IDENTITYENTITLEMENTS_CREATED - attributeName: identityEntitlementsCreated - - displayLabel: TASK_OUT_ACCOUNT_CORRELATION_GROUPS_CREATED - attributeName: groupsCreated - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-uncorrelated-accounts - source: | - $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $File = # System.IO.FileInfo | (optional) - - # Process Uncorrelated Accounts - - try { - Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025UncorrelatedAccounts" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sources#import-uncorrelated-accounts - source: | - from sailpoint.v2025.api.sources_api import SourcesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.load_uncorrelated_accounts_task import LoadUncorrelatedAccountsTask - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - file = None # bytearray | (optional) # bytearray | (optional) - try: - # Process Uncorrelated Accounts - - results = SourcesApi(api_client).import_uncorrelated_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_uncorrelated_accounts(id, x_sail_point_experimental, file) - print("The response of SourcesApi->import_uncorrelated_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) - /task-status/{id}: - get: - tags: - - Task Management - summary: Get Task Status by ID - description: Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - operationId: getTaskStatus - parameters: - - name: id - in: path - description: Task ID. - required: true - x-sailpoint-resource-operation-id: getTaskStatusList - example: 00eebcf881994e419d72e757fd30dc0e - style: simple - explode: false - schema: - type: string - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Responds with a TaskStatus for the task with the given task ID. - content: - application/json: - schema: - $ref: '#/paths/~1identities~1invite/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskStatus.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - description: Forbidden, generally due to a lack of security rights - '404': - description: TaskStatus with the given id was not found. - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:task-management:read - - idn:task-management:write - - applicationAuth: - - idn:task-management:read - - idn:task-management:write - x-sailpoint-userLevels: - - ORG_ADMIN - - HELPDESK - - CERT_ADMIN - - REPORT_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-task-status - source: | - $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Task Status by ID - - try { - Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/task-management#get-task-status - source: | - from sailpoint.v2025.api.task_management_api import TaskManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_status import TaskStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Task Status by ID - - results = TaskManagementApi(api_client).get_task_status(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TaskManagementApi(api_client).get_task_status(id, x_sail_point_experimental) - print("The response of TaskManagementApi->get_task_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) - patch: - operationId: updateTaskStatus - tags: - - Task Management - summary: Update Task Status by ID - description: Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - parameters: - - name: id - in: path - description: Task ID. - example: 00eebcf881994e419d72e757fd30dc0e - required: true - x-sailpoint-resource-operation-id: getTaskStatusList - style: simple - explode: false - schema: - type: string - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - description: The JSONPatch payload used to update the object. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /completionStatus - value: Error - - op: replace - path: /completed - value: '2024-05-17T19:33:16.470Z' - responses: - '200': - description: This response indicates the PATCH operation succeeded, and the API returns the updated task object. - content: - application/json: - schema: - $ref: '#/paths/~1identities~1invite/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskStatus.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:task-management:write - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - - REPORT_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#update-task-status - source: | - $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Task Status by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025TaskStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/task-management#update-task-status - source: | - from sailpoint.v2025.api.task_management_api import TaskManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.task_status import TaskStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the object. - try: - # Update Task Status by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = TaskManagementApi(api_client).update_task_status(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = TaskManagementApi(api_client).update_task_status(id, x_sail_point_experimental, new_json_patch_operation) - print("The response of TaskManagementApi->update_task_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) - /task-status: - get: - tags: - - Task Management - summary: Retrieve Task Status List - description: | - Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. - operationId: getTaskStatusList - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - example: completionStatus eq "Success" - required: false - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **sourceId**: *eq, in* - - **completionStatus**: *eq, in* - - **type**: *eq, in* - - in: query - name: sorters - schema: - type: string - format: comma-separated - example: '-created' - required: false - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created** - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Responds with a TaskStatus for the task with the given task ID. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1identities~1invite/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskStatus.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:task-management:read - - idn:task-management:write - - applicationAuth: - - idn:task-management:read - - idn:task-management:write - x-sailpoint-userLevels: - - ORG_ADMIN - - HELPDESK - - CERT_ADMIN - - REPORT_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-task-status-list - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "completionStatus eq "Success"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) - $Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) - - # Retrieve Task Status List - - try { - Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatusList" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/task-management#get-task-status-list - source: | - from sailpoint.v2025.api.task_management_api import TaskManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_status import TaskStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'completionStatus eq \"Success\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) - sorters = '-created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) - try: - # Retrieve Task Status List - - results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) - /task-status/pending-tasks: - get: - tags: - - Task Management - summary: Retrieve Pending Task Status List - description: Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - operationId: getPendingTasks - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Responds with a list of TaskStatus for pending tasks. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1identities~1invite/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskStatus.yaml - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:task-management:read - - idn:task-management:write - - applicationAuth: - - idn:task-management:read - - idn:task-management:write - x-sailpoint-userLevels: - - ORG_ADMIN - - HELPDESK - - CERT_ADMIN - - REPORT_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-pending-tasks - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieve Pending Task Status List - - try { - Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTasks" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/task-management#get-pending-tasks - source: | - from sailpoint.v2025.api.task_management_api import TaskManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.task_status import TaskStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieve Pending Task Status List - - results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count) - print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) - head: - tags: - - Task Management - summary: Retrieve Pending Task List Headers - description: Responds with headers only for list of task statuses for pending tasks. - operationId: getPendingTaskHeaders - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Retrieve headers for a list of TaskStatus for pending tasks. - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:task-management:read - - idn:task-management:write - - applicationAuth: - - idn:task-management:read - - idn:task-management:write - x-sailpoint-userLevels: - - ORG_ADMIN - - HELPDESK - - CERT_ADMIN - - REPORT_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-pending-task-headers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieve Pending Task List Headers - - try { - Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTaskHeaders" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/task-management#get-pending-task-headers - source: | - from sailpoint.v2025.api.task_management_api import TaskManagementApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Retrieve Pending Task List Headers - - TaskManagementApi(api_client).get_pending_task_headers(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # TaskManagementApi(api_client).get_pending_task_headers(x_sail_point_experimental, offset, limit, count) - except Exception as e: - print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e) - /tenant: - get: - operationId: getTenant - tags: - - Tenant - summary: Get Tenant Information. - description: This rest endpoint can be used to retrieve tenant details. - security: - - userAuth: - - sp:tenant:read - x-sailpoint-userLevels: - - Any - responses: - '200': - description: Tenant Info - content: - application/json: - schema: - type: object - properties: - id: - type: string - readOnly: true - description: The unique identifier for the Tenant - example: 2c91808568c529c60168cca6f90c1324 - name: - type: string - description: Abbreviated name of the Tenant - example: acme - fullName: - type: string - description: Human-readable name of the Tenant - example: Acme, Inc - pod: - type: string - description: Deployment pod for the Tenant - example: example-pod - region: - type: string - description: Deployment region for the Tenant - example: us-east-1 - description: - type: string - description: Description of the Tenant - example: Description of the Tenant - products: - type: array - items: - type: object - properties: - productName: - type: string - description: Name of the Product - example: idn - url: - type: string - description: URL of the Product - example: https://tenant-name.identitynow.com - productTenantId: - type: string - description: An identifier for a specific product-tenant combination - example: tenant#product - productRegion: - type: string - description: Product region - example: us-east-1 - productRight: - type: string - description: Right needed for the Product - example: idn:ui:view - apiUrl: - nullable: true - type: string - description: API URL of the Product - example: https://tenant-name.api.identitynow.com - licenses: - type: array - items: - type: object - properties: - licenseId: - type: string - description: Name of the license - example: idn:access-request - legacyFeatureName: - type: string - description: Legacy name of the license - example: ACCESS_REQUEST - attributes: - type: object - additionalProperties: true - description: Additional attributes for a product - example: - domain: https://tenant-name.identitynow.com - maxRegisteredUsers: 250 - zone: - type: string - description: Zone - example: Deployment zone for the Product - status: - type: string - description: Status of the product - example: active - statusDateTime: - type: string - format: date-time - description: Status datetime - example: '2020-05-19T13:49:37.385Z' - reason: - type: string - description: If there's a tenant provisioning failure then reason will have the description of error - example: Reason - notes: - type: string - description: Product could have additional notes added during tenant provisioning. - example: Example notes - dateCreated: - nullable: true - type: string - format: date-time - description: Date when the product was created - example: '2020-05-19T13:49:37.385Z' - lastUpdated: - nullable: true - type: string - format: date-time - description: Date when the product was last updated - example: '2020-05-19T13:49:37.385Z' - orgType: - nullable: true - type: string - enum: - - development - - staging - - production - - test - - partner - - training - - demonstration - - sandbox - - null - description: Type of org - example: test - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tenant#get-tenant - source: | - - # Get Tenant Information. - - try { - Get-V2025Tenant - - # Below is a request that includes all optional parameters - # Get-V2025Tenant - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Tenant" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tenant#get-tenant - source: | - from sailpoint.v2025.api.tenant_api import TenantApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tenant import Tenant - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get Tenant Information. - - results = TenantApi(api_client).get_tenant() - # Below is a request that includes all optional parameters - # results = TenantApi(api_client).get_tenant() - print("The response of TenantApi->get_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TenantApi->get_tenant: %s\n" % e) - /tenant-context: - get: - summary: Retrieve tenant context - tags: - - Tenant Context - description: | - Returns a list of key-value pairs representing the current state of the tenant's context. - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - security: - - userAuth: - - idn:tenant-context:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - operationId: getTenantContext - responses: - '200': - description: Successfully retrieved tenant context. - content: - application/json: - schema: - type: array - items: - type: object - properties: - key: - type: string - value: - type: string - example: - - key: IAS - value: International Accounting Standards - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - $ref: '#/paths/~1tenant-context/patch/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorResponseDto.yaml - '401': - description: Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. - content: - application/json: - schema: - type: object - properties: - error: - description: A message describing the error - example: 'JWT validation failed: JWT is expired' - '403': - description: Forbidden - Returned if the user you are running as, doesn't have access to this end-point. - content: - application/json: - schema: - $ref: '#/paths/~1tenant-context/patch/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorResponseDto.yaml - examples: - '403': - summary: An example of a 403 response object - value: - detailCode: 403 Forbidden - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server understood the request but refuses to authorize it. - '429': - description: 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. - content: - application/json: - schema: - type: object - properties: - message: - description: A message describing the error - example: ' Rate Limit Exceeded ' - '500': - description: Internal Server Error - Returned if there is an unexpected error. - content: - application/json: - schema: - $ref: '#/paths/~1tenant-context/patch/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorResponseDto.yaml - examples: - '500': - summary: An example of a 500 response object - value: - detailCode: 500.0 Internal Fault - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: An internal fault occurred. - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tenant-context#get-tenant-context - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieve tenant context - - try { - Get-V2025TenantContext -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TenantContext -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantContext" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tenant-context#get-tenant-context - source: | - from sailpoint.v2025.api.tenant_context_api import TenantContextApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_tenant_context200_response_inner import GetTenantContext200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Retrieve tenant context - - results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental) - print("The response of TenantContextApi->get_tenant_context:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TenantContextApi->get_tenant_context: %s\n" % e) - patch: - summary: Update tenant context - tags: - - Tenant Context - description: | - Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - - This endpoint is specifically designed to modify the `/Key/*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. - - Note that each tenant is limited to a maximum of 100 key-value pairs. - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - security: - - userAuth: - - idn:tenant-context:write - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - operationId: patchTenantContext - requestBody: - content: - application/json-patch+json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - examples: - Multiple operations in one call: - description: This example shows how multiple context keys may be updated with a single patch call. - value: - - op: add - path: /Key/IAS - value: Integrated Automation System - - op: replace - path: /Key/IAS - value: International Accounting Standards - - op: remove - path: /Key/NDR - Add a single context: - description: This example shows how a single context may be created with a single patch call. - value: - - op: add - path: /Key/IAS - value: Integrated Automation System - Update a single context: - description: This example shows how a single context may be updated with a single patch call. - value: - - op: replace - path: /Key/IAS - value: International Accounting Standards - Remove a single context: - description: This example shows how a single context may be removed with a single patch call. - value: - - op: remove - path: /Key/IAS - required: true - responses: - '200': - description: Tenant context updated successfully. - '400': - description: Bad request due to invalid input parameters. - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - description: Fine-grained error code providing more detail of the error. - example: 400.1 Bad Request Content - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - messages: - type: array - description: Generic localized reason for error - items: - type: object - properties: - locale: - type: string - description: The locale for the message text, a BCP 47 language tag. - example: en-US - nullable: true - localeOrigin: - 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 - text: - 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. - causes: - type: array - description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - items: - $ref: '#/paths/~1tenant-context/patch/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorMessageDto.yaml - examples: - incorrectPath: - summary: Invalid Path Example - value: - detailCode: Bad Request - trackingId: e9eaaeac516643ffa087cc476e7577c5 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: 'invalid patch request: field not patchable or does not contain key (/InvalidPath/IAS)' - invalidOperation: - summary: Invalid Operation Example - value: - detailCode: Bad Request - trackingId: 39cfb6a29d5a4522954d72124545d3c5 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: 'invalid patch request: operation not allowed (move)' - noKeyInPath: - summary: No Key in Path Example - value: - detailCode: Bad Request - trackingId: 6d3bdd67ac8a4382884875ed4abf1f13 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: 'invalid patch request: field not patchable or does not contain key (/Key/)' - capacityExceeded: - summary: Capacity Exceeded Example - value: - detailCode: Bad Request - trackingId: bd51a5e2f4ee4d5aa65ac2f7cd3c2445 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: 'unable to fulfill patch request: max tenant context capacity exceeded by 5 key/value pair(s)' - '401': - $ref: '#/paths/~1tenant-context/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml - '403': - $ref: '#/paths/~1tenant-context/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml - '404': - description: Not Found - returned if the request URL refers to a resource or object that does not exist - content: - application/json: - schema: - $ref: '#/paths/~1tenant-context/patch/responses/400/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorResponseDto.yaml - examples: - '404': - summary: An example of a 404 response object - value: - detailCode: 404 Not found - trackingId: b21b1f7ce4da4d639f2c62a57171b427 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The server did not find a current representation for the target resource. - '429': - $ref: '#/paths/~1tenant-context/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml - '500': - $ref: '#/paths/~1tenant-context/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tenant-context#patch-tenant-context - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @" - { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } - "@ - - # Update tenant context - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025TenantContext" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/tenant-context#patch-tenant-context - source: | - from sailpoint.v2025.api.tenant_context_api import TenantContextApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }''' # JsonPatchOperation | - try: - # Update tenant context - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - TenantContextApi(api_client).patch_tenant_context(x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # TenantContextApi(api_client).patch_tenant_context(x_sail_point_experimental, new_json_patch_operation) - except Exception as e: - print("Exception when calling TenantContextApi->patch_tenant_context: %s\n" % e) - /triggers: - get: - operationId: listTriggers - tags: - - Triggers - summary: List Triggers - description: Gets a list of triggers that are available in the tenant. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, ge, le* - example: id eq "idn:access-request-post-approval" - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name** - example: name - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of triggers. - content: - application/json: - schema: - type: array - items: - type: object - required: - - id - - name - - type - - inputSchema - - exampleInput - properties: - id: - type: string - description: Unique identifier of the trigger. - example: idn:access-request-dynamic-approver - name: - type: string - description: Trigger Name. - example: Access Request Dynamic Approver - type: - type: string - description: The type of trigger. - example: FIRE_AND_FORGET - enum: - - REQUEST_RESPONSE - - FIRE_AND_FORGET - description: - type: string - description: Trigger Description. - example: Trigger for getting a dynamic approver. - inputSchema: - type: string - description: The JSON schema of the payload that will be sent by the trigger to the subscribed service. - example: '{"definitions":{"record:AccessRequestDynamicApproverInput":{"type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"additionalProperties":true,"properties":{"accessRequestId":{"type":"string"},"requestedFor":{"$ref":"#/definitions/record:requestedForIdentityRef"},"requestedItems":{"type":"array","items":{"$ref":"#/definitions/record:requestedObjectRef"}},"requestedBy":{"$ref":"#/definitions/record:requestedByIdentityRef"}}},"record:requestedForIdentityRef":{"type":"object","required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"record:requestedObjectRef":{"type":"object","optional":["description","comment"],"required":["id","name","type","operation"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"oneOf":[{"type":"null"},{"type":"string"}]},"type":{"type":"string"},"operation":{"type":"string"},"comment":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"record:requestedByIdentityRef":{"type":"object","required":["type","id","name"],"additionalProperties":true,"properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverInput"}' - exampleInput: - description: An example of the JSON payload that will be sent by the trigger to the subscribed service. - oneOf: - - $ref: '#/x-webhooks/AccessRequestDynamicApproval/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/AccessRequestDynamicApprover.yaml - - $ref: '#/x-webhooks/AccessRequestDecision/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/AccessRequestPostApproval.yaml - - $ref: '#/x-webhooks/AccessRequestSubmitted/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/AccessRequestPreApproval.yaml - - $ref: '#/x-webhooks/AccountAggregationCompleted/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/AccountAggregationCompleted.yaml - - title: Account Attributes Changed - type: object - required: - - identity - - source - - account - - changes - properties: - identity: - required: - - id - - type - - name - type: object - description: The identity whose account attributes were updated. - properties: - type: - type: string - description: DTO type of the identity whose account attributes were updated. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of the identity whose account attributes were updated. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Display name of the identity whose account attributes were updated. - example: Michael Michaels - source: - required: - - id - - type - - name - type: object - description: The source that contains the account. - properties: - id: - description: ID of the object to which this reference applies - type: string - example: 4e4d982dddff4267ab12f0f1e72b5a6d - type: - type: string - enum: - - SOURCE - example: SOURCE - description: The type of object that is referenced - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: Corporate Active Directory - account: - type: object - description: Details of the account where the attributes changed. - required: - - id - - uuid - - name - - nativeIdentity - - type - properties: - id: - type: string - description: SailPoint generated unique identifier. - example: 52170a74-ca89-11ea-87d0-0242ac130003 - uuid: - nullable: true - type: string - description: The source's unique identifier for the account. UUID is generated by the source system. - example: 1cb1f07d-3e5a-4431-becd-234fa4306108 - name: - type: string - description: Name of the account. - example: john.doe - nativeIdentity: - type: string - description: Unique ID of the account on the source. - example: cn=john.doe,ou=users,dc=acme,dc=com - type: - enum: - - ACCOUNT - description: The type of the account - example: ACCOUNT - changes: - type: array - description: A list of attributes that changed. - items: - type: object - required: - - attribute - - oldValue - - newValue - properties: - attribute: - type: string - description: The name of the attribute. - example: sn - oldValue: - description: The previous value of the attribute. - nullable: true - oneOf: - - type: string - - type: boolean - - type: array - items: - nullable: true - type: string - example: doe - newValue: - description: The new value of the attribute. - nullable: true - oneOf: - - type: string - - type: boolean - - type: array - items: - nullable: true - type: string - example: ryans - - title: Account Correlated - type: object - required: - - identity - - source - - account - - attributes - properties: - identity: - required: - - type - - name - - id - type: object - description: Identity the account is correlated with. - properties: - type: - type: string - description: DTO type of the identity the account is correlated with. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of the identity the account is correlated with. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Display name of the identity the account is correlated with. - example: Michael Michaels - source: - required: - - id - - type - - name - type: object - description: The source the accounts are being correlated from. - properties: - type: - type: string - description: The DTO type of the source the accounts are being correlated from. - enum: - - SOURCE - example: SOURCE - id: - type: string - description: The ID of the source the accounts are being correlated from. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Display name of the source the accounts are being correlated from. - example: HR Active Directory - account: - type: object - description: The correlated account. - required: - - id - - name - - nativeIdentity - - type - properties: - type: - type: string - description: The correlated account's DTO type. - enum: - - ACCOUNT - example: ACCOUNT - id: - type: string - description: The correlated account's ID. - example: 98da47c31df444558c211f9b205184f6 - name: - type: string - description: The correlated account's display name. - example: Brian Mendoza - nativeIdentity: - type: string - description: Unique ID of the account on the source. - example: cn=john.doe,ou=users,dc=acme,dc=com - uuid: - nullable: true - type: string - description: The source's unique identifier for the account. UUID is generated by the source system. - example: 1cb1f07d-3e5a-4431-becd-234fa4306108 - attributes: - type: object - description: The attributes associated with the account. Attributes are unique per source. - additionalProperties: true - example: - sn: doe - givenName: john - memberOf: - - cn=g1,ou=groups,dc=acme,dc=com - - cn=g2,ou=groups,dc=acme,dc=com - - cn=g3,ou=groups,dc=acme,dc=com - entitlementCount: - type: integer - format: int32 - description: The number of entitlements associated with this account. - example: 0 - - title: Accounts Collected for Aggregation - type: object - required: - - source - - status - - started - - completed - - errors - - warnings - - stats - properties: - source: - required: - - id - - type - - name - type: object - description: Reference to the source that has been aggregated. - properties: - id: - description: ID of the object to which this reference applies - type: string - example: 4e4d982dddff4267ab12f0f1e72b5a6d - type: - type: string - enum: - - SOURCE - example: SOURCE - description: The type of object that is referenced - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: Corporate Active Directory - status: - description: The overall status of the collection. - enum: - - Success - - Failed - - Terminated - example: Success - started: - type: string - format: date-time - description: The date and time when the account collection started. - example: '2020-06-29T22:01:50.474Z' - completed: - type: string - format: date-time - description: The date and time when the account collection finished. - example: '2020-06-29T22:02:04.090Z' - errors: - nullable: true - description: A list of errors that occurred during the collection. - type: array - items: - type: string - description: A descriptive error message. - example: Unable to collect accounts for aggregation. - warnings: - nullable: true - description: A list of warnings that occurred during the collection. - type: array - items: - type: string - description: A descriptive warning message. - example: Account Skipped - stats: - type: object - description: Overall statistics about the account collection. - required: - - scanned - - unchanged - - changed - - added - - removed - properties: - scanned: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: The number of accounts which were scanned / iterated over. - example: 200 - unchanged: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: The number of accounts which existed before, but had no changes. - example: 190 - changed: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: The number of accounts which existed before, but had changes. - example: 6 - added: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: The number of accounts which are new - have not existed before. - example: 4 - removed: - type: integer - minimum: 0 - maximum: 2147483647 - format: int32 - description: The number accounts which existed before, but no longer exist (thus getting removed). - example: 3 - - title: Account Uncorrelated - type: object - required: - - identity - - source - - account - properties: - identity: - required: - - type - - name - - id - type: object - description: Identity the account is uncorrelated with. - properties: - type: - type: string - description: DTO type of the identity the account is uncorrelated with. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of the identity the account is uncorrelated with. - example: 2c3780a46faadee4016fb4e018c20652 - name: - type: string - description: Display name of the identity the account is uncorrelated with. - example: Allen Albertson - source: - required: - - type - - name - - id - type: object - description: The source the accounts are uncorrelated from. - properties: - type: - type: string - description: The DTO type of the source the accounts are uncorrelated from. - enum: - - SOURCE - example: SOURCE - id: - type: string - description: The ID of the source the accounts are uncorrelated from. - example: 2c6180835d191a86015d28455b4b231b - name: - type: string - description: Display name of the source the accounts are uncorrelated from. - example: Corporate Directory - account: - type: object - description: Uncorrelated account. - required: - - id - - name - - nativeIdentity - - type - properties: - type: - enum: - - ACCOUNT - description: Uncorrelated account's DTO type. - example: ACCOUNT - id: - type: string - description: Uncorrelated account's ID. - example: 4dd497e3723e439991cb6d0e478375dd - name: - type: string - description: Uncorrelated account's display name. - example: Sadie Jensen - nativeIdentity: - type: string - description: Unique ID of the account on the source. - example: cn=john.doe,ou=users,dc=acme,dc=com - uuid: - nullable: true - type: string - description: The source's unique identifier for the account. UUID is generated by the source system. - example: 1cb1f07d-3e5a-4431-becd-234fa4306108 - entitlementCount: - type: integer - format: int32 - description: The number of entitlements associated with this account. - example: 0 - - $ref: '#/x-webhooks/CampaignActivated/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/CampaignActivated.yaml - - $ref: '#/x-webhooks/CampaignEnded/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/CampaignEnded.yaml - - $ref: '#/x-webhooks/CampaignGenerated/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/CampaignGenerated.yaml - - $ref: '#/x-webhooks/CertificationSignedOff/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/CertificationSignedOff.yaml - - $ref: '#/x-webhooks/IdentityAttributesChanged/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/IdentityAttributesChanged.yaml - - $ref: '#/x-webhooks/IdentityCreated/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/IdentityCreated.yaml - - $ref: '#/x-webhooks/IdentityDeleted/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/IdentityDeleted.yaml - - $ref: '#/x-webhooks/ProvisioningCompleted/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/ProvisioningCompleted.yaml - - $ref: '#/x-webhooks/ScheduledSearch/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SavedSearchComplete.yaml - - $ref: '#/x-webhooks/NativeChangeAccountCreated/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceAccountCreated.yaml - - $ref: '#/x-webhooks/NativeChangeAccountDeleted/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceAccountDeleted.yaml - - $ref: '#/x-webhooks/NativeChangeAccountUpdated/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceAccountUpdated.yaml - - $ref: '#/x-webhooks/SourceCreated/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceCreated.yaml - - $ref: '#/x-webhooks/SourceDeleted/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceDeleted.yaml - - $ref: '#/x-webhooks/SourceUpdated/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceUpdated.yaml - - $ref: '#/x-webhooks/VaClusterStatusChange/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/VAClusterStatusChangeEvent.yaml - outputSchema: - type: string - description: The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. - nullable: true - example: '{"definitions":{"record:AccessRequestDynamicApproverOutput":{"type":["null","object"],"required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverOutput"}' - exampleOutput: - description: An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event. - nullable: true - oneOf: - - title: Access Request Dynamic Approver - type: object - nullable: true - required: - - id - - name - - type - properties: - id: - type: string - description: The unique ID of the identity to add to the approver list for the access request. - example: 2c91808b6ef1d43e016efba0ce470906 - name: - type: string - description: The name of the identity to add to the approver list for the access request. - example: Adam Adams - type: - enum: - - IDENTITY - - GOVERNANCE_GROUP - description: The type of object being referenced. - example: IDENTITY - - title: Access Request Pre Approval - type: object - required: - - approved - - comment - - approver - properties: - approved: - type: boolean - description: Whether or not to approve the access request. - example: false - comment: - type: string - description: A comment about the decision to approve or deny the request. - example: This access should be denied, because this will cause an SOD violation. - approver: - type: string - description: The name of the entity that approved or denied the request. - example: AcmeCorpExternalIntegration - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:trigger-service-subscriptions:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-triggers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "idn:access-request-post-approval"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) - - # List Triggers - - try { - Get-V2025Triggers -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Triggers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Triggers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#list-triggers - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.trigger import Trigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"idn:access-request-post-approval\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) - try: - # List Triggers - - results = TriggersApi(api_client).list_triggers(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->list_triggers: %s\n" % e) - /trigger-subscriptions: - post: - operationId: createSubscription - tags: - - Triggers - summary: Create a Subscription - description: |- - This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: - * HTTP subscriptions require httpConfig - * EventBridge subscriptions require eventBridgeConfig - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - triggerId - - type - - name - properties: - name: - type: string - description: Subscription name. - example: Access request subscription - description: - type: string - description: Subscription description. - example: Access requested to site xyz - triggerId: - type: string - description: ID of trigger subscribed to. - example: idn:access-requested - type: - type: string - enum: - - HTTP - - EVENTBRIDGE - - INLINE - - SCRIPT - - WORKFLOW - description: Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required. - example: HTTP - responseDeadline: - type: string - description: Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - example: PT1H - default: PT1H - httpConfig: - type: object - properties: - url: - type: string - description: URL of the external/custom integration. - example: https://www.example.com - httpDispatchMode: - type: string - description: HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC. - enum: - - SYNC - - ASYNC - - DYNAMIC - example: SYNC - httpAuthenticationType: - type: string - description: |- - Defines the HTTP Authentication type. Additional values may be added in the future. - - If *NO_AUTH* is selected, no extra information will be in HttpConfig. - - If *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings. - - If *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string. - enum: - - NO_AUTH - - BASIC_AUTH - - BEARER_TOKEN - default: NO_AUTH - example: BASIC_AUTH - basicAuthConfig: - type: object - properties: - userName: - type: string - description: The username to authenticate. - example: user@example.com - password: - type: string - nullable: true - description: The password to authenticate. On response, this field is set to null as to not return secrets. - example: null - nullable: true - description: Config required if BASIC_AUTH is used. - bearerTokenAuthConfig: - type: object - properties: - bearerToken: - type: string - nullable: true - description: Bearer token - example: null - nullable: true - description: Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. - required: - - url - - httpDispatchMode - eventBridgeConfig: - type: object - properties: - awsAccount: - type: string - description: AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. - example: '123456789012' - awsRegion: - type: string - description: AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. - example: us-west-1 - required: - - awsAccount - - awsRegion - enabled: - type: boolean - description: |- - Whether subscription should receive real-time trigger invocations or not. - - Test trigger invocations are always enabled regardless of this option. - default: true - example: true - filter: - type: string - description: JSONPath filter to conditionally invoke trigger when expression evaluates to true. - example: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - externalDocs: - description: JSONPath filter documentation - url: https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events - examples: - HTTP Subscription: - value: - name: Access request subscription - description: Access requested to site xyz - triggerId: idn:access-requested - type: HTTP - httpConfig: - url: https://www.example.com - httpDispatchMode: SYNC - httpAuthenticationType: BASIC_AUTH - basicAuthConfig: - userName: user@example.com - password: eRtg4%6yuI! - enabled: true - filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - HTTP Async Subscription: - value: - name: Access request subscription - description: Access requested to site xyz - triggerId: idn:access-requested - type: HTTP - responseDeadline: PT1H - httpConfig: - url: https://www.example.com - httpDispatchMode: ASYNC - httpAuthenticationType: BASIC_AUTH - basicAuthConfig: - userName: user@example.com - password: eRtg4%6yuI! - enabled: true - filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - EventBridge Subscription: - value: - name: Access request subscription - description: Access requested to site xyz - triggerId: idn:access-requested - type: EVENTBRIDGE - eventBridgeConfig: - awsAccount: '123456789012' - awsRegion: us-west-1 - enabled: true - filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - responses: - '201': - description: New subscription to a trigger. The trigger can now be invoked by the method defined in the subscription. - content: - application/json: - schema: - type: object - required: - - id - - triggerId - - type - - name - - triggerName - - enabled - properties: - id: - type: string - description: Subscription ID. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: - type: string - description: Subscription name. - example: Access request subscription - description: - type: string - description: Subscription description. - example: Access requested to site xyz - triggerId: - type: string - description: ID of trigger subscribed to. - example: idn:access-request-post-approval - triggerName: - type: string - description: Trigger name of trigger subscribed to. - example: Access Requested - type: - $ref: '#/paths/~1trigger-subscriptions/post/requestBody/content/application~1json/schema/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SubscriptionType.yaml - responseDeadline: - type: string - description: Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - example: PT1H - default: PT1H - httpConfig: - $ref: '#/paths/~1trigger-subscriptions/post/requestBody/content/application~1json/schema/properties/httpConfig' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/HttpConfig.yaml - eventBridgeConfig: - $ref: '#/paths/~1trigger-subscriptions/post/requestBody/content/application~1json/schema/properties/eventBridgeConfig' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EventBridgeConfig.yaml - enabled: - type: boolean - description: |- - Whether subscription should receive real-time trigger invocations or not. - Test trigger invocations are always enabled regardless of this option. - default: true - example: true - filter: - type: string - description: JSONPath filter to conditionally invoke trigger when expression evaluates to true. - example: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - externalDocs: - description: JSONPath filter documentation - url: https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#create-subscription - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SubscriptionPostRequest = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "triggerId" : "idn:access-requested", - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - } - "@ - - # Create a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest - New-V2025Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Subscription" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#create-subscription - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.subscription import Subscription - from sailpoint.v2025.models.subscription_post_request import SubscriptionPostRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - subscription_post_request = '''{ - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "triggerId" : "idn:access-requested", - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - }''' # SubscriptionPostRequest | - try: - # Create a Subscription - new_subscription_post_request = SubscriptionPostRequest.from_json(subscription_post_request) - results = TriggersApi(api_client).create_subscription(x_sail_point_experimental=x_sail_point_experimental, subscription_post_request=new_subscription_post_request) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).create_subscription(x_sail_point_experimental, new_subscription_post_request) - print("The response of TriggersApi->create_subscription:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->create_subscription: %s\n" % e) - get: - operationId: listSubscriptions - tags: - - Triggers - summary: List Subscriptions - description: Gets a list of all trigger subscriptions. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - required: false - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq* - - **triggerId**: *eq* - - **type**: *eq, le* - example: id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89" - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **triggerId, triggerName** - example: triggerName - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of subscriptions. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1trigger-subscriptions/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Subscription.yaml - examples: - HTTP Subscription: - value: - - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: Access request subscription - description: Access requested to site xyz - triggerId: idn:access-requested - triggerName: Access Requested - type: HTTP - httpConfig: - url: https://www.example.com - httpDispatchMode: SYNC - httpAuthenticationType: BASIC_AUTH - basicAuthConfig: - userName: user@example.com - password: null - enabled: true - filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - HTTP Async Subscription: - value: - name: Access request subscription - description: Access requested to site xyz - triggerId: idn:access-requested - triggerName: Access Requested - type: HTTP - responseDeadline: PT1H - httpConfig: - url: https://www.example.com - httpDispatchMode: ASYNC - httpAuthenticationType: BASIC_AUTH - basicAuthConfig: - userName: user@example.com - password: null - enabled: true - filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - EventBridge Subscription: - value: - - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: Access request subscription - description: Access requested to site xyz - triggerId: idn:access-requested - triggerName: Access Requested - type: EVENTBRIDGE - eventBridgeConfig: - awsAccount: '123456789012' - awsRegion: us-west-1 - enabled: true - filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:trigger-service-subscriptions:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-subscriptions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) - $Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) - - # List Subscriptions - - try { - Get-V2025Subscriptions -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Subscriptions -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Subscriptions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#list-subscriptions - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.subscription import Subscription - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"12cff757-c0c0-413b-8ad7-2a47956d1e89\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) - sorters = 'triggerName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) - try: - # List Subscriptions - - results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) - /trigger-subscriptions/{id}: - put: - operationId: updateSubscription - tags: - - Triggers - summary: Update a Subscription - description: |- - This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing - Subscription is completely replaced. The following fields are immutable: - - - * id - - * triggerId - - - Attempts to modify these fields result in 400. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSubscriptions - description: Subscription ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: Subscription name. - example: Access request subscription - description: - type: string - description: Subscription description. - example: Access requested to site xyz - type: - $ref: '#/paths/~1trigger-subscriptions/post/requestBody/content/application~1json/schema/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SubscriptionType.yaml - responseDeadline: - type: string - description: Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - example: PT1H - default: PT1H - httpConfig: - $ref: '#/paths/~1trigger-subscriptions/post/requestBody/content/application~1json/schema/properties/httpConfig' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/HttpConfig.yaml - eventBridgeConfig: - $ref: '#/paths/~1trigger-subscriptions/post/requestBody/content/application~1json/schema/properties/eventBridgeConfig' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EventBridgeConfig.yaml - enabled: - type: boolean - description: |- - Whether subscription should receive real-time trigger invocations or not. - - Test trigger invocations are always enabled regardless of this option. - default: true - example: true - filter: - type: string - description: JSONPath filter to conditionally invoke trigger when expression evaluates to true. - example: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - externalDocs: - description: JSONPath filter documentation - url: https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events - examples: - HTTP Subscription: - value: - name: Access request subscription - description: Access requested to site xyz - type: HTTP - httpConfig: - url: https://www.example.com - httpDispatchMode: SYNC - httpAuthenticationType: BASIC_AUTH - basicAuthConfig: - userName: user@example.com - password: eRtg4%6yuI! - enabled: true - filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - HTTP Async Subscription: - value: - name: Access request subscription - description: Access requested to site xyz - type: HTTP - responseDeadline: PT1H - httpConfig: - url: https://www.example.com - httpDispatchMode: ASYNC - httpAuthenticationType: BASIC_AUTH - basicAuthConfig: - userName: user@example.com - password: eRtg4%6yuI! - enabled: true - filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - EventBridge Subscription: - value: - name: Access request subscription - description: Access requested to site xyz - type: EVENTBRIDGE - eventBridgeConfig: - awsAccount: '123456789012' - awsRegion: us-west-1 - enabled: true - filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - responses: - '200': - description: Updated subscription. - content: - application/json: - schema: - $ref: '#/paths/~1trigger-subscriptions/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Subscription.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#update-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SubscriptionPutRequest = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - } - "@ - - # Update a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest - Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Subscription" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#update-subscription - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.subscription import Subscription - from sailpoint.v2025.models.subscription_put_request import SubscriptionPutRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - subscription_put_request = '''{ - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - }''' # SubscriptionPutRequest | - try: - # Update a Subscription - new_subscription_put_request = SubscriptionPutRequest.from_json(subscription_put_request) - results = TriggersApi(api_client).update_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental, subscription_put_request=new_subscription_put_request) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).update_subscription(id, x_sail_point_experimental, new_subscription_put_request) - print("The response of TriggersApi->update_subscription:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->update_subscription: %s\n" % e) - patch: - operationId: patchSubscription - tags: - - Triggers - summary: Patch a Subscription - description: |- - This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: - - **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSubscriptions - description: ID of the Subscription to patch - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json-patch+json: - schema: - description: Operations to be applied - type: array - items: - type: object - description: A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - anyOf: - - type: string - - type: integer - - type: object - - type: array - items: - anyOf: - - type: string - - type: integer - - type: object - description: The value to be used for the operation, required for "add" and "replace" operations - example: New description - example: - - op: replace - path: /description - value: A new description - - op: replace - path: /name - value: A new name - responses: - '200': - description: Updated subscription. - content: - application/json: - schema: - $ref: '#/paths/~1trigger-subscriptions/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Subscription.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#patch-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SubscriptionPatchRequestInner = @""@ - - - # Patch a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner - Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Subscription" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#patch-subscription - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.subscription import Subscription - from sailpoint.v2025.models.subscription_patch_request_inner import SubscriptionPatchRequestInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - subscription_patch_request_inner = '''[sailpoint.v2025.SubscriptionPatchRequestInner()]''' # List[SubscriptionPatchRequestInner] | - try: - # Patch a Subscription - new_subscription_patch_request_inner = SubscriptionPatchRequestInner.from_json(subscription_patch_request_inner) - results = TriggersApi(api_client).patch_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental, subscription_patch_request_inner=new_subscription_patch_request_inner) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).patch_subscription(id, x_sail_point_experimental, new_subscription_patch_request_inner) - print("The response of TriggersApi->patch_subscription:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) - delete: - operationId: deleteSubscription - tags: - - Triggers - summary: Delete a Subscription - description: Deletes an existing subscription to a trigger. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSubscriptions - description: Subscription ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#delete-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a Subscription - - try { - Remove-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Subscription" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#delete-subscription - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a Subscription - - TriggersApi(api_client).delete_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # TriggersApi(api_client).delete_subscription(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) - /trigger-subscriptions/validate-filter: - post: - operationId: testSubscriptionFilter - tags: - - Triggers - summary: Validate a Subscription Filter - description: |- - Validates a JSONPath filter expression against a provided mock input. - Request requires a security scope of: - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - input: - type: object - description: Mock input to evaluate filter expression against. - example: - identityId: 201327fda1c44704ac01181e963d463c - filter: - type: string - description: JSONPath filter to conditionally invoke trigger when expression evaluates to true. - example: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - externalDocs: - description: JSONPath filter documentation - url: https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events - required: - - input - - filter - example: - input: - identityId: 201327fda1c44704ac01181e963d463c - filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] - responses: - '200': - description: Boolean whether specified filter expression is valid against the input. - content: - application/json: - schema: - type: object - properties: - isValid: - type: boolean - default: false - description: When this field is true, the filter expression is valid against the input. - example: true - isValidJSONPath: - type: boolean - default: false - description: When this field is true, the filter expression is using a valid JSON path. - example: true - isPathExist: - type: boolean - default: false - description: When this field is true, the filter expression is using an existing path. - example: true - example: - isValid: true - isValidJSONPath: true - isPathExist: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:trigger-service-subscriptions:manage - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#test-subscription-filter - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ValidateFilterInputDto = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - } - } - "@ - - # Validate a Subscription Filter - - try { - $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto - Test-V2025SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result - - # Below is a request that includes all optional parameters - # Test-V2025SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SubscriptionFilter" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#test-subscription-filter - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.validate_filter_input_dto import ValidateFilterInputDto - from sailpoint.v2025.models.validate_filter_output_dto import ValidateFilterOutputDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - validate_filter_input_dto = '''{ - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - } - }''' # ValidateFilterInputDto | - try: - # Validate a Subscription Filter - new_validate_filter_input_dto = ValidateFilterInputDto.from_json(validate_filter_input_dto) - results = TriggersApi(api_client).test_subscription_filter(x_sail_point_experimental=x_sail_point_experimental, validate_filter_input_dto=new_validate_filter_input_dto) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).test_subscription_filter(x_sail_point_experimental, new_validate_filter_input_dto) - print("The response of TriggersApi->test_subscription_filter:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) - /trigger-invocations/status: - get: - operationId: listTriggerInvocationStatus - tags: - - Triggers - summary: List Latest Invocation Statuses - description: |- - Gets a list of latest invocation statuses. - Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. - This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **triggerId**: *eq* - - **subscriptionId**: *eq* - example: triggerId eq "idn:access-request-dynamic-approver" - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** - example: created - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of latest invocation statuses. - content: - application/json: - schema: - type: array - items: - type: object - required: - - id - - triggerId - - subscriptionId - - startInvocationInput - - type - - subscriptionName - - created - properties: - id: - type: string - description: Invocation ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - triggerId: - type: string - description: Trigger ID - example: idn:access-request-post-approval - subscriptionName: - type: string - description: Subscription name - example: Access request subscription - subscriptionId: - type: string - description: Subscription ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - type: - type: string - description: |- - Defines the Invocation type. - - **TEST** The trigger was invocated as a test, either via the test subscription button in the UI or via the start test invocation API. - - **REAL_TIME** The trigger subscription is live and was invocated by a real event in IdentityNow. - enum: - - TEST - - REAL_TIME - example: TEST - created: - type: string - format: date-time - description: Invocation created timestamp. ISO-8601 in UTC. - example: '2020-03-27T20:40:10.738Z' - completed: - type: string - format: date-time - description: Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. - example: '2020-03-27T20:42:14.738Z' - startInvocationInput: - type: object - properties: - triggerId: - type: string - description: Trigger ID - example: idn:access-requested - input: - type: object - example: - identityId: 201327fda1c44704ac01181e963d463c - description: Trigger input payload. Its schema is defined in the trigger definition. - contentJson: - type: object - example: - workflowId: 1234 - description: JSON map of invocation metadata - completeInvocationInput: - type: object - properties: - localizedError: - $ref: '#/paths/~1identities~1invite/post/responses/202/content/application~1json/schema/properties/messages/items/properties/localizedText' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/LocalizedMessage.yaml - output: - type: object - nullable: true - example: - approved: false - description: Trigger output that completed the invocation. Its schema is defined in the trigger definition. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:trigger-service-invocation-status:read - - sp:trigger-service-invocation-status:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-trigger-invocation-status - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "triggerId eq "idn:access-request-dynamic-approver"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) - - # List Latest Invocation Statuses - - try { - Get-V2025TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TriggerInvocationStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#list-trigger-invocation-status - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.invocation_status import InvocationStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'triggerId eq \"idn:access-request-dynamic-approver\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) - sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) - try: - # List Latest Invocation Statuses - - results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) - /trigger-invocations/{id}/complete: - post: - operationId: completeTriggerInvocation - tags: - - Triggers - summary: Complete Trigger Invocation - description: Completes an invocation to a REQUEST_RESPONSE type trigger. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listTriggerInvocationStatus - description: The ID of the invocation to complete. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - secret: - type: string - description: Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - error: - type: string - description: The error message to indicate a failed invocation or error if any. - example: Access request is denied. - output: - type: object - example: - approved: false - description: Trigger output to complete the invocation. Its schema is defined in the trigger definition. - required: - - secret - - output - example: - secret: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - output: - approved: false - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#complete-trigger-invocation - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CompleteInvocation = @" - { - "output" : { - "approved" : false - }, - "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "error" : "Access request is denied." - } - "@ - - # Complete Trigger Invocation - - try { - $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation - Complete-V2025TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result - - # Below is a request that includes all optional parameters - # Complete-V2025TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025TriggerInvocation" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#complete-trigger-invocation - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.complete_invocation import CompleteInvocation - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - complete_invocation = '''{ - "output" : { - "approved" : false - }, - "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "error" : "Access request is denied." - }''' # CompleteInvocation | - try: - # Complete Trigger Invocation - new_complete_invocation = CompleteInvocation.from_json(complete_invocation) - TriggersApi(api_client).complete_trigger_invocation(id=id, x_sail_point_experimental=x_sail_point_experimental, complete_invocation=new_complete_invocation) - # Below is a request that includes all optional parameters - # TriggersApi(api_client).complete_trigger_invocation(id, x_sail_point_experimental, new_complete_invocation) - except Exception as e: - print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) - /trigger-invocations/test: - post: - operationId: startTestTriggerInvocation - tags: - - Triggers - summary: Start a Test Invocation - description: Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - triggerId: - type: string - example: idn:access-request-post-approval - description: Trigger ID - input: - type: object - example: - identityId: 201327fda1c44704ac01181e963d463c - description: Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. - contentJson: - type: object - example: - workflowId: 1234 - description: JSON map of invocation metadata. - subscriptionIds: - type: array - items: - type: string - example: - - 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - description: Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. - required: - - triggerId - - contentJson - examples: - Test Trigger with Mock Input: - value: - triggerId: idn:access-requested - input: - identityId: 201327fda1c44704ac01181e963d463c - contentJson: - workflowId: 1234 - Send Test to only One Subscriber: - value: - triggerId: idn:access-requested - contentJson: - workflowId: 1234 - subscriptionIds: - - 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - responses: - '200': - description: Test trigger invocations that have been started for specified subscription(s). - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Invocation ID - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - triggerId: - type: string - description: Trigger ID - example: idn:access-requested - secret: - type: string - description: Unique invocation secret. - example: 0f979022-08be-44f2-b6f9-7393ec73ed9b - contentJson: - type: object - example: - workflowId: 1234 - description: JSON map of invocation metadata. - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - sp:trigger-service-invocation-status:manage - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#start-test-trigger-invocation - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TestInvocation = @" - { - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - }, - "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], - "triggerId" : "idn:access-request-post-approval", - "contentJson" : { - "workflowId" : 1234 - } - } - "@ - - # Start a Test Invocation - - try { - $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation - Start-V2025TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result - - # Below is a request that includes all optional parameters - # Start-V2025TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025TestTriggerInvocation" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/triggers#start-test-trigger-invocation - source: | - from sailpoint.v2025.api.triggers_api import TriggersApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.invocation import Invocation - from sailpoint.v2025.models.test_invocation import TestInvocation - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - test_invocation = '''{ - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - }, - "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], - "triggerId" : "idn:access-request-post-approval", - "contentJson" : { - "workflowId" : 1234 - } - }''' # TestInvocation | - try: - # Start a Test Invocation - new_test_invocation = TestInvocation.from_json(test_invocation) - results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental=x_sail_point_experimental, test_invocation=new_test_invocation) - # Below is a request that includes all optional parameters - # results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation) - print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) - /ui-metadata/tenant: - get: - operationId: getTenantUiMetadata - tags: - - UI Metadata - summary: Get a tenant UI metadata - description: This API endpoint retrieves UI metadata configured for your tenant. - security: - - userAuth: - - idn:ui-access-metadata-page:read - x-sailpoint-userLevels: - - ORG_ADMIN - responses: - '200': - description: A tenant UI metadata object - content: - application/json: - schema: - type: object - properties: - iframeWhiteList: - type: string - nullable: true - description: Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use "null". It will only allow include into iframe non authenticated portions of the product, such as password reset. - example: http://example.com http://example2.com - usernameLabel: - type: string - nullable: true - description: Descriptor for the username input field. If you would like to reset the value use "null". - example: Email - usernameEmptyText: - type: string - nullable: true - description: Placeholder text displayed in the username input field. If you would like to reset the value use "null". - example: Please provide your work email address... - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/ui-metadata#get-tenant-ui-metadata - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a tenant UI metadata - - try { - Get-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantUiMetadata" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/ui-metadata#get-tenant-ui-metadata - source: | - from sailpoint.v2025.api.ui_metadata_api import UIMetadataApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a tenant UI metadata - - results = UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental) - print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) - put: - operationId: setTenantUiMetadata - tags: - - UI Metadata - summary: Update tenant UI metadata - description: This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - iframeWhiteList: - type: string - nullable: true - description: Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use "null". It will only allow include into iframe non authenticated portions of the product, such as password reset. - example: http://example.com http://example2.com - usernameLabel: - type: string - nullable: true - description: Descriptor for the username input field. If you would like to reset the value use "null". - example: Email - usernameEmptyText: - type: string - nullable: true - description: Placeholder text displayed in the username input field. If you would like to reset the value use "null". - example: Please provide your work email address... - security: - - userAuth: - - idn:ui-access-metadata-page:manage - x-sailpoint-userLevels: - - ORG_ADMIN - responses: - '200': - description: A tenant UI metadata object - content: - application/json: - schema: - $ref: '#/paths/~1ui-metadata~1tenant/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ui-metadata/TenantUiMetadataItemResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/ui-metadata#set-tenant-ui-metadata - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TenantUiMetadataItemUpdateRequest = @" - { - "usernameEmptyText" : "Please provide your work email address...", - "usernameLabel" : "Email", - "iframeWhiteList" : "http://example.com http://example2.com" - } - "@ - - # Update tenant UI metadata - - try { - $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest - Set-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result - - # Below is a request that includes all optional parameters - # Set-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TenantUiMetadata" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/ui-metadata#set-tenant-ui-metadata - source: | - from sailpoint.v2025.api.ui_metadata_api import UIMetadataApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse - from sailpoint.v2025.models.tenant_ui_metadata_item_update_request import TenantUiMetadataItemUpdateRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - tenant_ui_metadata_item_update_request = '''{ - "usernameEmptyText" : "Please provide your work email address...", - "usernameLabel" : "Email", - "iframeWhiteList" : "http://example.com http://example2.com" - }''' # TenantUiMetadataItemUpdateRequest | - try: - # Update tenant UI metadata - new_tenant_ui_metadata_item_update_request = TenantUiMetadataItemUpdateRequest.from_json(tenant_ui_metadata_item_update_request) - results = UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental=x_sail_point_experimental, tenant_ui_metadata_item_update_request=new_tenant_ui_metadata_item_update_request) - # Below is a request that includes all optional parameters - # results = UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental, new_tenant_ui_metadata_item_update_request) - print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) - /verified-from-addresses: - get: - operationId: listFromAddresses - tags: - - Notifications - summary: List From Addresses - description: Retrieve a list of sender email addresses and their verification statuses - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **email**: *eq, ge, le, sw* - example: email eq "john.doe@company.com" - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **email** - example: email - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of Email Status - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - nullable: true - email: - type: string - example: sender@example.com - isVerifiedByDomain: - type: boolean - example: false - verificationStatus: - type: string - enum: - - PENDING - - SUCCESS - - FAILED - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-from-addresses - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "email eq "john.doe@company.com"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) - $Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) - - # List From Addresses - - try { - Get-V2025FromAddresses -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025FromAddresses -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FromAddresses" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#list-from-addresses - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.email_status_dto import EmailStatusDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'email eq \"john.doe@company.com\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) - sorters = 'email' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) - try: - # List From Addresses - - results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) - post: - operationId: createVerifiedFromAddress - tags: - - Notifications - summary: Create Verified From Address - description: Create a new sender email address and initiate verification process. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1verified-from-addresses/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EmailStatusDto.yaml - example: - email: sender@example.com - responses: - '201': - description: New Verified Email Status - content: - application/json: - schema: - $ref: '#/paths/~1verified-from-addresses/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EmailStatusDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-verified-from-address - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $EmailStatusDto = @" - { - "isVerifiedByDomain" : false, - "verificationStatus" : "PENDING", - "id" : "id", - "email" : "sender@example.com" - } - "@ - - # Create Verified From Address - - try { - $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto - New-V2025VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result - - # Below is a request that includes all optional parameters - # New-V2025VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025VerifiedFromAddress" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#create-verified-from-address - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.email_status_dto import EmailStatusDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - email_status_dto = '''{ - "isVerifiedByDomain" : false, - "verificationStatus" : "PENDING", - "id" : "id", - "email" : "sender@example.com" - }''' # EmailStatusDto | - try: - # Create Verified From Address - new_email_status_dto = EmailStatusDto.from_json(email_status_dto) - results = NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental=x_sail_point_experimental, email_status_dto=new_email_status_dto) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental, new_email_status_dto) - print("The response of NotificationsApi->create_verified_from_address:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) - /verified-from-addresses/{id}: - delete: - operationId: deleteVerifiedFromAddress - tags: - - Notifications - summary: Delete Verified From Address - description: Delete a verified sender email address - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listFromAddresses - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#delete-verified-from-address - source: | - $Id = "MyId" # String | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Verified From Address - - try { - Remove-V2025VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025VerifiedFromAddress" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#delete-verified-from-address - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'id_example' # str | # str | - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete Verified From Address - - NotificationsApi(api_client).delete_verified_from_address(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # NotificationsApi(api_client).delete_verified_from_address(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) - /verified-domains: - get: - security: - - userAuth: - - sp:notification-dkim-attributes:read - operationId: getDkimAttributes - tags: - - Notifications - summary: Get DKIM Attributes - description: Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. - responses: - '200': - description: List of DKIM Attributes - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - example: 123b45b0-aaaa-bbbb-a7db-123456a56abc - description: UUID associated with domain to be verified - address: - type: string - example: BobSmith@sailpoint.com - description: The identity or domain address - dkimEnabled: - type: boolean - default: false - example: true - description: Whether or not DKIM has been enabled for this domain / identity - dkimTokens: - type: array - items: - type: string - example: - - uq1m3jjk25ckd3whl4n7y46c56r5l6aq - - u7pm38jky9ckdawhlsn7y4dcj6f5lpgq - - uhpm3jjkjjckdkwhlqn7yw6cjer5tpay - description: The tokens to be added to a DNS for verification - dkimVerificationStatus: - type: string - example: Success - description: The current status if the domain /identity has been verified. Ie Success, Failed, Pending - description: DKIM attributes for a domain or identity - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-dkim-attributes - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get DKIM Attributes - - try { - Get-V2025DkimAttributes -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DkimAttributes -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DkimAttributes" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#get-dkim-attributes - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.dkim_attributes import DkimAttributes - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get DKIM Attributes - - results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) - print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) - post: - security: - - userAuth: - - sp:notification-verify-domain-dkim:write - operationId: createDomainDkim - tags: - - Notifications - summary: Verify domain address via DKIM - description: Create a domain to be verified via DKIM (DomainKeys Identified Mail) - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - domain: - type: string - example: sailpoint.com - description: A domain address - responses: - '200': - description: List of DKIM tokens required for the verification process. - content: - application/json: - schema: - type: object - properties: - id: - type: string - example: 123b45b0-aaaa-bbbb-a7db-123456a56abc - description: New UUID associated with domain to be verified - domain: - type: string - example: sailpoint.com - description: A domain address - dkimEnabled: - default: false - example: true - description: DKIM is enabled for this domain - dkimTokens: - type: array - items: - type: string - example: - - token1 - - token2 - - token3 - description: DKIM tokens required for authentication - dkimVerificationStatus: - type: string - example: PENDING - description: Status of DKIM authentication - description: Domain status DTO containing everything required to verify via DKIM - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '405': - description: Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. - content: - application/json: - schema: - type: object - properties: - errorName: - description: A message describing the error - example: NotSupportedException - errorMessage: - description: Description of the error - example: Cannot consume content type - trackingId: - type: string - description: Unique tracking id for the error. - example: e7eab60924f64aa284175b9fa3309599 - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-domain-dkim - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $DomainAddress = @" - { - "domain" : "sailpoint.com" - } - "@ - - # Verify domain address via DKIM - - try { - $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress - New-V2025DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result - - # Below is a request that includes all optional parameters - # New-V2025DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DomainDkim" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/notifications#create-domain-dkim - source: | - from sailpoint.v2025.api.notifications_api import NotificationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.domain_address import DomainAddress - from sailpoint.v2025.models.domain_status_dto import DomainStatusDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - domain_address = '''{ - "domain" : "sailpoint.com" - }''' # DomainAddress | - try: - # Verify domain address via DKIM - new_domain_address = DomainAddress.from_json(domain_address) - results = NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental=x_sail_point_experimental, domain_address=new_domain_address) - # Below is a request that includes all optional parameters - # results = NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental, new_domain_address) - print("The response of NotificationsApi->create_domain_dkim:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) - /workgroups: - get: - operationId: listWorkgroups - tags: - - Governance Groups - summary: List Governance Groups - description: This API returns list of Governance Groups - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1connector-rules/get/parameters/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit50.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in, sw* - - **name**: *eq, sw, in* - - **memberships.identityId**: *eq, in* - example: name sw "Test" - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created, modified, id, description** - example: name,-modified - required: false - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of Governance Groups - content: - application/json: - schema: - type: array - items: - type: object - properties: - owner: - allOf: - - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/ownerRef/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/OwnerDto.yaml - - type: object - properties: - displayName: - readOnly: true - description: The display name of the identity - type: string - example: Support - emailAddress: - readOnly: true - description: The primary email address of the identity - type: string - example: support@sailpoint.com - description: Governance group owner. - id: - type: string - description: Governance group ID. - example: 2c91808568c529c60168cca6f90c1313 - readOnly: true - name: - type: string - description: Governance group name. - example: DB Access Governance Group - description: - type: string - description: Governance group description. - example: Description of the Governance Group - memberCount: - type: integer - format: int64 - example: 1641498673000 - readOnly: true - description: Number of members in the governance group. - connectionCount: - type: integer - format: int64 - example: 1641498673000 - description: Number of connections in the governance group. - readOnly: true - created: - type: string - format: date-time - example: '2022-01-06T19:51:13Z' - modified: - type: string - format: date-time - example: '2022-01-06T19:51:13Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:workgroup:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-workgroups - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw "Test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) - - # List Governance Groups - - try { - Get-V2025Workgroups -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Workgroups -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workgroups" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#list-workgroups - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workgroup_dto import WorkgroupDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name sw \"Test\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) - try: - # List Governance Groups - - results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) - print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) - post: - operationId: createWorkgroup - security: - - userAuth: - - idn:workgroup:write - tags: - - Governance Groups - summary: Create a new Governance Group. - description: This API creates a new Governance Group. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1workgroups/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workgroups/WorkgroupDto.yaml - responses: - '200': - description: Governance Group object created. - content: - application/json: - schema: - $ref: '#/paths/~1workgroups/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workgroups/WorkgroupDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#create-workgroup - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $WorkgroupDto = @" - { - "owner" : { - "emailAddress" : "support@sailpoint.com", - "displayName" : "Support", - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "connectionCount" : 1641498673000, - "created" : "2022-01-06T19:51:13Z", - "memberCount" : 1641498673000, - "name" : "DB Access Governance Group", - "description" : "Description of the Governance Group", - "modified" : "2022-01-06T19:51:13Z", - "id" : "2c91808568c529c60168cca6f90c1313" - } - "@ - - # Create a new Governance Group. - - try { - $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto - New-V2025Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result - - # Below is a request that includes all optional parameters - # New-V2025Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workgroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#create-workgroup - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workgroup_dto import WorkgroupDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - workgroup_dto = '''{ - "owner" : { - "emailAddress" : "support@sailpoint.com", - "displayName" : "Support", - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "connectionCount" : 1641498673000, - "created" : "2022-01-06T19:51:13Z", - "memberCount" : 1641498673000, - "name" : "DB Access Governance Group", - "description" : "Description of the Governance Group", - "modified" : "2022-01-06T19:51:13Z", - "id" : "2c91808568c529c60168cca6f90c1313" - }''' # WorkgroupDto | - try: - # Create a new Governance Group. - new_workgroup_dto = WorkgroupDto.from_json(workgroup_dto) - results = GovernanceGroupsApi(api_client).create_workgroup(x_sail_point_experimental=x_sail_point_experimental, workgroup_dto=new_workgroup_dto) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).create_workgroup(x_sail_point_experimental, new_workgroup_dto) - print("The response of GovernanceGroupsApi->create_workgroup:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) - /workgroups/{id}: - get: - operationId: getWorkgroup - tags: - - Governance Groups - summary: Get Governance Group by Id - description: This API returns a Governance Groups by its ID. - parameters: - - in: path - name: id - required: true - schema: - type: string - description: ID of the Governance Group - example: 2c9180837ca6693d017ca8d097500149 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: A Governance Group - content: - application/json: - schema: - $ref: '#/paths/~1workgroups/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workgroups/WorkgroupDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:workgroup:read - - applicationAuth: - - idn:workgroup:read - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#get-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Governance Group by Id - - try { - Get-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workgroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#get-workgroup - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workgroup_dto import WorkgroupDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Governance Group by Id - - results = GovernanceGroupsApi(api_client).get_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).get_workgroup(id, x_sail_point_experimental) - print("The response of GovernanceGroupsApi->get_workgroup:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) - delete: - operationId: deleteWorkgroup - tags: - - Governance Groups - summary: Delete a Governance Group - description: This API deletes a Governance Group by its ID. - parameters: - - in: path - name: id - required: true - schema: - type: string - description: ID of the Governance Group - example: 2c9180837ca6693d017ca8d097500149 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:workgroup:write - - applicationAuth: - - idn:workgroup:write - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a Governance Group - - try { - Remove-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workgroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#delete-workgroup - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a Governance Group - - GovernanceGroupsApi(api_client).delete_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # GovernanceGroupsApi(api_client).delete_workgroup(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) - patch: - operationId: patchWorkgroup - tags: - - Governance Groups - summary: Patch a Governance Group - description: |- - This API updates an existing governance group by ID. The following fields and objects are patchable: - * name - * description - * owner - parameters: - - in: path - name: id - required: true - schema: - type: string - description: ID of the Governance Group - example: 2c9180837ca6693d017ca8d097500149 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - examples: - Replace Description: - description: Replace description of a Governance Group. - value: - - op: replace - path: /description - value: Governance Group new description. - responses: - '200': - description: A Governance Group. - content: - application/json: - schema: - $ref: '#/paths/~1workgroups/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workgroups/WorkgroupDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:workgroup:write - - applicationAuth: - - idn:workgroup:write - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#patch-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Governance Group - - try { - Update-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workgroup" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#patch-workgroup - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.workgroup_dto import WorkgroupDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[{op=replace, path=/description, value=Governance Group new description.}]''' # List[JsonPatchOperation] | (optional) - try: - # Patch a Governance Group - - results = GovernanceGroupsApi(api_client).patch_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).patch_workgroup(id, x_sail_point_experimental, new_json_patch_operation) - print("The response of GovernanceGroupsApi->patch_workgroup:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) - /workgroups/bulk-delete: - post: - operationId: deleteWorkgroupsInBulk - summary: Delete Governance Group(s) - tags: - - Governance Groups - description: |- - - This API initiates a bulk deletion of one or more Governance Groups. - - > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. - - > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. - - > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. - - > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. - - > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - ids: - description: List of IDs of Governance Groups to be deleted. - type: array - items: - type: string - example: - - 567a697e-885b-495a-afc5-d55e1c23a302 - - c7b0f7b2-1e78-4063-b294-a555333dacd2 - example: - ids: - - 567a697e-885b-495a-afc5-d55e1c23a302 - - c7b0f7b2-1e78-4063-b294-a555333dacd2 - responses: - '207': - description: Governance Group bulk delete response. - content: - application/json: - schema: - description: Bulk remove Governance Groups Response. - type: array - items: - type: object - properties: - id: - description: Id of the Governance Group. - type: string - example: 464ae7bf791e49fdb74606a2e4a89635 - status: - type: integer - format: int32 - description: | - - The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. - - > 204 - Governance Group deleted successfully. - - > 409 - Governance Group is in use,hence can not be deleted. - - > 404 - Governance Group not found. - example: 204 - description: - description: | - Human readable status description and containing additional context information about success or failures etc. - example: | - - > Governance Group deleted successfully. - - > Unable to delete Governance Group f80bba83-98c4-4ec2-81c8-373c00e9663b because it is in use. - - > Referenced Governance Group 2b711763-ed35-42a2-a80c-8f1ce0dc4a7f was not found. - type: string - required: - - id - - status - example: - - id: 464ae7bf791e49fdb74606a2e4a89635 - status: 204 - description: Governance Group deleted successfully. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:workgroup:write - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroups-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $WorkgroupBulkDeleteRequest = @" - { - "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] - } - "@ - - # Delete Governance Group(s) - - try { - $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest - Remove-V2025WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025WorkgroupsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#delete-workgroups-in-bulk - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workgroup_bulk_delete_request import WorkgroupBulkDeleteRequest - from sailpoint.v2025.models.workgroup_delete_item import WorkgroupDeleteItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - workgroup_bulk_delete_request = '''{ - "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] - }''' # WorkgroupBulkDeleteRequest | - try: - # Delete Governance Group(s) - new_workgroup_bulk_delete_request = WorkgroupBulkDeleteRequest.from_json(workgroup_bulk_delete_request) - results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental=x_sail_point_experimental, workgroup_bulk_delete_request=new_workgroup_bulk_delete_request) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request) - print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) - /workgroups/{workgroupId}/connections: - get: - operationId: listConnections - tags: - - Governance Groups - summary: List connections for Governance Group - description: This API returns list of connections associated with a Governance Group. - parameters: - - name: workgroupId - in: path - description: ID of the Governance Group. - required: true - schema: - type: string - example: 2c91808a7813090a017814121919ecca - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1connector-rules/get/parameters/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit50.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created, modified** - example: name,-modified - required: false - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List all connections associated with a Governance Group. - content: - application/json: - schema: - type: array - items: - type: object - properties: - object: - allOf: - - type: object - properties: - type: - allOf: - - type: string - enum: - - ACCESS_PROFILE - - ROLE - - SOD_POLICY - - SOURCE - description: An enumeration of the types of Objects associated with a Governance Group. Supported object types are ACCESS_PROFILE, ROLE, SOD_POLICY and SOURCE. - example: ACCESS_PROFILE - - description: Connection Object type - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable name of Connected object - example: Employee-database-read-write - description: - type: string - nullable: true - description: Description of the Connected object. - example: Collection of entitlements to read/write the employee database. - - description: Connected object to Governance Group - connectionType: - description: Connection Type. - type: string - enum: - - AccessRequestReviewer - - Owner - - ManagementWorkgroup - example: AccessRequestReviewer - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:workgroup:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-connections - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List connections for Governance Group - - try { - Get-V2025Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Connections" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#list-connections - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workgroup_connection_dto import WorkgroupConnectionDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - try: - # List connections for Governance Group - - results = GovernanceGroupsApi(api_client).list_connections(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) - print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) - /workgroups/{workgroupId}/members: - get: - operationId: listWorkgroupMembers - tags: - - Governance Groups - summary: List Governance Group Members - description: This API returns list of members associated with a Governance Group. - parameters: - - name: workgroupId - in: path - description: ID of the Governance Group. - required: true - schema: - type: string - example: 2c91808a7813090a017814121919ecca - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1connector-rules/get/parameters/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit50.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created, modified** - example: name,-modified - required: false - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List all members associated with a Governance Group. - content: - application/json: - schema: - type: array - items: - type: object - description: Identity of workgroup member. - properties: - type: - type: string - description: Workgroup member identity DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Workgroup member identity ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Workgroup member identity display name. - example: Michael Michaels - email: - type: string - description: Workgroup member identity email. - example: michael.michaels@sailpoint.com - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:workgroup:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Governance Group Members - - try { - Get-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkgroupMembers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#list-workgroup-members - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_workgroup_members200_response_inner import ListWorkgroupMembers200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - try: - # List Governance Group Members - - results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) - print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) - /workgroups/{workgroupId}/members/bulk-add: - post: - operationId: updateWorkgroupMembers - security: - - userAuth: - - idn:workgroup:write - tags: - - Governance Groups - summary: Add members to Governance Group - description: |- - This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. - - > **Following field of Identity is an optional field in the request.** - - > **name** - parameters: - - name: workgroupId - in: path - description: ID of the Governance Group. - required: true - schema: - type: string - example: 2c91808a7813090a017814121919ecca - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - description: List of identities to be added to a Governance Group members list. - required: true - content: - application/json: - schema: - description: List of identities to be added or removed to a Governance Group members list. - type: array - items: - type: object - description: Identity's basic details. - properties: - type: - type: string - description: Identity's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Identity's display name. - example: Michael Michaels - example: - - type: IDENTITY - id: 464ae7bf791e49fdb74606a2e4a89635 - name: Addie Smith - responses: - '207': - description: List of added and not added identities into Governance Group members list. - content: - application/json: - schema: - description: Bulk add Governance Group members Response. - type: array - items: - type: object - properties: - id: - description: Identifier of identity in bulk member add request. - type: string - example: 464ae7bf791e49fdb74606a2e4a89635 - status: - description: | - - The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. - The HTTP response status code returned for an individual Governance Group is requested for deletion. - - > 201 - Identity is added into Governance Group members list. - - > 409 - Identity is already member of Governance Group. - type: integer - format: int32 - example: 201 - description: - description: | - Human readable status description and containing additional context information about success or failures etc. - type: string - example: | - - > Identity is added into Governance Group members list. - - > Unable to set Membership of Identity "3244d5f2d04447498520f54c6789ae33" to Governance Group "f80bba83-98c4-4ec2-81c8-373c00e9663b"; the relationship already exists. - required: - - id - - status - example: - - id: 464ae7bf791e49fdb74606a2e4a89635 - status: 201 - description: Identity added to Governance Group members list. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#update-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityPreviewResponseIdentity = @""@ - - - # Add members to Governance Group - - try { - $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Update-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - - # Below is a request that includes all optional parameters - # Update-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025WorkgroupMembers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#update-workgroup-members - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_preview_response_identity import IdentityPreviewResponseIdentity - from sailpoint.v2025.models.workgroup_member_add_item import WorkgroupMemberAddItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_preview_response_identity = '''[sailpoint.v2025.IdentityPreviewResponseIdentity()]''' # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. - try: - # Add members to Governance Group - new_identity_preview_response_identity = IdentityPreviewResponseIdentity.from_json(identity_preview_response_identity) - results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental, identity_preview_response_identity=new_identity_preview_response_identity) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) - print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) - /workgroups/{workgroupId}/members/bulk-delete: - post: - operationId: deleteWorkgroupMembers - security: - - userAuth: - - idn:workgroup:write - - applicationAuth: - - idn:workgroup:write - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Governance Groups - summary: Remove members from Governance Group - description: |- - This API removes one or more members from a Governance Group. A - > **Following field of Identity is an optional field in the request.** - - > **name** - parameters: - - name: workgroupId - in: path - description: ID of the Governance Group. - required: true - schema: - type: string - example: 2c91808a7813090a017814121919ecca - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - description: List of identities to be removed from a Governance Group members list. - required: true - content: - application/json: - schema: - $ref: '#/paths/~1workgroups~1%7BworkgroupId%7D~1members~1bulk-add/post/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workgroups/BulkWorkgroupMembersRequest.yaml - responses: - '207': - description: List of deleted and not deleted identities from Governance Group members list. - content: - application/json: - schema: - description: Bulk add Governance Group members Response. - type: array - items: - type: object - properties: - id: - description: Identifier of identity in bulk member add /remove request. - type: string - example: 464ae7bf791e49fdb74606a2e4a89635 - status: - description: | - The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. - - > 204 - Identity is removed from Governance Group members list. - - > 404 - Identity is not member of Governance Group. - type: integer - format: int32 - example: 204 - description: - description: | - Human readable status description and containing additional context information about success or failures etc. - type: string - example: | - - > Identity deleted from Governance Group members list. - - > Referenced Governance Group Member with Identity Id "bc3a744678534eb78a8002ee2085df64" was not found. - required: - - id - - status - example: - - id: 464ae7bf791e49fdb74606a2e4a89635 - status: 204 - description: Identity deleted from Governance Group members list. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityPreviewResponseIdentity = @""@ - - - # Remove members from Governance Group - - try { - $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Remove-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - - # Below is a request that includes all optional parameters - # Remove-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025WorkgroupMembers" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/governance-groups#delete-workgroup-members - source: | - from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_preview_response_identity import IdentityPreviewResponseIdentity - from sailpoint.v2025.models.workgroup_member_delete_item import WorkgroupMemberDeleteItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - identity_preview_response_identity = '''[sailpoint.v2025.IdentityPreviewResponseIdentity()]''' # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. - try: - # Remove members from Governance Group - new_identity_preview_response_identity = IdentityPreviewResponseIdentity.from_json(identity_preview_response_identity) - results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental, identity_preview_response_identity=new_identity_preview_response_identity) - # Below is a request that includes all optional parameters - # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) - print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) - /form-definitions: - get: - tags: - - Custom Forms - summary: Export form definitions by tenant. - description: No parameters required. - operationId: searchFormDefinitionsByTenant - parameters: - - name: offset - in: query - description: |- - Offset - - Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). - The offset value is record-based, not page-based, and the index starts at 0. - schema: - type: integer - format: int64 - default: 0 - x-go-name: Offset - example: 250 - required: false - x-go-name: Offset - - name: limit - in: query - description: |- - Limit - - Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). - If it is not specified, a default limit is used. - schema: - type: integer - format: int64 - maxLength: 250 - minLength: 0 - default: 250 - x-go-name: Limit - example: 250 - required: false - x-go-name: Limit - - name: filters - in: query - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **name**: *eq, gt, sw, in* - - **description**: *eq, gt, sw, in* - - **created**: *eq, gt, sw, in* - - **modified**: *eq, gt, sw, in* - schema: - type: string - x-go-name: Filters - example: name sw "my form" - required: false - x-go-name: Filters - - name: sorters - in: query - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, description, created, modified** - schema: - type: string - default: name - x-go-name: Sorters - example: name - required: false - x-go-name: Sorters - responses: - '200': - description: Returns a list of form definitions by tenant - content: - application/json: - schema: - properties: - count: - description: Count number of results. - example: 1 - format: int64 - type: integer - results: - description: List of FormDefinitionResponse items. - items: - $ref: '#/paths/~1form-definitions/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionResponse.yaml - type: array - type: object - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - title: ErrorMessage is the standard API error response message type. - type: object - properties: - locale: - description: Locale is the current Locale - example: en-US - type: string - x-go-name: Locale - localeOrigin: - description: LocaleOrigin holds possible values of how the locale was selected - example: DEFAULT - type: string - x-go-name: LocaleOrigin - text: - description: Text is the actual text of the error message - example: This is an error - type: string - x-go-name: Text - x-go-package: github.com/sailpoint/atlas-go/atlas/web - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - title: Error is the standard API error response type. - type: object - properties: - detailCode: - description: DetailCode is the text of the status code returned - example: Internal Server Error - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - trackingId: - description: TrackingID is the request tracking unique identifier - example: 9cd03ef80e6a425eb6b11bdbb057cdb4 - type: string - x-go-name: TrackingID - x-go-package: github.com/sailpoint/atlas-go/atlas/web - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-definitions-by-tenant - source: | - $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") - - # Export form definitions by tenant. - - try { - Search-V2025FormDefinitionsByTenant - - # Below is a request that includes all optional parameters - # Search-V2025FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormDefinitionsByTenant" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#search-form-definitions-by-tenant - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_form_definitions_by_tenant_response import ListFormDefinitionsByTenantResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - filters = 'name sw \"my form\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') - try: - # Export form definitions by tenant. - - results = CustomFormsApi(api_client).search_form_definitions_by_tenant() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).search_form_definitions_by_tenant(offset, limit, filters, sorters) - print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) - post: - tags: - - Custom Forms - summary: Creates a form definition. - operationId: createFormDefinition - requestBody: - description: Body is the request payload to create form definition request - content: - application/json: - schema: - properties: - description: - description: Description is the form definition description - example: My form description - maxLength: 2000 - minLength: 0 - type: string - x-go-name: Description - formConditions: - description: FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - items: - description: Represent a form conditional. - properties: - ruleOperator: - description: |- - ConditionRuleLogicalOperatorType value. - AND ConditionRuleLogicalOperatorTypeAnd - OR ConditionRuleLogicalOperatorTypeOr - enum: - - AND - - OR - example: AND - type: string - x-go-enum-desc: |- - AND ConditionRuleLogicalOperatorTypeAnd - OR ConditionRuleLogicalOperatorTypeOr - x-go-name: RuleOperator - rules: - description: List of rules. - items: - properties: - sourceType: - description: |- - Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). - INPUT ConditionRuleSourceTypeInput - ELEMENT ConditionRuleSourceTypeElement - enum: - - INPUT - - ELEMENT - example: ELEMENT - type: string - x-go-enum-desc: |- - INPUT ConditionRuleSourceTypeInput - ELEMENT ConditionRuleSourceTypeElement - x-go-name: SourceType - source: - description: |- - Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, - the source is the name of a technical key of an element to retrieve its value. - example: department - type: string - x-go-name: Source - operator: - description: |- - ConditionRuleComparisonOperatorType value. - EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. - NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. - CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. - NOT_CO ConditionRuleComparisonOperatorTypeNotContains - IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. - NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes - EM ConditionRuleComparisonOperatorTypeEmpty - NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty - SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. - NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith - EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. - NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith - enum: - - EQ - - NE - - CO - - NOT_CO - - IN - - NOT_IN - - EM - - NOT_EM - - SW - - NOT_SW - - EW - - NOT_EW - example: EQ - type: string - x-go-enum-desc: |- - EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. - NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. - CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. - NOT_CO ConditionRuleComparisonOperatorTypeNotContains - IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. - NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes - EM ConditionRuleComparisonOperatorTypeEmpty - NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty - SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. - NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith - EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. - NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith - x-go-name: Operator - valueType: - description: |- - ConditionRuleValueType type. - STRING ConditionRuleValueTypeString This value is a static string. - STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. - INPUT ConditionRuleValueTypeInput This value is a reference to a form input. - ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). - LIST ConditionRuleValueTypeList - BOOLEAN ConditionRuleValueTypeBoolean - enum: - - STRING - - STRING_LIST - - INPUT - - ELEMENT - - LIST - - BOOLEAN - example: STRING - type: string - x-go-enum-desc: |- - STRING ConditionRuleValueTypeString This value is a static string. - STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. - INPUT ConditionRuleValueTypeInput This value is a reference to a form input. - ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). - LIST ConditionRuleValueTypeList - BOOLEAN ConditionRuleValueTypeBoolean - x-go-name: ValueType - value: - type: string - description: Based on the ValueType. - example: Engineering - x-go-name: Value - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - type: array - x-go-name: Rules - effects: - description: List of effects. - items: - description: Effect produced by a condition. - properties: - effectType: - description: |- - Type of effect to perform when the conditions are evaluated for this logic block. - HIDE ConditionEffectTypeHide Disables validations. - SHOW ConditionEffectTypeShow Enables validations. - DISABLE ConditionEffectTypeDisable Disables validations. - ENABLE ConditionEffectTypeEnable Enables validations. - REQUIRE ConditionEffectTypeRequire - OPTIONAL ConditionEffectTypeOptional - SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage - SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification - SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. - enum: - - HIDE - - SHOW - - DISABLE - - ENABLE - - REQUIRE - - OPTIONAL - - SUBMIT_MESSAGE - - SUBMIT_NOTIFICATION - - SET_DEFAULT_VALUE - example: HIDE - type: string - x-go-enum-desc: |- - HIDE ConditionEffectTypeHide Disables validations. - SHOW ConditionEffectTypeShow Enables validations. - DISABLE ConditionEffectTypeDisable Disables validations. - ENABLE ConditionEffectTypeEnable Enables validations. - REQUIRE ConditionEffectTypeRequire - OPTIONAL ConditionEffectTypeOptional - SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage - SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification - SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. - x-go-name: EffectType - config: - description: Arbitrary map containing a configuration based on the EffectType. - type: object - properties: - defaultValueLabel: - type: string - description: Effect type's label. - example: Access to Remove - element: - type: string - description: Element's identifier. - example: 8110662963316867 - x-go-name: Config - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - type: array - x-go-name: Effects - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - type: array - x-go-name: FormConditions - formElements: - description: FormElements is a list of nested form elements - items: - properties: - id: - description: Form element identifier. - example: 00000000-0000-0000-0000-000000000000 - type: string - x-go-name: ID - elementType: - description: |- - FormElementType value. - TEXT FormElementTypeText - TOGGLE FormElementTypeToggle - TEXTAREA FormElementTypeTextArea - HIDDEN FormElementTypeHidden - PHONE FormElementTypePhone - EMAIL FormElementTypeEmail - SELECT FormElementTypeSelect - DATE FormElementTypeDate - SECTION FormElementTypeSection - COLUMN_SET FormElementTypeColumns - IMAGE FormElementTypeImage - DESCRIPTION FormElementTypeDescription - enum: - - TEXT - - TOGGLE - - TEXTAREA - - HIDDEN - - PHONE - - EMAIL - - SELECT - - DATE - - SECTION - - COLUMN_SET - - IMAGE - - DESCRIPTION - example: TEXT - type: string - x-go-name: ElementType - config: - additionalProperties: true - description: Config object. - example: - label: Department - type: object - x-go-name: Config - x-go-enum-desc: |- - TEXT FormElementTypeText - TOGGLE FormElementTypeToggle - TEXTAREA FormElementTypeTextArea - HIDDEN FormElementTypeHidden - PHONE FormElementTypePhone - EMAIL FormElementTypeEmail - SELECT FormElementTypeSelect - DATE FormElementTypeDate - SECTION FormElementTypeSection - COLUMNS FormElementTypeColumns - key: - description: Technical key. - example: department - type: string - x-go-name: Key - validations: - nullable: true - type: array - items: - description: Set of FormElementValidation items. - type: object - properties: - validationType: - description: The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. - example: REQUIRED - type: string - enum: - - REQUIRED - - MIN_LENGTH - - MAX_LENGTH - - REGEX - - DATE - - MAX_DATE - - MIN_DATE - - LESS_THAN_DATE - - PHONE - - EMAIL - - DATA_SOURCE - - TEXTAREA - x-go-package: github.com/sailpoint/sp-forms/domain - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - type: array - x-go-name: FormElements - formInput: - description: FormInput is a list of form inputs that are required when creating a form-instance object - items: - properties: - id: - description: Unique identifier for the form input. - example: 00000000-0000-0000-0000-000000000000 - type: string - x-go-name: ID - type: - description: |- - FormDefinitionInputType value. - STRING FormDefinitionInputTypeString - enum: - - STRING - - ARRAY - example: STRING - type: string - x-go-enum-desc: STRING FormDefinitionInputTypeString - x-go-name: Type - label: - description: Name for the form input. - example: input1 - type: string - x-go-name: Label - description: - description: Form input's description. - example: A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic - type: string - x-go-name: Description - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - type: array - x-go-name: FormInput - name: - description: Name is the form definition name - example: My form - maxLength: 255 - type: string - x-go-name: Name - owner: - properties: - type: - description: |- - FormOwnerType value. - IDENTITY FormOwnerTypeIdentity - enum: - - IDENTITY - example: IDENTITY - type: string - x-go-enum-desc: IDENTITY FormOwnerTypeIdentity - x-go-name: Type - id: - description: Unique identifier of the form's owner. - example: 2c9180867624cbd7017642d8c8c81f67 - type: string - x-go-name: ID - name: - description: Name of the form's owner. - example: Grant Smith - type: string - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - usedBy: - description: UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used - items: - properties: - type: - description: |- - FormUsedByType value. - WORKFLOW FormUsedByTypeWorkflow - SOURCE FormUsedByTypeSource - MySailPoint FormUsedByType - enum: - - WORKFLOW - - SOURCE - - MySailPoint - example: WORKFLOW - type: string - x-go-enum-desc: |- - WORKFLOW FormUsedByTypeWorkflow - SOURCE FormUsedByTypeSource - x-go-name: Type - id: - description: Unique identifier of the system using the form. - example: 61940a92-5484-42bc-bc10-b9982b218cdf - type: string - x-go-name: ID - name: - description: Name of the system using the form. - example: Access Request Form - type: string - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - type: array - x-go-name: UsedBy - required: - - name - - owner - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - example: - name: my form - description: my form description - owner: - type: IDENTITY - id: 00000000-0000-0000-0000-000000000000 - formElements: - - id: '000000000000' - elementType: SECTION - config: - alignment: LEFT - description: elementType must be 'SECTION' for the root formElements, child formElements must be within the 'config' attribute - label: Section - labelStyle: h2 - showLabel: true - formElements: - - id: '0000000000000' - key: textField - elementType: TEXT - config: - default: '' - description: '' - helpText: form element type text - label: Text Field - placeholder: '' - required: false - validations: [] - required: false - responses: - '201': - description: Returns a new form definition - content: - application/json: - schema: - properties: - id: - description: Unique guid identifying the form definition. - example: 00000000-0000-0000-0000-000000000000 - type: string - x-go-name: FormDefinitionID - name: - description: Name of the form definition. - example: My form - type: string - x-go-name: Name - description: - description: Form definition's description. - example: My form description - type: string - x-go-name: Description - owner: - $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormOwner.yaml - usedBy: - description: List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. - items: - $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/usedBy/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormUsedBy.yaml - type: array - x-go-name: UsedBy - formInput: - description: List of form inputs required to create a form-instance object. - items: - $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/formInput/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionInput.yaml - type: array - x-go-name: FormInput - formElements: - description: List of nested form elements. - items: - $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/formElements/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormElement.yaml - type: array - x-go-name: FormElements - formConditions: - description: Conditional logic that can dynamically modify the form as the recipient is interacting with it. - items: - $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/formConditions/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormCondition.yaml - type: array - x-go-name: FormConditions - created: - description: Created is the date the form definition was created - example: '2023-07-12T20:14:57.74486Z' - format: date-time - type: string - x-go-name: Created - modified: - description: Modified is the last date the form definition was modified - example: '2023-07-12T20:14:57.74486Z' - format: date-time - type: string - x-go-name: Modified - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codegen-request-body-name: Body - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition - source: | - $Body = @" - { - "owner" : { - "name" : "Grant Smith", - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "formConditions" : [ { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - }, { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - } ], - "formInput" : [ { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - }, { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - } ], - "name" : "My form", - "description" : "My form description", - "usedBy" : [ { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - }, { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - } ], - "formElements" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - } ] - } - "@ - - # Creates a form definition. - - try { - New-V2025FormDefinition - - # Below is a request that includes all optional parameters - # New-V2025FormDefinition -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinition" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#create-form-definition - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_form_definition_request import CreateFormDefinitionRequest - from sailpoint.v2025.models.form_definition_response import FormDefinitionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - body = '''{ - "owner" : { - "name" : "Grant Smith", - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "formConditions" : [ { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - }, { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - } ], - "formInput" : [ { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - }, { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - } ], - "name" : "My form", - "description" : "My form description", - "usedBy" : [ { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - }, { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - } ], - "formElements" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - } ] - }''' # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) - try: - # Creates a form definition. - - results = CustomFormsApi(api_client).create_form_definition() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).create_form_definition(new_body) - print("The response of CustomFormsApi->create_form_definition:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) - /form-definitions/{formDefinitionID}: - get: - tags: - - Custom Forms - summary: Return a form definition. - description: Parameter `{formDefinitionID}` should match a form definition ID. - operationId: getFormDefinitionByKey - parameters: - - name: formDefinitionID - in: path - description: Form definition ID - required: true - x-sailpoint-resource-operation-id: searchFormDefinitionsByTenant - schema: - type: string - x-go-name: FormDefinitionID - example: 00000000-0000-0000-0000-000000000000 - x-go-name: FormDefinitionID - responses: - '200': - description: Returns a form definition - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionResponse.yaml - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '404': - description: An error with the item not found - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-definition-by-key - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - - # Return a form definition. - - try { - Get-V2025FormDefinitionByKey -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Get-V2025FormDefinitionByKey -FormDefinitionID $FormDefinitionID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormDefinitionByKey" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#get-form-definition-by-key - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_definition_response import FormDefinitionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - try: - # Return a form definition. - - results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id=form_definition_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id) - print("The response of CustomFormsApi->get_form_definition_by_key:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) - delete: - tags: - - Custom Forms - summary: Deletes a form definition. - description: Parameter `{formDefinitionID}` should match a form definition ID. - operationId: deleteFormDefinition - parameters: - - name: formDefinitionID - in: path - description: Form definition ID - required: true - x-sailpoint-resource-operation-id: searchFormDefinitionsByTenant - schema: - type: string - x-go-name: FormDefinitionID - example: 00000000-0000-0000-0000-000000000000 - x-go-name: FormDefinitionID - responses: - '204': - description: Returns an empty body - content: - application/json: - schema: - title: Nil represents the predeclared value nil. - type: object - x-go-package: go/types - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '404': - description: An error with the item not found - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#delete-form-definition - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - - # Deletes a form definition. - - try { - Remove-V2025FormDefinition -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Remove-V2025FormDefinition -FormDefinitionID $FormDefinitionID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025FormDefinition" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#delete-form-definition - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - try: - # Deletes a form definition. - - results = CustomFormsApi(api_client).delete_form_definition(form_definition_id=form_definition_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).delete_form_definition(form_definition_id) - print("The response of CustomFormsApi->delete_form_definition:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) - patch: - tags: - - Custom Forms - summary: Patch a form definition. - description: Parameter `{formDefinitionID}` should match a form definition ID. - operationId: patchFormDefinition - parameters: - - name: formDefinitionID - in: path - description: Form definition ID - required: true - x-sailpoint-resource-operation-id: searchFormDefinitionsByTenant - schema: - type: string - x-go-name: FormDefinitionID - example: 00000000-0000-0000-0000-000000000000 - x-go-name: FormDefinitionID - requestBody: - description: 'Body is the request payload to patch a form definition, check: https://jsonpatch.com' - content: - application/json: - schema: - title: Patch is an ordered collection of Operations. - description: Patch is an ordered collection of Operations. - type: array - example: - - op: replace - path: /description - value: a new description - items: - title: Operation is a single JSON-Patch step, such as a single 'add' operation. - type: object - additionalProperties: - type: object - properties: {} - x-go-package: github.com/evanphx/json-patch - x-go-package: github.com/evanphx/json-patch - example: - - op: replace - path: /description - value: test-description - required: false - responses: - '200': - description: Returns the form definition updated - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionResponse.yaml - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '404': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-codegen-request-body-name: Body - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#patch-form-definition - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) - $Body = @"[{op=replace, path=/description, value=test-description}]"@ - - - # Patch a form definition. - - try { - Update-V2025FormDefinition -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Update-V2025FormDefinition -FormDefinitionID $FormDefinitionID -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025FormDefinition" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#patch-form-definition - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_definition_response import FormDefinitionResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - body = '''[{op=replace, path=/description, value=test-description}]''' # List[Dict[str, object]] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) - try: - # Patch a form definition. - - results = CustomFormsApi(api_client).patch_form_definition(form_definition_id=form_definition_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).patch_form_definition(form_definition_id, new_body) - print("The response of CustomFormsApi->patch_form_definition:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) - /form-definitions/{formDefinitionID}/data-source: - post: - tags: - - Custom Forms - summary: Preview form definition data source. - operationId: showPreviewDataSource - parameters: - - name: formDefinitionID - in: path - description: Form definition ID - required: true - x-sailpoint-resource-operation-id: searchFormDefinitionsByTenant - schema: - type: string - x-go-name: FormDefinitionID - example: 00000000-0000-0000-0000-000000000000 - x-go-name: FormDefinitionID - - name: limit - in: query - description: |- - Limit - - Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). - If it is not specified, a default limit is used. - schema: - type: integer - format: int64 - maxLength: 250 - minLength: 0 - default: 10 - x-go-name: Limit - example: 10 - required: false - x-go-name: Limit - - name: filters - in: query - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **value**: *eq, ne, in* - - Supported composite operators: *not* - - Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in ("ID01")` - schema: - type: string - x-go-name: Filters - example: value eq "ID01" - required: false - x-go-name: Filters - - name: query - in: query - description: String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a "starts with" filter against several fields. - schema: - type: string - x-go-name: Query - example: ac - required: false - x-go-name: Query - requestBody: - description: Body is the request payload to create a form definition dynamic schema - content: - application/json: - schema: - properties: - dataSource: - properties: - config: - properties: - aggregationBucketField: - description: AggregationBucketField is the aggregation bucket field name - example: attributes.cloudStatus.exact - type: string - x-go-name: AggregationBucketField - indices: - description: Indices is a list of indices to use - example: - - identities - items: - enum: - - accessprofiles - - accountactivities - - entitlements - - identities - - events - - roles - - '*' - type: string - x-go-enum-desc: |- - accessprofiles SearchIndexAccessProfiles - accountactivities SearchIndexAccountActivities - entitlements SearchIndexEntitlements - identities SearchIndexIdentities - events SearchIndexEvents - roles SearchIndexRoles - * SearchIndexWildcard - type: array - x-go-name: Indices - objectType: - description: |- - ObjectType is a PreDefinedSelectOption value - IDENTITY PreDefinedSelectOptionIdentity - ACCESS_PROFILE PreDefinedSelectOptionAccessProfile - SOURCES PreDefinedSelectOptionSources - ROLE PreDefinedSelectOptionRole - ENTITLEMENT PreDefinedSelectOptionEntitlement - enum: - - IDENTITY - - ACCESS_PROFILE - - SOURCES - - ROLE - - ENTITLEMENT - example: IDENTITY - type: string - x-go-enum-desc: |- - IDENTITY PreDefinedSelectOptionIdentity - ACCESS_PROFILE PreDefinedSelectOptionAccessProfile - SOURCES PreDefinedSelectOptionSources - ROLE PreDefinedSelectOptionRole - ENTITLEMENT PreDefinedSelectOptionEntitlement - x-go-name: ObjectType - query: - description: Query is a text - example: '*' - type: string - x-go-name: Query - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - dataSourceType: - description: |- - DataSourceType is a FormElementDataSourceType value - STATIC FormElementDataSourceTypeStatic - INTERNAL FormElementDataSourceTypeInternal - SEARCH FormElementDataSourceTypeSearch - FORM_INPUT FormElementDataSourceTypeFormInput - enum: - - STATIC - - INTERNAL - - SEARCH - - FORM_INPUT - example: STATIC - type: string - x-go-enum-desc: |- - STATIC FormElementDataSourceTypeStatic - INTERNAL FormElementDataSourceTypeInternal - SEARCH FormElementDataSourceTypeSearch - FORM_INPUT FormElementDataSourceTypeFormInput - x-go-name: DataSourceType - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - required: false - responses: - '200': - description: Returns a preview of a form definition data source - content: - application/json: - schema: - description: PreviewDataSourceResponse is the response sent by `/form-definitions/{formDefinitionID}/data-source` endpoint - properties: - results: - description: Results holds a list of FormElementDataSourceConfigOptions items - example: '{"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]}' - items: - type: object - properties: - label: - description: Label is the main label to display to the user when selecting this option - type: string - example: regression-test-access-request-07c55dd6-3056-430a-86b5-fccc395bb6c5 - x-go-name: Label - subLabel: - description: SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option - type: string - example: '' - x-go-name: SubLabel - value: - description: Value is the value to save as an entry when the user selects this option - type: string - example: e96674448eba4ca1ba04eee999a8f3cd - x-go-name: Value - x-go-package: github.com/sailpoint/sp-forms/domain - type: array - x-go-name: Results - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '404': - description: An error with the item not found - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#show-preview-data-source - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) - $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) - $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) - $FormElementPreviewRequest = @" - { - "dataSource" : { - "config" : { - "indices" : [ "identities" ], - "query" : "*", - "aggregationBucketField" : "attributes.cloudStatus.exact", - "objectType" : "IDENTITY" - }, - "dataSourceType" : "STATIC" - } - } - "@ - - # Preview form definition data source. - - try { - Show-V2025PreviewDataSource -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Show-V2025PreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2025PreviewDataSource" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#show-preview-data-source - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_element_preview_request import FormElementPreviewRequest - from sailpoint.v2025.models.preview_data_source_response import PreviewDataSourceResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - limit = 10 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) - filters = 'value eq \"ID01\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) - query = 'ac' # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) - form_element_preview_request = '''{ - "dataSource" : { - "config" : { - "indices" : [ "identities" ], - "query" : "*", - "aggregationBucketField" : "attributes.cloudStatus.exact", - "objectType" : "IDENTITY" - }, - "dataSourceType" : "STATIC" - } - }''' # FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) - try: - # Preview form definition data source. - - results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id=form_definition_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id, limit, filters, query, new_form_element_preview_request) - print("The response of CustomFormsApi->show_preview_data_source:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) - /form-definitions/export: - get: - tags: - - Custom Forms - summary: List form definitions by tenant. - description: No parameters required. - operationId: exportFormDefinitionsByTenant - parameters: - - name: offset - in: query - description: |- - Offset - - Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). - The offset value is record-based, not page-based, and the index starts at 0. - schema: - type: integer - format: int64 - default: 0 - minimum: 0 - x-go-name: Offset - example: 0 - required: false - x-go-name: Offset - - name: limit - in: query - description: |- - Limit - - Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). - If it is not specified, a default limit is used. - schema: - type: integer - format: int64 - minimum: 0 - maximum: 250 - default: 250 - x-go-name: Limit - example: 250 - required: false - x-go-name: Limit - - name: filters - in: query - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **name**: *eq, gt, sw, in* - - **description**: *eq, gt, sw, in* - - **created**: *eq, gt, sw, in* - - **modified**: *eq, gt, sw, in* - schema: - type: string - x-go-name: Filters - example: name sw "my form" - required: false - x-go-name: Filters - - name: sorters - in: query - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, description, created, modified** - schema: - type: string - default: name - x-go-name: Sorters - example: name - required: false - x-go-name: Sorters - responses: - '200': - description: Returns a list of form definition objects by tenant used by SP-Config - content: - application/json: - schema: - type: array - items: - type: object - properties: - object: - $ref: '#/paths/~1form-definitions/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionResponse.yaml - self: - type: object - properties: - object: - type: object - description: Self block for imported/exported object. - properties: - type: - type: string - description: Imported/exported object's DTO type. - enum: - - FORM_DEFINITION - example: FORM_DEFINITION - id: - type: string - description: Imported/exported object's ID. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Imported/exported object's display name. - example: Temporary User Level Permissions - Requester - x-go-name: Self - version: - type: integer - format: int32 - x-go-name: Version - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#export-form-definitions-by-tenant - source: | - $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") - - # List form definitions by tenant. - - try { - Export-V2025FormDefinitionsByTenant - - # Below is a request that includes all optional parameters - # Export-V2025FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025FormDefinitionsByTenant" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#export-form-definitions-by-tenant - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - filters = 'name sw \"my form\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') - try: - # List form definitions by tenant. - - results = CustomFormsApi(api_client).export_form_definitions_by_tenant() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) - print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) - /form-definitions/forms-action-dynamic-schema: - post: - tags: - - Custom Forms - summary: Generate JSON Schema dynamically. - operationId: createFormDefinitionDynamicSchema - requestBody: - description: Body is the request payload to create a form definition dynamic schema - content: - application/json: - schema: - properties: - attributes: - properties: - formDefinitionId: - description: FormDefinitionID is a unique guid identifying this form definition - example: 00000000-0000-0000-0000-000000000000 - type: string - x-go-name: FormDefinitionID - type: object - x-go-name: Attributes - description: - description: Description is the form definition dynamic schema description text - example: A description - type: string - x-go-name: Description - id: - description: ID is a unique identifier - example: 00000000-0000-0000-0000-000000000000 - type: string - x-go-name: ID - type: - description: Type is the form definition dynamic schema type - example: action - type: string - x-go-name: Type - versionNumber: - description: VersionNumber is the form definition dynamic schema version number - example: 1 - format: int64 - type: integer - x-go-name: VersionNumber - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - example: - id: sp:forms - attributes: - formDefinitionId: 00000000-0000-0000-0000-000000000000 - description: AnotherDescription - type: action - versionNumber: 1 - required: false - responses: - '200': - description: Returns a form elements dynamic schema - content: - application/json: - schema: - properties: - outputSchema: - additionalProperties: {} - description: OutputSchema holds a JSON schema generated dynamically - example: - outputSchema: - $schema: https://json-schema.org/draft/2020-12/schema - additionalProperties: false - properties: - firstName: - title: First Name - type: string - fullName: - title: Full Name - type: string - lastName: - title: Last Name - type: string - startDate: - format: date-time - title: Start Date - type: string - type: object - type: object - x-go-name: OutputSchema - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '404': - description: An error with the item not found - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-codegen-request-body-name: Body - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition-dynamic-schema - source: | - $Body = @" - { - "description" : "A description", - "attributes" : { - "formDefinitionId" : "00000000-0000-0000-0000-000000000000" - }, - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "action", - "versionNumber" : 1 - } - "@ - - # Generate JSON Schema dynamically. - - try { - New-V2025FormDefinitionDynamicSchema - - # Below is a request that includes all optional parameters - # New-V2025FormDefinitionDynamicSchema -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinitionDynamicSchema" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#create-form-definition-dynamic-schema - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest - from sailpoint.v2025.models.form_definition_dynamic_schema_response import FormDefinitionDynamicSchemaResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - body = '''{ - "description" : "A description", - "attributes" : { - "formDefinitionId" : "00000000-0000-0000-0000-000000000000" - }, - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "action", - "versionNumber" : 1 - }''' # FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) - try: - # Generate JSON Schema dynamically. - - results = CustomFormsApi(api_client).create_form_definition_dynamic_schema() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(new_body) - print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) - /form-definitions/import: - post: - tags: - - Custom Forms - summary: Import form definitions from export. - operationId: importFormDefinitions - requestBody: - description: Body is the request payload to import form definitions - content: - application/json: - schema: - type: array - items: - type: object - properties: - object: - $ref: '#/paths/~1form-definitions/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionResponse.yaml - self: - type: string - x-go-name: Self - version: - type: integer - format: int32 - x-go-name: Version - example: - - version: 1 - self: - name: All fields not required - id: 05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa - type: FORM_DEFINITION - object: - id: 05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa - name: All fields not required - description: description - owner: - type: IDENTITY - id: 3447d8ec2602455ab6f1e8408a0f0150 - usedBy: - - type: WORKFLOW - id: 5008594c-dacc-4295-8fee-41df60477304 - - type: WORKFLOW - id: 97e75a75-c179-4fbc-a2da-b5fa4aaa8743 - formInput: - - type: STRING - label: input1 - description: A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic - formElements: - - id: '3069272797630701' - elementType: SECTION - config: - label: First Section - formElements: - - id: '3069272797630700' - elementType: TEXT - key: firstName - config: - label: First Name - - id: '3498415402897539' - elementType: TEXT - key: lastName - config: - label: Last Name - formConditions: - - ruleOperator: AND - rules: - - sourceType: INPUT - source: Department - operator: EQ - valueType: STRING - value: Sales - effects: - - effectType: HIDE - config: - element: '2614088730489570' - created: '2022-10-04T19:27:04.456Z' - modified: '2022-11-16T20:45:02.172Z' - required: false - responses: - '202': - description: Returns statuses of those form definition objects imported - content: - application/json: - schema: - type: object - properties: - errors: - type: array - items: - type: object - properties: - detail: - type: object - additionalProperties: - type: object - x-go-name: Detail - key: - type: string - x-go-name: Key - text: - type: string - x-go-name: Text - x-go-name: Errors - importedObjects: - type: array - items: - type: object - properties: - object: - $ref: '#/paths/~1form-definitions/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionResponse.yaml - self: - type: string - x-go-name: Self - version: - type: integer - format: int32 - x-go-name: Version - x-go-name: ImportedObjects - infos: - type: array - items: - type: object - properties: - detail: - type: object - additionalProperties: - type: object - x-go-name: Detail - key: - type: string - x-go-name: Key - text: - type: string - x-go-name: Text - x-go-name: Infos - warnings: - type: array - items: - type: object - properties: - detail: - type: object - additionalProperties: - type: object - x-go-name: Detail - key: - type: string - x-go-name: Key - text: - type: string - x-go-name: Text - x-go-name: Warnings - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-codegen-request-body-name: Body - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#import-form-definitions - source: | - - - - - - - $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ - - - # Import form definitions from export. - - try { - Import-V2025FormDefinitions - - # Below is a request that includes all optional parameters - # Import-V2025FormDefinitions -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025FormDefinitions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#import-form-definitions - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.import_form_definitions202_response import ImportFormDefinitions202Response - from sailpoint.v2025.models.import_form_definitions_request_inner import ImportFormDefinitionsRequestInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - body = '''[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]''' # List[ImportFormDefinitionsRequestInner] | Body is the request payload to import form definitions (optional) - try: - # Import form definitions from export. - - results = CustomFormsApi(api_client).import_form_definitions() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).import_form_definitions(new_body) - print("The response of CustomFormsApi->import_form_definitions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) - /form-definitions/{formDefinitionID}/upload: - post: - tags: - - Custom Forms - summary: Upload new form definition file. - description: Parameter `{formDefinitionID}` should match a form definition ID. - operationId: createFormDefinitionFileRequest - parameters: - - name: formDefinitionID - in: path - description: |- - FormDefinitionID - - String specifying FormDefinitionID - required: true - x-sailpoint-resource-operation-id: searchFormDefinitionsByTenant - example: 00000000-0000-0000-0000-000000000000 - schema: - type: string - x-go-name: FormDefinitionID - x-go-name: FormDefinitionID - requestBody: - content: - multipart/form-data: - schema: - type: object - required: - - file - properties: - file: - type: string - description: File specifying the multipart - format: binary - x-go-name: File - encoding: - file: - contentType: image/png, image/jpeg - required: true - responses: - '201': - description: Returns a new form definition file - content: - application/json: - schema: - type: object - properties: - created: - type: string - description: Created is the date the file was uploaded - example: '2023-07-12T20:14:57.744Z' - x-go-name: Created - fileId: - type: string - description: fileId is a unique ULID that serves as an identifier for the form definition file - example: 01FHZXHK8PTP9FVK99Z66GXQTX.png - x-go-name: FileID - formDefinitionId: - type: string - description: FormDefinitionID is a unique guid identifying this form definition - example: 00000000-0000-0000-0000-000000000000 - x-go-name: FormDefinitionID - x-go-package: github.com/sailpoint/sp-forms/internal/rest/response - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '404': - description: An error with the item not found - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '413': - description: An error with payload size too large - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '415': - description: An error with unsupported media type - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '503': - description: An external service is not available - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-codegen-request-body-name: Body - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition-file-request - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID - $File = # System.IO.FileInfo | File specifying the multipart - - # Upload new form definition file. - - try { - New-V2025FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File - - # Below is a request that includes all optional parameters - # New-V2025FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinitionFileRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#create-form-definition-file-request - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_definition_file_upload_response import FormDefinitionFileUploadResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID String specifying FormDefinitionID # str | FormDefinitionID String specifying FormDefinitionID - file = None # bytearray | File specifying the multipart # bytearray | File specifying the multipart - try: - # Upload new form definition file. - - results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id=form_definition_id, file=file) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id, file) - print("The response of CustomFormsApi->create_form_definition_file_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) - /form-definitions/{formDefinitionID}/file/{fileID}: - get: - tags: - - Custom Forms - summary: Download definition file by fileId. - operationId: getFileFromS3 - parameters: - - name: formDefinitionID - in: path - description: |- - FormDefinitionID - - Form definition ID - required: true - x-sailpoint-resource-operation-id: searchFormDefinitionsByTenant - example: 00000000-0000-0000-0000-000000000000 - schema: - type: string - x-go-name: FormDefinitionID - x-go-name: FormDefinitionID - - name: fileID - in: path - description: |- - FileID - - String specifying the hashed name of the uploaded file we are retrieving. - required: true - x-sailpoint-resource-operation-id: createFormDefinitionFileRequest - example: 00000031N0J7R2B57M8YG73J7M.png - schema: - type: string - x-go-name: FileID - x-go-name: FileID - responses: - '200': - description: Returns a file that is referred to by fileID and associated with the formDefinitionID - content: - application/json: - schema: - type: string - format: binary - image/jpeg: - schema: - type: string - format: binary - image/png: - schema: - type: string - format: binary - application/octet-stream: - schema: - type: string - format: binary - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/jpeg: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/png: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - application/octet-stream: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/jpeg: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/png: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - application/octet-stream: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/jpeg: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/png: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - application/octet-stream: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '404': - description: An error with the item not found - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/jpeg: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/png: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - application/octet-stream: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/jpeg: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/png: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - application/octet-stream: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '503': - description: An external service is not available - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/jpeg: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/png: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - application/octet-stream: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-codegen-request-body-name: Body - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-file-from-s3 - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID - $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. - - # Download definition file by fileId. - - try { - Get-V2025FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID - - # Below is a request that includes all optional parameters - # Get-V2025FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FileFromS3" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#get-file-from-s3 - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID Form definition ID # str | FormDefinitionID Form definition ID - file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving. - try: - # Download definition file by fileId. - - results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id=form_definition_id, file_id=file_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id) - print("The response of CustomFormsApi->get_file_from_s3:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) - /form-instances: - get: - tags: - - Custom Forms - summary: List form instances by tenant. - description: No parameters required. - operationId: searchFormInstancesByTenant - responses: - '200': - description: Returns a list of form instances by tenant - content: - application/json: - schema: - type: array - items: - type: object - properties: - count: - description: Count number of Results - type: integer - format: int64 - example: 1 - x-go-name: Count - results: - description: Results holds a list of FormInstanceResponse items - type: array - items: - $ref: '#/paths/~1form-instances/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormInstanceResponse.yaml - x-go-name: Results - x-go-package: github.com/sailpoint/sp-forms/domain - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-instances-by-tenant - source: | - - # List form instances by tenant. - - try { - Search-V2025FormInstancesByTenant - - # Below is a request that includes all optional parameters - # Search-V2025FormInstancesByTenant - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormInstancesByTenant" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#search-form-instances-by-tenant - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_form_instances_by_tenant_response import ListFormInstancesByTenantResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List form instances by tenant. - - results = CustomFormsApi(api_client).search_form_instances_by_tenant() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).search_form_instances_by_tenant() - print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) - post: - tags: - - Custom Forms - summary: Creates a form instance. - operationId: createFormInstance - requestBody: - description: Body is the request payload to create a form instance - content: - application/json: - schema: - properties: - createdBy: - properties: - id: - description: ID is a unique identifier - example: 00000000-0000-0000-0000-000000000000 - type: string - x-go-name: ID - type: - description: |- - Type is a form instance created by type enum value - WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution - SOURCE FormInstanceCreatedByTypeSource - enum: - - WORKFLOW_EXECUTION - - SOURCE - example: WORKFLOW_EXECUTION - type: string - x-go-enum-desc: |- - WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution - SOURCE FormInstanceCreatedByTypeSource - x-go-name: Type - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - expire: - description: Expire is required - example: '2023-08-12T20:14:57.74486Z' - type: string - x-go-name: Expire - formDefinitionId: - description: FormDefinitionID is the id of the form definition that created this form - example: 00000000-0000-0000-0000-000000000000 - type: string - x-go-name: FormDefinitionID - formInput: - additionalProperties: true - description: FormInput is an object of form input labels to value - example: - input1: Sales - type: object - x-go-name: FormInput - recipients: - description: Recipients is required - items: - properties: - id: - description: ID is a unique identifier - example: 00000000-0000-0000-0000-000000000000 - type: string - x-go-name: ID - type: - description: |- - Type is a FormInstanceRecipientType value - IDENTITY FormInstanceRecipientIdentity - enum: - - IDENTITY - example: IDENTITY - type: string - x-go-enum-desc: IDENTITY FormInstanceRecipientIdentity - x-go-name: Type - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - type: array - x-go-name: Recipients - standAloneForm: - default: false - description: StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - example: false - type: boolean - x-go-name: StandAloneForm - state: - description: |- - State is required, if not present initial state is FormInstanceStateAssigned - ASSIGNED FormInstanceStateAssigned - IN_PROGRESS FormInstanceStateInProgress - SUBMITTED FormInstanceStateSubmitted - COMPLETED FormInstanceStateCompleted - CANCELLED FormInstanceStateCancelled - enum: - - ASSIGNED - - IN_PROGRESS - - SUBMITTED - - COMPLETED - - CANCELLED - example: ASSIGNED - type: string - x-go-enum-desc: |- - ASSIGNED FormInstanceStateAssigned - IN_PROGRESS FormInstanceStateInProgress - SUBMITTED FormInstanceStateSubmitted - COMPLETED FormInstanceStateCompleted - CANCELLED FormInstanceStateCancelled - x-go-name: State - ttl: - description: |- - TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it - SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html - example: 1571827560 - format: int64 - type: integer - x-go-name: TTL - required: - - expire - - recipients - - createdBy - - formDefinitionId - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - example: - expire: '2023-06-20T15:57:55.332882Z' - formDefinitionId: 00000000-0000-0000-0000-000000000000 - recipients: - - type: IDENTITY - id: an-identity-id - createdBy: - type: WORKFLOW_EXECUTION - id: a-workflow-execution-id - required: false - responses: - '201': - description: Returns a new form instance - content: - application/json: - schema: - properties: - created: - description: Created is the date the form instance was assigned - example: '2023-07-12T20:14:57.74486Z' - format: date-time - type: string - x-go-name: Created - createdBy: - $ref: '#/paths/~1form-instances/post/requestBody/content/application~1json/schema/properties/createdBy' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormInstanceCreatedBy.yaml - expire: - description: Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record - example: '2023-08-12T20:14:57.74486Z' - type: string - x-go-name: Expire - formConditions: - description: FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - items: - $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/formConditions/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormCondition.yaml - type: array - x-go-name: FormConditions - formData: - nullable: true - additionalProperties: true - description: FormData is the data provided by the form on submit. The data is in a key -> value map - example: - department: Engineering - type: object - x-go-name: FormData - formDefinitionId: - description: FormDefinitionID is the id of the form definition that created this form - example: 49841cb8-00a5-4fbd-9888-8bbb28d48331 - type: string - x-go-name: FormDefinitionID - formElements: - description: FormElements is the configuration of the form, this would be a repeat of the fields from the form-config - items: - $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/formElements/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormElement.yaml - type: array - x-go-name: FormElements - formErrors: - description: FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors - items: - properties: - key: - description: Key is the technical key - example: department - type: string - x-go-name: Key - messages: - description: Messages is a list of web.ErrorMessage items - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - type: array - x-go-name: Messages - value: - description: Value is the value associated with a Key - example: Engineering - x-go-name: Value - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - type: array - x-go-name: FormErrors - formInput: - additionalProperties: {} - nullable: true - description: FormInput is an object of form input labels to value - example: - input1: Sales - type: object - x-go-name: FormInput - id: - description: Unique guid identifying this form instance - example: 06a2d961-07fa-44d1-8d0a-2f6470e30fd2 - type: string - x-go-name: FormInstanceID - modified: - description: Modified is the last date the form instance was modified - example: '2023-07-12T20:14:57.74486Z' - format: date-time - type: string - x-go-name: Modified - recipients: - description: Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it - items: - $ref: '#/paths/~1form-instances/post/requestBody/content/application~1json/schema/properties/recipients/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormInstanceRecipient.yaml - type: array - x-go-name: Recipients - standAloneForm: - default: false - description: StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - example: false - type: boolean - x-go-name: StandAloneForm - standAloneFormUrl: - description: StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI - example: https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000 - type: string - x-go-name: StandAloneFormURL - state: - description: |- - State the state of the form instance - ASSIGNED FormInstanceStateAssigned - IN_PROGRESS FormInstanceStateInProgress - SUBMITTED FormInstanceStateSubmitted - COMPLETED FormInstanceStateCompleted - CANCELLED FormInstanceStateCancelled - enum: - - ASSIGNED - - IN_PROGRESS - - SUBMITTED - - COMPLETED - - CANCELLED - example: ASSIGNED - type: string - x-go-enum-desc: |- - ASSIGNED FormInstanceStateAssigned - IN_PROGRESS FormInstanceStateInProgress - SUBMITTED FormInstanceStateSubmitted - COMPLETED FormInstanceStateCompleted - CANCELLED FormInstanceStateCancelled - x-go-name: State - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-codegen-request-body-name: Body - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-instance - source: | - $Body = @" - { - "formInput" : { - "input1" : "Sales" - }, - "standAloneForm" : false, - "createdBy" : { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "WORKFLOW_EXECUTION" - }, - "recipients" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - } ], - "expire" : "2023-08-12T20:14:57.74486Z", - "formDefinitionId" : "00000000-0000-0000-0000-000000000000", - "state" : "ASSIGNED", - "ttl" : 1571827560 - } - "@ - - # Creates a form instance. - - try { - New-V2025FormInstance - - # Below is a request that includes all optional parameters - # New-V2025FormInstance -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormInstance" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#create-form-instance - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_form_instance_request import CreateFormInstanceRequest - from sailpoint.v2025.models.form_instance_response import FormInstanceResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - body = '''{ - "formInput" : { - "input1" : "Sales" - }, - "standAloneForm" : false, - "createdBy" : { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "WORKFLOW_EXECUTION" - }, - "recipients" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - } ], - "expire" : "2023-08-12T20:14:57.74486Z", - "formDefinitionId" : "00000000-0000-0000-0000-000000000000", - "state" : "ASSIGNED", - "ttl" : 1571827560 - }''' # CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) - try: - # Creates a form instance. - - results = CustomFormsApi(api_client).create_form_instance() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).create_form_instance(new_body) - print("The response of CustomFormsApi->create_form_instance:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) - /form-instances/{formInstanceID}: - get: - tags: - - Custom Forms - summary: Returns a form instance. - description: Parameter `{formInstanceID}` should match a form instance ID. - operationId: getFormInstanceByKey - parameters: - - name: formInstanceID - in: path - description: Form instance ID - required: true - x-sailpoint-resource-operation-id: searchFormInstancesByTenant - schema: - type: string - x-go-name: FormInstanceID - example: 00000000-0000-0000-0000-000000000000 - x-go-name: FormInstanceID - responses: - '200': - description: Returns a form instance by its key - content: - application/json: - schema: - $ref: '#/paths/~1form-instances/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormInstanceResponse.yaml - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '404': - description: An error with the item not found - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: [] - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-instance-by-key - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - - # Returns a form instance. - - try { - Get-V2025FormInstanceByKey -FormInstanceID $FormInstanceID - - # Below is a request that includes all optional parameters - # Get-V2025FormInstanceByKey -FormInstanceID $FormInstanceID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormInstanceByKey" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#get-form-instance-by-key - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_instance_response import FormInstanceResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID - try: - # Returns a form instance. - - results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id=form_instance_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id) - print("The response of CustomFormsApi->get_form_instance_by_key:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) - patch: - tags: - - Custom Forms - summary: Patch a form instance. - description: Parameter `{formInstanceID}` should match a form instance ID. - operationId: patchFormInstance - parameters: - - name: formInstanceID - in: path - description: Form instance ID - required: true - x-sailpoint-resource-operation-id: searchFormInstancesByTenant - schema: - type: string - x-go-name: FormInstanceID - example: 00000000-0000-0000-0000-000000000000 - x-go-name: FormInstanceID - requestBody: - description: 'Body is the request payload to patch a form instance, check: https://jsonpatch.com' - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions~1%7BformDefinitionID%7D/patch/requestBody/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Patch.yaml - example: - - op: replace - path: /state - value: SUBMITTED - - op: replace - path: /formData - value: - a-key-1: a-value-1 - a-key-2: true - a-key-3: 1 - required: false - responses: - '200': - description: Returns the form instance updated - content: - application/json: - schema: - $ref: '#/paths/~1form-instances/post/responses/201/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormInstanceResponse.yaml - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '404': - description: An error with the item not found - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '409': - description: An error with the request property conflicts with stored - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: [] - x-codegen-request-body-name: Body - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#patch-form-instance - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) - $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ - - - # Patch a form instance. - - try { - Update-V2025FormInstance -FormInstanceID $FormInstanceID - - # Below is a request that includes all optional parameters - # Update-V2025FormInstance -FormInstanceID $FormInstanceID -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025FormInstance" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#patch-form-instance - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.form_instance_response import FormInstanceResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID - body = '''[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]''' # List[Dict[str, object]] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) - try: - # Patch a form instance. - - results = CustomFormsApi(api_client).patch_form_instance(form_instance_id=form_instance_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).patch_form_instance(form_instance_id, new_body) - print("The response of CustomFormsApi->patch_form_instance:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) - /form-instances/{formInstanceID}/data-source/{formElementID}: - get: - tags: - - Custom Forms - summary: Retrieves dynamic data by element. - description: |- - Parameter `{formInstanceID}` should match a form instance ID. - Parameter `{formElementID}` should match a form element ID at the data source configuration. - operationId: searchFormElementDataByElementID - parameters: - - name: formInstanceID - in: path - description: Form instance ID - required: true - x-sailpoint-resource-operation-id: searchFormDefinitionsByTenant - schema: - type: string - x-go-name: FormInstanceID - example: 00000000-0000-0000-0000-000000000000 - x-go-name: FormInstanceID - - name: formElementID - in: path - description: Form element ID - required: true - x-sailpoint-resource-operation-id: getFormInstanceByKey - schema: - type: string - x-go-name: FormElementID - example: 1 - x-go-name: FormElementID - - name: limit - in: query - description: |- - Limit - - Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). - If it is not specified, a default limit is used. - schema: - type: integer - format: int64 - maxLength: 250 - minLength: 0 - default: 250 - x-go-name: Limit - example: 250 - required: false - x-go-name: Limit - - name: filters - in: query - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **value**: *eq, ne, in* - - Supported composite operators: *not* - - Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in ("ID01")` - schema: - type: string - x-go-name: Filters - example: value eq "ID01" - required: false - x-go-name: Filters - - name: query - in: query - description: String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a "starts with" filter against several fields. - schema: - type: string - x-go-name: Query - example: support - required: false - x-go-name: Query - responses: - '200': - description: Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration - content: - application/json: - schema: - properties: - results: - description: Results holds a list of FormElementDataSourceConfigOptions items - example: '{"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]}' - items: - $ref: '#/paths/~1form-definitions~1%7BformDefinitionID%7D~1data-source/post/responses/200/content/application~1json/schema/properties/results/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormElementDataSourceConfigOptions.yaml - type: array - x-go-name: Results - type: object - x-go-package: github.com/sailpoint/sp-forms/domain - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '404': - description: An error with the item not found - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: [] - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-element-data-by-element-id - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - $FormElementID = "1" # String | Form element ID - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) - $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) - - # Retrieves dynamic data by element. - - try { - Search-V2025FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID - - # Below is a request that includes all optional parameters - # Search-V2025FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormElementDataByElementID" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#search-form-element-data-by-element-id - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_form_element_data_by_element_id_response import ListFormElementDataByElementIDResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID - form_element_id = '1' # str | Form element ID # str | Form element ID - limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - filters = 'value eq \"ID01\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) - query = 'support' # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) - try: - # Retrieves dynamic data by element. - - results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id=form_instance_id, form_element_id=form_element_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id, form_element_id, limit, filters, query) - print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) - /form-instances/{formInstanceID}/file/{fileID}: - get: - tags: - - Custom Forms - summary: Download instance file by fileId. - operationId: getFormInstanceFile - parameters: - - name: formInstanceID - in: path - description: |- - FormInstanceID - - Form instance ID - required: true - x-sailpoint-resource-operation-id: searchFormDefinitionsByTenant - example: 00000000-0000-0000-0000-000000000000 - schema: - type: string - x-go-name: FormInstanceID - x-go-name: FormInstanceID - - name: fileID - in: path - description: |- - FileID - - String specifying the hashed name of the uploaded file we are retrieving. - required: true - x-sailpoint-resource-operation-id: createFormDefinitionFileRequest - example: 00000031N0J7R2B57M8YG73J7M.png - schema: - type: string - x-go-name: FileID - x-go-name: FileID - responses: - '200': - description: Returns a file that is referred to by fileID and associated with the formInstanceID - content: - application/json: - schema: - type: string - format: binary - image/jpeg: - schema: - type: string - format: binary - image/png: - schema: - type: string - format: binary - application/octet-stream: - schema: - type: string - format: binary - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/jpeg: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/png: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - application/octet-stream: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/jpeg: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/png: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - application/octet-stream: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/jpeg: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/png: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - application/octet-stream: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '404': - description: An error with the item not found - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/jpeg: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/png: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - application/octet-stream: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/jpeg: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/png: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - application/octet-stream: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '503': - description: An external service is not available - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/jpeg: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - image/png: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - application/octet-stream: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-codegen-request-body-name: Body - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-instance-file - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID - $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. - - # Download instance file by fileId. - - try { - Get-V2025FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID - - # Below is a request that includes all optional parameters - # Get-V2025FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormInstanceFile" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#get-form-instance-file - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - form_instance_id = '00000000-0000-0000-0000-000000000000' # str | FormInstanceID Form instance ID # str | FormInstanceID Form instance ID - file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving. - try: - # Download instance file by fileId. - - results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id=form_instance_id, file_id=file_id) - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id) - print("The response of CustomFormsApi->get_form_instance_file:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) - /form-definitions/predefined-select-options: - get: - tags: - - Custom Forms - summary: List predefined select options. - description: No parameters required. - operationId: searchPreDefinedSelectOptions - responses: - '200': - description: Returns a list of available predefined select options - content: - application/json: - schema: - type: object - properties: - results: - description: Results holds a list of PreDefinedSelectOption items - type: array - items: - type: string - description: PreDefinedSelectOption pre-defined select options - example: IDENTITY - x-go-package: github.com/sailpoint/sp-forms/domain - x-go-name: Results - x-go-package: github.com/sailpoint/sp-forms/domain - '400': - description: An error with the request occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '401': - description: An error with the authorization occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '403': - description: An error with the user permissions occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - '429': - description: Too many requests - content: - application/json: - schema: - $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml - '500': - description: An internal server error occurred - content: - application/json: - schema: - type: object - properties: - detailCode: - type: string - x-go-name: DetailCode - messages: - type: array - items: - $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml - x-go-name: Messages - statusCode: - type: integer - format: int64 - x-go-name: StatusCode - trackingId: - type: string - x-go-name: TrackingID - security: - - userAuth: - - sp:forms:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-pre-defined-select-options - source: | - - # List predefined select options. - - try { - Search-V2025PreDefinedSelectOptions - - # Below is a request that includes all optional parameters - # Search-V2025PreDefinedSelectOptions - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025PreDefinedSelectOptions" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/custom-forms#search-pre-defined-select-options - source: | - from sailpoint.v2025.api.custom_forms_api import CustomFormsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_predefined_select_options_response import ListPredefinedSelectOptionsResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List predefined select options. - - results = CustomFormsApi(api_client).search_pre_defined_select_options() - # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).search_pre_defined_select_options() - print("The response of CustomFormsApi->search_pre_defined_select_options:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) - /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}: - get: - tags: - - Access Request Identity Metrics - summary: Return access request identity metrics - description: Use this API to return information access metrics. - operationId: getAccessRequestIdentityMetrics - parameters: - - name: identityId - in: path - description: Manager's identity ID. - required: true - x-sailpoint-resource-operation-id: listIdentities - schema: - type: string - example: 7025c863-c270-4ba6-beea-edf3cb091573 - - name: requestedObjectId - in: path - description: Requested access item's ID. - required: true - schema: - type: string - example: 2db501be-f0fb-4cc5-a695-334133c52891 - x-sailpoint-resource-operation-id: - - listEntitlements - - listRoles - - listAccessProfiles - - name: type - in: path - description: Requested access item's type. - required: true - schema: - type: string - enum: - - ENTITLEMENT - - ROLE - - ACCESS_PROFILE - example: ENTITLEMENT - security: - - userAuth: - - idn:access-request-approvals:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - responses: - '200': - description: Summary of the resource access and source activity for the direct reports of the provided manager. - content: - application/json: - schema: - type: object - items: - type: object - properties: - identitiesWithAccess: - type: integer - format: int64 - nullable: true - description: A count of the provided manager's direct reports that have already been granted the access item in question. - example: 8 - identitiesWithActivity: - type: integer - format: int64 - nullable: true - description: A count of the provided manager's direct reports that have activity within the associated source. - example: 5 - totalIdentities: - type: integer - format: int64 - nullable: true - description: Total number of identities who share a manager with the identity requesting access. - example: 10 - squadAvailable: - type: boolean - default: false - description: True if the manager's ID can be found. False if the manager's ID cannot be found. - example: true - validActivityObject: - type: boolean - default: false - description: True if the requested access item is associated with a single Activity Data Insights connector source. False if the requested access item type is a role. If it's a role, it matches to multiple sources, so a single relevant source can't be determined for activity metrics. - example: true - activitySourceConfigured: - type: boolean - default: false - description: True if the Activity Data Insights connector is configured for the source associated with the requested access item. False if the matching Activity Data Insights connector is not configured. - example: true - requestedObjectActive: - type: boolean - default: false - description: True if the requested access item exists and is available. False if the requested access item is either missing or deleted. - example: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-identity-metrics#get-access-request-identity-metrics - source: | - $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. - $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. - $Type = "ENTITLEMENT" # String | Requested access item's type. - - # Return access request identity metrics - - try { - Get-V2025AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestIdentityMetrics" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/access-request-identity-metrics#get-access-request-identity-metrics - source: | - from sailpoint.v2025.api.access_request_identity_metrics_api import AccessRequestIdentityMetricsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_id = '7025c863-c270-4ba6-beea-edf3cb091573' # str | Manager's identity ID. # str | Manager's identity ID. - requested_object_id = '2db501be-f0fb-4cc5-a695-334133c52891' # str | Requested access item's ID. # str | Requested access item's ID. - type = 'ENTITLEMENT' # str | Requested access item's type. # str | Requested access item's type. - try: - # Return access request identity metrics - - results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id=identity_id, requested_object_id=requested_object_id, type=type) - # Below is a request that includes all optional parameters - # results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type) - print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) - /icons/{objectType}/{objectId}: - put: - operationId: setIcon - tags: - - Icons - summary: Update an icon - description: This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - parameters: - - in: path - name: objectType - schema: - type: string - enum: - - application - required: true - description: Object type. Available options ['application'] - example: application - - in: path - name: objectId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: Object id. - example: a291e870-48c3-4953-b656-fb5ce2a93169 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - required: - - image - properties: - image: - type: string - format: binary - description: file with icon. Allowed mime-types ['image/png', 'image/jpeg'] - example: \x00\x00\x00\x02 - security: - - userAuth: - - idn:icons:manage - responses: - '200': - description: Icon updated - content: - application/json: - schema: - type: object - properties: - icon: - type: string - description: url to file with icon - example: '' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/icons#set-icon - source: | - $ObjectType = "application" # String | Object type. Available options ['application'] - $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] - - # Update an icon - - try { - Set-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image - - # Below is a request that includes all optional parameters - # Set-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025Icon" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/icons#set-icon - source: | - from sailpoint.v2025.api.icons_api import IconsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.set_icon200_response import SetIcon200Response - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] - object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - image = None # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] - try: - # Update an icon - - results = IconsApi(api_client).set_icon(object_type=object_type, object_id=object_id, x_sail_point_experimental=x_sail_point_experimental, image=image) - # Below is a request that includes all optional parameters - # results = IconsApi(api_client).set_icon(object_type, object_id, x_sail_point_experimental, image) - print("The response of IconsApi->set_icon:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling IconsApi->set_icon: %s\n" % e) - delete: - operationId: deleteIcon - tags: - - Icons - summary: Delete an icon - description: This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - parameters: - - in: path - name: objectType - schema: - type: string - enum: - - application - required: true - description: Object type. Available options ['application'] - example: application - - in: path - name: objectId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: Object id. - example: a291e870-48c3-4953-b656-fb5ce2a93169 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - security: - - userAuth: - - idn:icons:manage - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/icons#delete-icon - source: | - $ObjectType = "application" # String | Object type. Available options ['application'] - $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete an icon - - try { - Remove-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Icon" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/icons#delete-icon - source: | - from sailpoint.v2025.api.icons_api import IconsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] - object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete an icon - - IconsApi(api_client).delete_icon(object_type=object_type, object_id=object_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # IconsApi(api_client).delete_icon(object_type, object_id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling IconsApi->delete_icon: %s\n" % e) - /suggested-entitlement-description-batches/{batchId}/stats: - get: - tags: - - Suggested Entitlement Description - operationId: getSedBatchStats - summary: Submit Sed Batch Stats Request - description: | - 'Submit Sed Batch Stats Request. - - Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats - of the batchId.' - parameters: - - name: batchId - in: path - description: Batch Id - schema: - type: string - format: uuid - example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - required: true - x-sailpoint-resource-operation-id: getSedBatches - responses: - '200': - description: Stats of Sed batch. - content: - application/json: - schema: - description: Sed Batch Stats - type: object - properties: - batchComplete: - description: batch complete - type: boolean - example: true - default: false - batchId: - description: batch Id - format: uuid - type: string - example: 016629d1-1d25-463f-97f3-c6686846650 - discoveredCount: - description: discovered count - format: int64 - type: integer - example: 100 - discoveryComplete: - description: discovery complete - type: boolean - example: true - default: false - processedCount: - description: processed count - format: int64 - example: 100 - type: integer - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:sed:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#get-sed-batch-stats - source: | - $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id - - # Submit Sed Batch Stats Request - - try { - Get-V2025SedBatchStats -BatchId $BatchId - - # Below is a request that includes all optional parameters - # Get-V2025SedBatchStats -BatchId $BatchId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SedBatchStats" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#get-sed-batch-stats - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed_batch_stats import SedBatchStats - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id - try: - # Submit Sed Batch Stats Request - - results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id=batch_id) - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id) - print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) - /suggested-entitlement-description-batches: - get: - tags: - - Suggested Entitlement Description - operationId: getSedBatches - summary: List Sed Batch Request - description: |- - List Sed Batches. - API responses with Sed Batch Status - responses: - '200': - description: Status of batch - content: - application/json: - schema: - description: Sed Batch Status - type: object - properties: - status: - description: status of batch - type: string - example: OK - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:sed:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#get-sed-batches - source: | - - # List Sed Batch Request - - try { - Get-V2025SedBatches - - # Below is a request that includes all optional parameters - # Get-V2025SedBatches - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SedBatches" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#get-sed-batches - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed_batch_status import SedBatchStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Sed Batch Request - - results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches() - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches() - print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) - post: - tags: - - Suggested Entitlement Description - operationId: submitSedBatchRequest - summary: Submit Sed Batch Request - description: |- - Submit Sed Batch Request. - Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - requestBody: - description: Sed Batch Request - content: - application/json-patch+json: - schema: - description: Sed Batch Request - type: object - minProperties: 1 - properties: - entitlements: - description: list of entitlement ids - type: array - minItems: 1 - items: - type: string - example: 016629d1-1d25-463f-97f3-c6686846650 - seds: - description: list of sed ids - type: array - minItems: 1 - items: - type: string - example: 016629d1-1d25-463f-97f3-c6686846650 - responses: - '200': - description: Sed Batch Response - content: - application/json: - schema: - description: Sed Batch Response - type: object - properties: - batchId: - description: BatchId that groups all the ids together - format: uuid - type: string - example: 016629d1-1d25-463f-97f3-c6686846650 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:sed:write - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-batch-request - source: | - $SedBatchRequest = @" - { - "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] - } - "@ - - # Submit Sed Batch Request - - try { - Submit-V2025SedBatchRequest - - # Below is a request that includes all optional parameters - # Submit-V2025SedBatchRequest -SedBatchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedBatchRequest" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#submit-sed-batch-request - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed_batch_request import SedBatchRequest - from sailpoint.v2025.models.sed_batch_response import SedBatchResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sed_batch_request = '''{ - "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] - }''' # SedBatchRequest | Sed Batch Request (optional) - try: - # Submit Sed Batch Request - - results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request() - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(new_sed_batch_request) - print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) - /suggested-entitlement-description-approvals: - post: - tags: - - Suggested Entitlement Description - summary: Submit Bulk Approval Request - description: |- - Submit Bulk Approval Request for SED. - Request body takes list of SED Ids. API responses with list of SED Approval Status - operationId: submitSedApproval - requestBody: - description: Sed Approval - content: - application/json-patch+json: - schema: - items: - description: Sed Approval Request Body - type: object - properties: - items: - description: List of SED id's - items: - format: uuid - type: string - type: array - example: 016629d1-1d25-463f-97f3-c6686846650 - type: array - required: true - responses: - '200': - description: List of SED Approval Status - content: - application/json: - schema: - items: - description: SED Approval Status - type: object - properties: - failedReason: - description: failed reason will be display if status is failed - type: string - example: invalid status - id: - description: Sed id - format: uuid - type: string - example: 016629d1-1d25-463f-97f3-c6686846650 - status: - description: SUCCESS | FAILED - example: SUCCESS - type: string - type: array - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:sed:write - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-approval - source: | - $SedApproval = @"{ - "items" : "016629d1-1d25-463f-97f3-c6686846650" - }"@ - - - # Submit Bulk Approval Request - - try { - $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-V2025SedApproval -SedApproval $Result - - # Below is a request that includes all optional parameters - # Submit-V2025SedApproval -SedApproval $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedApproval" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#submit-sed-approval - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed_approval import SedApproval - from sailpoint.v2025.models.sed_approval_status import SedApprovalStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sed_approval = '''[sailpoint.v2025.SedApproval()]''' # List[SedApproval] | Sed Approval - try: - # Submit Bulk Approval Request - new_sed_approval = SedApproval.from_json(sed_approval) - results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(sed_approval=new_sed_approval) - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) - print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) - /suggested-entitlement-description-assignments: - post: - tags: - - Suggested Entitlement Description - operationId: submitSedAssignment - summary: Submit Sed Assignment Request - description: |- - Submit Assignment Request. - Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - requestBody: - description: Sed Assignment Request - content: - application/json-patch+json: - schema: - description: Sed Assignment - type: object - properties: - assignee: - description: Sed Assignee - type: object - properties: - type: - description: |- - Type of assignment - When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER - IDENTITY SED_ASSIGNEE_IDENTITY_TYPE - GROUP SED_ASSIGNEE_GROUP_TYPE - SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE - ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE - enum: - - IDENTITY - - GROUP - - SOURCE_OWNER - - ENTITLEMENT_OWNER - type: string - example: SOURCE_OWNER - value: - description: |- - Identity or Group identifier - Empty when using source/entitlement owner personas - type: string - example: 016629d1-1d25-463f-97f3-c6686846650 - required: - - type - items: - description: List of SED id's - items: - format: uuid - type: string - example: 016629d1-1d25-463f-97f3-c6686846650 - type: array - required: true - responses: - '202': - description: Sed Assignment Response - content: - application/json: - schema: - description: Sed Assignment Response - type: object - properties: - batchId: - description: BatchId that groups all the ids together - format: uuid - type: string - example: 016629d1-1d25-463f-97f3-c6686846650 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:sed:write - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-assignment - source: | - $SedAssignment = @" - { - "assignee" : { - "type" : "SOURCE_OWNER", - "value" : "016629d1-1d25-463f-97f3-c6686846650" - }, - "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] - } - "@ - - # Submit Sed Assignment Request - - try { - $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-V2025SedAssignment -SedAssignment $Result - - # Below is a request that includes all optional parameters - # Submit-V2025SedAssignment -SedAssignment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedAssignment" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#submit-sed-assignment - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed_assignment import SedAssignment - from sailpoint.v2025.models.sed_assignment_response import SedAssignmentResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sed_assignment = '''{ - "assignee" : { - "type" : "SOURCE_OWNER", - "value" : "016629d1-1d25-463f-97f3-c6686846650" - }, - "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] - }''' # SedAssignment | Sed Assignment Request - try: - # Submit Sed Assignment Request - new_sed_assignment = SedAssignment.from_json(sed_assignment) - results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(sed_assignment=new_sed_assignment) - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(new_sed_assignment) - print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) - /suggested-entitlement-descriptions: - get: - tags: - - Suggested Entitlement Description - operationId: listSeds - summary: List Suggested Entitlement Descriptions - description: |- - List of Suggested Entitlement Descriptions (SED) - - SED field descriptions: - - **batchId**: the ID of the batch of entitlements that are submitted for description generation - - **displayName**: the display name of the entitlement that we are generating a description for - - **sourceName**: the name of the source associated with the entitlement that we are generating the description for - - **sourceId**: the ID of the source associated with the entitlement that we are generating the description for - - **status**: the status of the suggested entitlement description, valid status options: "requested", "suggested", "not_suggested", "failed", "assigned", "approved", "denied" - - **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **batchId**: *eq, ne* - - **displayName**: *eq, ne, co* - - **sourceName**: *eq, ne, co* - - **sourceId**: *eq, ne* - - **status**: *eq, ne* - - **fullText**: *co* - in: query - name: filters - example: displayName co "Read and Write" - required: false - schema: - type: string - - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **displayName, sourceName, status** - in: query - name: sorters - required: false - example: sorters=displayName - schema: - type: string - - description: |- - If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. - This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - in: query - name: count-only - required: false - example: count-only=true - schema: - type: boolean - default: false - - description: |- - By default, the ListSeds API will only return items that you have requested to be generated. - This option will allow you to see all items that have been requested - in: query - name: requested-by-anyone - example: requested-by-anyone=true - required: false - schema: - type: boolean - default: false - - description: Will limit records to items that are in "suggested" or "approved" status - in: query - name: show-pending-status-only - example: show-pending-status-only=true - required: false - schema: - type: boolean - default: false - responses: - '200': - description: List of Suggested Entitlement Details - content: - application/json: - schema: - items: - description: Suggested Entitlement Description - type: object - properties: - Name: - type: string - description: name of the entitlement - example: BatchInvoiceProcessing - approved_by: - type: string - description: entitlement approved by - example: 2c918086-76de-afbf-0176-f6d28f65565a - approved_type: - type: string - description: entitlement approved type - example: admin - approved_when: - format: date-time - type: string - example: '2024-03-22T16:32:16.308Z' - description: entitlement approved then - attribute: - type: string - description: entitlement attribute - example: Role - description: - type: string - description: description of entitlement - example: This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable procedures. - displayName: - type: string - description: entitlement display name - example: AWS-Cloud-Billing - id: - format: uuid - type: string - description: sed id - example: ead281ee-12a9-40ac-9534-36b5d7d65d53 - sourceId: - type: string - description: entitlement source id - example: 103f567b93ee49b991c40f9412f87643 - sourceName: - type: string - description: entitlement source name - example: IDN Salesforce - status: - type: string - description: entitlement status - example: suggested - suggestedDescription: - type: string - description: llm suggested entitlement description - example: This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable - type: - type: string - description: entitlement type - example: group - value: - type: string - description: entitlement value - example: group - type: array - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:sed:read - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#list-seds - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) - $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) - $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) - $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) - $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) - - # List Suggested Entitlement Descriptions - - try { - Get-V2025Seds - - # Below is a request that includes all optional parameters - # Get-V2025Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Seds" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#list-seds - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed import Sed - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'displayName co \"Read and Write\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) - sorters = 'sorters=displayName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) - count_only = False # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to False) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to False) - requested_by_anyone = False # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to False) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to False) - show_pending_status_only = False # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to False) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to False) - try: - # List Suggested Entitlement Descriptions - - results = SuggestedEntitlementDescriptionApi(api_client).list_seds() - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) - print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) - patch: - tags: - - Suggested Entitlement Description - operationId: patchSed - summary: Patch Suggested Entitlement Description - description: Patch Suggested Entitlement Description - parameters: - - description: id is sed id - in: path - name: id - example: ebab396f-0af1-4050-89b7-dafc63ec70e7 - required: true - x-sailpoint-resource-operation-id: listSeds - schema: - type: string - format: uuid - requestBody: - description: Sed Patch Request - content: - application/json-patch+json: - schema: - items: - description: Patch for Suggested Entitlement Description - type: object - properties: - op: - description: desired operation - type: string - example: replace - path: - description: field to be patched - type: string - example: status - value: - description: value to replace with - example: approved - type: array - required: true - responses: - '200': - description: detail of patched sed - content: - application/json: - schema: - $ref: '#/paths/~1suggested-entitlement-descriptions/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Sed.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - security: - - userAuth: - - idn:sed:write - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#patch-sed - source: | - $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id - $SedPatch = @"{ - "op" : "replace", - "path" : "status", - "value" : "approved" - }"@ - - - # Patch Suggested Entitlement Description - - try { - $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-V2025Sed -Id $Id -SedPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025Sed -Id $Id -SedPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Sed" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#patch-sed - source: | - from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sed import Sed - from sailpoint.v2025.models.sed_patch import SedPatch - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id - sed_patch = '''[sailpoint.v2025.SedPatch()]''' # List[SedPatch] | Sed Patch Request - try: - # Patch Suggested Entitlement Description - new_sed_patch = SedPatch.from_json(sed_patch) - results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id=id, sed_patch=new_sed_patch) - # Below is a request that includes all optional parameters - # results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, new_sed_patch) - print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) - /discovered-applications: - get: - operationId: getDiscoveredApplications - tags: - - Application Discovery - summary: Get Discovered Applications for Tenant - description: | - Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - security: - - userAuth: - - idn:application-discovery:read - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - in: query - name: detail - schema: - type: string - enum: - - SLIM - - FULL - description: Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - example: FULL - - in: query - name: filter - schema: - type: string - description: | - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - - Filtering is supported for the following fields and operators: - - **name**: *eq, sw, co* - - **description**: *eq, sw, co* - - **createdAtStart**: *eq, le, ge* - - **createdAtEnd**: *eq, le, ge* - - **discoveredAtStart**: *eq, le, ge* - - **discoveredAtEnd**: *eq, le, ge* - - **discoverySource**: *eq, in* - example: name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas") - required: false - style: form - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** - example: name - responses: - '200': - description: List of discovered applications. By default, the API returns a list of SLIM discovered applications. - content: - application/json: - schema: - type: array - items: - oneOf: - - type: object - description: Discovered applications - title: Slim Discovered Application - properties: - id: - type: string - format: uuid - description: Unique identifier for the discovered application. - example: 2d9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the discovered application. - example: ExampleApp - discoverySource: - type: string - description: Source from which the application was discovered. - example: csv - discoveredVendor: - type: string - description: The vendor associated with the discovered application. - example: ExampleVendor - description: - type: string - description: A brief description of the discovered application. - example: An application for managing examples. - recommendedConnectors: - type: array - items: - type: string - description: List of recommended connectors for the application. - example: - - ConnectorA - - ConnectorB - discoveredAt: - type: string - format: date-time - description: The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. - example: '2023-01-01T12:00:00Z' - createdAt: - type: string - format: date-time - description: The timestamp when the application was first discovered, in ISO 8601 format. - example: '2023-01-01T12:00:00Z' - status: - type: string - description: |- - The status of an application within the discovery source. - - By default this field is set to "ACTIVE" when the application is discovered. - - If an application has been deleted from within the discovery source, the status will be set to "INACTIVE". - example: ACTIVE - - type: object - description: Discovered applications with their respective associated sources - title: Discovered Application - properties: - id: - type: string - format: uuid - description: Unique identifier for the discovered application. - example: 2d9180835d2e5168015d32f890ca1581 - name: - type: string - description: Name of the discovered application. - example: ExampleApp - discoverySource: - type: string - description: Source from which the application was discovered. - example: csv - discoveredVendor: - type: string - description: The vendor associated with the discovered application. - example: ExampleVendor - description: - type: string - description: A brief description of the discovered application. - example: An application for managing examples. - recommendedConnectors: - type: array - items: - type: string - description: List of recommended connectors for the application. - example: - - ConnectorA - - ConnectorB - discoveredAt: - type: string - format: date-time - description: The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. - example: '2023-01-01T12:00:00Z' - createdAt: - type: string - format: date-time - description: The timestamp when the application was first discovered, in ISO 8601 format. - example: '2023-01-01T12:00:00Z' - status: - type: string - description: |- - The status of an application within the discovery source. - - By default this field is set to "ACTIVE" when the application is discovered. - - If an application has been deleted from within the discovery source, the status will be set to "INACTIVE". - example: ACTIVE - associatedSources: - type: array - items: - type: string - format: uuid - description: List of associated sources related to this discovered application. - example: - - e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 - - a0303682-5e4a-44f7-bdc2-6ce6112549c1 - examples: - Slim Discovered Application: - description: List of discovered applications - value: - - id: 09d88a67-bae8-422c-a09b-f7a72f5ab032 - name: Example App - discoverySource: csv - discoveredVendor: Example Vendor - description: An application for managing examples. - recommendedConnectors: - - ConnectorA - - ConnectorB - discoveredAt: '2023-07-01T12:00:00Z' - createdAt: '2024-06-01T12:00:00Z' - status: ACTIVE - - id: 59310a1e-0d8f-42fa-95aa-b82b263de7f6 - name: Sample Tracker - discoverySource: Okta SaaS - discoveredVendor: Sample Vendor - description: A tool for monitoring and managing samples. - recommendedConnectors: - - ConnectorC - - ConnectorD - discoveredAt: '2023-08-15T08:00:00Z' - createdAt: '2024-05-20T08:00:00Z' - status: ACTIVE - - id: dfe675cb-f689-475f-99f1-49e348449867 - name: Demo Manager - discoverySource: Okta SaaS - discoveredVendor: Demo Provider - description: Software to demonstrate basic functionalities. - recommendedConnectors: - - ConnectorE - - ConnectorF - discoveredAt: '2023-09-10T15:00:00Z' - createdAt: '2024-07-03T15:00:00Z' - status: ACTIVE - Discovered Application: - description: List of discovered applications with their respective associated sources - value: - - id: 6f672248-2dac-4cf5-9531-fca0719cbb4a - name: Example App - discoverySource: csv - discoveredVendor: Example Vendor - description: An application for managing examples. - recommendedConnectors: - - ConnectorA - - ConnectorB - discoveredAt: '2023-07-01T12:00:00Z' - createdAt: '2024-06-01T12:00:00Z' - status: ACTIVE - associatedSources: - - e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 - - id: b3a3a704-6a45-45ee-a501-bbc332388222 - name: Sample Tracker - discoverySource: Okta SaaS - discoveredVendor: Sample Vendor - description: A tool for monitoring and managing samples. - recommendedConnectors: - - ConnectorC - - ConnectorD - discoveredAt: '2023-08-15T08:00:00Z' - createdAt: '2024-05-20T08:00:00Z' - status: ACTIVE - associatedSources: - - a3b159f2-5f09-43c9-b40e-a6f317aa5b8f - - e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 - - id: 1d070458-faed-4a6c-8990-918ad70a06ee - name: Demo Manager - discoverySource: Okta SaaS - discoveredVendor: Demo Provider - description: Software to demonstrate basic functionalities. - recommendedConnectors: - - ConnectorE - - ConnectorF - discoveredAt: '2023-09-10T15:00:00Z' - createdAt: '2024-07-03T15:00:00Z' - status: ACTIVE - associatedSources: - - 4e2d7605-833f-4c34-8d03-5b2c7d2f4f66 - - f9b7e2ce-aced-4117-a95f-4ffad8b33989 - - a3b159f2-5f09-43c9-b40e-a6f317aa5b8f - - id: 9be7c5a5-9f37-46ba-965a-e5b9453472c6 - name: Task Organizer - discoverySource: Manual Entry - discoveredVendor: Organizer Solutions - description: An application designed to help teams manage tasks and projects efficiently. - recommendedConnectors: - - ConnectorG - - ConnectorH - discoveredAt: '2023-10-05T14:00:00Z' - createdAt: '2024-08-01T14:00:00Z' - status: ACTIVE - associatedSources: [] - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#get-discovered-applications - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) - $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) - - # Get Discovered Applications for Tenant - - try { - Get-V2025DiscoveredApplications - - # Below is a request that includes all optional parameters - # Get-V2025DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DiscoveredApplications" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/application-discovery#get-discovered-applications - source: | - from sailpoint.v2025.api.application_discovery_api import ApplicationDiscoveryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) - filter = 'name eq \"Okta\" and description co \"Okta\" and discoverySource in (\"csv\", \"Okta Saas\")' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) - try: - # Get Discovered Applications for Tenant - - results = ApplicationDiscoveryApi(api_client).get_discovered_applications() - # Below is a request that includes all optional parameters - # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) - print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - /manual-discover-applications-template: - get: - summary: Download CSV Template for Discovery - tags: - - Application Discovery - description: | - Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. - - The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - security: - - userAuth: - - idn:application-discovery:read - operationId: getManualDiscoverApplicationsCsvTemplate - responses: - '200': - description: A CSV file download was successful. - content: - text/csv: - schema: - type: object - properties: - application_name: - type: string - description: Name of the application. - example: Example Application - description: - type: string - description: Description of the application. - example: Example Description - example: | - application_name,description - Example Application,Example Description - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#get-manual-discover-applications-csv-template - source: | - - # Download CSV Template for Discovery - - try { - Get-V2025ManualDiscoverApplicationsCsvTemplate - - # Below is a request that includes all optional parameters - # Get-V2025ManualDiscoverApplicationsCsvTemplate - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/application-discovery#get-manual-discover-applications-csv-template - source: | - from sailpoint.v2025.api.application_discovery_api import ApplicationDiscoveryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Download CSV Template for Discovery - - results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() - # Below is a request that includes all optional parameters - # results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() - print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) - /manual-discover-applications: - post: - summary: Upload CSV to Discover Applications - tags: - - Application Discovery - description: |- - Uploading a CSV file with application data for manual correlation to specific ISC connectors. - If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - security: - - userAuth: - - idn:application-discovery:write - operationId: sendManualDiscoverApplicationsCsvTemplate - requestBody: - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - description: The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - example: |- - application_name,description - "Sample App","This is a sample description for Sample App." - "Another App","Description for Another App." - required: - - file - responses: - '200': - description: The CSV has been successfully processed. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#send-manual-discover-applications-csv-template - source: | - $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - - # Upload CSV to Discover Applications - - try { - Send-V2025ManualDiscoverApplicationsCsvTemplate -File $File - - # Below is a request that includes all optional parameters - # Send-V2025ManualDiscoverApplicationsCsvTemplate -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/application-discovery#send-manual-discover-applications-csv-template - source: | - from sailpoint.v2025.api.application_discovery_api import ApplicationDiscoveryApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - file = None # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - try: - # Upload CSV to Discover Applications - - ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file=file) - # Below is a request that includes all optional parameters - # ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file) - except Exception as e: - print("Exception when calling ApplicationDiscoveryApi->send_manual_discover_applications_csv_template: %s\n" % e) - /vendor-connector-mappings: - get: - security: - - userAuth: - - idn:application-discovery:read - operationId: getVendorConnectorMappings - tags: - - Vendor Connector Mappings - summary: List Vendor Connector Mappings - description: | - Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. - responses: - '200': - description: Successfully retrieved list. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The unique identifier for the vendor-connector mapping. - example: 78733556-9ea3-4f59-bf69-e5cd92b011b4 - vendor: - type: string - description: The name of the vendor. - example: Example vendor - connector: - type: string - description: The name of the connector. - example: Example connector - createdAt: - type: string - format: date-time - description: The creation timestamp of the mapping. - example: '2024-03-13T12:56:19.391294Z' - createdBy: - type: string - description: The identifier of the user who created the mapping. - example: admin - updatedAt: - type: object - nullable: true - properties: - Time: - type: string - format: date-time - description: The timestamp when the mapping was last updated, represented in ISO 8601 format. - example: '2024-03-14T12:56:19.391294Z' - Valid: - type: boolean - description: A flag indicating if the 'Time' field is set and valid. - default: false - example: true - description: An object representing the nullable timestamp of the last update. - updatedBy: - type: object - nullable: true - properties: - String: - type: string - description: The identifier of the user who last updated the mapping, if available. - example: user-67891 - Valid: - type: boolean - description: A flag indicating if the 'String' field is set and valid. - default: false - example: true - description: An object representing the nullable identifier of the user who last updated the mapping. - deletedAt: - type: object - nullable: true - properties: - Time: - type: string - format: date-time - description: The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. - example: '0001-01-01T00:00:00Z' - Valid: - type: boolean - description: A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. - default: false - example: false - description: An object representing the nullable timestamp of when the mapping was deleted. - deletedBy: - type: object - nullable: true - properties: - String: - type: string - description: The identifier of the user who deleted the mapping, if applicable. - example: '' - Valid: - type: boolean - description: A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. - default: false - example: false - description: An object representing the nullable identifier of the user who deleted the mapping. - example: - - id: 78733556-9ea3-4f59-bf69-e5cd92b011b4 - vendor: Example Vendor - connector: Example Connector - createdAt: '2024-03-13T12:56:19.391294Z' - createdBy: admin - updatedAt: - Time: '2024-03-14T12:56:19.391294Z' - Valid: true - updatedBy: - String: user-67891 - Valid: true - deletedAt: - Time: '0001-01-01T00:00:00Z' - Valid: false - deletedBy: - String: '' - Valid: false - - id: 78733556-9ea3-4f59-bf69-e5cd92b011b5 - vendor: Another Corporation - connector: Another Connector - createdAt: '2024-04-13T11:46:19.391294Z' - createdBy: admin - updatedAt: - Time: '0001-01-01T00:00:00Z' - Valid: false - updatedBy: - String: '' - Valid: false - deletedAt: - Time: '0001-01-01T00:00:00Z' - Valid: false - deletedBy: - String: '' - Valid: false - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '405': - $ref: '#/paths/~1verified-domains/post/responses/405' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/405.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#get-vendor-connector-mappings - source: | - - # List Vendor Connector Mappings - - try { - Get-V2025VendorConnectorMappings - - # Below is a request that includes all optional parameters - # Get-V2025VendorConnectorMappings - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025VendorConnectorMappings" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/vendor-connector-mappings#get-vendor-connector-mappings - source: | - from sailpoint.v2025.api.vendor_connector_mappings_api import VendorConnectorMappingsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.vendor_connector_mapping import VendorConnectorMapping - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Vendor Connector Mappings - - results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() - # Below is a request that includes all optional parameters - # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() - print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - post: - security: - - userAuth: - - idn:application-discovery:write - operationId: createVendorConnectorMapping - tags: - - Vendor Connector Mappings - summary: Create Vendor Connector Mapping - description: | - Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1vendor-connector-mappings/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/VendorConnectorMapping.yaml - responses: - '200': - description: Successfully created a new vendor connector mapping. - content: - application/json: - schema: - $ref: '#/paths/~1vendor-connector-mappings/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/VendorConnectorMapping.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '405': - $ref: '#/paths/~1verified-domains/post/responses/405' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/405.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#create-vendor-connector-mapping - source: | - $VendorConnectorMapping = @" - { - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - } - "@ - - # Create Vendor Connector Mapping - - try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-V2025VendorConnectorMapping -VendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # New-V2025VendorConnectorMapping -VendorConnectorMapping $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025VendorConnectorMapping" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/vendor-connector-mappings#create-vendor-connector-mapping - source: | - from sailpoint.v2025.api.vendor_connector_mappings_api import VendorConnectorMappingsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.vendor_connector_mapping import VendorConnectorMapping - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - vendor_connector_mapping = '''{ - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - }''' # VendorConnectorMapping | - try: - # Create Vendor Connector Mapping - new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping) - results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping) - # Below is a request that includes all optional parameters - # results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(new_vendor_connector_mapping) - print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) - delete: - security: - - userAuth: - - idn:application-discovery:write - operationId: deleteVendorConnectorMapping - tags: - - Vendor Connector Mappings - summary: Delete Vendor Connector Mapping - description: | - Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1vendor-connector-mappings/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/VendorConnectorMapping.yaml - responses: - '200': - description: Successfully deleted the specified vendor connector mapping. - content: - application/json: - schema: - type: object - properties: - count: - type: integer - description: The number of vendor connector mappings successfully deleted. - example: 1 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#delete-vendor-connector-mapping - source: | - $VendorConnectorMapping = @" - { - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - } - "@ - - # Delete Vendor Connector Mapping - - try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-V2025VendorConnectorMapping -VendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # Remove-V2025VendorConnectorMapping -VendorConnectorMapping $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025VendorConnectorMapping" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/vendor-connector-mappings#delete-vendor-connector-mapping - source: | - from sailpoint.v2025.api.vendor_connector_mappings_api import VendorConnectorMappingsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response - from sailpoint.v2025.models.vendor_connector_mapping import VendorConnectorMapping - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - vendor_connector_mapping = '''{ - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - }''' # VendorConnectorMapping | - try: - # Delete Vendor Connector Mapping - new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping) - results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping) - # Below is a request that includes all optional parameters - # results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(new_vendor_connector_mapping) - print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) - /source-apps/{id}: - get: - operationId: getSourceApp - tags: - - Apps - summary: Get source app by ID - description: This API returns a source app by its ID. - security: - - userAuth: - - idn:app-roles:read - parameters: - - name: id - in: path - description: ID of the source app - required: true - x-sailpoint-resource-operation-id: listAllSourceApp - schema: - type: string - example: 2c91808a7813090a017814121e121518 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Responds with the source app. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The source app id - example: 2c91808874ff91550175097daaec161c - cloudAppId: - type: string - description: The deprecated source app id - example: '9854520' - name: - type: string - description: The source app name - example: my app - created: - type: string - description: Time when the source app was created - format: date-time - example: '2020-10-08T18:33:52.029Z' - modified: - type: string - description: Time when the source app was last modified - format: date-time - example: '2020-10-08T18:33:52.029Z' - enabled: - type: boolean - default: false - description: True if the source app is enabled - example: true - provisionRequestEnabled: - type: boolean - default: false - description: True if the source app is provision request enabled - example: true - description: - type: string - nullable: false - description: The description of the source app - example: the source app for engineers - matchAllAccounts: - type: boolean - default: false - description: True if the source app match all accounts - example: true - appCenterEnabled: - type: boolean - default: true - description: True if the source app is shown in the app center - example: true - accountSource: - type: object - nullable: true - properties: - id: - type: string - description: The source ID - example: 2c9180827ca885d7017ca8ce28a000eb - type: - type: string - description: The source type, will always be "SOURCE" - example: SOURCE - name: - type: string - description: The source name - example: ODS-AD-Source - useForPasswordManagement: - type: boolean - default: false - description: If the source is used for password management - example: ture - passwordPolicies: - type: array - nullable: true - description: The password policies for the source - items: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml - example: - - type: PASSWORD_POLICY - id: 006a072ecc6647f68bba9f4a4ad34649 - name: Password Policy 1 - owner: - type: object - nullable: true - allOf: - - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml - description: The owner of source app - example: - id: 85d173e7d57e496569df763231d6deb6a - type: IDENTITY - name: John Doe - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#get-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get source app by ID - - try { - Get-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#get-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app import SourceApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get source app by ID - - results = AppsApi(api_client).get_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).get_source_app(id, x_sail_point_experimental) - print("The response of AppsApi->get_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->get_source_app: %s\n" % e) - patch: - operationId: patchSourceApp - tags: - - Apps - summary: Patch source app by ID - description: |- - This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. - Name, description and owner can't be empty or null. - security: - - userAuth: - - idn:app-roles:manage - parameters: - - name: id - in: path - description: ID of the source app to patch - required: true - x-sailpoint-resource-operation-id: listAllSourceApp - schema: - type: string - example: 2c91808a7813090a017814121e121518 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /enabled - value: true - examples: - Make an app enabled and matchAllAccounts in one call: - description: This example shows how multiple fields may be updated with a single patch call. - value: - - op: replace - path: /enabled - value: true - - op: replace - path: /matchAllAccounts - value: true - Replace an owner for an source app: - description: This example shows how to use patch to replace the source app's owner by replacing the owner's info. - value: - - op: replace - path: /owner - value: - id: 2c9180858315595501831958427e5424 - Update the description for the source app: - description: This example shows how to use patch to update a description for the source app. - value: - - op: replace - path: /description - value: new description for the source app - Update the name for the source app: - description: This example shows how to use patch to update the source app's name. - value: - - op: replace - path: /name - value: source app new name - Add access profile: - description: Add one access profile to the existing list - value: - - op: add - path: /accessProfiles/- - value: 2c9180857725c14301772a93bb77242d - Replace access profiles: - description: Replace all access profiles with a new list of access profiles - value: - - op: replace - path: /accessProfiles - value: - - 2c9180857725c14301772a93bb77242d - - c9575abb5e3a4e3db82b2f989a738aa2 - Remove access profile: - description: Remove the first access profile in the list - value: - - op: remove - path: /accessProfiles/0 - responses: - '200': - description: Responds with the source app as updated. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The source app id - example: 2c91808874ff91550175097daaec161c - cloudAppId: - type: string - description: The deprecated source app id - example: '9854520' - name: - type: string - description: The source app name - example: my app - created: - type: string - description: Time when the source app was created - format: date-time - example: '2020-10-08T18:33:52.029Z' - modified: - type: string - description: Time when the source app was last modified - format: date-time - example: '2020-10-08T18:33:52.029Z' - enabled: - type: boolean - default: false - description: True if the source app is enabled - example: true - provisionRequestEnabled: - type: boolean - default: false - description: True if the source app is provision request enabled - example: true - description: - type: string - nullable: false - description: The description of the source app - example: the source app for engineers - matchAllAccounts: - type: boolean - default: false - description: True if the source app match all accounts - example: true - appCenterEnabled: - type: boolean - default: true - description: True if the source app is shown in the app center - example: true - accessProfiles: - type: array - items: - type: string - nullable: true - description: List of IDs of access profiles - example: - - 2c9180857725c14301772a93bb77242d - - c9dc28e148a24d65b3ccb5fb8ca5ddd9 - accountSource: - type: object - nullable: true - properties: - id: - type: string - description: The source ID - example: 2c9180827ca885d7017ca8ce28a000eb - type: - type: string - description: The source type, will always be "SOURCE" - example: SOURCE - name: - type: string - description: The source name - example: ODS-AD-Source - useForPasswordManagement: - type: boolean - default: false - description: If the source is used for password management - example: ture - passwordPolicies: - type: array - nullable: true - description: The password policies for the source - items: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml - example: - - type: PASSWORD_POLICY - id: 006a072ecc6647f68bba9f4a4ad34649 - name: Password Policy 1 - owner: - type: object - nullable: true - allOf: - - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml - description: The owner of source app - example: - id: 85d173e7d57e496569df763231d6deb6a - type: IDENTITY - name: John Doe - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#patch-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch source app by ID - - try { - Update-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#patch-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.source_app_patch_dto import SourceAppPatchDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]''' # List[JsonPatchOperation] | (optional) - try: - # Patch source app by ID - - results = AppsApi(api_client).patch_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).patch_source_app(id, x_sail_point_experimental, new_json_patch_operation) - print("The response of AppsApi->patch_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->patch_source_app: %s\n" % e) - delete: - operationId: deleteSourceApp - security: - - userAuth: - - idn:app-roles:manage - - idn:app-roles:delete - tags: - - Apps - summary: Delete source app by ID - description: Use this API to delete a specific source app - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listAllSourceApp - description: source app ID. - example: 2c9180835d191a86015d28455b4a2329 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Responds with the source app as deleted. - content: - application/json: - schema: - $ref: '#/paths/~1source-apps~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/SourceApp.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#delete-source-app - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete source app by ID - - try { - Remove-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#delete-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app import SourceApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete source app by ID - - results = AppsApi(api_client).delete_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).delete_source_app(id, x_sail_point_experimental) - print("The response of AppsApi->delete_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->delete_source_app: %s\n" % e) - /source-apps/bulk-update: - post: - operationId: updateSourceAppsInBulk - tags: - - Apps - summary: Bulk update source apps - description: |- - This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. - The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. - Name, description and owner can't be empty or null. - security: - - userAuth: - - idn:app-roles:manage - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - content: - application/json: - schema: - type: object - properties: - appIds: - type: array - description: List of source app ids to update - maxItems: 50 - items: - type: string - example: - - 2c91808a7624751a01762f19d665220d - - 2c91808a7624751a01762f19d67c220e - - 2c91808a7624751a01762f19d692220f - jsonPatch: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - description: The JSONPatch payload used to update the source app. - example: - - op: replace - path: /enabled - value: false - - op: replace - path: /matchAllAccounts - value: false - required: - - appIds - - jsonPatch - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#update-source-apps-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceAppBulkUpdateRequest = @" - { - "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : false - }, { - "op" : "replace", - "path" : "/matchAllAccounts", - "value" : false - } ] - } - "@ - - # Bulk update source apps - - try { - Update-V2025SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -SourceAppBulkUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceAppsInBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#update-source-apps-in-bulk - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app_bulk_update_request import SourceAppBulkUpdateRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - source_app_bulk_update_request = '''{ - "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : false - }, { - "op" : "replace", - "path" : "/matchAllAccounts", - "value" : false - } ] - }''' # SourceAppBulkUpdateRequest | (optional) - try: - # Bulk update source apps - - AppsApi(api_client).update_source_apps_in_bulk(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # AppsApi(api_client).update_source_apps_in_bulk(x_sail_point_experimental, new_source_app_bulk_update_request) - except Exception as e: - print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) - /source-apps/assigned: - get: - operationId: listAssignedSourceApp - tags: - - Apps - summary: List assigned source apps - security: - - userAuth: - - idn:app-roles:read - description: This API returns the list of source apps assigned for logged in user. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** - example: name,-modified - required: false - style: form - explode: true - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, in, co, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **accountSource.id**: *eq, in* - example: name eq "source app name" - required: false - style: form - explode: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of source apps - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1source-apps~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/SourceApp.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-assigned-source-app - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) - $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - - # List assigned source apps - - try { - Get-V2025AssignedSourceApp -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AssignedSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AssignedSourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-assigned-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app import SourceApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) - filters = 'name eq \"source app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - try: - # List assigned source apps - - results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) - print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) - /source-apps: - get: - operationId: listAvailableSourceApps - tags: - - Apps - summary: List available source apps - security: - - userAuth: - - idn:app-roles:read - description: This API returns the list of source apps available for access request. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** - example: name,-modified - required: false - style: form - explode: true - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, in, co, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **accountSource.id**: *eq, in* - example: name eq "source app name" - required: false - style: form - explode: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of source apps - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1source-apps~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/SourceApp.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-available-source-apps - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - - # List available source apps - - try { - Get-V2025AvailableSourceApps -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AvailableSourceApps" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-available-source-apps - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app import SourceApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - filters = 'name eq \"source app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - try: - # List available source apps - - results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) - print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) - post: - operationId: createSourceApp - tags: - - Apps - summary: Create source app - description: This endpoint creates a source app using the given source app payload - security: - - userAuth: - - idn:app-roles:manage - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - name - - description - - accountSource - properties: - name: - type: string - description: The source app name - example: my app - description: - type: string - nullable: false - description: The description of the source app - example: the source app for engineers - matchAllAccounts: - type: boolean - default: false - description: True if the source app match all accounts - example: true - accountSource: - type: object - required: - - id - properties: - id: - type: string - nullable: false - description: The source ID - example: 2c9180827ca885d7017ca8ce28a000eb - type: - type: string - description: The source type, will always be "SOURCE" - example: SOURCE - name: - type: string - description: The source name - example: ODS-AD-Source - example: - name: new app name - description: app description - matchAllAccounts: true - accountSource: - id: edcb0951812949d085b60cd8bf35bc78 - responses: - '200': - description: Responds with the source app as created. - content: - application/json: - schema: - $ref: '#/paths/~1source-apps~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/SourceApp.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#create-source-app - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceAppCreateDto = @" - { - "name" : "my app", - "description" : "the source app for engineers", - "accountSource" : { - "name" : "ODS-AD-Source", - "id" : "2c9180827ca885d7017ca8ce28a000eb", - "type" : "SOURCE" - }, - "matchAllAccounts" : true - } - "@ - - # Create source app - - try { - $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto - New-V2025SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result - - # Below is a request that includes all optional parameters - # New-V2025SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#create-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app import SourceApp - from sailpoint.v2025.models.source_app_create_dto import SourceAppCreateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - source_app_create_dto = '''{ - "name" : "my app", - "description" : "the source app for engineers", - "accountSource" : { - "name" : "ODS-AD-Source", - "id" : "2c9180827ca885d7017ca8ce28a000eb", - "type" : "SOURCE" - }, - "matchAllAccounts" : true - }''' # SourceAppCreateDto | - try: - # Create source app - new_source_app_create_dto = SourceAppCreateDto.from_json(source_app_create_dto) - results = AppsApi(api_client).create_source_app(x_sail_point_experimental=x_sail_point_experimental, source_app_create_dto=new_source_app_create_dto) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).create_source_app(x_sail_point_experimental, new_source_app_create_dto) - print("The response of AppsApi->create_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->create_source_app: %s\n" % e) - /source-apps/all: - get: - operationId: listAllSourceApp - tags: - - Apps - summary: List all source apps - security: - - userAuth: - - idn:app-roles:manage - x-sailpoint-userLevels: - - ORG_ADMIN - description: 'This API returns the list of all source apps for the org. ' - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** - example: name,-modified - required: false - style: form - explode: true - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, in, co, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **owner.id**: *eq, in* - - **accountSource.id**: *eq, in* - - **enabled**: *eq* - example: enabled eq true - required: false - style: form - explode: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of source apps - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1source-apps~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/SourceApp.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-all-source-app - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - $Filters = "enabled eq true" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) - - # List all source apps - - try { - Get-V2025AllSourceApp -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AllSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllSourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-all-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_app import SourceApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - filters = 'enabled eq true' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) - try: - # List all source apps - - results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) - print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) - /source-apps/{id}/access-profiles: - get: - operationId: listAccessProfilesForSourceApp - tags: - - Apps - summary: List access profiles for the specified source app - security: - - userAuth: - - idn:app-roles:manage - description: This API returns the list of access profiles for the specified source app - parameters: - - name: id - in: path - description: ID of the source app - required: true - x-sailpoint-resource-operation-id: listAllSourceApp - schema: - type: string - example: 2c91808a7813090a017814121e121518 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, in* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - example: name eq "developer access profile" - required: false - style: form - explode: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of access profiles for the specified source app - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of the Access Profile - example: 2c91808a7190d06e01719938fcd20792 - name: - type: string - description: Name of the Access Profile - example: Employee-database-read-write - description: - type: string - nullable: true - description: Information about the Access Profile - example: Collection of entitlements to read/write the employee database - created: - type: string - description: Date the Access Profile was created - format: date-time - example: '2021-03-01T22:32:58.104Z' - modified: - type: string - description: Date the Access Profile was last modified. - format: date-time - example: '2021-03-02T20:22:28.104Z' - disabled: - type: boolean - default: true - description: Whether the Access Profile is enabled. - example: true - requestable: - type: boolean - default: false - description: Whether the Access Profile is requestable via access request. - example: true - protected: - type: boolean - default: false - description: Whether the Access Profile is protected. - example: false - ownerId: - type: string - description: The owner ID of the Access Profile - example: 9870808a7190d06e01719938fcd20792 - sourceId: - type: integer - format: int64 - nullable: true - description: The source ID of the Access Profile - example: 10360661 - sourceName: - type: string - description: The source name of the Access Profile - example: AD Source - appId: - type: integer - format: int64 - nullable: true - description: The source app ID of the Access Profile - example: 10360661 - appName: - type: string - nullable: true - description: The source app name of the Access Profile - example: mail app - applicationId: - type: string - description: The id of the application - example: edcb0951812949d085b60cd8bf35bc78 - type: - type: string - description: The type of the access profile - example: source - entitlements: - type: array - items: - type: string - description: List of IDs of entitlements - example: - - 2c9180857725c14301772a93bb77242d - - c9dc28e148a24d65b3ccb5fb8ca5ddd9 - entitlementCount: - type: integer - format: int32 - example: 12 - description: The number of entitlements in the access profile - segments: - type: array - items: - type: string - description: List of IDs of segments, if any, to which this Access Profile is assigned. - example: - - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - - 29cb6c06-1da8-43ea-8be4-b3125f248f2a - approvalSchemes: - type: string - description: | - Comma-separated list of approval schemes. Each approval scheme is one of - - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> - example: accessProfileOwner - revokeRequestApprovalSchemes: - type: string - description: | - Comma-separated list of revoke request approval schemes. Each approval - scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> - example: accessProfileOwner - requestCommentsRequired: - type: boolean - default: false - description: Whether the access profile require request comment for access request. - example: true - deniedCommentsRequired: - type: boolean - default: false - description: Whether denied comment is required when access request is denied. - example: true - accountSelector: - type: object - description: How to select account when there are multiple accounts for the user - properties: - selectors: - type: array - nullable: true - items: - type: object - properties: - applicationId: - type: string - description: The application id - example: 2c91808874ff91550175097daaec161c" - accountMatchConfig: - type: object - properties: - matchExpression: - type: object - properties: - matchTerms: - type: array - items: - type: object - properties: - name: - type: string - description: The attribute name - example: mail - value: - type: string - description: The attribute value - example: 1234 Albany Dr - op: - type: string - description: The operator between name and value - example: eq - container: - type: boolean - default: false - description: If it is a container or a real match term - example: true - and: - type: boolean - description: If it is AND logical operator for the children match terms - default: false - example: false - children: - type: array - nullable: true - items: - type: object - additionalProperties: true - description: The children under this match term - example: - - name: businessCategory - value: Service - op: eq - container: false - and: false - children: null - example: - - name: '' - value: '' - op: null - container: true - and: false - children: - - name: businessCategory - value: Service - op: eq - container: false - and: false - children: null - and: - type: boolean - description: If it is AND operators for match terms - default: true - example: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-access-profiles-for-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "name eq "developer access profile"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List access profiles for the specified source app - - try { - Get-V2025AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfilesForSourceApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-access-profiles-for-source-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile_details import AccessProfileDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'name eq \"developer access profile\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - try: - # List access profiles for the specified source app - - results = AppsApi(api_client).list_access_profiles_for_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters) - print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) - /source-apps/{id}/access-profiles/bulk-remove: - post: - operationId: deleteAccessProfilesFromSourceAppByBulk - tags: - - Apps - summary: Bulk remove access profiles from the specified source app - security: - - userAuth: - - idn:app-roles:manage - description: This API returns the final list of access profiles for the specified source app after removing - parameters: - - name: id - in: path - description: ID of the source app - required: true - x-sailpoint-resource-operation-id: listAllSourceApp - schema: - type: string - example: 2c91808a7813090a017814121e121518 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - type: string - description: List of access profile IDs for removal - example: - - c9575abb5e3a4e3db82b2f989a738aa2 - - c9dc28e148a24d65b3ccb5fb8ca5ddd9 - responses: - '200': - description: The final list of access profiles for the specified source app - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1source-apps~1%7Bid%7D~1access-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/AccessProfileDetails.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#delete-access-profiles-from-source-app-by-bulk - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @"[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]"@ - - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # Bulk remove access profiles from the specified source app - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2025AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-V2025AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfilesFromSourceAppByBulk" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#delete-access-profiles-from-source-app-by-bulk - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_profile_details import AccessProfileDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]''' # List[str] | - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # Bulk remove access profiles from the specified source app - new_request_body = RequestBody.from_json(request_body) - results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit) - print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) - /user-apps/{id}: - patch: - operationId: patchUserApp - tags: - - Apps - summary: Patch user app by ID - description: |- - This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - The following fields are patchable: **account** - security: - - userAuth: - - idn:app-roles:read - parameters: - - name: id - in: path - description: ID of the user app to patch - required: true - x-sailpoint-resource-operation-id: listAllUserApps - schema: - type: string - example: 2c91808a7813090a017814121e121518 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /account - value: - id: 0891808a7813090a017814121e121518 - type: ACCOUNT - responses: - '200': - description: Responds with the user app as updated. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The user app id - example: 2c91808874ff91550175097daaec161c - created: - type: string - description: Time when the user app was created - format: date-time - example: '2020-10-08T18:33:52.029Z' - modified: - type: string - description: Time when the user app was last modified - format: date-time - example: '2020-10-08T18:33:52.029Z' - hasMultipleAccounts: - type: boolean - default: false - description: True if the owner has multiple accounts for the source - example: false - useForPasswordManagement: - type: boolean - default: false - description: True if the source has password feature - example: true - provisionRequestEnabled: - type: boolean - default: false - description: True if the source app related to the user app is provision request enabled - example: true - appCenterEnabled: - type: boolean - default: true - description: True if the source app related to the user app is shown in the app center - example: true - sourceApp: - type: object - properties: - id: - type: string - description: the source app ID - example: edcb0951812949d085b60cd8bf35bc78 - type: - type: string - description: It will always be "APPLICATION" - example: APPLICATION - name: - type: string - description: the source app name - example: test-app - source: - type: object - properties: - id: - type: string - description: the source ID - example: 9870808a7190d06e01719938fcd20792 - type: - type: string - description: It will always be "SOURCE" - example: SOURCE - name: - type: string - description: the source name - example: test-source - account: - type: object - properties: - id: - type: string - description: the account ID - example: 85d173e7d57e496569df763231d6deb6a - type: - type: string - description: It will always be "ACCOUNT" - example: ACCOUNT - name: - type: string - description: the account name - example: test account - owner: - type: object - properties: - id: - type: string - description: The identity ID - example: 2c9180827ca885d7017ca8ce28a000eb - type: - type: string - description: It will always be "IDENTITY" - example: IDENTITY - name: - type: string - description: The identity name - example: John - alias: - type: string - description: The identity alias - example: John.Doe - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#patch-user-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch user app by ID - - try { - Update-V2025UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025UserApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#patch-user-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.user_app import UserApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | (optional) - try: - # Patch user app by ID - - results = AppsApi(api_client).patch_user_app(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).patch_user_app(id, x_sail_point_experimental, new_json_patch_operation) - print("The response of AppsApi->patch_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->patch_user_app: %s\n" % e) - /user-apps/{id}/available-accounts: - get: - operationId: listAvailableAccountsForUserApp - tags: - - Apps - summary: List available accounts for user app - security: - - userAuth: - - idn:app-roles:read - description: This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - parameters: - - name: id - in: path - description: ID of the user app - required: true - x-sailpoint-resource-operation-id: listAllUserApps - schema: - type: string - example: 2c91808a7813090a017814121e121518 - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of available accounts for the specified user app - content: - application/json: - schema: - type: array - items: - type: object - properties: - appId: - type: string - description: The source app ID - example: fbf4f72280304f1a8bc808fc2a3bcf7b - appDisplayName: - type: string - description: The source app display name - example: AD source app - sourceAccount: - type: object - properties: - id: - type: string - description: The account ID - example: fbf4f72280304f1a8bc808fc2a3bcf7b - nativeIdentity: - type: string - description: The native identity of account - example: CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com - displayName: - type: string - description: The display name of account - example: Abby Smith - sourceId: - type: string - description: The source ID of account - example: 10efa58ea3954883b52bf74f489ce8f9 - sourceDisplayName: - type: string - description: The source name of account - example: ODS-AD-SOURCE - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-available-accounts-for-user-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List available accounts for user app - - try { - Get-V2025AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AvailableAccountsForUserApp" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-available-accounts-for-user-app - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.app_account_details import AppAccountDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List available accounts for user app - - results = AppsApi(api_client).list_available_accounts_for_user_app(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count) - print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) - /user-apps: - get: - operationId: listOwnedUserApps - tags: - - Apps - summary: List owned user apps - security: - - userAuth: - - idn:app-roles:read - description: This API returns the list of user apps assigned to logged in user - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq* - - **ownerName**: *eq, sw* - - **ownerAlias**: *eq, sw* - - **accountId**: *eq* - - **sourceAppId**: *eq* - example: name eq "user app name" - required: false - style: form - explode: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of user apps - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1user-apps~1%7Bid%7D/patch/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/UserApp.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-owned-user-apps - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) - - # List owned user apps - - try { - Get-V2025OwnedUserApps -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025OwnedUserApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OwnedUserApps" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-owned-user-apps - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.user_app import UserApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) - try: - # List owned user apps - - results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) - print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) - /user-apps/all: - get: - operationId: listAllUserApps - tags: - - Apps - summary: List all user apps - security: - - userAuth: - - idn:app-roles:manage - description: |- - This API returns the list of all user apps with specified filters. - This API must be used with **filters** query parameter. - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq* - - **ownerId**: *eq* - - **ownerName**: *eq, sw* - - **ownerAlias**: *eq, sw* - - **accountId**: *eq* - - **sourceAppId**: *eq* - example: name eq "user app name" - required: true - style: form - explode: true - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: List of user apps - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1user-apps~1%7Bid%7D/patch/responses/200/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/UserApp.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-all-user-apps - source: | - $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List all user apps - - try { - Get-V2025AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllUserApps" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/apps#list-all-user-apps - source: | - from sailpoint.v2025.api.apps_api import AppsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.user_app import UserApp - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List all user apps - - results = AppsApi(api_client).list_all_user_apps(filters=filters, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) - print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) - /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}: - post: - operationId: updateAttributeKeyAndValueToRole - summary: Add a Metadata to Role. - description: This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - tags: - - Roles - security: - - userAuth: - - idn:role:update - - idn:role-checked:update - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - parameters: - - name: id - in: path - required: true - schema: - type: string - description: The Id of a role - example: c24359c389374d0fb8585698a2189e3d - - name: attributeKey - in: path - required: true - schema: - type: string - description: Technical name of the Attribute. - example: iscPrivacy - - name: attributeValue - in: path - required: true - schema: - type: string - description: Technical name of the Attribute Value. - example: public - responses: - '200': - description: Responds with the Role as updated. - content: - application/json: - schema: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/Role.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#update-attribute-key-and-value-to-role - source: | - $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - - # Add a Metadata to Role. - - try { - Update-V2025AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - - # Below is a request that includes all optional parameters - # Update-V2025AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AttributeKeyAndValueToRole" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#update-attribute-key-and-value-to-role - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role import Role - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c24359c389374d0fb8585698a2189e3d' # str | The Id of a role # str | The Id of a role - attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. - try: - # Add a Metadata to Role. - - results = RolesApi(api_client).update_attribute_key_and_value_to_role(id=id, attribute_key=attribute_key, attribute_value=attribute_value) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).update_attribute_key_and_value_to_role(id, attribute_key, attribute_value) - print("The response of RolesApi->update_attribute_key_and_value_to_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->update_attribute_key_and_value_to_role: %s\n" % e) - delete: - operationId: deleteMetadataFromRoleByKeyAndValue - summary: Remove a Metadata From Role. - description: This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - tags: - - Roles - security: - - userAuth: - - idn:role:delete - - idn:role-checked:delete - - idn:role:update - - idn:role-checked:update - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - parameters: - - name: id - in: path - required: true - schema: - type: string - description: The role's id. - example: 2c91808c74ff913f0175097daa9d59cd - - name: attributeKey - in: path - required: true - schema: - type: string - description: Technical name of the Attribute. - example: iscPrivacy - - name: attributeValue - in: path - required: true - schema: - type: string - description: Technical name of the Attribute Value. - example: public - responses: - '202': - description: Request accepted - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-metadata-from-role-by-key-and-value - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - - # Remove a Metadata From Role. - - try { - Remove-V2025MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - - # Below is a request that includes all optional parameters - # Remove-V2025MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MetadataFromRoleByKeyAndValue" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#delete-metadata-from-role-by-key-and-value - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c91808c74ff913f0175097daa9d59cd' # str | The role's id. # str | The role's id. - attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. - attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. - try: - # Remove a Metadata From Role. - - RolesApi(api_client).delete_metadata_from_role_by_key_and_value(id=id, attribute_key=attribute_key, attribute_value=attribute_value) - # Below is a request that includes all optional parameters - # RolesApi(api_client).delete_metadata_from_role_by_key_and_value(id, attribute_key, attribute_value) - except Exception as e: - print("Exception when calling RolesApi->delete_metadata_from_role_by_key_and_value: %s\n" % e) - /roles/access-model-metadata/bulk-update/ids: - post: - operationId: updateRolesMetadataByIds - summary: Bulk-Update Roles' Metadata by ID - description: |- - This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. - A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. - Custom metadata update, including add, replace need suit licensed. - tags: - - Roles - security: - - UserContextAuth: - - idn:role:update - - idn:role-checked:update - requestBody: - required: true - content: - application/json: - schema: - description: This API initialize a Bulk update by Id request of Role metadata. The maximum role count in a single update request is 3000. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. - type: object - properties: - roles: - description: Roles' Id to be updated - type: array - items: - type: string - example: - - b1db89554cfa431cb8b9921ea38d9367 - operation: - description: The operation to be performed - type: string - enum: - - ADD - - REMOVE - - REPLACE - example: REPLACE - replaceScope: - description: The choice of update scope. - type: string - enum: - - ALL - - ATTRIBUTE - example: ALL - values: - description: The metadata to be updated, including attribute key and value. - type: array - nullable: false - items: - type: object - required: - - attribute - - values - properties: - attribute: - type: string - description: the key of metadata attribute - example: iscFederalClassifications - values: - type: array - description: the values of attribute to be updated - items: - type: string - example: secret - nullable: true - example: - - secret - example: - - attribute: iscFederalClassifications - values: - - topSecret - required: - - roles - - operation - - values - responses: - '202': - description: Returned if bulk update request created - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the task which is executing the bulk update. This also used in to the bulk-update/** API to track status. - example: 2c9180867817ac4d017817c491119a20 - type: - type: string - description: Type of the bulk update object. - example: Role - status: - type: string - description: The status of the bulk update request, could also checked by getBulkUpdateStatus API - enum: - - CREATED - - PRE_PROCESS - - PRE_PROCESS_COMPLETED - - POST_PROCESS - - COMPLETED - - CHUNK_PENDING - - CHUNK_PROCESSING - example: CREATED - created: - type: string - description: Time when the bulk update request was created - format: date-time - example: '2020-10-08T18:33:52.029Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-ids - source: | - $RoleMetadataBulkUpdateByIdRequest = @" - { - "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], - "values" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "topSecret" ] - } ], - "replaceScope" : "ALL", - "operation" : "REPLACE" - } - "@ - - # Bulk-Update Roles' Metadata by ID - - try { - $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest - Update-V2025RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByIds" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#update-roles-metadata-by-ids - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_bulk_update_response import RoleBulkUpdateResponse - from sailpoint.v2025.models.role_metadata_bulk_update_by_id_request import RoleMetadataBulkUpdateByIdRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_metadata_bulk_update_by_id_request = '''{ - "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], - "values" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "topSecret" ] - } ], - "replaceScope" : "ALL", - "operation" : "REPLACE" - }''' # RoleMetadataBulkUpdateByIdRequest | - try: - # Bulk-Update Roles' Metadata by ID - new_role_metadata_bulk_update_by_id_request = RoleMetadataBulkUpdateByIdRequest.from_json(role_metadata_bulk_update_by_id_request) - results = RolesApi(api_client).update_roles_metadata_by_ids(role_metadata_bulk_update_by_id_request=new_role_metadata_bulk_update_by_id_request) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).update_roles_metadata_by_ids(new_role_metadata_bulk_update_by_id_request) - print("The response of RolesApi->update_roles_metadata_by_ids:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->update_roles_metadata_by_ids: %s\n" % e) - /roles/access-model-metadata/bulk-update/filter: - post: - operationId: updateRolesMetadataByFilter - summary: Bulk-Update Roles' Metadata by Filters - description: |- - This API initiates a bulk update of metadata for one or more Roles by filter. - A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - The maximum metadata value count for a single role is 25. - Custom metadata update, including add, replace need suit licensed. - tags: - - Roles - security: - - UserContextAuth: - - idn:role:update - - idn:role-checked:update - requestBody: - required: true - content: - application/json: - schema: - description: This API initialize a a Bulk update by filter request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. - type: object - properties: - filters: - description: |- - Filtering is supported for the following fields and operators: - - **id** : *eq, in* - - **name** : *eq, sw* - - **created** : *gt, lt, ge, le* - - **modified** : *gt, lt, ge, le* - - **owner.id** : *eq, in* - - **requestable** : *eq* - type: string - example: ' requestable eq false' - operation: - description: The operation to be performed - type: string - enum: - - ADD - - REMOVE - - REPLACE - example: REPLACE - replaceScope: - description: The choice of update scope. - type: string - enum: - - ALL - - ATTRIBUTE - example: ALL - values: - description: The metadata to be updated, including attribute key and value. - type: array - nullable: false - items: - type: object - required: - - attribute - - values - properties: - attributeKey: - type: string - description: the key of metadata attribute - example: iscFederalClassifications - values: - type: array - description: the values of attribute to be updated - items: - type: string - example: secret - nullable: true - example: - - secret - example: - - attribute: iscFederalClassifications - values: - - topSecret - required: - - filters - - operation - - values - example: - operation: ADD - replaceScope: ALL - filters: requestable eq false - values: - - attribute: iscFederalClassifications - values: - - topSecret - responses: - '202': - description: Returned if bulk update request created - content: - application/json: - schema: - $ref: '#/paths/~1roles~1access-model-metadata~1bulk-update~1ids/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/role-metadata/RoleBulkUpdateResponse.yaml - examples: - Update request created successfully: - value: - id: 2d82ac17-eb0d-4ba6-9918-dcad6ee0294d - type: ROLE - status: CREATED - created: '2024-09-16T18:59:06.871Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-filter - source: | - $RoleMetadataBulkUpdateByFilterRequest = @" - { - "values" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "topSecret" ] - } ], - "filters" : " requestable eq false", - "replaceScope" : "ALL", - "operation" : "REPLACE" - } - "@ - - # Bulk-Update Roles' Metadata by Filters - - try { - $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest - Update-V2025RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByFilter" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#update-roles-metadata-by-filter - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_bulk_update_response import RoleBulkUpdateResponse - from sailpoint.v2025.models.role_metadata_bulk_update_by_filter_request import RoleMetadataBulkUpdateByFilterRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_metadata_bulk_update_by_filter_request = '''{ - "values" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "topSecret" ] - } ], - "filters" : " requestable eq false", - "replaceScope" : "ALL", - "operation" : "REPLACE" - }''' # RoleMetadataBulkUpdateByFilterRequest | - try: - # Bulk-Update Roles' Metadata by Filters - new_role_metadata_bulk_update_by_filter_request = RoleMetadataBulkUpdateByFilterRequest.from_json(role_metadata_bulk_update_by_filter_request) - results = RolesApi(api_client).update_roles_metadata_by_filter(role_metadata_bulk_update_by_filter_request=new_role_metadata_bulk_update_by_filter_request) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).update_roles_metadata_by_filter(new_role_metadata_bulk_update_by_filter_request) - print("The response of RolesApi->update_roles_metadata_by_filter:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->update_roles_metadata_by_filter: %s\n" % e) - /roles/access-model-metadata/bulk-update/query: - post: - operationId: updateRolesMetadataByQuery - summary: Bulk-Update Roles' Metadata by Query - description: |- - This API initiates a bulk update of metadata for one or more Roles by query. - A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - The maximum metadata value count for a single role is 25. - Custom metadata update, including add, replace need suit licensed. - tags: - - Roles - security: - - UserContextAuth: - - idn:role:update - - idn:role-checked:update - requestBody: - required: true - content: - application/json: - schema: - description: |- - Bulk update by query request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. - For more information about the query could refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/v3/search-post) - type: object - properties: - query: - description: query the identities to be updated - type: object - items: - $ref: '#/components/schemas/RoleMetadataBulkUpdateByQueryRequest/properties/query/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/Search.yaml - example: - query": - indices: - - roles - queryType: TEXT - textQuery: - terms: - - test123 - fields: - - id - matchAny: false - contains: true - includeNested: false - operation: - description: The operation to be performed - type: string - enum: - - ADD - - REMOVE - - REPLACE - example: REPLACE - replaceScope: - description: The choice of update scope. - type: string - enum: - - ALL - - ATTRIBUTE - example: ALL - values: - description: The metadata to be updated, including attribute key and value. - type: array - nullable: false - items: - type: object - required: - - attribute - - values - properties: - attributeKey: - type: string - description: the key of metadata attribute - example: iscFederalClassifications - attributeValue: - type: array - description: the values of attribute to be updated - items: - type: string - example: topSecret - example: - - topSecret - required: - - query - - operation - - values - example: - example of a success update: - query: - indices: - - roles - queryType: TEXT - textQuery: - terms: - - test123 - fields: - - id - matchAny: false - contains: true - includeNested: false - operation: REPLACE - replaceScope: ALL - values: - - attribute: iscFederalClassifications - values: - - secret - responses: - '202': - description: Returned if bulk update request created - content: - application/json: - schema: - $ref: '#/paths/~1roles~1access-model-metadata~1bulk-update~1ids/post/responses/202/content/application~1json/schema' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/role-metadata/RoleBulkUpdateResponse.yaml - examples: - Update request created successfully: - value: - id: 2d82ac17-eb0d-4ba6-9918-dcad6ee0294d - type: ROLE - status: CREATED - created: '2024-09-16T18:59:06.871594Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-query - source: | - $RoleMetadataBulkUpdateByQueryRequest = @" - { - "query" : { - "query\"" : { - "indices" : [ "roles" ], - "queryType" : "TEXT", - "textQuery" : { - "terms" : [ "test123" ], - "fields" : [ "id" ], - "matchAny" : false, - "contains" : true - }, - "includeNested" : false - } - }, - "values" : [ { - "attributeValue" : [ "topSecret" ], - "attributeKey" : "iscFederalClassifications" - }, { - "attributeValue" : [ "topSecret" ], - "attributeKey" : "iscFederalClassifications" - } ], - "replaceScope" : "ALL", - "operation" : "REPLACE" - } - "@ - - # Bulk-Update Roles' Metadata by Query - - try { - $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest - Update-V2025RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByQuery" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#update-roles-metadata-by-query - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_bulk_update_response import RoleBulkUpdateResponse - from sailpoint.v2025.models.role_metadata_bulk_update_by_query_request import RoleMetadataBulkUpdateByQueryRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - role_metadata_bulk_update_by_query_request = '''{ - "query" : { - "query\"" : { - "indices" : [ "roles" ], - "queryType" : "TEXT", - "textQuery" : { - "terms" : [ "test123" ], - "fields" : [ "id" ], - "matchAny" : false, - "contains" : true - }, - "includeNested" : false - } - }, - "values" : [ { - "attributeValue" : [ "topSecret" ], - "attributeKey" : "iscFederalClassifications" - }, { - "attributeValue" : [ "topSecret" ], - "attributeKey" : "iscFederalClassifications" - } ], - "replaceScope" : "ALL", - "operation" : "REPLACE" - }''' # RoleMetadataBulkUpdateByQueryRequest | - try: - # Bulk-Update Roles' Metadata by Query - new_role_metadata_bulk_update_by_query_request = RoleMetadataBulkUpdateByQueryRequest.from_json(role_metadata_bulk_update_by_query_request) - results = RolesApi(api_client).update_roles_metadata_by_query(role_metadata_bulk_update_by_query_request=new_role_metadata_bulk_update_by_query_request) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).update_roles_metadata_by_query(new_role_metadata_bulk_update_by_query_request) - print("The response of RolesApi->update_roles_metadata_by_query:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) - /roles/access-model-metadata/bulk-update/id: - get: - operationId: getBulkUpdateStatusById - summary: Get Bulk-Update Status by ID - description: |- - - This API initial a request for one bulk update's status by bulk update Id returns the status of the bulk update process. - A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - security: - - UserContextAuth: - - idn:role:update - - idn:role-checked:update - tags: - - Roles - parameters: - - name: id - in: path - required: true - schema: - type: string - description: The Id of the bulk update task. - example: c24359c389374d0fb8585698a2189e3d - responses: - '202': - description: return if bulk update status could be found. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the task which is executing the bulk update. This also used in to the bulk-update/** API to track status. - example: 2c9180867817ac4d017817c491119a20 - type: - type: string - description: Type of the bulk update object. - example: Role - status: - type: string - description: The status of the bulk update request, could also checked by getBulkUpdateStatus API - enum: - - CREATED - - PRE_PROCESS - - PRE_PROCESS_COMPLETED - - POST_PROCESS - - COMPLETED - - CHUNK_PENDING - - CHUNK_PROCESSING - example: CREATED - created: - type: string - description: Time when the bulk update request was created - format: date-time - example: '2020-10-08T18:33:52.029Z' - examples: - Update request created successfully: - value: - id: 2d82ac17-eb0d-4ba6-9918-dcad6ee0294d - type: ROLE - status: CREATED - created: '2024-09-16T18:59:06.871594Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-bulk-update-status-by-id - source: | - $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. - - # Get Bulk-Update Status by ID - - try { - Get-V2025BulkUpdateStatusById -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025BulkUpdateStatusById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BulkUpdateStatusById" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#get-bulk-update-status-by-id - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_bulk_update_response import RoleBulkUpdateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c24359c389374d0fb8585698a2189e3d' # str | The Id of the bulk update task. # str | The Id of the bulk update task. - try: - # Get Bulk-Update Status by ID - - results = RolesApi(api_client).get_bulk_update_status_by_id(id=id) - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).get_bulk_update_status_by_id(id) - print("The response of RolesApi->get_bulk_update_status_by_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->get_bulk_update_status_by_id: %s\n" % e) - /roles/access-model-metadata/bulk-update: - get: - operationId: getBulkUpdateStatus - summary: Get Bulk-Update Statuses - description: This API returns a list of all unfinished bulk update process status of the tenant. - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - security: - - userAuth: - - idn:role:update - - idn:role-checked:update - tags: - - Roles - responses: - '200': - description: successfully get the status of all unfinished bulk updates request. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the task which is executing the bulk update. This also used in to the bulk-update/** API to track status. - example: 2c9180867817ac4d017817c491119a20 - type: - type: string - description: Type of the bulk update object. - example: Role - status: - type: string - description: The status of the bulk update request, only list unfinished request's status, the status could also checked by getBulkUpdateStatus API - enum: - - CREATED - - PRE_PROCESS - - POST_PROCESS - - CHUNK_PENDING - - CHUNK_PROCESSING - example: CREATED - created: - type: string - description: Time when the bulk update request was created - format: date-time - example: '2020-10-08T18:33:52.029Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-bulk-update-status - source: | - - # Get Bulk-Update Statuses - - try { - Get-V2025BulkUpdateStatus - - # Below is a request that includes all optional parameters - # Get-V2025BulkUpdateStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BulkUpdateStatus" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#get-bulk-update-status - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role_get_all_bulk_update_response import RoleGetAllBulkUpdateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get Bulk-Update Statuses - - results = RolesApi(api_client).get_bulk_update_status() - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).get_bulk_update_status() - print("The response of RolesApi->get_bulk_update_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) - /roles/filter: - post: - operationId: searchRolesByFilter - summary: Filter Roles by Metadata - description: |- - This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. - A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - security: - - UserContextAuth: - - idn:role:read - - idn:role-checked:read - tags: - - Roles - parameters: - - name: for-subadmin - in: query - schema: - type: string - description: If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - example: 5168015d32f890ca15812c9180835d2e - required: false - - name: limit - in: query - schema: - type: integer - format: int32 - minimum: 0 - maximum: 250 - default: 50 - description: Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - example: 50 - required: false - - name: offset - in: query - description: |- - Offset into the full result set. Usually specified with *limit* to paginate through the results. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - required: false - example: 0 - - name: count - in: query - description: |- - Boolean indicating whether a total count is returned, factoring in any filter parameters, in the X-Total-Count response header. The value is the total size of the collection that would be returned if limit and offset were ignored. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - schema: - type: boolean - default: false - required: false - example: true - - name: sorters - in: query - schema: - type: string - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created, modified** - example: name,-modified - required: false - - name: for-segment-ids - in: query - schema: - type: string - description: |- - If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. - If segmentation is currently unavailable, specifying this parameter results in an error. - example: 0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d - required: false - - name: include-unsegmented - in: query - description: Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - schema: - type: boolean - default: true - required: false - example: false - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - requestBody: - content: - application/json: - schema: - description: AMMFilterValues - type: object - properties: - filters: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **owner.id**: *eq, in* - - **requestable**: *eq* - example: dimensional eq false - nullable: true - ammKeyValues: - nullable: true - type: array - items: - type: object - properties: - attribute: - description: attribute key of a metadata. - type: string - example: iscFederalClassifications - values: - description: A list of attribute key names to filter roles. If the values is empty, will only filter by attribute key. - type: array - items: - type: string - example: secret - example: - - secret - example: - - attribute: iscFederalClassifications - values: - - secret - example: - filters: dimensional eq false - ammKeyValues: - - attribute: iscFederalClassifications - values: - - secret - responses: - '200': - description: Responds with A list of Roles - content: - application/json: - schema: - type: array - allOf: - - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/Role.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#search-roles-by-filter - source: | - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) - $RoleListFilterDTO = @" - { - "ammKeyValues" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "secret" ] - } ], - "filters" : "dimensional eq false" - } - "@ - - # Filter Roles by Metadata - - try { - Search-V2025RolesByFilter - - # Below is a request that includes all optional parameters - # Search-V2025RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -RoleListFilterDTO $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025RolesByFilter" - Write-Host $_.ErrorDetails - } - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/roles#search-roles-by-filter - source: | - from sailpoint.v2025.api.roles_api import RolesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.role import Role - from sailpoint.v2025.models.role_list_filter_dto import RoleListFilterDTO - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - limit = 50 # int | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) - role_list_filter_dto = '''{ - "ammKeyValues" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "secret" ] - } ], - "filters" : "dimensional eq false" - }''' # RoleListFilterDTO | (optional) - try: - # Filter Roles by Metadata - - results = RolesApi(api_client).search_roles_by_filter() - # Below is a request that includes all optional parameters - # results = RolesApi(api_client).search_roles_by_filter(for_subadmin, limit, offset, count, sorters, for_segment_ids, include_unsegmented, new_role_list_filter_dto) - print("The response of RolesApi->search_roles_by_filter:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling RolesApi->search_roles_by_filter: %s\n" % e) -security: - - userAuth: - - sp:scopes:all -components: - securitySchemes: - userAuth: - type: oauth2 - x-displayName: Personal Access Token - description: | - OAuth2 Bearer token (JWT) generated using either a [personal access token (PAT)](https://developer.sailpoint.com/docs/api/authentication/#generate-a-personal-access-token) or through the [authorization code flow](https://developer.sailpoint.com/docs/api/authentication/#request-access-token-with-authorization-code-grant-flow). - - Personal access tokens are associated with a user in Identity Security Cloud and relies on the user's [user level](https://documentation.sailpoint.com/saas/help/common/users/index.html) (ex. Admin, Helpdesk, etc.) to determine a base level of access. - - See [Identity Security Cloud REST API Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information. - flows: - clientCredentials: - tokenUrl: https://tenant.api.identitynow.com/oauth/token - scopes: - sp:scopes:default: default scope - sp:scopes:all: access to all scopes - authorizationCode: - authorizationUrl: https://tenant.login.sailpoint.com/oauth/authorize - tokenUrl: https://tenant.api.identitynow.com/oauth/token - scopes: - sp:scopes:default: default scope - sp:scopes:all: access to all scopes - applicationAuth: - type: oauth2 - x-displayName: Client Credentials - description: | - OAuth2 Bearer token (JWT) generated using [client credentials flow](https://developer.sailpoint.com/docs/api/authentication/#request-access-token-with-client-credentials-grant-flow). - - Client credentials refers to tokens that are not associated with a user in Identity Security Cloud. - - See [Identity Security Cloud REST API Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information. - flows: - clientCredentials: - tokenUrl: https://tenant.api.identitynow.com/oauth/token - scopes: - sp:scopes:default: default scope - sp:scopes:all: access to all scopes - schemas: - AccessRequest: - type: object - properties: - requestedFor: - description: A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. - type: array - items: - type: string - example: 2c918084660f45d6016617daa9210584 - requestType: - type: string - enum: - - GRANT_ACCESS - - REVOKE_ACCESS - - null - description: Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. - example: GRANT_ACCESS - nullable: true - requestedItems: - type: array - items: - type: object - properties: - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: The type of the item being requested. - example: ACCESS_PROFILE - id: - type: string - description: ID of Role, Access Profile or Entitlement being requested. - example: 2c9180835d2e5168015d32f890ca1581 - comment: - type: string - description: | - Comment provided by requester. - * Comment is required when the request is of type Revoke Access. - example: Requesting access profile for John Doe - clientMetadata: - type: object - additionalProperties: - type: string - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - example: - requestedAppName: test-app - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. - removeDate: - type: string - description: | - The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. - * Specify a date in the future. - * The current SLA for the deprovisioning is 24 hours. - * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. - format: date-time - example: '2020-07-11T21:23:15.000Z' - required: - - id - - type - minItems: 1 - maxItems: 25 - clientMetadata: - type: object - additionalProperties: - type: string - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - required: - - requestedFor - - requestedItems - AccessRequestItem: - type: object - properties: - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: The type of the item being requested. - example: ACCESS_PROFILE - id: - type: string - description: ID of Role, Access Profile or Entitlement being requested. - example: 2c9180835d2e5168015d32f890ca1581 - comment: - type: string - description: | - Comment provided by requester. - * Comment is required when the request is of type Revoke Access. - example: Requesting access profile for John Doe - clientMetadata: - type: object - additionalProperties: - type: string - example: - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - requestedAppName: test-app - example: - requestedAppName: test-app - requestedAppId: 2c91808f7892918f0178b78da4a305a1 - description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. - removeDate: - type: string - description: | - The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. - * Specify a date in the future. - * The current SLA for the deprovisioning is 24 hours. - * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. - format: date-time - example: '2020-07-11T21:23:15.000Z' - required: - - id - - type - AccessProfileDocument: - description: 'More complete representation of an access profile. ' - allOf: - - type: object - properties: - description: - type: string - description: Access item's description. - example: Admin access - created: - type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - type: string - description: ISO-8601 date-time referring to the time when the object was last modified. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - synced: - type: string - description: |- - ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. - This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. - There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - nullable: true - format: date-time - example: '2018-06-25T20:22:33.104Z' - enabled: - type: boolean - description: Indicates whether the access item is currently enabled. - default: false - example: true - requestable: - type: boolean - description: Indicates whether the access item can be requested. - default: true - example: true - requestCommentsRequired: - type: boolean - description: Indicates whether comments are required for requests to access the item. - default: false - example: false - owner: - type: object - description: Owner's identity. - properties: - type: - type: string - description: Owner's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Owner's identity ID. - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Owner's display name. - example: Support - email: - type: string - description: Owner's email. - example: cloud-support@sailpoint.com - - type: object - required: - - id - - name - properties: - id: - type: string - description: Access profile's ID. - example: 2c9180825a6c1adc015a71c9023f0818 - name: - type: string - description: Access profile's name. - example: Cloud Eng - source: - type: object - description: Access profile's source. - properties: - id: - type: string - description: Source's ID. - example: ff8081815757d4fb0157588f3d9d008f - name: - type: string - description: Source's name. - example: Employees - entitlements: - type: array - description: Entitlements the access profile has access to. - items: - type: object - properties: - hasPermissions: - type: boolean - description: Indicates whether the entitlement has permissions. - default: false - example: false - description: - type: string - description: Entitlement's description. - nullable: true - example: Cloud engineering - attribute: - type: string - description: Entitlement attribute's name. - example: memberOf - value: - type: string - description: Entitlement's value. - example: CN=Cloud Engineering,DC=sailpoint,DC=COM - schema: - type: string - description: Entitlement's schema. - example: group - privileged: - type: boolean - description: Indicates whether the entitlement is privileged. - default: false - example: false - id: - type: string - description: Entitlement's ID. - example: 2c918084575812550157589064f33b89 - name: - type: string - description: Entitlement's name. - example: CN=Cloud Engineering,DC=sailpoint,DC=COM - entitlementCount: - type: integer - description: Number of entitlements. - example: 5 - segments: - type: array - description: Segments with the access profile. - items: - type: object - properties: - id: - type: string - example: b009b6e3-b56d-41d9-8735-cb532ea0b017 - description: Segment's unique ID. - name: - type: string - example: Test Segment - description: Segment's display name. - segmentCount: - type: integer - description: Number of segments with the access profile. - format: int32 - example: 1 - tags: - type: array - description: Tags that have been applied to the object. - items: - type: string - example: - - TAG_1 - - TAG_2 - apps: - type: array - description: Applications with the access profile - items: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - description: Name of application - example: Travel and Expense - description: - description: Description of application. - type: string - example: Travel and Expense Application - owner: - type: object - description: Owner's identity. - properties: - type: - type: string - description: Owner's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Owner's identity ID. - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Owner's display name. - example: John Doe - email: - type: string - description: Owner's email. - example: john.doe@sailpoint.com - AccessProfileSummary: - description: This is a summary representation of an access profile. - allOf: - - allOf: - - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DisplayReference.yaml - - type: object - properties: - description: - description: Description of access item. - type: string - nullable: true - example: null - - type: object - properties: - type: - type: string - description: Type of the access item. - example: ACCESS_PROFILE - source: - type: object - properties: - id: - type: string - example: 2c91808568c529c60168cca6f90c1313 - description: The unique ID of the referenced object. - name: - type: string - example: John Doe - description: The human readable name of the referenced object. - owner: - allOf: - - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - - type: object - properties: - displayName: - type: string - example: John Q. Doe - revocable: - type: boolean - example: true - AccessReviewReassignment: - type: object - properties: - reassign: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of item or identity being reassigned. - example: ef38f94347e94562b5bb8424a56397d8 - type: - type: string - description: The type of item or identity being reassigned. - enum: - - TARGET_SUMMARY - - ITEM - - IDENTITY_SUMMARY - example: ITEM - required: - - id - - type - reassignTo: - type: string - description: The ID of the identity to which the certification is reassigned - example: ef38f94347e94562b5bb8424a56397d8 - reason: - type: string - description: The reason comment for why the reassign was made - example: reassigned for some reason - required: - - reassign - - reassignTo - - reason - Account: - allOf: - - type: object - required: - - name - properties: - id: - description: System-generated unique ID of the Object - type: string - example: id12345 - readOnly: true - name: - description: Name of the Object - type: string - example: aName - nullable: true - created: - description: Creation date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - modified: - description: Last modification date of the Object - type: string - example: '2015-05-28T14:07:17Z' - format: date-time - readOnly: true - - type: object - required: - - sourceId - - sourceName - - attributes - - authoritative - - disabled - - locked - - nativeIdentity - - systemAccount - - uncorrelated - - manuallyCorrelated - - hasEntitlements - properties: - sourceId: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - description: The unique ID of the source this account belongs to - sourceName: - type: string - nullable: true - example: Employees - description: The display name of the source this account belongs to - identityId: - type: string - example: 2c9180835d2e5168015d32f890ca1581 - description: The unique ID of the identity this account is correlated to - cloudLifecycleState: - type: string - nullable: true - example: active - description: The lifecycle state of the identity this account is correlated to - identityState: - type: string - nullable: true - example: ACTIVE - description: The identity state of the identity this account is correlated to - connectionType: - type: string - nullable: true - example: direct - description: The connection type of the source this account is from - isMachine: - type: boolean - default: false - description: Indicates if the account is of machine type - example: true - recommendation: - allOf: - - type: object - properties: - type: - type: string - enum: - - HUMAN - - MACHINE - description: Recommended type of account. - example: MACHINE - method: - type: string - enum: - - DISCOVERY - - SOURCE - - CRITERIA - description: Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. - example: DISCOVERY - required: - - type - - method - - nullable: true - description: Indicates that the account is currently classified to be one type but is recommended to be a different one - example: - type: MACHINE - method: DISCOVERY - attributes: - type: object - nullable: true - additionalProperties: true - description: The account attributes that are aggregated - example: - firstName: SailPoint - lastName: Support - displayName: SailPoint Support - authoritative: - type: boolean - description: Indicates if this account is from an authoritative source - example: false - description: - type: string - description: A description of the account - nullable: true - example: null - disabled: - type: boolean - description: Indicates if the account is currently disabled - example: false - locked: - type: boolean - description: Indicates if the account is currently locked - example: false - nativeIdentity: - type: string - description: The unique ID of the account generated by the source system - example: '552775' - systemAccount: - type: boolean - example: false - description: If true, this is a user account within IdentityNow. If false, this is an account from a source system. - uncorrelated: - type: boolean - description: Indicates if this account is not correlated to an identity - example: false - uuid: - type: string - description: The unique ID of the account as determined by the account schema - example: '{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}' - nullable: true - manuallyCorrelated: - type: boolean - description: Indicates if the account has been manually correlated to an identity - example: false - hasEntitlements: - type: boolean - description: Indicates if the account has entitlements - example: true - identity: - description: The identity this account is correlated to - type: object - properties: - id: - type: string - description: The ID of the identity - example: 2c918084660f45d6016617daa9210584 - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - name: - type: string - description: display name of identity - example: John Doe - sourceOwner: - type: object - nullable: true - description: The owner of the source this account belongs to. - properties: - id: - type: string - description: The ID of the identity - example: 2c918084660f45d6016617daa9210584 - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - name: - type: string - description: display name of identity - example: Adam Kennedy - features: - type: string - description: A string list containing the owning source's features - example: ENABLE - nullable: true - origin: - type: string - nullable: true - enum: - - AGGREGATED - - PROVISIONED - - null - description: The origin of the account either aggregated or provisioned - example: AGGREGATED - ownerIdentity: - allOf: - - type: object - properties: - type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - MACHINE_IDENTITY - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: William Wilson - - description: The identity who owns this account, used only for machine accounts - nullable: true - example: - id: 2c918084660f45d6016617daa9210584 - type: IDENTITY - name: Adam Kennedy - AccountActivity: - type: object - properties: - id: - type: string - description: Id of the account activity - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: The name of the activity - example: 2c9180835d2e5168015d32f890ca1581 - created: - description: When the activity was first created - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - modified: - description: When the activity was last modified - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - nullable: true - completed: - description: When the activity was completed - type: string - format: date-time - nullable: true - example: '2018-10-19T13:49:37.385Z' - completionStatus: - nullable: true - type: string - description: The status after completion. - enum: - - SUCCESS - - FAILURE - - INCOMPLETE - - PENDING - - null - example: SUCCESS - type: - nullable: true - type: string - example: appRequest - description: | - The type of action the activity performed. Please see the following list of types. This list may grow over time. - - - CloudAutomated - - IdentityAttributeUpdate - - appRequest - - LifecycleStateChange - - AccountStateUpdate - - AccountAttributeUpdate - - CloudPasswordRequest - - Attribute Synchronization Refresh - - Certification - - Identity Refresh - - Lifecycle Change Refresh - - - [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). - requesterIdentitySummary: - type: object - nullable: true - properties: - id: - type: string - description: ID of this identity summary - example: ff80818155fe8c080155fe8d925b0316 - name: - type: string - description: Human-readable display name of identity - example: SailPoint Services - identityId: - type: string - description: ID of the identity that this summary represents - example: c15b9f5cca5a4e9599eaa0e64fa921bd - completed: - type: boolean - description: Indicates if all access items for this summary have been decided on - example: true - default: false - targetIdentitySummary: - $ref: '#/components/schemas/AccountActivity/properties/requesterIdentitySummary' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentitySummary.yaml - errors: - nullable: true - description: A list of error messages, if any, that were encountered. - type: array - items: - type: string - example: - - 'sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.' - warnings: - nullable: true - description: A list of warning messages, if any, that were encountered. - type: array - items: - type: string - example: - - Some warning, another warning - items: - nullable: true - type: array - description: Individual actions performed as part of this account activity - items: - type: object - properties: - id: - type: string - description: Item id - example: 48c545831b264409a81befcabb0e3c5a - name: - type: string - description: Human-readable display name of item - example: 48c545831b264409a81befcabb0e3c5a - requested: - type: string - format: date-time - description: Date and time item was requested - example: '2017-07-11T18:45:37.098Z' - approvalStatus: - type: string - nullable: true - enum: - - FINISHED - - REJECTED - - RETURNED - - EXPIRED - - PENDING - - CANCELED - - null - example: PENDING - description: The state of an approval status - provisioningStatus: - type: string - enum: - - PENDING - - FINISHED - - UNVERIFIABLE - - COMMITED - - FAILED - - RETRY - description: Provisioning state of an account activity item - example: PENDING - requesterComment: - type: object - nullable: true - properties: - commenterId: - type: string - description: Id of the identity making the comment - example: 2c918084660f45d6016617daa9210584 - commenterName: - type: string - description: Human-readable display name of the identity making the comment - example: Adam Kennedy - body: - type: string - description: Content of the comment - example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat. - date: - type: string - format: date-time - description: Date and time comment was made - example: '2017-07-11T18:45:37.098Z' - reviewerIdentitySummary: - $ref: '#/components/schemas/AccountActivity/properties/requesterIdentitySummary' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentitySummary.yaml - reviewerComment: - $ref: '#/components/schemas/AccountActivity/properties/items/items/properties/requesterComment' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Comment.yaml - operation: - type: string - nullable: true - enum: - - ADD - - CREATE - - MODIFY - - DELETE - - DISABLE - - ENABLE - - UNLOCK - - LOCK - - REMOVE - - SET - - null - description: Represents an operation in an account activity item - example: ADD - attribute: - type: string - description: Attribute to which account activity applies - nullable: true - example: detectedRoles - value: - type: string - description: Value of attribute - nullable: true - example: Treasury Analyst [AccessProfile-1529010191212] - nativeIdentity: - nullable: true - type: string - description: Native identity in the target system to which the account activity applies - example: Sandie.Camero - sourceId: - type: string - description: Id of Source to which account activity applies - example: 2c91808363ef85290164000587130c0c - accountRequestInfo: - type: object - nullable: true - properties: - requestedObjectId: - type: string - description: Id of requested object - example: 2c91808563ef85690164001c31140c0c - requestedObjectName: - type: string - description: Human-readable name of requested object - example: Treasury Analyst - requestedObjectType: - $ref: '#/components/schemas/RequestableObject/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RequestableObjectType.yaml - description: If an account activity item is associated with an access request, captures details of that request. - clientMetadata: - nullable: true - type: object - additionalProperties: - type: string - description: Arbitrary key-value pairs, if any were included in the corresponding access request item - example: - customKey1: custom value 1 - customKey2: custom value 2 - removeDate: - nullable: true - type: string - description: The date the role or access profile or entitlement is no longer assigned to the specified identity. - format: date-time - example: '2020-07-11T00:00:00Z' - executionStatus: - type: string - description: The current state of execution. - enum: - - EXECUTING - - VERIFYING - - TERMINATED - - COMPLETED - example: COMPLETED - clientMetadata: - nullable: true - type: object - additionalProperties: - type: string - description: Arbitrary key-value pairs, if any were included in the corresponding access request - example: - customKey1: custom value 1 - customKey2: custom value 2 - AccountActivitySearchedItem: - description: AccountActivity - type: object - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - description: ID of account activity. - action: - type: string - description: Type of action performed in the activity. - externalDocs: - description: Learn more about account activity action types - url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data - example: Identity Refresh. - created: - type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - type: string - description: ISO-8601 date-time referring to the time when the object was last modified. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - synced: - type: string - description: |- - ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. - This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. - There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - example: '2018-06-25T20:22:28.104Z' - stage: - type: string - description: Activity's current stage. - example: Completed - status: - type: string - description: Activity's current status. - example: Complete - requester: - allOf: - - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - - type: object - properties: - type: - type: string - example: Identity - description: Type of object - recipient: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/requester' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/ActivityIdentity.yaml - trackingNumber: - type: string - description: Account activity's tracking number. - example: 61aad0c9e8134eca89e76a35e0cabe3f - errors: - type: array - description: Errors provided by the source while completing account actions. - items: - type: string - nullable: true - example: null - warnings: - type: array - description: Warnings provided by the source while completing account actions. - items: - type: string - nullable: true - example: null - approvals: - type: array - description: Approvals performed on an item during activity. - items: - type: object - properties: - comments: - type: array - items: - type: object - properties: - comment: - type: string - description: The comment text - example: This request was autoapproved by our automated ETS subscriber. - commenter: - type: string - description: The name of the commenter - example: Automated AR Approval - date: - $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml - modified: - $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml - owner: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/requester' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/ActivityIdentity.yaml - result: - type: string - description: The result of the approval - example: Finished - attributeRequest: - type: object - properties: - name: - type: string - description: Attribute name. - example: groups - op: - type: string - description: Operation to perform on attribute. - example: Add - value: - oneOf: - - type: string - example: '3203537556531076' - - type: array - items: - type: string - example: - - '3203537556531076' - - '1263537556831096' - description: Value of attribute. - source: - allOf: - - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - - type: object - properties: - type: - type: string - example: Delimited File - description: Type of source returned. - originalRequests: - type: array - description: Original actions that triggered all individual source actions related to the account action. - items: - type: object - properties: - accountId: - type: string - description: Account ID. - example: CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com - result: - type: object - properties: - status: - type: string - description: Request result status - example: Manual Task Created - attributeRequests: - type: array - description: Attribute changes requested for account. - items: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/attributeRequest' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/AttributeRequest.yaml - op: - type: string - description: Operation used. - example: add - source: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/AccountSource.yaml - expansionItems: - type: array - description: Controls that translated the attribute requests into actual provisioning actions on the source. - items: - type: object - properties: - accountId: - type: string - description: The ID of the account - example: 2c91808981f58ea601821c3e93482e6f - cause: - type: string - example: Role - description: Cause of the expansion item. - name: - type: string - description: The name of the item - example: smartsheet-role - attributeRequest: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/attributeRequest' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/AttributeRequest.yaml - source: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/AccountSource.yaml - id: - type: string - description: ID of the expansion item - example: ac2887ffe0e7435a8c18c73f7ae94c7b - state: - type: string - description: State of the expansion item - example: EXECUTING - accountRequests: - type: array - description: Account data for each individual source action triggered by the original requests. - items: - type: object - properties: - accountId: - type: string - description: Unique ID of the account - example: John.Doe - attributeRequests: - type: array - items: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/attributeRequest' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/AttributeRequest.yaml - op: - type: string - example: Modify - description: The operation that was performed - provisioningTarget: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/AccountSource.yaml - result: - type: object - properties: - errors: - type: array - items: - type: string - example: |- - [ConnectorError] [ - { - "code": "unrecognized_keys", - "keys": [ - "groups" - ], - "path": [], - "message": "Unrecognized key(s) in object: 'groups'" - } - ] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e) - description: Error message. - status: - type: string - description: The status of the account request - example: failed - ticketId: - type: string - nullable: true - example: null - description: ID of associated ticket. - source: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/AccountSource.yaml - sources: - type: string - description: Sources involved in the account activity. - example: smartsheet-test, airtable-v4, IdentityNow - AccountAttributes: - type: object - required: - - attributes - properties: - attributes: - description: The schema attribute values for the account - type: object - additionalProperties: true - example: - city: Austin - displayName: John Doe - userName: jdoe - sAMAccountName: jDoe - mail: john.doe@sailpoint.com - AccountsAsyncResult: - description: Accounts async response containing details on started async process - required: - - id - type: object - properties: - id: - description: id of the task - type: string - example: 2c91808474683da6017468693c260195 - AccountToggleRequest: - description: Request used for account enable/disable - type: object - properties: - externalVerificationId: - description: If set, an external process validates that the user wants to proceed with this request. - type: string - example: 3f9180835d2e5168015d32f890ca1581 - forceProvisioning: - description: If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow. - type: boolean - example: false - AccountUnlockRequest: - description: Request used for account unlock - type: object - properties: - externalVerificationId: - description: If set, an external process validates that the user wants to proceed with this request. - type: string - example: 3f9180835d2e5168015d32f890ca1581 - unlockIDNAccount: - description: If set, the IDN account is unlocked after the workflow completes. - type: boolean - example: false - forceProvisioning: - description: If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. - type: boolean - example: false - ApprovalItems: - type: object - properties: - id: - type: string - description: The approval item's ID - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - nullable: true - application: - type: string - description: The name of the application/source - example: Active Directory - name: - type: string - description: The attribute's name - example: emailAddress - nullable: true - operation: - type: string - description: The attribute's operation - example: update - value: - type: string - description: The attribute's value - example: a@b.com - nullable: true - state: - allOf: - - type: string - nullable: true - enum: - - Finished - - Rejected - - Returned - - Expired - - Pending - - Canceled - - null - example: Pending - description: The state of a work item - - nullable: true - Campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - - correlatedStatus - - mandatoryCommentRequirement - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - correlatedStatus: - 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 - mandatoryCommentRequirement: - 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 - Certification: - type: object - properties: - id: - example: 2c9180835d2e5168015d32f890ca1581 - type: string - description: id of the certification - name: - example: Source Owner Access Review for Employees [source] - type: string - description: name of the certification - campaign: - type: object - required: - - id - - name - - type - - campaignType - - description - - correlatedStatus - - mandatoryCommentRequirement - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - correlatedStatus: - 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 - mandatoryCommentRequirement: - 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 - completed: - type: boolean - description: Have all decisions been made? - example: true - identitiesCompleted: - type: integer - description: The number of identities for whom all decisions have been made and are complete. - example: 5 - format: int32 - identitiesTotal: - type: integer - description: The total number of identities in the Certification, both complete and incomplete. - example: 10 - format: int32 - created: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: created date - modified: - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: modified date - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made. - example: 20 - format: int32 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions. - example: 40 - format: int32 - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - nullable: true - signed: - type: string - format: date-time - nullable: true - description: The date the reviewer signed off on the Certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - description: The type of the reviewing identity. - example: IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The created date of the reviewing identity. - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The modified date of the reviewing identity. - reassignment: - type: object - nullable: true - properties: - from: - $ref: '#/components/schemas/Reassignment/properties/from' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertificationReference.yaml - comment: - type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - hasErrors: - description: Identifies if the certification has an error - type: boolean - example: false - errorMessage: - description: Description of the certification error - nullable: true - type: string - example: The certification has an error - phase: - type: string - description: | - The current phase of the campaign. - * `STAGED`: The campaign is waiting to be activated. - * `ACTIVE`: The campaign is active. - * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - enum: - - STAGED - - ACTIVE - - SIGNED - example: ACTIVE - CertificationReference: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - example: CERTIFICATION - reviewer: - $ref: '#/components/schemas/Certification/properties/reviewer' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Reviewer.yaml - EntitlementDocument: - description: Entitlement - allOf: - - type: object - required: - - id - - name - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - description: ID of the referenced object. - name: - type: string - example: john.doe - description: The human readable name of the referenced object. - - type: object - properties: - modified: - type: string - description: ISO-8601 date-time referring to the time when the object was last modified. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - synced: - type: string - description: |- - ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. - This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. - There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - displayName: - type: string - description: Entitlement's display name. - example: Admin - source: - type: object - description: Entitlement's source. - properties: - id: - type: string - description: ID of entitlement's source. - example: 2c91808b6e9e6fb8016eec1a2b6f7b5f - name: - type: string - description: Display name of entitlement's source. - example: ODS-HR-Employees - type: - type: string - example: SOURCE - description: Type of object. - segments: - type: array - description: Segments with the entitlement. - items: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/segments/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseSegment.yaml - segmentCount: - type: integer - description: Number of segments with the role. - format: int32 - example: 1 - requestable: - type: boolean - description: Indicates whether the entitlement is requestable. - default: false - example: false - cloudGoverned: - type: boolean - description: Indicates whether the entitlement is cloud governed. - default: false - example: false - created: - type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - privileged: - type: boolean - description: Indicates whether the entitlement is privileged. - default: false - example: false - tags: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml - attribute: - type: string - description: Attribute information for the entitlement. - example: groups - value: - type: string - description: Value of the entitlement. - example: 1733ff75-441e-4327-9bfc-3ac445fd8cd1 - sourceSchemaObjectType: - type: string - description: Source schema object type of the entitlement. - example: group - schema: - type: string - description: Schema type of the entitlement. - example: group - hash: - type: string - description: Read-only calculated hash value of an entitlement. - example: c6fab95235584cca98a454a2f51e5683bc77d6a0 - attributes: - type: object - additionalProperties: true - description: Attributes of the entitlement. - truncatedAttributes: - type: array - description: Truncated attributes of the entitlement. - items: - type: string - containsDataAccess: - type: boolean - description: Indicates whether the entitlement contains data access. - default: false - manuallyUpdatedFields: - type: object - description: Indicates whether the entitlement's display name and/or description have been manually updated. - nullable: true - properties: - DESCRIPTION: - type: boolean - default: false - example: false - DISPLAY_NAME: - type: boolean - default: false - example: false - permissions: - type: array - items: - type: object - properties: - target: - type: string - description: The target the permission would grants rights on. - example: SYS.GV_$TRANSACTION - rights: - type: array - description: All the rights (e.g. actions) that this permission allows on the target - items: - type: string - example: SELECT - EntitlementSummary: - description: EntitlementReference - allOf: - - $ref: '#/components/schemas/AccessProfileSummary/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/Access.yaml - - type: object - properties: - source: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - type: - type: string - description: Type of the access item. - example: ENTITLEMENT - privileged: - type: boolean - example: false - attribute: - type: string - example: memberOf - value: - type: string - example: CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: - type: boolean - example: false - Event: - type: object - description: Event - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - description: ID of the entitlement. - name: - type: string - example: Add Entitlement Passed - description: Name of the entitlement. - created: - type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - synced: - type: string - description: |- - ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. - This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. - There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - example: '2018-06-25T20:22:28.104Z' - action: - type: string - description: Name of the event as it's displayed in audit reports. - example: AddEntitlement - type: - type: string - description: Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - example: ACCESS_ITEM - actor: - type: object - properties: - name: - type: string - description: Name of the actor that generated the event. - example: System - target: - type: object - properties: - name: - type: string - description: Name of the target, or recipient, of the event. - example: Carol.Adams - stack: - type: string - description: The event's stack. - example: tpe - trackingNumber: - type: string - description: ID of the group of events. - example: 63f891e0735f4cc8bf1968144a1e7440 - ipAddress: - type: string - description: Target system's IP address. - example: 52.52.97.85 - details: - type: string - description: ID of event's details. - example: 73b65dfbed1842548c207432a18c84b0 - attributes: - type: object - description: Attributes involved in the event. - additionalProperties: true - example: - pod: stg03-useast1 - org: acme - sourceName: SailPoint - objects: - type: array - description: Objects the event is happening to. - items: - type: string - example: AUTHENTICATION - operation: - type: string - description: Operation, or action, performed during the event. - example: ADD - status: - type: string - description: Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - example: PASSED - technicalName: - type: string - description: Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. - example: ENTITLEMENT_ADD_PASSED - IdentityDocument: - description: Identity - allOf: - - $ref: '#/components/schemas/EntitlementDocument/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseDocument.yaml - - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DisplayReference.yaml - - type: object - properties: - displayName: - type: string - example: Carol.Adams - description: Identity's display name. - firstName: - type: string - description: Identity's first name. - example: Carol - lastName: - type: string - description: Identity's last name. - example: Adams - email: - type: string - description: Identity's primary email address. - example: Carol.Adams@sailpointdemo.com - created: - type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - type: string - description: ISO-8601 date-time referring to the time when the object was last modified. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - phone: - type: string - description: Identity's phone number. - example: +1 440-527-3672 - synced: - type: string - description: |- - ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. - This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. - There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - inactive: - type: boolean - description: Indicates whether the identity is inactive. - default: false - example: false - protected: - type: boolean - description: Indicates whether the identity is protected. - default: false - example: false - status: - type: string - description: Identity's status in SailPoint. - example: UNREGISTERED - employeeNumber: - type: string - description: Identity's employee number. - example: 1a2a3d4e - manager: - type: object - description: Identity's manager. - nullable: true - properties: - id: - type: string - description: ID of identity's manager. - example: 2c9180867dfe694b017e208e27c05799 - name: - type: string - description: Name of identity's manager. - example: Amanda.Ross - displayName: - type: string - description: Display name of identity's manager. - example: Amanda.Ross - isManager: - type: boolean - description: Indicates whether the identity is a manager of other identities. - example: false - identityProfile: - type: object - description: Identity's identity profile. - properties: - id: - type: string - description: Identity profile's ID. - example: 3bc8ad26b8664945866b31339d1ff7d2 - name: - type: string - description: Identity profile's name. - example: HR Employees - source: - type: object - description: Identity's source. - properties: - id: - type: string - description: ID of identity's source. - example: 2c91808b6e9e6fb8016eec1a2b6f7b5f - name: - type: string - description: Display name of identity's source. - example: ODS-HR-Employees - attributes: - type: object - description: Map or dictionary of key/value pairs. - additionalProperties: true - example: - country: US - firstname: Carol - cloudStatus: UNREGISTERED - disabled: - type: boolean - description: Indicates whether the identity is disabled. - default: false - example: false - locked: - type: boolean - description: Indicates whether the identity is locked. - default: false - example: false - processingState: - type: string - description: Identity's processing state. - nullable: true - example: ERROR - processingDetails: - type: object - properties: - date: - $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml - stage: - type: string - example: In Process - retryCount: - type: integer - example: 0 - format: int32 - stackTrace: - type: string - example: - message: - type: string - example: - accounts: - type: array - description: List of accounts associated with the identity. - items: - allOf: - - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - - type: object - properties: - accountId: - type: string - description: Account ID. - example: John.Doe - source: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/AccountSource.yaml - disabled: - type: boolean - description: Indicates whether the account is disabled. - default: false - example: false - locked: - type: boolean - description: Indicates whether the account is locked. - default: false - example: false - privileged: - type: boolean - description: Indicates whether the account is privileged. - default: false - example: false - manuallyCorrelated: - type: boolean - description: Indicates whether the account has been manually correlated to an identity. - default: false - example: false - passwordLastSet: - $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml - entitlementAttributes: - type: object - nullable: true - description: Map or dictionary of key/value pairs. - additionalProperties: true - example: - moderator: true - admin: true - trust_level: '4' - created: - type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - supportsPasswordChange: - type: boolean - description: Indicates whether the account supports password change. - default: false - example: false - accountAttributes: - type: object - nullable: true - description: Map or dictionary of key/value pairs. - additionalProperties: true - example: - type: global - admin: true - trust_level: '4' - accountCount: - type: integer - description: Number of accounts associated with the identity. - format: int32 - example: 3 - apps: - type: array - description: List of applications the identity has access to. - items: - allOf: - - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - - type: object - properties: - source: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - account: - type: object - properties: - id: - type: string - description: The SailPoint generated unique ID - example: 2c9180837dfe6949017e21f3d8cd6d49 - accountId: - type: string - description: The account ID generated by the source - example: CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - appCount: - type: integer - format: int32 - description: Number of applications the identity has access to. - example: 2 - access: - type: array - description: List of access items assigned to the identity. - items: - discriminator: - propertyName: type - mapping: - ACCESS_PROFILE: ../access/AccessProfileSummary.yaml - ENTITLEMENT: ../access/AccessProfileEntitlement.yaml - ROLE: ../access/AccessProfileRole.yaml - oneOf: - - description: This is a summary representation of an access profile. - allOf: - - $ref: '#/components/schemas/AccessProfileSummary/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/Access.yaml - - type: object - properties: - type: - type: string - description: Type of the access item. - example: ACCESS_PROFILE - source: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - owner: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DisplayReference.yaml - revocable: - type: boolean - example: true - - description: EntitlementReference - allOf: - - $ref: '#/components/schemas/AccessProfileSummary/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/Access.yaml - - type: object - properties: - source: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - type: - type: string - description: Type of the access item. - example: ENTITLEMENT - privileged: - type: boolean - example: false - attribute: - type: string - example: memberOf - value: - type: string - example: CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: - type: boolean - example: false - - description: Role - allOf: - - $ref: '#/components/schemas/AccessProfileSummary/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/Access.yaml - - type: object - properties: - type: - type: string - description: Type of the access item. - example: ROLE - owner: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DisplayReference.yaml - disabled: - type: boolean - revocable: - type: boolean - accessCount: - type: integer - format: int32 - description: Number of access items assigned to the identity. - example: 5 - entitlementCount: - type: integer - format: int32 - description: Number of entitlements assigned to the identity. - example: 10 - roleCount: - type: integer - format: int32 - description: Number of roles assigned to the identity. - example: 1 - accessProfileCount: - type: integer - format: int32 - description: Number of access profiles assigned to the identity. - example: 1 - owns: - type: array - description: Access items the identity owns. - items: - type: object - properties: - sources: - type: array - items: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - entitlements: - type: array - items: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - accessProfiles: - type: array - items: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - roles: - type: array - items: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - apps: - type: array - items: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - governanceGroups: - type: array - items: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - fallbackApprover: - type: boolean - example: false - ownsCount: - type: integer - format: int32 - description: Number of access items the identity owns. - example: 5 - tags: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml - tagsCount: - type: integer - format: int32 - description: Number of tags on the identity. - visibleSegments: - type: array - description: List of segments that the identity is in. - items: - type: string - nullable: true - example: - - All Employees - visibleSegmentCount: - type: integer - format: int32 - description: Number of segments the identity is in. - example: 1 - IdentityProfile: - allOf: - - $ref: '#/components/schemas/Account/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - - type: object - required: - - authoritativeSource - properties: - description: - type: string - description: Identity profile's description. - example: My custom flat file profile - nullable: true - owner: - type: object - description: Identity profile's owner. - nullable: true - properties: - type: - type: string - enum: - - IDENTITY - description: Owner's object type. - example: IDENTITY - id: - type: string - description: Owner's ID. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Owner's name. - example: William Wilson - priority: - type: integer - format: int64 - description: Identity profile's priority. - example: 10 - authoritativeSource: - type: object - properties: - type: - type: string - enum: - - SOURCE - description: Authoritative source's object type. - example: SOURCE - id: - type: string - description: Authoritative source's ID. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Authoritative source's name. - example: HR Active Directory - identityRefreshRequired: - type: boolean - default: false - description: Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. - example: true - identityCount: - type: integer - description: Number of identities belonging to the identity profile. - format: int32 - example: 8 - identityAttributeConfig: - type: object - description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - properties: - enabled: - description: Backend will only promote values if the profile/mapping is enabled. - type: boolean - default: false - example: true - attributeTransforms: - type: array - items: - type: object - description: Transform definition for an identity attribute. - properties: - identityAttributeName: - type: string - description: Identity attribute's name. - example: email - transformDefinition: - type: object - properties: - type: - type: string - description: Transform definition type. - example: accountAttribute - attributes: - type: object - additionalProperties: true - description: Arbitrary key-value pairs to store any metadata for the object - example: - attributeName: e-mail - sourceName: MySource - sourceId: 2c9180877a826e68017a8c0b03da1a53 - identityExceptionReportReference: - type: object - nullable: true - properties: - taskResultId: - type: string - format: uuid - description: Task result ID. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - reportName: - type: string - example: My annual report - description: Report name. - hasTimeBasedAttr: - description: Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. - type: boolean - default: false - example: true - IdentityReferenceWithNameAndEmail: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only. - example: IDENTITY - id: - type: string - description: Identity ID. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Identity's human-readable display name. This is read-only. - example: Alison Ferguso - email: - type: string - nullable: true - description: Identity's email address. This is read-only. - example: alison.ferguso@identitysoon.com - ProvisioningConfig: - type: object - description: Specification of a Service Desk integration provisioning configuration. - properties: - universalManager: - description: Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. - type: boolean - readOnly: true - default: false - example: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - allOf: - - type: object - description: Source for Service Desk integration template. - properties: - type: - type: string - description: DTO type of source for service desk integration template. - enum: - - SOURCE - example: SOURCE - id: - type: string - description: ID of source for service desk integration template. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable name of source for service desk integration template. - example: HR Active Directory - example: - - type: SOURCE - id: 2c9180855d191c59015d291ceb051111 - name: My Source 1 - - type: SOURCE - id: 2c9180855d191c59015d291ceb052222 - name: My Source 2 - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - nullable: true - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - example: | - \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n - noProvisioningRequests: - description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - type: boolean - default: false - example: true - provisioningRequestExpiration: - description: When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. - type: integer - format: int32 - example: 7 - ProvisioningPolicy: - type: object - required: - - name - properties: - name: - type: string - description: the provisioning policy name - example: example provisioning policy for inactive identities - description: - type: string - description: the description of the provisioning policy - example: this provisioning policy creates access based on an identity going inactive - usageType: - type: string - nullable: false - enum: - - CREATE - - UPDATE - - ENABLE - - DISABLE - - DELETE - - ASSIGN - - UNASSIGN - - CREATE_GROUP - - UPDATE_GROUP - - DELETE_GROUP - - REGISTER - - CREATE_IDENTITY - - UPDATE_IDENTITY - - EDIT_GROUP - - UNLOCK - - CHANGE_PASSWORD - example: CREATE - description: |- - The type of provisioning policy usage. - In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. - These are the common usage types: - CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. - UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. - ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. - DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. - You can use these four usage types for all your provisioning policy needs. - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the attribute. - example: userName - transform: - type: object - description: The transform to apply to the field - example: - type: rule - attributes: - name: Create Unique LDAP Attribute - default: {} - attributes: - type: object - description: Attributes required for the transform - example: - template: ${firstname}.${lastname}${uniqueCounter} - cloudMaxUniqueChecks: '50' - cloudMaxSize: '20' - cloudRequired: 'true' - isRequired: - type: boolean - readOnly: true - description: Flag indicating whether or not the attribute is required. - default: false - example: false - type: - type: string - description: The type of the attribute. - example: string - isMultiValued: - type: boolean - description: Flag indicating whether or not the attribute is multi-valued. - default: false - example: false - QueuedCheckConfigDetails: - description: Configuration of maximum number of days and interval for checking Service Desk integration queue status. - required: - - provisioningStatusCheckIntervalMinutes - - provisioningMaxStatusCheckDays - type: object - properties: - provisioningStatusCheckIntervalMinutes: - description: Interval in minutes between status checks - type: string - example: 30 - provisioningMaxStatusCheckDays: - description: Maximum number of days to check - type: string - example: 2 - Reassignment: - type: object - nullable: true - properties: - from: - type: object - properties: - id: - type: string - description: The id of the certification. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the certification. - example: Certification Name - type: - type: string - enum: - - CERTIFICATION - example: CERTIFICATION - reviewer: - $ref: '#/components/schemas/Certification/properties/reviewer' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Reviewer.yaml - comment: - type: string - description: The comment entered when the Certification was reassigned - example: Reassigned for a reason - ReassignmentReference: - type: object - properties: - id: - type: string - description: The ID of item or identity being reassigned. - example: ef38f94347e94562b5bb8424a56397d8 - type: - type: string - description: The type of item or identity being reassigned. - enum: - - TARGET_SUMMARY - - ITEM - - IDENTITY_SUMMARY - example: ITEM - required: - - id - - type - RemediationItems: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - RequestableObject: - type: object - properties: - id: - type: string - description: Id of the requestable object itself - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Human-readable display name of the requestable object - example: Applied Research Access - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - description: The time when the requestable object was created - modified: - nullable: true - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: The time when the requestable object was last modified - description: - type: string - description: Description of the requestable object. - example: Access to research information, lab results, and schematics. - nullable: true - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: Currently supported requestable object types. - example: ACCESS_PROFILE - requestStatus: - allOf: - - type: string - enum: - - AVAILABLE - - PENDING - - ASSIGNED - - null - description: Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results. - example: AVAILABLE - - nullable: true - identityRequestId: - type: string - description: If *requestStatus* is *PENDING*, indicates the id of the associated account activity. - nullable: true - example: null - ownerRef: - type: object - nullable: true - properties: - type: - type: string - description: The type can only be IDENTITY. This is read-only. - example: IDENTITY - id: - type: string - description: Identity ID. - example: 5168015d32f890ca15812c9180835d2e - name: - type: string - description: Identity's human-readable display name. This is read-only. - example: Alison Ferguso - email: - type: string - nullable: true - description: Identity's email address. This is read-only. - example: alison.ferguso@identitysoon.com - requestCommentsRequired: - type: boolean - description: Whether the requester must provide comments when requesting the object. - example: false - RequestableObjectType: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: Currently supported requestable object types. - example: ACCESS_PROFILE - RequestableObjectRequestStatus: - type: string - enum: - - AVAILABLE - - PENDING - - ASSIGNED - - null - description: Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results. - example: AVAILABLE - Reviewer: - type: object - properties: - id: - type: string - description: The id of the reviewer. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the reviewer. - example: Reviewer Name - email: - type: string - description: The email of the reviewing identity. - example: reviewer@test.com - type: - type: string - enum: - - IDENTITY - description: The type of the reviewing identity. - example: IDENTITY - created: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The created date of the reviewing identity. - modified: - nullable: true - example: '2018-06-25T20:22:28.104Z' - format: date-time - type: string - description: The modified date of the reviewing identity. - RoleDocument: - description: Role - allOf: - - $ref: '#/components/schemas/AccessProfileDocument/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/BaseAccess.yaml - - type: object - required: - - id - - name - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - description: ID of the role. - name: - type: string - example: Branch Manager Access - description: Name of the role. - accessProfiles: - type: array - description: Access profiles included with the role. - nullable: true - items: - type: object - properties: - id: - type: string - example: 2c91809c6faade77016fb4f0b63407ae - description: Access profile's unique ID. - name: - type: string - example: Admin Access - description: Access profile's display name. - accessProfileCount: - type: integer - description: Number of access profiles included with the role. - nullable: true - format: int32 - example: 1 - tags: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml - segments: - type: array - description: Segments with the role. - nullable: true - items: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/segments/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseSegment.yaml - segmentCount: - type: integer - description: Number of segments with the role. - nullable: true - format: int32 - example: 1 - entitlements: - type: array - description: Entitlements included with the role. - nullable: true - items: - allOf: - - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/entitlement/BaseEntitlement.yaml - - properties: - sourceSchemaObjectType: - type: string - description: Schema objectType. - example: group - hash: - type: string - description: Read-only calculated hash value of an entitlement. - example: c6fab95235584cca98a454a2f51e5683bc77d6a0 - entitlementCount: - type: integer - description: Number of entitlements included with the role. - nullable: true - format: int32 - example: 3 - dimensional: - type: boolean - example: false - default: false - dimensionSchemaAttributeCount: - type: integer - description: Number of dimension attributes included with the role. - nullable: true - format: int32 - example: 3 - dimensionSchemaAttributes: - type: array - description: Dimension attributes included with the role. - nullable: true - items: - type: object - properties: - derived: - type: boolean - example: true - default: true - displayName: - type: string - description: Displayname of the dimension attribute. - example: Department - name: - type: string - description: Name of the dimension attribute. - example: department - dimensions: - type: array - nullable: true - items: - type: object - properties: - id: - type: string - description: Unique ID of the dimension. - example: b3c28992ba964a40a7598978139d1ced - name: - type: string - description: Name of the dimension. - example: Manager Austin Branch - description: - type: string - nullable: true - description: Description of the dimension. - example: Managers located at the Austin branch - entitlements: - type: array - description: Entitlements included with the role. - nullable: true - items: - allOf: - - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/entitlement/BaseEntitlement.yaml - - properties: - sourceSchemaObjectType: - type: string - description: Schema objectType. - example: group - hash: - type: string - description: Read-only calculated hash value of an entitlement. - example: c6fab95235584cca98a454a2f51e5683bc77d6a0 - accessProfiles: - type: array - nullable: true - description: Access profiles included in the dimension. - items: - $ref: '#/components/schemas/RoleDocument/allOf/1/properties/accessProfiles/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseAccessProfile.yaml - RoleSummary: - description: Role - allOf: - - $ref: '#/components/schemas/AccessProfileSummary/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/Access.yaml - - type: object - properties: - type: - type: string - description: Type of the access item. - example: ROLE - owner: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DisplayReference.yaml - disabled: - type: boolean - revocable: - type: boolean - SearchDocument: - type: object - oneOf: - - description: 'More complete representation of an access profile. ' - allOf: - - $ref: '#/components/schemas/AccessProfileDocument/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/BaseAccess.yaml - - type: object - required: - - id - - name - properties: - id: - type: string - description: Access profile's ID. - example: 2c9180825a6c1adc015a71c9023f0818 - name: - type: string - description: Access profile's name. - example: Cloud Eng - source: - type: object - description: Access profile's source. - properties: - id: - type: string - description: Source's ID. - example: ff8081815757d4fb0157588f3d9d008f - name: - type: string - description: Source's name. - example: Employees - entitlements: - type: array - description: Entitlements the access profile has access to. - items: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/entitlement/BaseEntitlement.yaml - entitlementCount: - type: integer - description: Number of entitlements. - example: 5 - segments: - type: array - description: Segments with the access profile. - items: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/segments/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseSegment.yaml - segmentCount: - type: integer - description: Number of segments with the access profile. - format: int32 - example: 1 - tags: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml - apps: - type: array - description: Applications with the access profile - items: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/apps/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/AccessApps.yaml - - description: AccountActivity - type: object - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - description: ID of account activity. - action: - type: string - description: Type of action performed in the activity. - externalDocs: - description: Learn more about account activity action types - url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data - example: Identity Refresh. - created: - type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - type: string - description: ISO-8601 date-time referring to the time when the object was last modified. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - synced: - type: string - description: |- - ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. - This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. - There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - example: '2018-06-25T20:22:28.104Z' - stage: - type: string - description: Activity's current stage. - example: Completed - status: - type: string - description: Activity's current status. - example: Complete - requester: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/requester' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/ActivityIdentity.yaml - recipient: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/requester' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/ActivityIdentity.yaml - trackingNumber: - type: string - description: Account activity's tracking number. - example: 61aad0c9e8134eca89e76a35e0cabe3f - errors: - type: array - description: Errors provided by the source while completing account actions. - items: - type: string - nullable: true - example: null - warnings: - type: array - description: Warnings provided by the source while completing account actions. - items: - type: string - nullable: true - example: null - approvals: - type: array - description: Approvals performed on an item during activity. - items: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/Approval.yaml - originalRequests: - type: array - description: Original actions that triggered all individual source actions related to the account action. - items: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/originalRequests/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/OriginalRequest.yaml - expansionItems: - type: array - description: Controls that translated the attribute requests into actual provisioning actions on the source. - items: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/expansionItems/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/ExpansionItem.yaml - accountRequests: - type: array - description: Account data for each individual source action triggered by the original requests. - items: - $ref: '#/components/schemas/AccountActivitySearchedItem/properties/accountRequests/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/AccountRequest.yaml - sources: - type: string - description: Sources involved in the account activity. - example: smartsheet-test, airtable-v4, IdentityNow - - description: Entitlement - allOf: - - $ref: '#/components/schemas/EntitlementDocument/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseDocument.yaml - - type: object - properties: - modified: - type: string - description: ISO-8601 date-time referring to the time when the object was last modified. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - synced: - type: string - description: |- - ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. - This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. - There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - displayName: - type: string - description: Entitlement's display name. - example: Admin - source: - type: object - description: Entitlement's source. - properties: - id: - type: string - description: ID of entitlement's source. - example: 2c91808b6e9e6fb8016eec1a2b6f7b5f - name: - type: string - description: Display name of entitlement's source. - example: ODS-HR-Employees - type: - type: string - example: SOURCE - description: Type of object. - segments: - type: array - description: Segments with the entitlement. - items: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/segments/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseSegment.yaml - segmentCount: - type: integer - description: Number of segments with the role. - format: int32 - example: 1 - requestable: - type: boolean - description: Indicates whether the entitlement is requestable. - default: false - example: false - cloudGoverned: - type: boolean - description: Indicates whether the entitlement is cloud governed. - default: false - example: false - created: - type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - privileged: - type: boolean - description: Indicates whether the entitlement is privileged. - default: false - example: false - tags: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml - attribute: - type: string - description: Attribute information for the entitlement. - example: groups - value: - type: string - description: Value of the entitlement. - example: 1733ff75-441e-4327-9bfc-3ac445fd8cd1 - sourceSchemaObjectType: - type: string - description: Source schema object type of the entitlement. - example: group - schema: - type: string - description: Schema type of the entitlement. - example: group - hash: - type: string - description: Read-only calculated hash value of an entitlement. - example: c6fab95235584cca98a454a2f51e5683bc77d6a0 - attributes: - type: object - additionalProperties: true - description: Attributes of the entitlement. - truncatedAttributes: - type: array - description: Truncated attributes of the entitlement. - items: - type: string - containsDataAccess: - type: boolean - description: Indicates whether the entitlement contains data access. - default: false - manuallyUpdatedFields: - type: object - description: Indicates whether the entitlement's display name and/or description have been manually updated. - nullable: true - properties: - DESCRIPTION: - type: boolean - default: false - example: false - DISPLAY_NAME: - type: boolean - default: false - example: false - permissions: - type: array - items: - type: object - properties: - target: - type: string - description: The target the permission would grants rights on. - example: SYS.GV_$TRANSACTION - rights: - type: array - description: All the rights (e.g. actions) that this permission allows on the target - items: - type: string - example: SELECT - - type: object - description: Event - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - description: ID of the entitlement. - name: - type: string - example: Add Entitlement Passed - description: Name of the entitlement. - created: - type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - synced: - type: string - description: |- - ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. - This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. - There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - example: '2018-06-25T20:22:28.104Z' - action: - type: string - description: Name of the event as it's displayed in audit reports. - example: AddEntitlement - type: - type: string - description: Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - example: ACCESS_ITEM - actor: - type: object - properties: - name: - type: string - description: Name of the actor that generated the event. - example: System - target: - type: object - properties: - name: - type: string - description: Name of the target, or recipient, of the event. - example: Carol.Adams - stack: - type: string - description: The event's stack. - example: tpe - trackingNumber: - type: string - description: ID of the group of events. - example: 63f891e0735f4cc8bf1968144a1e7440 - ipAddress: - type: string - description: Target system's IP address. - example: 52.52.97.85 - details: - type: string - description: ID of event's details. - example: 73b65dfbed1842548c207432a18c84b0 - attributes: - type: object - description: Attributes involved in the event. - additionalProperties: true - example: - pod: stg03-useast1 - org: acme - sourceName: SailPoint - objects: - type: array - description: Objects the event is happening to. - items: - type: string - example: AUTHENTICATION - operation: - type: string - description: Operation, or action, performed during the event. - example: ADD - status: - type: string - description: Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - example: PASSED - technicalName: - type: string - description: Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. - example: ENTITLEMENT_ADD_PASSED - - description: Identity - allOf: - - $ref: '#/components/schemas/EntitlementDocument/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseDocument.yaml - - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DisplayReference.yaml - - type: object - properties: - displayName: - type: string - example: Carol.Adams - description: Identity's display name. - firstName: - type: string - description: Identity's first name. - example: Carol - lastName: - type: string - description: Identity's last name. - example: Adams - email: - type: string - description: Identity's primary email address. - example: Carol.Adams@sailpointdemo.com - created: - type: string - description: ISO-8601 date-time referring to the time when the object was created. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - modified: - type: string - description: ISO-8601 date-time referring to the time when the object was last modified. - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - phone: - type: string - description: Identity's phone number. - example: +1 440-527-3672 - synced: - type: string - description: |- - ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. - This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. - There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - inactive: - type: boolean - description: Indicates whether the identity is inactive. - default: false - example: false - protected: - type: boolean - description: Indicates whether the identity is protected. - default: false - example: false - status: - type: string - description: Identity's status in SailPoint. - example: UNREGISTERED - employeeNumber: - type: string - description: Identity's employee number. - example: 1a2a3d4e - manager: - type: object - description: Identity's manager. - nullable: true - properties: - id: - type: string - description: ID of identity's manager. - example: 2c9180867dfe694b017e208e27c05799 - name: - type: string - description: Name of identity's manager. - example: Amanda.Ross - displayName: - type: string - description: Display name of identity's manager. - example: Amanda.Ross - isManager: - type: boolean - description: Indicates whether the identity is a manager of other identities. - example: false - identityProfile: - type: object - description: Identity's identity profile. - properties: - id: - type: string - description: Identity profile's ID. - example: 3bc8ad26b8664945866b31339d1ff7d2 - name: - type: string - description: Identity profile's name. - example: HR Employees - source: - type: object - description: Identity's source. - properties: - id: - type: string - description: ID of identity's source. - example: 2c91808b6e9e6fb8016eec1a2b6f7b5f - name: - type: string - description: Display name of identity's source. - example: ODS-HR-Employees - attributes: - type: object - description: Map or dictionary of key/value pairs. - additionalProperties: true - example: - country: US - firstname: Carol - cloudStatus: UNREGISTERED - disabled: - type: boolean - description: Indicates whether the identity is disabled. - default: false - example: false - locked: - type: boolean - description: Indicates whether the identity is locked. - default: false - example: false - processingState: - type: string - description: Identity's processing state. - nullable: true - example: ERROR - processingDetails: - $ref: '#/components/schemas/IdentityDocument/allOf/2/properties/processingDetails' - description: Identity's processing details. - nullable: true - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/identity/ProcessingDetails.yaml - accounts: - type: array - description: List of accounts associated with the identity. - items: - $ref: '#/components/schemas/IdentityDocument/allOf/2/properties/accounts/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/BaseAccount.yaml - accountCount: - type: integer - description: Number of accounts associated with the identity. - format: int32 - example: 3 - apps: - type: array - description: List of applications the identity has access to. - items: - $ref: '#/components/schemas/IdentityDocument/allOf/2/properties/apps/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/identity/App.yaml - appCount: - type: integer - format: int32 - description: Number of applications the identity has access to. - example: 2 - access: - type: array - description: List of access items assigned to the identity. - items: - $ref: '#/components/schemas/IdentityDocument/allOf/2/properties/access/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/identity/IdentityAccess.yaml - accessCount: - type: integer - format: int32 - description: Number of access items assigned to the identity. - example: 5 - entitlementCount: - type: integer - format: int32 - description: Number of entitlements assigned to the identity. - example: 10 - roleCount: - type: integer - format: int32 - description: Number of roles assigned to the identity. - example: 1 - accessProfileCount: - type: integer - format: int32 - description: Number of access profiles assigned to the identity. - example: 1 - owns: - type: array - description: Access items the identity owns. - items: - $ref: '#/components/schemas/IdentityDocument/allOf/2/properties/owns/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/identity/Owns.yaml - ownsCount: - type: integer - format: int32 - description: Number of access items the identity owns. - example: 5 - tags: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml - tagsCount: - type: integer - format: int32 - description: Number of tags on the identity. - visibleSegments: - type: array - description: List of segments that the identity is in. - items: - type: string - nullable: true - example: - - All Employees - visibleSegmentCount: - type: integer - format: int32 - description: Number of segments the identity is in. - example: 1 - - description: Role - allOf: - - $ref: '#/components/schemas/AccessProfileDocument/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/BaseAccess.yaml - - type: object - required: - - id - - name - properties: - id: - type: string - example: 2c91808375d8e80a0175e1f88a575222 - description: ID of the role. - name: - type: string - example: Branch Manager Access - description: Name of the role. - accessProfiles: - type: array - description: Access profiles included with the role. - nullable: true - items: - $ref: '#/components/schemas/RoleDocument/allOf/1/properties/accessProfiles/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseAccessProfile.yaml - accessProfileCount: - type: integer - description: Number of access profiles included with the role. - nullable: true - format: int32 - example: 1 - tags: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - nullable: true - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml - segments: - type: array - description: Segments with the role. - nullable: true - items: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/segments/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseSegment.yaml - segmentCount: - type: integer - description: Number of segments with the role. - nullable: true - format: int32 - example: 1 - entitlements: - type: array - description: Entitlements included with the role. - nullable: true - items: - allOf: - - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/entitlement/BaseEntitlement.yaml - - properties: - sourceSchemaObjectType: - type: string - description: Schema objectType. - example: group - hash: - type: string - description: Read-only calculated hash value of an entitlement. - example: c6fab95235584cca98a454a2f51e5683bc77d6a0 - entitlementCount: - type: integer - description: Number of entitlements included with the role. - nullable: true - format: int32 - example: 3 - dimensional: - type: boolean - example: false - default: false - dimensionSchemaAttributeCount: - type: integer - description: Number of dimension attributes included with the role. - nullable: true - format: int32 - example: 3 - dimensionSchemaAttributes: - type: array - description: Dimension attributes included with the role. - nullable: true - items: - type: object - properties: - derived: - type: boolean - example: true - default: true - displayName: - type: string - description: Displayname of the dimension attribute. - example: Department - name: - type: string - description: Name of the dimension attribute. - example: department - dimensions: - type: array - nullable: true - items: - type: object - properties: - id: - type: string - description: Unique ID of the dimension. - example: b3c28992ba964a40a7598978139d1ced - name: - type: string - description: Name of the dimension. - example: Manager Austin Branch - description: - type: string - nullable: true - description: Description of the dimension. - example: Managers located at the Austin branch - entitlements: - type: array - description: Entitlements included with the role. - nullable: true - items: - allOf: - - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/entitlement/BaseEntitlement.yaml - - properties: - sourceSchemaObjectType: - type: string - description: Schema objectType. - example: group - hash: - type: string - description: Read-only calculated hash value of an entitlement. - example: c6fab95235584cca98a454a2f51e5683bc77d6a0 - accessProfiles: - type: array - nullable: true - description: Access profiles included in the dimension. - items: - $ref: '#/components/schemas/RoleDocument/allOf/1/properties/accessProfiles/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseAccessProfile.yaml - SavedSearch: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - type: object - description: | - A typed reference to the object. - properties: - type: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml - id: - description: | - The id of the object. - type: string - example: 2c91808568c529c60168cca6f90c1313 - required: - - type - - id - ownerId: - type: string - description: The ID of the identity that owns this saved search. - example: 2c91808568c529c60168cca6f90c1313 - public: - type: boolean - description: Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. - default: false - example: false - - type: object - properties: - name: - description: | - The name of the saved search. - type: string - example: Disabled accounts - description: - description: | - The description of the saved search. - type: string - nullable: true - example: Disabled accounts - - type: object - properties: - created: - description: | - The date the saved search was initially created. - $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml - modified: - description: | - The last date the saved search was modified. - $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml - indices: - description: | - The names of the Elasticsearch indices in which to search. - type: array - items: - description: |- - Enum representing the currently supported indices. - Additional values may be added in the future without notice. - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - - '*' - example: identities - example: - - identities - columns: - description: | - The columns to be returned (specifies the order in which they will be presented) for each document type. - - The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - type: object - additionalProperties: - type: array - items: - type: object - properties: - field: - description: | - The name of the field. - type: string - example: email - header: - description: | - The value of the header. - type: string - example: Work Email - required: - - field - example: - identity: - - field: displayName - header: Display Name - - field: e-mail - header: Work Email - query: - description: | - The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - type: string - example: '@accounts(disabled:true)' - fields: - description: | - The fields to be searched against in a multi-field query. - type: array - nullable: true - items: - type: string - example: - - disabled - orderBy: - description: | - Sort by index. This takes precedence over the `sort` property. - type: object - additionalProperties: - type: array - items: - type: string - nullable: true - example: - identity: - - lastName - - firstName - role: - - name - sort: - description: | - The fields to be used to sort the search results. - type: array - items: - type: string - example: - - displayName - nullable: true - filters: - nullable: true - allOf: - - type: object - description: The filters to be applied for each filtered field name. - example: - attributes.cloudAuthoritativeSource: - type: EXISTS - exclude: true - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2019-12-01' - inclusive: true - upper: - value: '2020-01-01' - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - protected: - type: TERMS - terms: - - 'true' - - type: object - properties: - type: - description: |- - Enum representing the currently supported filter types. - Additional values may be added in the future without notice. - type: string - enum: - - EXISTS - - RANGE - - TERMS - example: RANGE - range: - type: object - description: The range of values to be filtered. - properties: - lower: - type: object - required: - - value - properties: - value: - description: The value of the range's endpoint. - type: string - example: '1' - inclusive: - description: Indicates if the endpoint is included in the range. - type: boolean - default: false - example: false - upper: - $ref: '#/components/schemas/SavedSearch/allOf/2/properties/filters/allOf/1/properties/range/properties/lower' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/filter/Bound.yaml - terms: - description: The terms to be filtered. - type: array - items: - type: string - example: account_count - exclude: - description: Indicates if the filter excludes results. - type: boolean - default: false - example: false - required: - - indices - - query - Schedule: - type: object - description: The schedule information. - properties: - type: - description: | - Enum representing the currently supported schedule types. - - Additional values may be added in the future without notice. - type: string - enum: - - DAILY - - WEEKLY - - MONTHLY - - CALENDAR - - ANNUALLY - example: WEEKLY - months: - allOf: - - type: object - properties: - type: - description: | - Enum representing the currently supported selector types. - - LIST - the *values* array contains one or more distinct values. - - RANGE - the *values* array contains two values: the start and end of the range, inclusive. - - Additional values may be added in the future without notice. - type: string - enum: - - LIST - - RANGE - example: LIST - values: - description: | - The selected values. - type: array - items: - type: string - example: - - MON - - WED - interval: - nullable: true - description: | - The selected interval for RANGE selectors. - type: integer - format: int32 - example: 3 - required: - - type - - values - - description: | - The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. - example: - type: LIST - values: - - '3' - - '6' - - '9' - - '12' - nullable: true - days: - allOf: - - $ref: '#/components/schemas/Schedule/properties/months/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/Selector.yaml - - description: | - The days to execute the search. - - If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. - - If `type` is `MONTHLY` or `ANNUALLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. - example: - type: LIST - values: - - MON - - WED - - FRI - nullable: true - hours: - allOf: - - $ref: '#/components/schemas/Schedule/properties/months/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/Selector.yaml - - description: The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - expiration: - type: string - nullable: true - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: A date-time in ISO-8601 format - timeZoneId: - description: The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. - nullable: true - type: string - example: America/Chicago - required: - - type - - hours - ScheduledSearch: - type: object - allOf: - - type: object - properties: - id: - description: The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - readOnly: true - owner: - description: The owner of the scheduled search - readOnly: true - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - ownerId: - description: | - The ID of the scheduled search owner. - - Please use the `id` in the `owner` object instead. - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - readOnly: true - deprecated: true - - type: object - properties: - name: - description: | - The name of the scheduled search. - type: string - example: Daily disabled accounts - nullable: true - description: - description: | - The description of the scheduled search. - type: string - nullable: true - example: Daily disabled accounts - - type: object - properties: - savedSearchId: - description: The ID of the saved search that will be executed. - type: string - example: 554f1511-f0a1-4744-ab14-599514d3e57c - created: - allOf: - - $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml - description: The date the scheduled search was initially created. - readOnly: true - modified: - allOf: - - $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml - description: The last date the scheduled search was modified. - readOnly: true - schedule: - type: object - description: The schedule information. - properties: - type: - $ref: '#/components/schemas/Schedule/properties/type' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/ScheduleType.yaml - months: - allOf: - - $ref: '#/components/schemas/Schedule/properties/months/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/Selector.yaml - - description: | - The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. - example: - type: LIST - values: - - '3' - - '6' - - '9' - - '12' - nullable: true - days: - allOf: - - $ref: '#/components/schemas/Schedule/properties/months/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/Selector.yaml - - description: | - The days to execute the search. - - If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. - - If `type` is `MONTHLY` or `ANNUALLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. - example: - type: LIST - values: - - MON - - WED - - FRI - nullable: true - hours: - allOf: - - $ref: '#/components/schemas/Schedule/properties/months/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/Selector.yaml - - description: The hours selected. - example: - type: RANGE - values: - - '9' - - '18' - interval: 3 - expiration: - description: The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000' - $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml - timeZoneId: - description: The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. - nullable: true - type: string - example: America/Chicago - required: - - type - - hours - recipients: - description: A list of identities that should receive the scheduled search report via email. - type: array - items: - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - enabled: - description: | - Indicates if the scheduled search is enabled. - type: boolean - default: false - example: false - emailEmptyResults: - description: | - Indicates if email generation should occur when search returns no results. - type: boolean - default: false - example: false - displayQueryDetails: - description: | - Indicates if the generated email should include the query and search results preview (which could include PII). - type: boolean - default: false - example: false - required: - - savedSearchId - - schedule - - recipients - required: - - id - - owner - - ownerId - ServiceDeskIntegrationDto: - allOf: - - type: object - description: Service Desk integration's specification. - required: - - name - - description - - type - - attributes - properties: - id: - type: string - description: Unique identifier for the Service Desk integration - example: 62945a496ef440189b1f03e3623411c8 - name: - description: Service Desk integration's name. The name must be unique. - type: string - example: Service Desk Integration Name - created: - type: string - format: date-time - description: The date and time the Service Desk integration was created - example: '2024-01-17T18:45:25.994Z' - modified: - type: string - format: date-time - description: The date and time the Service Desk integration was last modified - example: '2024-02-18T18:45:25.994Z' - description: - description: Service Desk integration's description. - type: string - example: A very nice Service Desk integration - type: - description: | - Service Desk integration types: - - - ServiceNowSDIM - - ServiceNow - type: string - default: ServiceNowSDIM - example: ServiceNowSDIM - ownerRef: - allOf: - - type: object - description: Owner's identity. - properties: - type: - type: string - description: Owner's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Owner's identity ID. - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Owner's name. - example: Support - clusterRef: - allOf: - - type: object - description: Source cluster. - properties: - type: - type: string - description: Source cluster DTO type. - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: Source cluster ID. - example: 2c9180847a7fccdd017aa5896f9f4f6f - name: - type: string - description: Source cluster display name. - example: Training VA - cluster: - description: Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). - type: string - example: xyzzy999 - deprecated: true - nullable: true - managedSources: - description: Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). - type: array - items: - type: string - deprecated: true - example: - - 2c9180835d191a86015d28455b4a2329 - - 2c5680835d191a85765d28455b4a9823 - provisioningConfig: - type: object - description: Specification of a Service Desk integration provisioning configuration. - properties: - universalManager: - description: Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. - type: boolean - readOnly: true - default: false - example: true - managedResourceRefs: - description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. - type: array - items: - allOf: - - $ref: '#/components/schemas/ProvisioningConfig/properties/managedResourceRefs/items/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskSource.yaml - example: - - type: SOURCE - id: 2c9180855d191c59015d291ceb051111 - name: My Source 1 - - type: SOURCE - id: 2c9180855d191c59015d291ceb052222 - name: My Source 2 - planInitializerScript: - description: This is a reference to a plan initializer script. - type: object - nullable: true - properties: - source: - description: This is a Rule that allows provisioning instruction changes. - type: string - example: | - \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n - noProvisioningRequests: - description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - type: boolean - default: false - example: true - provisioningRequestExpiration: - description: When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. - type: integer - format: int32 - example: 7 - attributes: - description: Service Desk integration's attributes. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - example: - property: value - key: value - beforeProvisioningRule: - allOf: - - type: object - description: Before Provisioning Rule. - properties: - type: - type: string - description: Before Provisioning Rule DTO type. - enum: - - RULE - example: RULE - id: - type: string - description: Before Provisioning Rule ID. - example: 048eb3d55c5a4758bd07dccb87741c78 - name: - type: string - description: Rule display name. - example: Before Provisioning Airtable Rule - ServiceDeskIntegrationTemplateDto: - allOf: - - $ref: '#/components/schemas/Account/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - - type: object - description: This is the model for a Service Desk integration template, used to create and edit Service Desk Integrations. - required: - - type - - attributes - - provisioningConfig - properties: - type: - description: The 'type' property specifies the type of the Service Desk integration template. - type: string - example: Web Service SDIM - default: Web Service SDIM - attributes: - description: The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. - type: object - additionalProperties: true - example: - property: value - key: value - provisioningConfig: - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/provisioningConfig' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningConfig.yaml - ServiceDeskIntegrationTemplateType: - description: This represents a Service Desk Integration template type. - required: - - type - - scriptName - type: object - properties: - name: - description: This is the name of the type. - example: aName - type: string - type: - description: This is the type value for the type. - example: aType - type: string - scriptName: - description: This is the scriptName attribute value for the type. - example: aScriptName - type: string - Source: - type: object - properties: - id: - type: string - readOnly: true - description: Source ID. - example: 2c91808568c529c60168cca6f90c1324 - name: - type: string - description: Source's human-readable name. - example: My Source - description: - type: string - description: Source's human-readable description. - example: This is the corporate directory. - owner: - description: Reference to identity object who owns the source. - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Owner identity's ID. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Owner identity's human-readable display name. - example: MyName - cluster: - description: Reference to the source's associated cluster. - type: object - nullable: true - required: - - name - - id - - type - properties: - type: - description: Type of object being referenced. - type: string - enum: - - CLUSTER - example: CLUSTER - id: - type: string - description: Cluster ID. - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Cluster's human-readable display name. - example: Corporate Cluster - accountCorrelationConfig: - description: Reference to account correlation config object. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - example: ACCOUNT_CORRELATION_CONFIG - id: - type: string - description: Account correlation config ID. - example: 2c9180855d191c59015d28583727245a - name: - type: string - description: Account correlation config's human-readable display name. - example: Directory [source-62867] Account Correlation - accountCorrelationRule: - description: Reference to a rule that can do COMPLEX correlation. Only use this rule when you can't use accountCorrelationConfig. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - RULE - example: RULE - id: - type: string - description: Rule ID. - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Rule's human-readable display name. - example: Example Rule - managerCorrelationMapping: - allOf: - - type: object - properties: - accountAttributeName: - 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 - identityAttributeName: - type: string - description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - example: manager - - nullable: true - description: | - Filter object used during manager correlation to match incoming manager values to an existing manager's - account/identity. - managerCorrelationRule: - description: Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn't sufficient. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - RULE - example: RULE - id: - type: string - description: Rule ID. - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Rule's human-readable display name. - example: Example Rule - beforeProvisioningRule: - description: 'Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. ' - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - RULE - example: RULE - id: - type: string - description: Rule ID. - example: 2c918085708c274401708c2a8a760001 - name: - type: string - description: Rule's human-readable display name. - example: Example Rule - schemas: - type: array - items: - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - CONNECTOR_SCHEMA - example: CONNECTOR_SCHEMA - id: - type: string - description: Schema ID. - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Schema's human-readable display name. - example: MySchema - description: List of references to schema objects. - example: - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232a - name: account - - type: CONNECTOR_SCHEMA - id: 2c9180835d191a86015d28455b4b232b - name: group - passwordPolicies: - type: array - nullable: true - items: - type: object - properties: - type: - description: Type of object being referenced. - type: string - enum: - - PASSWORD_POLICY - example: PASSWORD_POLICY - id: - type: string - description: Policy ID. - example: 2c91808568c529c60168cca6f90c1777 - name: - type: string - description: Policy's human-readable display name. - example: My Password Policy - description: List of references to the associated PasswordPolicy objects. - example: - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb053980 - name: Corporate Password Policy - - type: PASSWORD_POLICY - id: 2c9180855d191c59015d291ceb057777 - name: Vendor Password Policy - features: - type: array - 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 - - ARM_SECURITY_EXTRACT - - ARM_UTILIZATION_EXTRACT - - ARM_CHANGELOG_EXTRACT - - USES_UUID - - APPLICATION_DISCOVERY - example: AUTHENTICATE - description: |- - Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. - * AUTHENTICATE: The source supports pass-through authentication. - * COMPOSITE: The source supports composite source creation. - * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. - * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. - * ENABLE The source supports reading if an account is enabled or disabled. - * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. - * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. - * 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. - * SEARCH - * TEMPLATE - * UNLOCK: The source supports reading if an account is locked or unlocked. - * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. - * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. - * 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. - * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. - * SYNC_PROVISIONING: The source can provision accounts synchronously. - * 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. - * CURRENT_PASSWORD: Some source types support verification of the current password - * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. - * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. - * NO_AGGREGATION: A source that does not support aggregation. - * 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. - * 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. - * 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. - * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. - * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. - * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. - * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM - * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM - * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - example: - - PROVISIONING - - NO_PERMISSIONS_PROVISIONING - - GROUPS_HAVE_MEMBERS - type: - 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 - connector: - type: string - description: Connector script name. - example: active-directory - connectorClass: - type: string - description: Fully qualified name of the Java class that implements the connector interface. - example: sailpoint.connector.LDAPConnector - connectorAttributes: - type: object - description: Connector specific configuration. This configuration will differ from type to type. - example: - healthCheckTimeout: 30 - authSearchAttributes: - - cn - - uid - - mail - deleteThreshold: - type: integer - format: int32 - description: Number from 0 to 100 that specifies when to skip the delete phase. - example: 10 - authoritative: - type: boolean - description: When this is true, it indicates that the source is referenced by an identity profile. - default: false - example: false - managementWorkgroup: - description: Reference to management workgroup for the source. - type: object - nullable: true - properties: - type: - description: Type of object being referenced. - type: string - enum: - - GOVERNANCE_GROUP - example: GOVERNANCE_GROUP - id: - type: string - description: Management workgroup ID. - example: 2c91808568c529c60168cca6f90c2222 - name: - type: string - description: Management workgroup's human-readable display name. - example: My Management Workgroup - healthy: - type: boolean - description: When this is true, it indicates that the source is healthy. - default: false - example: true - status: - type: string - enum: - - SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT - - SOURCE_STATE_ERROR_CLUSTER - - SOURCE_STATE_ERROR_SOURCE - - SOURCE_STATE_ERROR_VA - - SOURCE_STATE_FAILURE_CLUSTER - - SOURCE_STATE_FAILURE_SOURCE - - SOURCE_STATE_HEALTHY - - SOURCE_STATE_UNCHECKED_CLUSTER - - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES - - SOURCE_STATE_UNCHECKED_SOURCE - - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS - description: 'Status identifier that gives specific information about why a source is or isn''t healthy. ' - example: SOURCE_STATE_HEALTHY - since: - type: string - description: Timestamp that shows when a source health check was last performed. - example: '2021-09-28T15:48:29.380Z' - connectorId: - type: string - description: Connector ID - example: active-directory - connectorName: - type: string - description: Name of the connector that was chosen during source creation. - example: Active Directory - connectionType: - type: string - description: Type of connection (direct or file). - example: file - connectorImplementationId: - type: string - description: Connector implementation ID. - example: delimited-file - created: - type: string - description: Date-time when the source was created - format: date-time - example: '2022-02-08T14:50:03.827Z' - modified: - type: string - description: Date-time when the source was last modified. - format: date-time - example: '2024-01-23T18:08:50.897Z' - credentialProviderEnabled: - type: boolean - description: If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - default: false - example: false - category: - type: string - nullable: true - default: null - description: Source category (e.g. null, CredentialProvider). - example: CredentialProvider - required: - - name - - owner - - connector - SourceHealthDto: - type: object - description: Dto for source health data - properties: - id: - type: string - readOnly: true - description: the id of the Source - example: 2c91808568c529c60168cca6f90c1324 - type: - 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 - name: - type: string - description: the name of the source - example: Source1234 - org: - type: string - description: source's org - example: denali-cjh - isAuthoritative: - type: boolean - example: false - description: Is the source authoritative - isCluster: - type: boolean - example: false - description: Is the source in a cluster - hostname: - type: string - example: megapod-useast1-secret-hostname.sailpoint.com - description: source's hostname - pod: - type: string - description: source's pod - example: megapod-useast1 - iqServiceVersion: - type: string - nullable: true - description: The version of the iqService - example: iqVersion123 - status: - type: string - enum: - - SOURCE_STATE_ERROR_CLUSTER - - SOURCE_STATE_ERROR_SOURCE - - SOURCE_STATE_ERROR_VA - - SOURCE_STATE_FAILURE_CLUSTER - - SOURCE_STATE_FAILURE_SOURCE - - SOURCE_STATE_HEALTHY - - SOURCE_STATE_UNCHECKED_CLUSTER - - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES - - SOURCE_STATE_UNCHECKED_SOURCE - - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS - - SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT - description: connection test result - example: SOURCE_STATE_UNCHECKED_SOURCE - SourceSchedule: - type: object - required: - - type - - cronExpression - properties: - type: - type: string - enum: - - ACCOUNT_AGGREGATION - - GROUP_AGGREGATION - description: The type of the Schedule. - example: ACCOUNT_AGGREGATION - cronExpression: - type: string - description: The cron expression of the schedule. - example: 0 0 5,13,21 * * ? - Transform: - type: object - description: The representation of an internally- or customer-defined transform. - required: - - name - - type - - attributes - properties: - name: - type: string - description: Unique name of this transform - example: Timestamp To Date - minLength: 1 - maxLength: 50 - type: - type: string - description: The type of transform operation - enum: - - accountAttribute - - base64Decode - - base64Encode - - concat - - conditional - - dateCompare - - dateFormat - - dateMath - - decomposeDiacriticalMarks - - e164phone - - firstValid - - rule - - identityAttribute - - indexOf - - iso3166 - - lastIndexOf - - leftPad - - lookup - - lower - - normalizeNames - - randomAlphaNumeric - - randomNumeric - - reference - - replaceAll - - replace - - rightPad - - split - - static - - substring - - trim - - upper - - usernameGenerator - - uuid - - displayName - - rfc5646 - example: dateFormat - externalDocs: - description: Transform Operations - url: https://developer.sailpoint.com/idn/docs/transforms/operations - attributes: - nullable: true - description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - oneOf: - - title: accountAttribute - type: object - required: - - sourceName - - attributeName - properties: - sourceName: - type: string - description: A reference to the source to search for the account - example: Workday - attributeName: - type: string - description: The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. - example: DEPARTMENT - accountSortAttribute: - type: string - description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - example: created - default: created - accountSortDescending: - type: boolean - description: The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) - example: false - default: false - accountReturnFirstLink: - type: boolean - description: The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false - example: false - default: false - accountFilter: - type: string - description: |- - This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. - Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - example: '!(nativeIdentity.startsWith("*DELETED*"))' - accountPropertyFilter: - type: string - description: |- - This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. - - All account attributes are available for filtering as this operation is performed in memory. - example: (groups.containsAll({'Admin'}) || location == 'Austin') - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - default: false - input: - type: object - description: This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - additionalProperties: true - example: - type: accountAttribute - attributes: - attributeName: first_name - sourceName: Source - - title: base64Decode - type: object - properties: - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: base64Encode - type: object - properties: - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: concat - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of items to join together - example: - - John - - ' ' - - Smith - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: conditional - type: object - required: - - expression - - positiveCondition - - negativeCondition - properties: - expression: - type: string - description: |- - A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. - - The `eq` operator is the only valid comparison - example: ValueA eq ValueB - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: 'false' - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: dateCompare - type: object - required: - - firstDate - - secondDate - - operator - - positiveCondition - - negativeCondition - properties: - firstDate: - description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). - oneOf: - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/AccountAttribute.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/DateFormat.yaml - secondDate: - description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). - oneOf: - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/AccountAttribute.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/DateFormat.yaml - operator: - type: string - description: | - This is the comparison to perform. - | Operation | Description | - | --------- | ------- | - | LT | Strictly less than: `firstDate < secondDate` | - | LTE | Less than or equal to: `firstDate <= secondDate` | - | GT | Strictly greater than: `firstDate > secondDate` | - | GTE | Greater than or equal to: `firstDate >= secondDate` | - enum: - - LT - - LTE - - GT - - GTE - example: LT - positiveCondition: - type: string - description: The output of the transform if the expression evalutes to true - example: 'true' - negativeCondition: - type: string - description: The output of the transform if the expression evalutes to false - example: false - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: dateFormat - type: object - properties: - inputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - title: Named Construct - type: string - description: | - | Construct | Date Time Pattern | Description | - | --------- | ----------------- | ----------- | - | ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | - | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | - | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | - | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | - | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - enum: - - ISO8601 - - LDAP - - PEOPLE_SOFT - - EPOCH_TIME_JAVA - - EPOCH_TIME_WIN32 - example: PEOPLE_SOFT - - title: Java Simple Date Format - type: string - description: | - There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. - - >NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. - (This table is from the SimpleDateFormat page.) - - | Date Time Pattern | Result | - | ----------------- | ------ | - | `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | - | `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | - | `h:mm a` | 12:08 PM | - | `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | - | `K:mm a, z` | 0:08 PM, PDT | - | `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | - | `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | - | `yyMMddHHmmssZ` | 010704120856-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | - | `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | - | `YYYY-'W'ww-u` | 2001-W27-3 | - example: mm/dd/yyyy - outputFormat: - description: |- - A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. - - *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - oneOf: - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6/properties/inputFormat/oneOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/date-formats/namedConstructs.yaml - - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6/properties/inputFormat/oneOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/date-formats/simpleDateFormat.yaml - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: dateMath - type: object - required: - - expression - properties: - expression: - type: string - description: | - A string value of the date and time components to operation on, along with the math operations to execute. - externalDocs: - description: Date Math Expressions - url: https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure - example: now+1w - roundUp: - type: boolean - description: | - A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. - - - If not provided, the transform will default to `false` - - - `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) - - - `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - example: false - default: false - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: decomposeDiacriticalMarks - type: object - properties: - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: e164phone - type: object - properties: - defaultRegion: - type: string - description: | - This is an optional attribute that can be used to define the region of the phone number to format into. - - - If defaultRegion is not provided, it will take US as the default country. - - - The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - example: US - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: firstValid - type: object - required: - - values - properties: - values: - type: array - items: - type: object - description: An array of attributes to evaluate for existence. - example: - - attributes: - sourceName: Active Directory - attributeName: sAMAccountName - type: accountAttribute - - attributes: - sourceName: Okta - attributeName: login - type: accountAttribute - - attributes: - sourceName: HR Source - attributeName: employeeID - type: accountAttribute - ignoreErrors: - type: boolean - description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - example: false - default: false - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - - title: rule - oneOf: - - type: object - required: - - name - properties: - name: - type: string - description: This is the name of the Transform rule that needs to be invoked by the transform - example: Transform Calculation Rule - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - - type: object - required: - - name - - operation - - includeNumbers - - includeSpecialChars - - length - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `generateRandomString` - example: generateRandomString - includeNumbers: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include numbers - example: true - includeSpecialChars: - type: boolean - description: This must be either "true" or "false" to indicate whether the generator logic should include special characters - example: true - length: - type: string - description: | - This specifies how long the randomly generated string needs to be - - - >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - example: '10' - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - type: object - required: - - name - - operation - - uid - properties: - name: - type: string - description: This must always be set to "Cloud Services Deployment Utility" - example: Cloud Services Deployment Utility - operation: - type: string - description: The operation to perform `getReferenceIdentityAttribute` - example: getReferenceIdentityAttribute - uid: - type: string - description: | - This is the SailPoint User Name (uid) value of the identity whose attribute is desired - - As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. - example: 2c91808570313110017040b06f344ec9 - requiresPeriodicRefresh: - type: boolean - description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - example: false - - title: identityAttribute - type: object - required: - - name - properties: - name: - type: string - description: The system (camel-cased) name of the identity attribute to bring in - example: email - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: indexOf - type: object - required: - - substring - properties: - substring: - type: string - description: A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. - example: admin_ - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: iso3166 - type: object - properties: - format: - type: string - description: | - An optional value to denote which ISO 3166 format to return. Valid values are: - - - `alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied - - - `alpha3` - Three-character country code (e.g., "USA") - - - `numeric` - The numeric country code (e.g., "840") - example: alpha2 - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: leftPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: lookup - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: | - This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched - - - >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. - example: - USA: Americas - FRA: EMEA - AUS: APAC - default: Unknown Region - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: lower - type: object - properties: - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: nameNormalizer - type: object - properties: - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: randomAlphaNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: randomNumeric - type: object - properties: - length: - type: string - description: | - This is an integer value specifying the size/number of characters the random string must contain - - - * This value must be a positive number and cannot be blank - - - * If no length is provided, the transform will default to a value of `32` - - - * Due to identity attribute data constraints, the maximum allowable value is `450` characters - example: '10' - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: reference - type: object - required: - - id - properties: - id: - type: string - description: This ID specifies the name of the pre-existing transform which you want to use within your current transform - example: Existing Transform - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: replaceAll - type: object - required: - - table - properties: - table: - type: object - additionalProperties: true - description: An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. - example: - '-': ' ' - '"': '''' - ñ: 'n' - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: replace - type: object - required: - - regex - - replacement - properties: - regex: - type: string - description: This can be a string or a regex pattern in which you want to replace. - example: '[^a-zA-Z]' - externalDocs: - description: Regex Builder - url: https://regex101.com/ - replacement: - type: string - description: This is the replacement string that should be substituded wherever the string or pattern is found. - example: ' ' - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: rightPad - type: object - required: - - length - properties: - length: - type: string - description: An integer value for the desired length of the final output string - example: '4' - padding: - type: string - description: | - A string value representing the character that the incoming data should be padded with to get to the desired length - - - If not provided, the transform will default to a single space (" ") character for padding - example: '0' - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: split - type: object - required: - - delimiter - - index - properties: - delimiter: - type: string - description: This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data - example: ',' - index: - type: string - description: An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. - example: '5' - throws: - type: boolean - description: | - A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) - - - `true` - The transform should return "IndexOutOfBoundsException" - - - `false` - The transform should return null - - - If not provided, the transform will default to false and return a null - example: true - default: false - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: static - type: object - required: - - values - properties: - values: - type: string - description: This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. - example: string$variable - externalDocs: - description: Static Transform Documentation - url: https://developer.sailpoint.com/idn/docs/transforms/operations/static - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - - title: substring - type: object - required: - - begin - properties: - begin: - type: integer - description: | - The index of the first character to include in the returned substring. - - - If `begin` is set to -1, the transform will begin at character 0 of the input data - example: 1 - format: int32 - beginOffset: - type: integer - description: | - This integer value is the number of characters to add to the begin attribute when returning a substring. - - This attribute is only used if begin is not -1. - example: 3 - format: int32 - end: - type: integer - description: | - The index of the first character to exclude from the returned substring. - - If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - example: 6 - format: int32 - endOffset: - type: integer - description: | - This integer value is the number of characters to add to the end attribute when returning a substring. - - This attribute is only used if end is provided and is not -1. - example: 1 - format: int32 - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: trim - type: object - properties: - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: upper - type: object - properties: - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - input: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - - title: uuid - type: object - properties: - requiresPeriodicRefresh: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - WorkItems: - type: object - properties: - id: - type: string - description: ID of the work item - example: 2c9180835d2e5168015d32f890ca1581 - requesterId: - type: string - description: ID of the requester - example: 2c9180835d2e5168015d32f890ca1581 - nullable: true - requesterDisplayName: - type: string - description: The displayname of the requester - example: John Smith - nullable: true - ownerId: - type: string - description: The ID of the owner - example: 2c9180835d2e5168015d32f890ca1581 - nullable: true - ownerName: - type: string - description: The name of the owner - example: Jason Smith - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - description: Time when the work item was created - modified: - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: Time when the work item was last updated - nullable: true - description: - type: string - description: The description of the work item - example: Create account on source 'AD' - state: - type: string - enum: - - Finished - - Rejected - - Returned - - Expired - - Pending - - Canceled - example: Finished - description: The state of a work item - type: - type: string - enum: - - Generic - - Certification - - Remediation - - Delegation - - Approval - - ViolationReview - - Form - - PolicyVioloation - - Challenge - - ImpactAnalysis - - Signoff - - Event - - ManualAction - - Test - example: Generic - description: The type of the work item - remediationItems: - type: array - nullable: true - items: - type: object - properties: - id: - type: string - description: The ID of the certification - example: 2c9180835d2e5168015d32f890ca1581 - targetId: - type: string - description: The ID of the certification target - example: 2c9180835d2e5168015d32f890ca1581 - targetName: - type: string - description: The name of the certification target - example: john.smith - targetDisplayName: - type: string - description: The display name of the certification target - example: emailAddress - applicationName: - type: string - description: The name of the application/source - example: Active Directory - attributeName: - type: string - description: The name of the attribute being certified - example: phoneNumber - attributeOperation: - type: string - description: The operation of the certification on the attribute - example: update - attributeValue: - type: string - description: The value of the attribute being certified - example: 512-555-1212 - nativeIdentity: - type: string - description: The native identity of the target - example: jason.smith2 - description: A list of remediation items - approvalItems: - type: array - nullable: true - items: - type: object - properties: - id: - type: string - description: The approval item's ID - example: 2c9180835d2e5168015d32f890ca1581 - account: - type: string - description: The account referenced by the approval item - example: john.smith - nullable: true - application: - type: string - description: The name of the application/source - example: Active Directory - name: - type: string - description: The attribute's name - example: emailAddress - nullable: true - operation: - type: string - description: The attribute's operation - example: update - value: - type: string - description: The attribute's value - example: a@b.com - nullable: true - state: - allOf: - - $ref: '#/components/schemas/ApprovalItems/properties/state/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItemState.yaml - - nullable: true - description: A list of items that need to be approved - name: - type: string - description: The work item name - example: Account Create - nullable: true - completed: - type: string - format: date-time - example: '2018-10-19T13:49:37.385Z' - description: The time at which the work item completed - nullable: true - numItems: - type: integer - format: int32 - description: The number of items in the work item - example: 19 - nullable: true - form: - allOf: - - type: object - properties: - id: - type: string - description: ID of the form - example: 2c9180835d2e5168015d32f890ca1581 - nullable: true - name: - type: string - description: Name of the form - example: AccountSelection Form - nullable: true - title: - type: string - nullable: true - description: The form title - example: Account Selection for John.Doe - subtitle: - type: string - nullable: true - description: The form subtitle. - example: Please select from the following - targetUser: - type: string - description: The name of the user that should be shown this form - example: Jane.Doe - sections: - type: array - items: - type: object - allOf: - - type: object - properties: - name: - type: string - nullable: true - description: Name of the FormItem - example: Field1 - - type: object - properties: - label: - type: string - nullable: true - description: Label of the section - example: Section 1 - formItems: - type: array - items: - type: object - description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails - example: [] - description: Sections of the form - - nullable: true - errors: - type: array - items: - type: string - example: - - The work item ID that was specified was not found. - description: An array of errors that ocurred during the work item - WorkItemsCount: - type: object - properties: - count: - type: integer - description: The count of work items - example: 29 - WorkItemsSummary: - type: object - properties: - open: - type: integer - description: The count of open work items - example: 29 - completed: - type: integer - description: The count of completed work items - example: 1 - total: - type: integer - description: The count of total work items - example: 30 - AccountUsage: - type: object - properties: - date: - type: string - format: date - description: The first day of the month for which activity is aggregated. - example: '2023-04-21' - count: - type: integer - format: int64 - description: The number of days within the month that the account was active in a source. - example: 10 - SourceUsage: - type: object - properties: - date: - type: string - format: date - description: The first day of the month for which activity is aggregated. - example: '2023-04-21' - count: - type: number - format: float - description: The average number of days that accounts were active within this source, for the month. - example: 10.45 - SourceUsageStatus: - type: object - properties: - status: - type: string - description: |- - Source Usage Status. Acceptable values are: - - COMPLETE - - This status means that an activity data source has been setup and usage insights are available for the source. - - INCOMPLETE - - This status means that an activity data source has not been setup and usage insights are not available for the source. - example: COMPLETE - enum: - - COMPLETE - - INCOMPLETE - BrandingItem: - type: object - properties: - name: - type: string - description: name of branding item - example: default - productName: - type: string - description: product name - example: product name - nullable: true - actionButtonColor: - type: string - description: hex value of color for action button - example: 0074D9 - nullable: true - activeLinkColor: - type: string - description: hex value of color for link - example: 1.1e+70 - nullable: true - navigationColor: - type: string - description: hex value of color for navigation bar - example: 1.1e+70 - nullable: true - emailFromAddress: - type: string - description: email from address - example: no-reply@sailpoint.com - nullable: true - standardLogoURL: - type: string - description: url to standard logo - example: '' - nullable: true - loginInformationalMessage: - type: string - description: login information message - example: '' - nullable: true - BrandingItemCreate: - type: object - required: - - name - - productName - properties: - name: - type: string - description: name of branding item - example: custom-branding-item - productName: - type: string - description: product name - example: product name - nullable: true - actionButtonColor: - type: string - description: hex value of color for action button - example: 0074D9 - activeLinkColor: - type: string - description: hex value of color for link - example: 1.1e+70 - navigationColor: - type: string - description: hex value of color for navigation bar - example: 1.1e+70 - emailFromAddress: - type: string - description: email from address - example: no-reply@sailpoint.com - loginInformationalMessage: - type: string - description: login information message - example: '' - fileStandard: - type: string - format: binary - description: png file with logo - example: \x00\x00\x00\x02 - RoleBulkUpdateResponse: - type: object - properties: - id: - type: string - description: ID of the task which is executing the bulk update. This also used in to the bulk-update/** API to track status. - example: 2c9180867817ac4d017817c491119a20 - type: - type: string - description: Type of the bulk update object. - example: Role - status: - type: string - description: The status of the bulk update request, could also checked by getBulkUpdateStatus API - enum: - - CREATED - - PRE_PROCESS - - PRE_PROCESS_COMPLETED - - POST_PROCESS - - COMPLETED - - CHUNK_PENDING - - CHUNK_PROCESSING - example: CREATED - created: - type: string - description: Time when the bulk update request was created - format: date-time - example: '2020-10-08T18:33:52.029Z' - RoleGetAllBulkUpdateResponse: - type: object - properties: - id: - type: string - description: ID of the task which is executing the bulk update. This also used in to the bulk-update/** API to track status. - example: 2c9180867817ac4d017817c491119a20 - type: - type: string - description: Type of the bulk update object. - example: Role - status: - type: string - description: The status of the bulk update request, only list unfinished request's status, the status could also checked by getBulkUpdateStatus API - enum: - - CREATED - - PRE_PROCESS - - POST_PROCESS - - CHUNK_PENDING - - CHUNK_PROCESSING - example: CREATED - created: - type: string - description: Time when the bulk update request was created - format: date-time - example: '2020-10-08T18:33:52.029Z' - RoleListFilterDTO: - description: AMMFilterValues - type: object - properties: - filters: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **owner.id**: *eq, in* - - **requestable**: *eq* - example: dimensional eq false - nullable: true - ammKeyValues: - nullable: true - type: array - items: - type: object - properties: - attribute: - description: attribute key of a metadata. - type: string - example: iscFederalClassifications - values: - description: A list of attribute key names to filter roles. If the values is empty, will only filter by attribute key. - type: array - items: - type: string - example: secret - example: - - secret - example: - - attribute: iscFederalClassifications - values: - - secret - RoleMetadataBulkUpdateByFilterRequest: - description: This API initialize a a Bulk update by filter request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. - type: object - properties: - filters: - description: |- - Filtering is supported for the following fields and operators: - - **id** : *eq, in* - - **name** : *eq, sw* - - **created** : *gt, lt, ge, le* - - **modified** : *gt, lt, ge, le* - - **owner.id** : *eq, in* - - **requestable** : *eq* - type: string - example: ' requestable eq false' - operation: - description: The operation to be performed - type: string - enum: - - ADD - - REMOVE - - REPLACE - example: REPLACE - replaceScope: - description: The choice of update scope. - type: string - enum: - - ALL - - ATTRIBUTE - example: ALL - values: - description: The metadata to be updated, including attribute key and value. - type: array - nullable: false - items: - type: object - required: - - attribute - - values - properties: - attributeKey: - type: string - description: the key of metadata attribute - example: iscFederalClassifications - values: - type: array - description: the values of attribute to be updated - items: - type: string - example: secret - nullable: true - example: - - secret - example: - - attribute: iscFederalClassifications - values: - - topSecret - required: - - filters - - operation - - values - RoleMetadataBulkUpdateByIdRequest: - description: This API initialize a Bulk update by Id request of Role metadata. The maximum role count in a single update request is 3000. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. - type: object - properties: - roles: - description: Roles' Id to be updated - type: array - items: - type: string - example: - - b1db89554cfa431cb8b9921ea38d9367 - operation: - description: The operation to be performed - type: string - enum: - - ADD - - REMOVE - - REPLACE - example: REPLACE - replaceScope: - description: The choice of update scope. - type: string - enum: - - ALL - - ATTRIBUTE - example: ALL - values: - description: The metadata to be updated, including attribute key and value. - type: array - nullable: false - items: - type: object - required: - - attribute - - values - properties: - attribute: - type: string - description: the key of metadata attribute - example: iscFederalClassifications - values: - type: array - description: the values of attribute to be updated - items: - type: string - example: secret - nullable: true - example: - - secret - example: - - attribute: iscFederalClassifications - values: - - topSecret - required: - - roles - - operation - - values - RoleMetadataBulkUpdateByQueryRequest: - description: |- - Bulk update by query request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. - For more information about the query could refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/v3/search-post) - type: object - properties: - query: - description: query the identities to be updated - type: object - items: - type: object - properties: - indices: - description: The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - externalDocs: - description: Learn more about search indices here. - url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html - type: array - items: - $ref: '#/components/schemas/SavedSearch/allOf/2/properties/indices/items' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/Index.yaml - example: - - identities - queryType: - description: |- - The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. - To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - - TEXT - - TYPEAHEAD - default: SAILPOINT - example: SAILPOINT - queryVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - example: '5.2' - - type: string - description: |- - The version of the query object. - This version number will map to the version of Elasticsearch for the query strings and objects being used. - query: - type: object - description: Query parameters used to construct an Elasticsearch query object. - properties: - query: - description: The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - type: string - example: name:a* - fields: - description: |- - The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of "a*" to be applied to "name", "firstName", and the "source.name". The response will include all results matching the "a*" query found in those three fields. - A field's availability depends on the indices being searched. For example, if you are searching "identities", you can apply your search to the "firstName" field, but you couldn't use "firstName" with a search on "access profiles". Refer to the response schema for the respective lists of available fields. - type: string - example: - - firstName,lastName,email - timeZone: - description: The time zone to be applied to any range query related to dates. - type: string - example: America/Chicago - innerHit: - type: object - description: Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query. - required: - - query - - type - properties: - query: - description: The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - type: string - example: source.name:\"Active Directory\" - type: - description: The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document "nested" within another document. For example, an identity can have nested documents for access, accounts, and apps. - type: string - example: access - queryDsl: - description: The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. - type: object - example: - match: - name: john.doe - textQuery: - type: object - description: Query parameters used to construct an Elasticsearch text query object. - required: - - terms - - fields - properties: - terms: - description: Words or characters that specify a particular thing to be searched for. - type: array - items: - type: string - example: - - The quick brown fox - - '3141592' - - '7' - fields: - description: The fields to be searched. - type: array - items: - type: string - example: - - displayName - - employeeNumber - - roleCount - matchAny: - description: Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. - type: boolean - default: false - example: false - contains: - description: Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. - type: boolean - default: false - example: true - typeAheadQuery: - type: object - description: 'Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." ' - required: - - query - - field - properties: - query: - description: The type ahead query string used to construct a phrase prefix match query. - type: string - example: Work - field: - description: The field on which to perform the type ahead search. - type: string - example: source.name - nestedType: - description: The nested type. - type: string - example: access - maxExpansions: - description: |- - The number of suffixes the last term will be expanded into. - Influences the performance of the query and the number results returned. - Valid values: 1 to 1000. - type: integer - format: int32 - minimum: 1 - maximum: 1000 - default: 10 - example: 10 - size: - description: The max amount of records the search will return. - type: integer - format: int32 - minimum: 1 - default: 100 - example: 100 - sort: - description: The sort order of the returned records. - type: string - default: desc - example: asc - sortByValue: - description: The flag that defines the sort type, by count or value. - type: boolean - default: false - example: true - includeNested: - description: Indicates whether nested objects from returned search results should be included. - type: boolean - default: true - example: true - queryResultFilter: - type: object - description: Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. - properties: - includes: - description: The list of field names to include in the result documents. - type: array - items: - type: string - example: - - name - - displayName - excludes: - description: The list of field names to exclude from the result documents. - type: array - items: - type: string - example: - - stacktrace - aggregationType: - description: | - Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. - - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - default: DSL - example: DSL - aggregationsVersion: - allOf: - - $ref: '#/components/schemas/RoleMetadataBulkUpdateByQueryRequest/properties/query/items/properties/queryVersion/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/ElasticVersion.yaml - - type: string - description: |- - The version of the language being used for aggregation queries. - This version number will map to the version of Elasticsearch for the aggregation query object. - aggregationsDsl: - description: The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. - type: object - example: {} - aggregations: - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - example: COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - example: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object - properties: - subAggregation: - allOf: - - $ref: '#/components/schemas/RoleMetadataBulkUpdateByQueryRequest/properties/query/items/properties/aggregations/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/aggregate/Aggregations.yaml - - type: object - properties: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - $ref: '#/components/schemas/RoleMetadataBulkUpdateByQueryRequest/properties/query/items/properties/aggregations/allOf/0' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/aggregate/Aggregations.yaml - sort: - description: The fields to be used to sort the search results. Use + or - to specify the sort direction. - type: array - items: - type: string - example: - - displayName - - +id - searchAfter: - description: |- - Used to begin the search window at the values specified. - This parameter consists of the last values of the sorted fields in the current record set. - This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. - It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. - For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example ["displayName", "id"]. - If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is "John Doe", then using that displayName and ID will start a new search after this identity. - The searchAfter value will look like ["John Doe","2c91808375d8e80a0175e1f88a575221"] - type: array - items: - type: string - example: - - John Doe - - 2c91808375d8e80a0175e1f88a575221 - filters: - description: The filters to be applied for each filtered field name. - type: object - additionalProperties: - $ref: '#/components/schemas/SavedSearch/allOf/2/properties/filters/allOf/1' - x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/filter/Filter.yaml - example: {} - example: - query": - indices: - - roles - queryType: TEXT - textQuery: - terms: - - test123 - fields: - - id - matchAny: false - contains: true - includeNested: false - operation: - description: The operation to be performed - type: string - enum: - - ADD - - REMOVE - - REPLACE - example: REPLACE - replaceScope: - description: The choice of update scope. - type: string - enum: - - ALL - - ATTRIBUTE - example: ALL - values: - description: The metadata to be updated, including attribute key and value. - type: array - nullable: false - items: - type: object - required: - - attribute - - values - properties: - attributeKey: - type: string - description: the key of metadata attribute - example: iscFederalClassifications - attributeValue: - type: array - description: the values of attribute to be updated - items: - type: string - example: topSecret - example: - - topSecret - required: - - query - - operation - - values From d51a425b9195fe6455e9b379f4ee5c1b5e03be98 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Wed, 9 Apr 2025 09:42:57 +0000 Subject: [PATCH 39/82] Automated commit by github action: 14354024344 --- static/api-specs/idn/beta/paths/workflow.yaml | 18 ++++++- .../api-specs/idn/beta/paths/workflows.yaml | 48 +++++++++++++++++++ .../api-specs/idn/v2024/paths/workflow.yaml | 18 ++++++- .../api-specs/idn/v2024/paths/workflows.yaml | 16 ++++++- .../api-specs/idn/v2025/paths/workflow.yaml | 18 ++++++- .../api-specs/idn/v2025/paths/workflows.yaml | 16 ++++++- .../idn/v3/paths/workflows/workflow.yaml | 20 ++++++++ .../idn/v3/paths/workflows/workflows.yaml | 48 +++++++++++++++++++ 8 files changed, 195 insertions(+), 7 deletions(-) diff --git a/static/api-specs/idn/beta/paths/workflow.yaml b/static/api-specs/idn/beta/paths/workflow.yaml index 4bb0757c6..9bcd525d0 100644 --- a/static/api-specs/idn/beta/paths/workflow.yaml +++ b/static/api-specs/idn/beta/paths/workflow.yaml @@ -7,6 +7,8 @@ get: Get a single workflow by id. security: - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -18,6 +20,14 @@ get: schema: type: string example: c17bea3a-574d-453c-9e04-4365fbf5af0b + - name: workflowMetrics + in: query + description: disable workflow metrics + required: false + schema: + type: boolean + default: true + example: false responses: '200': description: >- @@ -37,7 +47,7 @@ get: '500': $ref: '../../v3/responses/500.yaml' put: - operationId: updateWorkflow + operationId: putWorkflow tags: - Workflows summary: Update Workflow @@ -45,6 +55,8 @@ put: Perform a full update of a workflow. The updated workflow object is returned in the response. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -88,6 +100,8 @@ patch: Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -198,6 +212,8 @@ delete: Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path diff --git a/static/api-specs/idn/beta/paths/workflows.yaml b/static/api-specs/idn/beta/paths/workflows.yaml index 54bd51650..08997250c 100644 --- a/static/api-specs/idn/beta/paths/workflows.yaml +++ b/static/api-specs/idn/beta/paths/workflows.yaml @@ -7,6 +7,8 @@ post: Create a new workflow with the desired trigger and steps specified in the request body. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN requestBody: required: true content: @@ -133,6 +135,52 @@ get: List all workflows in the tenant. security: - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - name: limit + in: query + description: >- + Max number of results to return. + + See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) + for more information. + required: false + example: 250 + schema: + type: integer + format: int32 + minimum: 0 + maximum: 250 + default: 250 + - name: offset + in: query + description: >- + Offset into the full result set. Usually specified with *limit* to paginate through the results. + + See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) + for more information. + required: false + example: 0 + schema: + type: integer + format: int32 + minimum: 0 + default: 0 + - name: triggerId + in: query + description: Trigger ID + required: false + schema: + type: string + example: "idn:identity-created" + - name: connectorInstanceId + in: query + description: Connector Instance ID + required: false + schema: + type: string + example: "28541fec-bb81-4ad4-88ef-0f7d213adcad" responses: '200': description: >- diff --git a/static/api-specs/idn/v2024/paths/workflow.yaml b/static/api-specs/idn/v2024/paths/workflow.yaml index 2f835308f..49b3e2766 100644 --- a/static/api-specs/idn/v2024/paths/workflow.yaml +++ b/static/api-specs/idn/v2024/paths/workflow.yaml @@ -7,6 +7,8 @@ get: Get a single workflow by id. security: - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -18,6 +20,14 @@ get: schema: type: string example: c17bea3a-574d-453c-9e04-4365fbf5af0b + - name: workflowMetrics + in: query + description: disable workflow metrics + required: false + schema: + type: boolean + default: true + example: false responses: '200': description: >- @@ -37,7 +47,7 @@ get: '500': $ref: '../responses/500.yaml' put: - operationId: updateWorkflow + operationId: putWorkflow tags: - Workflows summary: Update Workflow @@ -45,6 +55,8 @@ put: Perform a full update of a workflow. The updated workflow object is returned in the response. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -88,6 +100,8 @@ patch: Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -198,6 +212,8 @@ delete: Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path diff --git a/static/api-specs/idn/v2024/paths/workflows.yaml b/static/api-specs/idn/v2024/paths/workflows.yaml index 44a0d511a..968cd4818 100644 --- a/static/api-specs/idn/v2024/paths/workflows.yaml +++ b/static/api-specs/idn/v2024/paths/workflows.yaml @@ -9,7 +9,6 @@ post: - userAuth: [sp:workflow:manage] x-sailpoint-userLevels: - ORG_ADMIN - - SOURCE_ADMIN requestBody: required: true content: @@ -137,11 +136,24 @@ get: parameters: - $ref: '../parameters/limit.yaml' - $ref: '../parameters/offset.yaml' + - name: triggerId + in: query + description: Trigger ID + required: false + schema: + type: string + example: "idn:identity-created" + - name: connectorInstanceId + in: query + description: Connector Instance ID + required: false + schema: + type: string + example: "28541fec-bb81-4ad4-88ef-0f7d213adcad" security: - userAuth: [sp:workflow:read] x-sailpoint-userLevels: - ORG_ADMIN - - SOURCE_ADMIN responses: '200': description: >- diff --git a/static/api-specs/idn/v2025/paths/workflow.yaml b/static/api-specs/idn/v2025/paths/workflow.yaml index 2f835308f..49b3e2766 100644 --- a/static/api-specs/idn/v2025/paths/workflow.yaml +++ b/static/api-specs/idn/v2025/paths/workflow.yaml @@ -7,6 +7,8 @@ get: Get a single workflow by id. security: - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -18,6 +20,14 @@ get: schema: type: string example: c17bea3a-574d-453c-9e04-4365fbf5af0b + - name: workflowMetrics + in: query + description: disable workflow metrics + required: false + schema: + type: boolean + default: true + example: false responses: '200': description: >- @@ -37,7 +47,7 @@ get: '500': $ref: '../responses/500.yaml' put: - operationId: updateWorkflow + operationId: putWorkflow tags: - Workflows summary: Update Workflow @@ -45,6 +55,8 @@ put: Perform a full update of a workflow. The updated workflow object is returned in the response. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -88,6 +100,8 @@ patch: Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -198,6 +212,8 @@ delete: Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path diff --git a/static/api-specs/idn/v2025/paths/workflows.yaml b/static/api-specs/idn/v2025/paths/workflows.yaml index 44a0d511a..968cd4818 100644 --- a/static/api-specs/idn/v2025/paths/workflows.yaml +++ b/static/api-specs/idn/v2025/paths/workflows.yaml @@ -9,7 +9,6 @@ post: - userAuth: [sp:workflow:manage] x-sailpoint-userLevels: - ORG_ADMIN - - SOURCE_ADMIN requestBody: required: true content: @@ -137,11 +136,24 @@ get: parameters: - $ref: '../parameters/limit.yaml' - $ref: '../parameters/offset.yaml' + - name: triggerId + in: query + description: Trigger ID + required: false + schema: + type: string + example: "idn:identity-created" + - name: connectorInstanceId + in: query + description: Connector Instance ID + required: false + schema: + type: string + example: "28541fec-bb81-4ad4-88ef-0f7d213adcad" security: - userAuth: [sp:workflow:read] x-sailpoint-userLevels: - ORG_ADMIN - - SOURCE_ADMIN responses: '200': description: >- diff --git a/static/api-specs/idn/v3/paths/workflows/workflow.yaml b/static/api-specs/idn/v3/paths/workflows/workflow.yaml index a7ee77556..4f87f9f3c 100644 --- a/static/api-specs/idn/v3/paths/workflows/workflow.yaml +++ b/static/api-specs/idn/v3/paths/workflows/workflow.yaml @@ -7,16 +7,27 @@ get: Get a single workflow by id. security: - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path description: Id of the workflow required: true + x-sailpoint-resource-operation-id: listWorkflows style: simple explode: false schema: type: string example: c17bea3a-574d-453c-9e04-4365fbf5af0b + - name: workflowMetrics + in: query + description: disable workflow metrics + required: false + schema: + type: boolean + default: true + example: false responses: '200': description: >- @@ -44,11 +55,14 @@ put: Perform a full update of a workflow. The updated workflow object is returned in the response. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path description: Id of the Workflow required: true + x-sailpoint-resource-operation-id: listWorkflows style: simple explode: false schema: @@ -86,11 +100,14 @@ patch: Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path description: Id of the Workflow required: true + x-sailpoint-resource-operation-id: listWorkflows style: simple explode: false schema: @@ -195,11 +212,14 @@ delete: Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path description: Id of the Workflow required: true + x-sailpoint-resource-operation-id: listWorkflows style: simple explode: false schema: diff --git a/static/api-specs/idn/v3/paths/workflows/workflows.yaml b/static/api-specs/idn/v3/paths/workflows/workflows.yaml index 78943df16..99169abff 100644 --- a/static/api-specs/idn/v3/paths/workflows/workflows.yaml +++ b/static/api-specs/idn/v3/paths/workflows/workflows.yaml @@ -7,6 +7,52 @@ get: List all workflows in the tenant. security: - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - name: triggerId + in: query + description: Trigger ID + required: false + schema: + type: string + example: "idn:identity-created" + - name: connectorInstanceId + in: query + description: Connector Instance ID + required: false + schema: + type: string + example: "28541fec-bb81-4ad4-88ef-0f7d213adcad" + - name: limit + in: query + description: >- + Max number of results to return. + + See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) + for more information. + required: false + example: 250 + schema: + type: integer + format: int32 + minimum: 0 + maximum: 250 + default: 250 + - name: offset + in: query + description: >- + Offset into the full result set. Usually specified with *limit* to paginate through the results. + + See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) + for more information. + required: false + example: 0 + schema: + type: integer + format: int32 + minimum: 0 + default: 0 responses: '200': description: >- @@ -36,6 +82,8 @@ post: Create a new workflow with the desired trigger and steps specified in the request body. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN requestBody: required: true content: From 7407bdf43f88939a05d5af7cb472a584b01a0062 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Wed, 9 Apr 2025 09:20:54 -0400 Subject: [PATCH 40/82] fix link --- docs/tools/cli/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/cli/index.md b/docs/tools/cli/index.md index ef25b0c83..2d7a835c7 100644 --- a/docs/tools/cli/index.md +++ b/docs/tools/cli/index.md @@ -40,7 +40,7 @@ Learn how to use the SailPoint command line interface (CLI) in this guide. - [PAT Authentication](#pat-authentication) - [Environment variable configuration](#environment-variable-configuration) - [Usage](#usage) -- [Support](#Support) +- [Support](#support) - [Contribution](#contribution) - [Questions](#questions) From 0e8e928ec307cd3fa0425513789d530eabcdd1c0 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Wed, 9 Apr 2025 17:41:04 +0000 Subject: [PATCH 41/82] Automated commit by github action: 14363556634 --- static/api-specs/idn/sailpoint-api.v2024.yaml | 2 + static/api-specs/idn/sailpoint-api.v2025.yaml | 2 + .../access-requests-accounts-selection.yaml | 37 +++++++++++++++++++ .../schemas/AccountsSelectionRequest.yaml | 31 ++++++++++++++++ .../access-requests/AccountInfoRef.yaml | 23 ++++++++++++ .../AccountsSelectionResponse.yaml | 7 ++++ .../IdentityAccountSelections.yaml | 24 ++++++++++++ .../RequestedItemAccountSelections.yaml | 37 +++++++++++++++++++ .../SourceAccountSelections.yaml | 19 ++++++++++ .../access-requests-accounts-selection.yaml | 37 +++++++++++++++++++ .../schemas/AccountsSelectionRequest.yaml | 31 ++++++++++++++++ .../access-requests/AccountInfoRef.yaml | 23 ++++++++++++ .../AccountsSelectionResponse.yaml | 7 ++++ .../IdentityAccountSelections.yaml | 24 ++++++++++++ .../RequestedItemAccountSelections.yaml | 37 +++++++++++++++++++ .../SourceAccountSelections.yaml | 19 ++++++++++ 16 files changed, 360 insertions(+) create mode 100644 static/api-specs/idn/v2024/paths/access-requests-accounts-selection.yaml create mode 100644 static/api-specs/idn/v2024/schemas/AccountsSelectionRequest.yaml create mode 100644 static/api-specs/idn/v2024/schemas/access-requests/AccountInfoRef.yaml create mode 100644 static/api-specs/idn/v2024/schemas/access-requests/AccountsSelectionResponse.yaml create mode 100644 static/api-specs/idn/v2024/schemas/access-requests/IdentityAccountSelections.yaml create mode 100644 static/api-specs/idn/v2024/schemas/access-requests/RequestedItemAccountSelections.yaml create mode 100644 static/api-specs/idn/v2024/schemas/access-requests/SourceAccountSelections.yaml create mode 100644 static/api-specs/idn/v2025/paths/access-requests-accounts-selection.yaml create mode 100644 static/api-specs/idn/v2025/schemas/AccountsSelectionRequest.yaml create mode 100644 static/api-specs/idn/v2025/schemas/access-requests/AccountInfoRef.yaml create mode 100644 static/api-specs/idn/v2025/schemas/access-requests/AccountsSelectionResponse.yaml create mode 100644 static/api-specs/idn/v2025/schemas/access-requests/IdentityAccountSelections.yaml create mode 100644 static/api-specs/idn/v2025/schemas/access-requests/RequestedItemAccountSelections.yaml create mode 100644 static/api-specs/idn/v2025/schemas/access-requests/SourceAccountSelections.yaml diff --git a/static/api-specs/idn/sailpoint-api.v2024.yaml b/static/api-specs/idn/sailpoint-api.v2024.yaml index ca7296963..a662bf389 100644 --- a/static/api-specs/idn/sailpoint-api.v2024.yaml +++ b/static/api-specs/idn/sailpoint-api.v2024.yaml @@ -1355,6 +1355,8 @@ paths: $ref: ./v2024/paths/access-request-cancel.yaml /access-requests/bulk-cancel: $ref: ./v2024/paths/bulk-cancel-access-request.yaml + /access-requests/accounts-selection: + $ref: ./v2024/paths/access-requests-accounts-selection.yaml /access-request-config: $ref: ./v2024/paths/access-request-config.yaml /access-request-status: diff --git a/static/api-specs/idn/sailpoint-api.v2025.yaml b/static/api-specs/idn/sailpoint-api.v2025.yaml index 3da165703..7eb1768bd 100644 --- a/static/api-specs/idn/sailpoint-api.v2025.yaml +++ b/static/api-specs/idn/sailpoint-api.v2025.yaml @@ -1355,6 +1355,8 @@ paths: $ref: ./v2025/paths/access-request-cancel.yaml /access-requests/bulk-cancel: $ref: ./v2025/paths/bulk-cancel-access-request.yaml + /access-requests/accounts-selection: + $ref: ./v2024/paths/access-requests-accounts-selection.yaml /access-request-config: $ref: ./v2025/paths/access-request-config.yaml /access-request-status: diff --git a/static/api-specs/idn/v2024/paths/access-requests-accounts-selection.yaml b/static/api-specs/idn/v2024/paths/access-requests-accounts-selection.yaml new file mode 100644 index 000000000..eece22e3c --- /dev/null +++ b/static/api-specs/idn/v2024/paths/access-requests-accounts-selection.yaml @@ -0,0 +1,37 @@ +post: + operationId: loadAccountSelections + security: + - userAuth: [ idn:access-request:create ] + x-sailpoint-userLevels: + - ORG_ADMIN + - USER + summary: Get accounts selections for identity + tags: + - Access Requests + description: | + Use this API to fetch account information for an identity against the items in an access request. + + Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/AccountsSelectionRequest.yaml' + responses: + '200': + description: Accounts Selection Response + content: + application/json: + schema: + $ref: '../schemas/access-requests/AccountsSelectionResponse.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/AccountsSelectionRequest.yaml b/static/api-specs/idn/v2024/schemas/AccountsSelectionRequest.yaml new file mode 100644 index 000000000..3f220c106 --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/AccountsSelectionRequest.yaml @@ -0,0 +1,31 @@ +type: object +properties: + requestedFor: + description: A list of Identity IDs for whom the Access is requested. + type: array + items: + type: string + example: 2c918084660f45d6016617daa9210584 + requestType: + $ref: 'AccessRequestType.yaml' + requestedItems: + type: array + items: + $ref: 'AccessRequestItem.yaml' + minItems: 1 + maxItems: 25 + clientMetadata: + type: object + additionalProperties: + type: string + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + description: >- + Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on + associated APIs such as /account-activities. + +required : ["requestedFor", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/access-requests/AccountInfoRef.yaml b/static/api-specs/idn/v2024/schemas/access-requests/AccountInfoRef.yaml new file mode 100644 index 000000000..db4c223eb --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/AccountInfoRef.yaml @@ -0,0 +1,23 @@ +type: object +properties: + uuid: + type: string + description: The uuid for the account, available under the 'objectguid' attribute + example: '{fab7119e-004f-4822-9c33-b8d570d6c6a6}' + nativeIdentity: + type: string + description: The 'distinguishedName' attribute for the account + example: 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' + type: + $ref: './../DtoType.yaml' + description: DTO type + example: 'ACCOUNT' + id: + type: string + description: The account id + example: 'f19d168c27374fd1aff3b483573f997f' + name: + type: string + description: The account display name + example: 'UserAccount.761a2248b' + diff --git a/static/api-specs/idn/v2024/schemas/access-requests/AccountsSelectionResponse.yaml b/static/api-specs/idn/v2024/schemas/access-requests/AccountsSelectionResponse.yaml new file mode 100644 index 000000000..9b02d748e --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/AccountsSelectionResponse.yaml @@ -0,0 +1,7 @@ +type: object +properties: + identities: + description: A list of available account selections per identity in the request, for all the requested items + type: array + items: + $ref: 'IdentityAccountSelections.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/access-requests/IdentityAccountSelections.yaml b/static/api-specs/idn/v2024/schemas/access-requests/IdentityAccountSelections.yaml new file mode 100644 index 000000000..81710446a --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/IdentityAccountSelections.yaml @@ -0,0 +1,24 @@ +type: object +properties: + requestedItems: + description: Available account selections for the identity, per requested item + type: array + items: + $ref: 'RequestedItemAccountSelections.yaml' + accountsSelectionRequired: + description: A boolean indicating whether any account selections will be required for the user to raise an access request + type: boolean + example: false + default: false + type: + $ref: './../DtoType.yaml' + description: DTO type + example: IDENTITY + id: + description: The identity id for the user + type: string + example: '70016590f2df4b879bdb1313a9e4e19e' + name: + description: The name of the identity + type: string + example: 'User name' diff --git a/static/api-specs/idn/v2024/schemas/access-requests/RequestedItemAccountSelections.yaml b/static/api-specs/idn/v2024/schemas/access-requests/RequestedItemAccountSelections.yaml new file mode 100644 index 000000000..36619dd3c --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/RequestedItemAccountSelections.yaml @@ -0,0 +1,37 @@ +type: object +properties: + description: + type: string + description: The description for this requested item + example: 'An access profile for the admins' + accountsSelectionBlocked: + type: boolean + default: false + description: | + This field indicates if account selections are not allowed for this requested item. + * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. + * An example is where a user is requesting an access profile that is already assigned to one of their accounts. + example: false + accountsSelectionBlockedReason: + type: string + description: If account selections are not allowed for an item, this field will denote the reason. + nullable: true + example: 'ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT' + type: + type: string + enum: [ ACCESS_PROFILE, ROLE, ENTITLEMENT ] + description: The type of the item being requested. + example: ACCESS_PROFILE + id: + type: string + description: The id of the requested item + example: '720fd239701344aea76c93ba91376aec' + name: + type: string + description: The name of the requested item + example: 'Test Access Profile' + sources: + description: The details for the sources and accounts for the requested item and identity combination + type: array + items: + $ref: 'SourceAccountSelections.yaml' diff --git a/static/api-specs/idn/v2024/schemas/access-requests/SourceAccountSelections.yaml b/static/api-specs/idn/v2024/schemas/access-requests/SourceAccountSelections.yaml new file mode 100644 index 000000000..6810f66c1 --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/SourceAccountSelections.yaml @@ -0,0 +1,19 @@ +type: object +properties: + type: + $ref: './../DtoType.yaml' + description: DTO type + example: SOURCE + id: + description: The source id + type: string + example: '3ac3c43785a845fa9820b0c1ac767cd5' + name: + description: The source name + example: 'Test Source_Name' + type: string + accounts: + description: The accounts information for a particular source in the requested item + type: array + items: + $ref: 'AccountInfoRef.yaml' diff --git a/static/api-specs/idn/v2025/paths/access-requests-accounts-selection.yaml b/static/api-specs/idn/v2025/paths/access-requests-accounts-selection.yaml new file mode 100644 index 000000000..eece22e3c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/access-requests-accounts-selection.yaml @@ -0,0 +1,37 @@ +post: + operationId: loadAccountSelections + security: + - userAuth: [ idn:access-request:create ] + x-sailpoint-userLevels: + - ORG_ADMIN + - USER + summary: Get accounts selections for identity + tags: + - Access Requests + description: | + Use this API to fetch account information for an identity against the items in an access request. + + Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/AccountsSelectionRequest.yaml' + responses: + '200': + description: Accounts Selection Response + content: + application/json: + schema: + $ref: '../schemas/access-requests/AccountsSelectionResponse.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccountsSelectionRequest.yaml b/static/api-specs/idn/v2025/schemas/AccountsSelectionRequest.yaml new file mode 100644 index 000000000..3f220c106 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountsSelectionRequest.yaml @@ -0,0 +1,31 @@ +type: object +properties: + requestedFor: + description: A list of Identity IDs for whom the Access is requested. + type: array + items: + type: string + example: 2c918084660f45d6016617daa9210584 + requestType: + $ref: 'AccessRequestType.yaml' + requestedItems: + type: array + items: + $ref: 'AccessRequestItem.yaml' + minItems: 1 + maxItems: 25 + clientMetadata: + type: object + additionalProperties: + type: string + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + description: >- + Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on + associated APIs such as /account-activities. + +required : ["requestedFor", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/access-requests/AccountInfoRef.yaml b/static/api-specs/idn/v2025/schemas/access-requests/AccountInfoRef.yaml new file mode 100644 index 000000000..db4c223eb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/AccountInfoRef.yaml @@ -0,0 +1,23 @@ +type: object +properties: + uuid: + type: string + description: The uuid for the account, available under the 'objectguid' attribute + example: '{fab7119e-004f-4822-9c33-b8d570d6c6a6}' + nativeIdentity: + type: string + description: The 'distinguishedName' attribute for the account + example: 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' + type: + $ref: './../DtoType.yaml' + description: DTO type + example: 'ACCOUNT' + id: + type: string + description: The account id + example: 'f19d168c27374fd1aff3b483573f997f' + name: + type: string + description: The account display name + example: 'UserAccount.761a2248b' + diff --git a/static/api-specs/idn/v2025/schemas/access-requests/AccountsSelectionResponse.yaml b/static/api-specs/idn/v2025/schemas/access-requests/AccountsSelectionResponse.yaml new file mode 100644 index 000000000..9b02d748e --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/AccountsSelectionResponse.yaml @@ -0,0 +1,7 @@ +type: object +properties: + identities: + description: A list of available account selections per identity in the request, for all the requested items + type: array + items: + $ref: 'IdentityAccountSelections.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/access-requests/IdentityAccountSelections.yaml b/static/api-specs/idn/v2025/schemas/access-requests/IdentityAccountSelections.yaml new file mode 100644 index 000000000..81710446a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/IdentityAccountSelections.yaml @@ -0,0 +1,24 @@ +type: object +properties: + requestedItems: + description: Available account selections for the identity, per requested item + type: array + items: + $ref: 'RequestedItemAccountSelections.yaml' + accountsSelectionRequired: + description: A boolean indicating whether any account selections will be required for the user to raise an access request + type: boolean + example: false + default: false + type: + $ref: './../DtoType.yaml' + description: DTO type + example: IDENTITY + id: + description: The identity id for the user + type: string + example: '70016590f2df4b879bdb1313a9e4e19e' + name: + description: The name of the identity + type: string + example: 'User name' diff --git a/static/api-specs/idn/v2025/schemas/access-requests/RequestedItemAccountSelections.yaml b/static/api-specs/idn/v2025/schemas/access-requests/RequestedItemAccountSelections.yaml new file mode 100644 index 000000000..36619dd3c --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/RequestedItemAccountSelections.yaml @@ -0,0 +1,37 @@ +type: object +properties: + description: + type: string + description: The description for this requested item + example: 'An access profile for the admins' + accountsSelectionBlocked: + type: boolean + default: false + description: | + This field indicates if account selections are not allowed for this requested item. + * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. + * An example is where a user is requesting an access profile that is already assigned to one of their accounts. + example: false + accountsSelectionBlockedReason: + type: string + description: If account selections are not allowed for an item, this field will denote the reason. + nullable: true + example: 'ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT' + type: + type: string + enum: [ ACCESS_PROFILE, ROLE, ENTITLEMENT ] + description: The type of the item being requested. + example: ACCESS_PROFILE + id: + type: string + description: The id of the requested item + example: '720fd239701344aea76c93ba91376aec' + name: + type: string + description: The name of the requested item + example: 'Test Access Profile' + sources: + description: The details for the sources and accounts for the requested item and identity combination + type: array + items: + $ref: 'SourceAccountSelections.yaml' diff --git a/static/api-specs/idn/v2025/schemas/access-requests/SourceAccountSelections.yaml b/static/api-specs/idn/v2025/schemas/access-requests/SourceAccountSelections.yaml new file mode 100644 index 000000000..6810f66c1 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/SourceAccountSelections.yaml @@ -0,0 +1,19 @@ +type: object +properties: + type: + $ref: './../DtoType.yaml' + description: DTO type + example: SOURCE + id: + description: The source id + type: string + example: '3ac3c43785a845fa9820b0c1ac767cd5' + name: + description: The source name + example: 'Test Source_Name' + type: string + accounts: + description: The accounts information for a particular source in the requested item + type: array + items: + $ref: 'AccountInfoRef.yaml' From 6150a9b9fd09d2d7a3ccd94444cff823a395aa3b Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Fri, 11 Apr 2025 15:51:04 +0000 Subject: [PATCH 42/82] Automated commit by github action: 14407042707 --- static/api-specs/idn/sailpoint-api.v2024.yaml | 6 ++++++ static/api-specs/idn/sailpoint-api.v2025.yaml | 6 ++++++ static/api-specs/idn/v2024/schemas/IdpDetails.yaml | 12 ++++-------- .../idn/v2024/schemas/ProvisioningPolicyDto.yaml | 1 + .../v2024/schemas/ServiceProviderConfiguration.yaml | 2 +- static/api-specs/idn/v2024/schemas/SpDetails.yaml | 12 ++++++------ .../IdentityEntitlementDetailsAccountTarget.yaml | 2 +- static/api-specs/idn/v2025/schemas/IdpDetails.yaml | 12 ++++-------- .../idn/v2025/schemas/ProvisioningPolicyDto.yaml | 1 + .../v2025/schemas/ServiceProviderConfiguration.yaml | 2 +- static/api-specs/idn/v2025/schemas/SpDetails.yaml | 12 ++++++------ static/api-specs/idn/v3/schemas/IdpDetails.yaml | 12 ++++-------- .../idn/v3/schemas/ProvisioningPolicyDto.yaml | 1 + .../idn/v3/schemas/ServiceProviderConfiguration.yaml | 2 +- static/api-specs/idn/v3/schemas/SpDetails.yaml | 12 ++++++------ 15 files changed, 49 insertions(+), 46 deletions(-) diff --git a/static/api-specs/idn/sailpoint-api.v2024.yaml b/static/api-specs/idn/sailpoint-api.v2024.yaml index a662bf389..eddb906b4 100644 --- a/static/api-specs/idn/sailpoint-api.v2024.yaml +++ b/static/api-specs/idn/sailpoint-api.v2024.yaml @@ -1399,6 +1399,12 @@ paths: $ref: ./v2024/paths/account-activity-get-one.yaml /auth-org/network-config: $ref: ./v2024/paths/auth-org-network-config.yaml + /auth-org/lockout-config: + $ref: "./v2024/paths/auth-org-lockout-config.yaml" + /auth-org/service-provider-config: + $ref: "./v2024/paths/auth-org-service-provider-config.yaml" + /auth-org/session-config: + $ref: "./v2024/paths/auth-org-session-config.yaml" /auth-users/{id}: $ref: ./v2024/paths/auth-user.yaml /brandings: diff --git a/static/api-specs/idn/sailpoint-api.v2025.yaml b/static/api-specs/idn/sailpoint-api.v2025.yaml index 7eb1768bd..2f979ee31 100644 --- a/static/api-specs/idn/sailpoint-api.v2025.yaml +++ b/static/api-specs/idn/sailpoint-api.v2025.yaml @@ -1399,6 +1399,12 @@ paths: $ref: ./v2025/paths/account-activity-get-one.yaml /auth-org/network-config: $ref: ./v2025/paths/auth-org-network-config.yaml + /auth-org/lockout-config: + $ref: "./v2025/paths/auth-org-lockout-config.yaml" + /auth-org/service-provider-config: + $ref: "./v2025/paths/auth-org-service-provider-config.yaml" + /auth-org/session-config: + $ref: "./v2025/paths/auth-org-session-config.yaml" /auth-users/{id}: $ref: ./v2025/paths/auth-user.yaml /brandings: diff --git a/static/api-specs/idn/v2024/schemas/IdpDetails.yaml b/static/api-specs/idn/v2024/schemas/IdpDetails.yaml index e7b9337c4..56a1da30f 100644 --- a/static/api-specs/idn/v2024/schemas/IdpDetails.yaml +++ b/static/api-specs/idn/v2024/schemas/IdpDetails.yaml @@ -2,12 +2,14 @@ allOf: - $ref: './FederationProtocolDetails.yaml' - type: object description: Specification of Identity Provider Details section of Service Provider Config + required: + - mappingAttribute properties: binding: type: string description: Defines the binding used for the SAML flow. Used with IDP configurations. example: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST - authContext: + authnContext: type: string description: Specifies the SAML authentication method to use. Used with IDP configurations. example: urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport @@ -15,7 +17,7 @@ allOf: type: string description: The IDP logout URL. Used with IDP configurations. example: https://dev-206445.oktapreview.com/login/signout - includeAuthContext: + includeAuthnContext: type: boolean description: Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. default: false @@ -42,12 +44,6 @@ allOf: type: string description: Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. example: email - role: - type: string - description: Federation protocol role - example: SAML_IDP - enum: - - SAML_IDP certificateExpirationDate: type: string description: The expiration date extracted from the certificate. diff --git a/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml b/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml index bba00330b..176675355 100644 --- a/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml +++ b/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml @@ -3,6 +3,7 @@ required: - name properties: name: + nullable: true type: string description: the provisioning policy name example: example provisioning policy for inactive identities diff --git a/static/api-specs/idn/v2024/schemas/ServiceProviderConfiguration.yaml b/static/api-specs/idn/v2024/schemas/ServiceProviderConfiguration.yaml index cd2107220..a5c93d9e2 100644 --- a/static/api-specs/idn/v2024/schemas/ServiceProviderConfiguration.yaml +++ b/static/api-specs/idn/v2024/schemas/ServiceProviderConfiguration.yaml @@ -29,7 +29,7 @@ properties: provider and a customer's SailPoint instance (i.e., the service provider). type: array items: - oneOf: + anyOf: - $ref: 'IdpDetails.yaml' - $ref: 'SpDetails.yaml' example: [ diff --git a/static/api-specs/idn/v2024/schemas/SpDetails.yaml b/static/api-specs/idn/v2024/schemas/SpDetails.yaml index 36c835107..e66688188 100644 --- a/static/api-specs/idn/v2024/schemas/SpDetails.yaml +++ b/static/api-specs/idn/v2024/schemas/SpDetails.yaml @@ -3,12 +3,6 @@ allOf: - type: object description: Specification of a Service Provider Details properties: - role: - type: string - description: Federation protocol role - example: SAML_SP - enum: - - SAML_SP alias: type: string description: Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. @@ -17,3 +11,9 @@ allOf: type: string description: The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. example: https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp + legacyAcsUrl: + type: string + description: The legacy ACS URL used for SAML authentication. Used with SP configurations. + example: https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp + required: + - callbackUrl diff --git a/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsAccountTarget.yaml b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsAccountTarget.yaml index 617b80a4a..af6724d00 100644 --- a/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsAccountTarget.yaml +++ b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsAccountTarget.yaml @@ -5,7 +5,7 @@ properties: description: The id of account example: "c5ef070e-92c6-4276-a006-98490f132dec" accountName: - type: EntitlementDto + type: string description: The name of account example: "Adalberto.XYZ" accountUUID: diff --git a/static/api-specs/idn/v2025/schemas/IdpDetails.yaml b/static/api-specs/idn/v2025/schemas/IdpDetails.yaml index e7b9337c4..56a1da30f 100644 --- a/static/api-specs/idn/v2025/schemas/IdpDetails.yaml +++ b/static/api-specs/idn/v2025/schemas/IdpDetails.yaml @@ -2,12 +2,14 @@ allOf: - $ref: './FederationProtocolDetails.yaml' - type: object description: Specification of Identity Provider Details section of Service Provider Config + required: + - mappingAttribute properties: binding: type: string description: Defines the binding used for the SAML flow. Used with IDP configurations. example: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST - authContext: + authnContext: type: string description: Specifies the SAML authentication method to use. Used with IDP configurations. example: urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport @@ -15,7 +17,7 @@ allOf: type: string description: The IDP logout URL. Used with IDP configurations. example: https://dev-206445.oktapreview.com/login/signout - includeAuthContext: + includeAuthnContext: type: boolean description: Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. default: false @@ -42,12 +44,6 @@ allOf: type: string description: Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. example: email - role: - type: string - description: Federation protocol role - example: SAML_IDP - enum: - - SAML_IDP certificateExpirationDate: type: string description: The expiration date extracted from the certificate. diff --git a/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml b/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml index bba00330b..176675355 100644 --- a/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml +++ b/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml @@ -3,6 +3,7 @@ required: - name properties: name: + nullable: true type: string description: the provisioning policy name example: example provisioning policy for inactive identities diff --git a/static/api-specs/idn/v2025/schemas/ServiceProviderConfiguration.yaml b/static/api-specs/idn/v2025/schemas/ServiceProviderConfiguration.yaml index cd2107220..a5c93d9e2 100644 --- a/static/api-specs/idn/v2025/schemas/ServiceProviderConfiguration.yaml +++ b/static/api-specs/idn/v2025/schemas/ServiceProviderConfiguration.yaml @@ -29,7 +29,7 @@ properties: provider and a customer's SailPoint instance (i.e., the service provider). type: array items: - oneOf: + anyOf: - $ref: 'IdpDetails.yaml' - $ref: 'SpDetails.yaml' example: [ diff --git a/static/api-specs/idn/v2025/schemas/SpDetails.yaml b/static/api-specs/idn/v2025/schemas/SpDetails.yaml index 36c835107..e66688188 100644 --- a/static/api-specs/idn/v2025/schemas/SpDetails.yaml +++ b/static/api-specs/idn/v2025/schemas/SpDetails.yaml @@ -3,12 +3,6 @@ allOf: - type: object description: Specification of a Service Provider Details properties: - role: - type: string - description: Federation protocol role - example: SAML_SP - enum: - - SAML_SP alias: type: string description: Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. @@ -17,3 +11,9 @@ allOf: type: string description: The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. example: https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp + legacyAcsUrl: + type: string + description: The legacy ACS URL used for SAML authentication. Used with SP configurations. + example: https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp + required: + - callbackUrl diff --git a/static/api-specs/idn/v3/schemas/IdpDetails.yaml b/static/api-specs/idn/v3/schemas/IdpDetails.yaml index e7b9337c4..56a1da30f 100644 --- a/static/api-specs/idn/v3/schemas/IdpDetails.yaml +++ b/static/api-specs/idn/v3/schemas/IdpDetails.yaml @@ -2,12 +2,14 @@ allOf: - $ref: './FederationProtocolDetails.yaml' - type: object description: Specification of Identity Provider Details section of Service Provider Config + required: + - mappingAttribute properties: binding: type: string description: Defines the binding used for the SAML flow. Used with IDP configurations. example: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST - authContext: + authnContext: type: string description: Specifies the SAML authentication method to use. Used with IDP configurations. example: urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport @@ -15,7 +17,7 @@ allOf: type: string description: The IDP logout URL. Used with IDP configurations. example: https://dev-206445.oktapreview.com/login/signout - includeAuthContext: + includeAuthnContext: type: boolean description: Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. default: false @@ -42,12 +44,6 @@ allOf: type: string description: Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. example: email - role: - type: string - description: Federation protocol role - example: SAML_IDP - enum: - - SAML_IDP certificateExpirationDate: type: string description: The expiration date extracted from the certificate. diff --git a/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml b/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml index 102ea24f0..a86e7a572 100644 --- a/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml +++ b/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml @@ -3,6 +3,7 @@ required: - name properties: name: + nullable: true type: string description: the provisioning policy name example: example provisioning policy for inactive identities diff --git a/static/api-specs/idn/v3/schemas/ServiceProviderConfiguration.yaml b/static/api-specs/idn/v3/schemas/ServiceProviderConfiguration.yaml index cd2107220..a5c93d9e2 100644 --- a/static/api-specs/idn/v3/schemas/ServiceProviderConfiguration.yaml +++ b/static/api-specs/idn/v3/schemas/ServiceProviderConfiguration.yaml @@ -29,7 +29,7 @@ properties: provider and a customer's SailPoint instance (i.e., the service provider). type: array items: - oneOf: + anyOf: - $ref: 'IdpDetails.yaml' - $ref: 'SpDetails.yaml' example: [ diff --git a/static/api-specs/idn/v3/schemas/SpDetails.yaml b/static/api-specs/idn/v3/schemas/SpDetails.yaml index 36c835107..c49333d3d 100644 --- a/static/api-specs/idn/v3/schemas/SpDetails.yaml +++ b/static/api-specs/idn/v3/schemas/SpDetails.yaml @@ -3,12 +3,6 @@ allOf: - type: object description: Specification of a Service Provider Details properties: - role: - type: string - description: Federation protocol role - example: SAML_SP - enum: - - SAML_SP alias: type: string description: Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. @@ -17,3 +11,9 @@ allOf: type: string description: The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. example: https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp + legacyAcsUrl: + type: string + description: The legacy ACS URL used for SAML authentication. Used with SP configurations. + example: https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp + required: + - callbackUrl \ No newline at end of file From 822416d6f5b6c44d35830354cfbb725d5fccc786 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Fri, 11 Apr 2025 15:52:43 +0000 Subject: [PATCH 43/82] Update to powershell SDK docs: 14407073468 --- .../Beta/Methods/BetaAccessRequestsApi.md | 131 ++++++- .../Beta/Methods/BetaWorkflowsApi.md | 190 ++++----- .../Reference/Beta/Models/AccessRequest.md | 6 +- .../Reference/Beta/Models/AccountItemRef.md | 37 ++ .../Beta/Models/RequestedForDtoRef.md | 37 ++ .../Beta/Models/RequestedItemDtoRef.md | 49 +++ .../Reference/Beta/Models/SourceItemRef.md | 37 ++ .../V2024/Methods/V2024AccessRequestsApi.md | 244 +++++++++++- .../V2024/Methods/V2024ConfigurationHubApi.md | 2 +- .../V2024GlobalTenantSecuritySettingsApi.md | 295 ++++++++++++++ .../Reference/V2024/Models/AccessRequest.md | 6 +- .../Reference/V2024/Models/AccountInfoRef.md | 43 ++ .../Reference/V2024/Models/AccountItemRef.md | 37 ++ .../V2024/Models/AccountsSelectionRequest.md | 41 ++ .../V2024/Models/AccountsSelectionResponse.md | 35 ++ .../V2024/Models/FederationProtocolDetails.md | 37 ++ .../V2024/Models/IdentityAccountSelections.md | 43 ++ .../Reference/V2024/Models/IdpDetails.md | 61 +++ .../V2024/Models/JITConfiguration.md | 39 ++ .../V2024/Models/LockoutConfiguration.md | 39 ++ .../V2024/Models/RequestedForDtoRef.md | 37 ++ .../Models/RequestedItemAccountSelections.md | 47 +++ .../V2024/Models/RequestedItemDtoRef.md | 49 +++ .../V2024/Models/ScheduledActionPayload.md | 2 +- .../V2024/Models/ScheduledActionResponse.md | 2 +- .../Models/ServiceProviderConfiguration.md | 41 ++ ...igurationFederationProtocolDetailsInner.md | 67 ++++ .../V2024/Models/SessionConfiguration.md | 39 ++ .../V2024/Models/SourceAccountSelections.md | 41 ++ .../Reference/V2024/Models/SourceItemRef.md | 37 ++ .../Reference/V2024/Models/SpDetails.md | 43 ++ .../V2025/Methods/V2025AccessRequestsApi.md | 298 +++++++++++++- .../V2025/Methods/V2025ConfigurationHubApi.md | 2 +- .../V2025GlobalTenantSecuritySettingsApi.md | 295 ++++++++++++++ .../Reference/V2025/Models/AccessRequest.md | 6 +- .../V2025/Models/AccessRequestItem1.md | 47 +++ .../Reference/V2025/Models/AccountInfoRef.md | 43 ++ .../Reference/V2025/Models/AccountItemRef.md | 37 ++ .../V2025/Models/AccountsSelectionRequest.md | 41 ++ .../V2025/Models/AccountsSelectionResponse.md | 35 ++ .../V2025/Models/FederationProtocolDetails.md | 37 ++ .../V2025/Models/IdentityAccountSelections.md | 43 ++ .../Models/IdentityEntitlementDetails.md | 41 ++ ...IdentityEntitlementDetailsAccountTarget.md | 49 +++ ...dentityEntitlementDetailsEntitlementDto.md | 55 +++ .../Reference/V2025/Models/IdpDetails.md | 61 +++ .../V2025/Models/JITConfiguration.md | 39 ++ .../V2025/Models/LockoutConfiguration.md | 39 ++ .../V2025/Models/RequestedForDtoRef.md | 37 ++ .../Models/RequestedItemAccountSelections.md | 47 +++ .../V2025/Models/RequestedItemDtoRef.md | 49 +++ .../V2025/Models/ScheduledActionPayload.md | 2 +- .../V2025/Models/ScheduledActionResponse.md | 2 +- .../Models/ServiceProviderConfiguration.md | 41 ++ ...igurationFederationProtocolDetailsInner.md | 67 ++++ .../V2025/Models/SessionConfiguration.md | 39 ++ .../V2025/Models/SourceAccountSelections.md | 41 ++ .../Reference/V2025/Models/SourceItemRef.md | 37 ++ .../Reference/V2025/Models/SpDetails.md | 43 ++ .../Reference/V3/Methods/AccessRequestsApi.md | 131 ++++++- .../Reference/V3/Methods/WorkflowsApi.md | 14 +- .../Reference/V3/Models/AccessRequest.md | 6 +- .../Reference/V3/Models/AccountItemRef.md | 37 ++ .../Reference/V3/Models/IdpDetails.md | 12 +- .../Reference/V3/Models/RequestedForDtoRef.md | 37 ++ .../V3/Models/RequestedItemDtoRef.md | 49 +++ ...igurationFederationProtocolDetailsInner.md | 20 +- .../Reference/V3/Models/SourceItemRef.md | 37 ++ .../Reference/V3/Models/SpDetails.md | 10 +- .../powershell_code_examples_overlay.yaml | 236 ++++++++--- .../powershell_code_examples_overlay.yaml | 345 ++++++++++++++++- .../powershell_code_examples_overlay.yaml | 366 +++++++++++++++++- .../v3/powershell_code_examples_overlay.yaml | 138 ++++++- 73 files changed, 4637 insertions(+), 188 deletions(-) create mode 100644 docs/tools/sdk/powershell/Reference/Beta/Models/AccountItemRef.md create mode 100644 docs/tools/sdk/powershell/Reference/Beta/Models/RequestedForDtoRef.md create mode 100644 docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemDtoRef.md create mode 100644 docs/tools/sdk/powershell/Reference/Beta/Models/SourceItemRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/AccountInfoRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/AccountItemRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionRequest.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionResponse.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/FederationProtocolDetails.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAccountSelections.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/IdpDetails.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/JITConfiguration.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/LockoutConfiguration.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/RequestedForDtoRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemAccountSelections.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemDtoRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfiguration.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/SessionConfiguration.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountSelections.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/SourceItemRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/SpDetails.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem1.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/AccountInfoRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/AccountItemRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionRequest.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionResponse.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/FederationProtocolDetails.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/IdentityAccountSelections.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetails.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/IdpDetails.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/JITConfiguration.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/LockoutConfiguration.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/RequestedForDtoRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemAccountSelections.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemDtoRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfiguration.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/SessionConfiguration.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/SourceAccountSelections.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/SourceItemRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/SpDetails.md create mode 100644 docs/tools/sdk/powershell/Reference/V3/Models/AccountItemRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V3/Models/RequestedForDtoRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemDtoRef.md create mode 100644 docs/tools/sdk/powershell/Reference/V3/Models/SourceItemRef.md diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md index 160616eb4..aa6c93e03 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md @@ -174,6 +174,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -184,6 +185,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-request) @@ -213,7 +215,7 @@ Code | Description | Data Type ### Example ```powershell $AccessRequest = @"{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -274,6 +276,133 @@ $AccessRequest = @"{ "type" : "ACCESS_PROFILE", "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md index 3e1b7d0c7..07ca16453 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md @@ -33,9 +33,9 @@ Method | HTTP request | Description [**Update-BetaWorkflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow [**Submit-BetaExternalExecuteWorkflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger [**Submit-BetaWorkflowExternalTrigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**Send-BetaWorkflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow [**Test-BetaExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger [**Test-BetaWorkflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id -[**Update-BetaWorkflow**](#update-workflow) | **PUT** `/workflows/{id}` | Update Workflow ## cancel-workflow-execution @@ -184,6 +184,7 @@ Get a single workflow by id. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Id of the workflow + Query | WorkflowMetrics | **Boolean** | (optional) (default to $true) | disable workflow metrics ### Return type [**Workflow**](../models/workflow) @@ -205,6 +206,7 @@ Code | Description | Data Type ### Example ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) # Get Workflow By Id @@ -212,7 +214,7 @@ try { Get-BetaWorkflow -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkflow -Id $Id + # Get-BetaWorkflow -Id $Id -WorkflowMetrics $WorkflowMetrics } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" Write-Host $_.ErrorDetails @@ -572,6 +574,10 @@ List all workflows in the tenant. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | TriggerId | **String** | (optional) | Trigger ID + Query | ConnectorInstanceId | **String** | (optional) | Connector Instance ID ### Return type [**Workflow[]**](../models/workflow) @@ -592,6 +598,10 @@ Code | Description | Data Type ### Example ```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$TriggerId = "idn:identity-created" # String | Trigger ID (optional) +$ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) # List Workflows @@ -599,7 +609,7 @@ try { Get-BetaWorkflows # Below is a request that includes all optional parameters - # Get-BetaWorkflows + # Get-BetaWorkflows -Limit $Limit -Offset $Offset -TriggerId $TriggerId -ConnectorInstanceId $ConnectorInstanceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" Write-Host $_.ErrorDetails @@ -752,6 +762,93 @@ try { ``` [[Back to top]](#) +## put-workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-workflow) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Workflow + Body | WorkflowBody | [**WorkflowBody**](../models/workflow-body) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | 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. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow +$WorkflowBody = @"{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false +}"@ + +# Update Workflow + +try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-BetaWorkflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-BetaWorkflow -Id $Id -WorkflowBody $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## test-external-execute-workflow Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. @@ -848,90 +945,3 @@ try { } ``` [[Back to top]](#) - -## update-workflow -Perform a full update of a workflow. The updated workflow object is returned in the response. - -[API Spec](https://developer.sailpoint.com/docs/api/beta/update-workflow) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Id of the Workflow - Body | WorkflowBody | [**WorkflowBody**](../models/workflow-body) | True | - -### Return type -[**Workflow**](../models/workflow) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The Workflow object | Workflow -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | 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. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow -$WorkflowBody = @"{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false -}"@ - -# Update Workflow - -try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Update-BetaWorkflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -WorkflowBody $Result -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails -} -``` -[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md index b8a9416bb..01f0c246b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md @@ -20,15 +20,17 @@ Name | Type | Description | Notes **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] **RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] ## Examples - Prepare the resource ```powershell -$AccessRequest = Initialize-PSSailpoint.BetaAccessRequest -RequestedFor null ` +$AccessRequest = Initialize-PSSailpoint.BetaAccessRequest -RequestedFor 2c918084660f45d6016617daa9210584 ` -RequestType null ` -RequestedItems null ` - -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ` + -RequestedForWithRequestedItems null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountItemRef.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountItemRef.md new file mode 100644 index 000000000..b68eea0c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountItemRef.md @@ -0,0 +1,37 @@ +--- +id: beta-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountItemRef', 'BetaAccountItemRef'] +slug: /tools/sdk/powershell/beta/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'BetaAccountItemRef'] +--- + + +# AccountItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountUuid** | **String** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' attribute for the account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountItemRef = Initialize-PSSailpoint.BetaAccountItemRef -AccountUuid {fab7119e-004f-4822-9c33-b8d570d6c6a6} ` + -NativeIdentity CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local +``` + +- Convert the resource to JSON +```powershell +$AccountItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedForDtoRef.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..b3333ad7c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedForDtoRef.md @@ -0,0 +1,37 @@ +--- +id: beta-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedForDtoRef', 'BetaRequestedForDtoRef'] +slug: /tools/sdk/powershell/beta/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'BetaRequestedForDtoRef'] +--- + + +# RequestedForDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | The identity id for which the access is requested | [required] +**RequestedItems** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] + +## Examples + +- Prepare the resource +```powershell +$RequestedForDtoRef = Initialize-PSSailpoint.BetaRequestedForDtoRef -IdentityId cb89bc2f1ee6445fbea12224c526ba3a ` + -RequestedItems null +``` + +- Convert the resource to JSON +```powershell +$RequestedForDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemDtoRef.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..4d8218d3e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemDtoRef.md @@ -0,0 +1,49 @@ +--- +id: beta-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDtoRef', 'BetaRequestedItemDtoRef'] +slug: /tools/sdk/powershell/beta/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'BetaRequestedItemDtoRef'] +--- + + +# RequestedItemDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required] +**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required] +**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemDtoRef = Initialize-PSSailpoint.BetaRequestedItemDtoRef -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ` + -AccountSelection null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceItemRef.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceItemRef.md new file mode 100644 index 000000000..1862f5d50 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceItemRef.md @@ -0,0 +1,37 @@ +--- +id: beta-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceItemRef', 'BetaSourceItemRef'] +slug: /tools/sdk/powershell/beta/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'BetaSourceItemRef'] +--- + + +# SourceItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **String** | The id for the source on which account selections are made | [optional] +**Accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceItemRef = Initialize-PSSailpoint.BetaSourceItemRef -SourceId cb89bc2f1ee6445fbea12224c526ba3a ` + -Accounts null +``` + +- Convert the resource to JSON +```powershell +$SourceItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md index 2b6a2bea7..79ee383c2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md @@ -40,6 +40,7 @@ Method | HTTP request | Description [**Get-V2024AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration [**Get-V2024AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status [**Get-V2024AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators +[**Invoke-V2024LoadAccountSelections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity [**Set-V2024AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration @@ -283,6 +284,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -293,6 +295,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-request) @@ -322,7 +325,7 @@ Code | Description | Data Type ### Example ```powershell $AccessRequest = @"{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -383,6 +386,133 @@ $AccessRequest = @"{ "type" : "ACCESS_PROFILE", "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }"@ @@ -573,6 +703,118 @@ try { ``` [[Back to top]](#) +## load-account-selections +Use this API to fetch account information for an identity against the items in an access request. + +Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/load-account-selections) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccountsSelectionRequest | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True | + +### Return type +[**AccountsSelectionResponse**](../models/accounts-selection-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Accounts Selection Response | AccountsSelectionResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccountsSelectionRequest = @"{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] +}"@ + +# Get accounts selections for identity + +try { + $Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest + Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024LoadAccountSelections" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## set-access-request-config This endpoint replaces the current access-request configuration. diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md index af0956980..5036d1e6e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md @@ -252,7 +252,7 @@ Code | Description | Data Type ### Example ```powershell $ScheduledActionPayload = @"{ - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 12 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md index eb18b82a8..73f417c06 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md @@ -21,8 +21,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2024AuthOrgNetworkConfig**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. +[**Get-V2024AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. [**Get-V2024AuthOrgNetworkConfig**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. +[**Get-V2024AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**Get-V2024AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**Update-V2024AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration [**Update-V2024AuthOrgNetworkConfig**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. +[**Update-V2024AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**Update-V2024AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration ## create-auth-org-network-config @@ -76,6 +82,50 @@ try { ``` [[Back to top]](#) +## get-auth-org-lockout-config +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-lockout-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Lockout configuration for the tenant's auth org. | LockoutConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Auth Org Lockout Configuration. + +try { + Get-V2024AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgLockoutConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## get-auth-org-network-config This API returns the details of an org's network auth configuration. @@ -120,6 +170,147 @@ try { ``` [[Back to top]](#) +## get-auth-org-service-provider-config +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-service-provider-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Service provider configuration for the tenant. | ServiceProviderConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Service Provider Configuration. + +try { + Get-V2024AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgServiceProviderConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## get-auth-org-session-config +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-session-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Session configuration for the tenant's auth org. | SessionConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Auth Org Session Configuration. + +try { + Get-V2024AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgSessionConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgSessionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## patch-auth-org-lockout-config +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-lockout-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Auth Org lockout configuration. | LockoutConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + +# Update Auth Org Lockout Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## patch-auth-org-network-config This API updates an existing network configuration for an org using PATCH Requires security scope of: 'sp:auth-org:manage' @@ -172,3 +363,107 @@ try { } ``` [[Back to top]](#) + +## patch-auth-org-service-provider-config +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-service-provider-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Auth Org Service Provider configuration updated. | ServiceProviderConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + +# Update Service Provider Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## patch-auth-org-session-config +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-session-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Auth Org session configuration. | SessionConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + +# Update Auth Org Session Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgSessionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md index 2c5d49654..cec94a34d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md @@ -20,15 +20,17 @@ Name | Type | Description | Notes **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] **RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] ## Examples - Prepare the resource ```powershell -$AccessRequest = Initialize-PSSailpoint.V2024AccessRequest -RequestedFor null ` +$AccessRequest = Initialize-PSSailpoint.V2024AccessRequest -RequestedFor 2c918084660f45d6016617daa9210584 ` -RequestType null ` -RequestedItems null ` - -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ` + -RequestedForWithRequestedItems null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountInfoRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountInfoRef.md new file mode 100644 index 000000000..3a6ee6d6b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountInfoRef.md @@ -0,0 +1,43 @@ +--- +id: v2024-account-info-ref +title: AccountInfoRef +pagination_label: AccountInfoRef +sidebar_label: AccountInfoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountInfoRef', 'V2024AccountInfoRef'] +slug: /tools/sdk/powershell/v2024/models/account-info-ref +tags: ['SDK', 'Software Development Kit', 'AccountInfoRef', 'V2024AccountInfoRef'] +--- + + +# AccountInfoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | **String** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' attribute for the account | [optional] +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | The account id | [optional] +**Name** | **String** | The account display name | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountInfoRef = Initialize-PSSailpoint.V2024AccountInfoRef -Uuid {fab7119e-004f-4822-9c33-b8d570d6c6a6} ` + -NativeIdentity CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local ` + -Type null ` + -Id f19d168c27374fd1aff3b483573f997f ` + -Name UserAccount.761a2248b +``` + +- Convert the resource to JSON +```powershell +$AccountInfoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountItemRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountItemRef.md new file mode 100644 index 000000000..b432a39d0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountItemRef.md @@ -0,0 +1,37 @@ +--- +id: v2024-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountItemRef', 'V2024AccountItemRef'] +slug: /tools/sdk/powershell/v2024/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'V2024AccountItemRef'] +--- + + +# AccountItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountUuid** | **String** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' attribute for the account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountItemRef = Initialize-PSSailpoint.V2024AccountItemRef -AccountUuid {fab7119e-004f-4822-9c33-b8d570d6c6a6} ` + -NativeIdentity CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local +``` + +- Convert the resource to JSON +```powershell +$AccountItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionRequest.md new file mode 100644 index 000000000..b7ed27500 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-accounts-selection-request +title: AccountsSelectionRequest +pagination_label: AccountsSelectionRequest +sidebar_label: AccountsSelectionRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsSelectionRequest', 'V2024AccountsSelectionRequest'] +slug: /tools/sdk/powershell/v2024/models/accounts-selection-request +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionRequest', 'V2024AccountsSelectionRequest'] +--- + + +# AccountsSelectionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | **[]String** | A list of Identity IDs for whom the Access is requested. | [required] +**RequestType** | [**AccessRequestType**](access-request-type) | | [optional] +**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountsSelectionRequest = Initialize-PSSailpoint.V2024AccountsSelectionRequest -RequestedFor 2c918084660f45d6016617daa9210584 ` + -RequestType null ` + -RequestedItems null ` + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +``` + +- Convert the resource to JSON +```powershell +$AccountsSelectionRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionResponse.md new file mode 100644 index 000000000..ef0bf563c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-accounts-selection-response +title: AccountsSelectionResponse +pagination_label: AccountsSelectionResponse +sidebar_label: AccountsSelectionResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsSelectionResponse', 'V2024AccountsSelectionResponse'] +slug: /tools/sdk/powershell/v2024/models/accounts-selection-response +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionResponse', 'V2024AccountsSelectionResponse'] +--- + + +# AccountsSelectionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identities** | [**[]IdentityAccountSelections**](identity-account-selections) | A list of available account selections per identity in the request, for all the requested items | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountsSelectionResponse = Initialize-PSSailpoint.V2024AccountsSelectionResponse -Identities null +``` + +- Convert the resource to JSON +```powershell +$AccountsSelectionResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/FederationProtocolDetails.md b/docs/tools/sdk/powershell/Reference/V2024/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..8a04d1b03 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/FederationProtocolDetails.md @@ -0,0 +1,37 @@ +--- +id: v2024-federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FederationProtocolDetails', 'V2024FederationProtocolDetails'] +slug: /tools/sdk/powershell/v2024/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'V2024FederationProtocolDetails'] +--- + + +# FederationProtocolDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] + +## Examples + +- Prepare the resource +```powershell +$FederationProtocolDetails = Initialize-PSSailpoint.V2024FederationProtocolDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 +``` + +- Convert the resource to JSON +```powershell +$FederationProtocolDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAccountSelections.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAccountSelections.md new file mode 100644 index 000000000..79f0012a9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAccountSelections.md @@ -0,0 +1,43 @@ +--- +id: v2024-identity-account-selections +title: IdentityAccountSelections +pagination_label: IdentityAccountSelections +sidebar_label: IdentityAccountSelections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAccountSelections', 'V2024IdentityAccountSelections'] +slug: /tools/sdk/powershell/v2024/models/identity-account-selections +tags: ['SDK', 'Software Development Kit', 'IdentityAccountSelections', 'V2024IdentityAccountSelections'] +--- + + +# IdentityAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedItems** | [**[]RequestedItemAccountSelections**](requested-item-account-selections) | Available account selections for the identity, per requested item | [optional] +**AccountsSelectionRequired** | **Boolean** | A boolean indicating whether any account selections will be required for the user to raise an access request | [optional] [default to $false] +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | The identity id for the user | [optional] +**Name** | **String** | The name of the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAccountSelections = Initialize-PSSailpoint.V2024IdentityAccountSelections -RequestedItems null ` + -AccountsSelectionRequired false ` + -Type null ` + -Id 70016590f2df4b879bdb1313a9e4e19e ` + -Name User name +``` + +- Convert the resource to JSON +```powershell +$IdentityAccountSelections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdpDetails.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdpDetails.md new file mode 100644 index 000000000..79a3fc1ed --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdpDetails.md @@ -0,0 +1,61 @@ +--- +id: v2024-idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdpDetails', 'V2024IdpDetails'] +slug: /tools/sdk/powershell/v2024/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'V2024IdpDetails'] +--- + + +# IdpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | **String** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**NameId** | **String** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**CertificateExpirationDate** | **String** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | **String** | The name extracted from the certificate. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdpDetails = Initialize-PSSailpoint.V2024IdpDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` + -AuthnContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` + -IncludeAuthnContext false ` + -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` + -JitConfiguration null ` + -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` + -LoginUrlPost https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -MappingAttribute email ` + -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` + -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL +``` + +- Convert the resource to JSON +```powershell +$IdpDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/JITConfiguration.md b/docs/tools/sdk/powershell/Reference/V2024/Models/JITConfiguration.md new file mode 100644 index 000000000..84debaf6c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/JITConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2024-jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JITConfiguration', 'V2024JITConfiguration'] +slug: /tools/sdk/powershell/v2024/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'V2024JITConfiguration'] +--- + + +# JITConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **Boolean** | The indicator for just-in-time provisioning enabled | [optional] [default to $false] +**SourceId** | **String** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**SourceAttributeMappings** | **map[string]String** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] + +## Examples + +- Prepare the resource +```powershell +$JITConfiguration = Initialize-PSSailpoint.V2024JITConfiguration -Enabled false ` + -SourceId 2c9180857377ed2901739c12a2da5ac8 ` + -SourceAttributeMappings {firstName=okta.firstName, lastName=okta.lastName, email=okta.email} +``` + +- Convert the resource to JSON +```powershell +$JITConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/LockoutConfiguration.md b/docs/tools/sdk/powershell/Reference/V2024/Models/LockoutConfiguration.md new file mode 100644 index 000000000..140d4c1e5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/LockoutConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2024-lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LockoutConfiguration', 'V2024LockoutConfiguration'] +slug: /tools/sdk/powershell/v2024/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'V2024LockoutConfiguration'] +--- + + +# LockoutConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaximumAttempts** | **Int32** | The maximum attempts allowed before lockout occurs. | [optional] +**LockoutDuration** | **Int32** | The total time in minutes a user will be locked out. | [optional] +**LockoutWindow** | **Int32** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LockoutConfiguration = Initialize-PSSailpoint.V2024LockoutConfiguration -MaximumAttempts 5 ` + -LockoutDuration 15 ` + -LockoutWindow 5 +``` + +- Convert the resource to JSON +```powershell +$LockoutConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedForDtoRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..5bcda47c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedForDtoRef.md @@ -0,0 +1,37 @@ +--- +id: v2024-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedForDtoRef', 'V2024RequestedForDtoRef'] +slug: /tools/sdk/powershell/v2024/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'V2024RequestedForDtoRef'] +--- + + +# RequestedForDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | The identity id for which the access is requested | [required] +**RequestedItems** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] + +## Examples + +- Prepare the resource +```powershell +$RequestedForDtoRef = Initialize-PSSailpoint.V2024RequestedForDtoRef -IdentityId cb89bc2f1ee6445fbea12224c526ba3a ` + -RequestedItems null +``` + +- Convert the resource to JSON +```powershell +$RequestedForDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemAccountSelections.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemAccountSelections.md new file mode 100644 index 000000000..dc30beac1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemAccountSelections.md @@ -0,0 +1,47 @@ +--- +id: v2024-requested-item-account-selections +title: RequestedItemAccountSelections +pagination_label: RequestedItemAccountSelections +sidebar_label: RequestedItemAccountSelections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemAccountSelections', 'V2024RequestedItemAccountSelections'] +slug: /tools/sdk/powershell/v2024/models/requested-item-account-selections +tags: ['SDK', 'Software Development Kit', 'RequestedItemAccountSelections', 'V2024RequestedItemAccountSelections'] +--- + + +# RequestedItemAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **String** | The description for this requested item | [optional] +**AccountsSelectionBlocked** | **Boolean** | This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. | [optional] [default to $false] +**AccountsSelectionBlockedReason** | **String** | If account selections are not allowed for an item, this field will denote the reason. | [optional] +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [optional] +**Id** | **String** | The id of the requested item | [optional] +**Name** | **String** | The name of the requested item | [optional] +**Sources** | [**[]SourceAccountSelections**](source-account-selections) | The details for the sources and accounts for the requested item and identity combination | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemAccountSelections = Initialize-PSSailpoint.V2024RequestedItemAccountSelections -Description An access profile for the admins ` + -AccountsSelectionBlocked false ` + -AccountsSelectionBlockedReason ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT ` + -Type ACCESS_PROFILE ` + -Id 720fd239701344aea76c93ba91376aec ` + -Name Test Access Profile ` + -Sources null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemAccountSelections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemDtoRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..d8f223127 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemDtoRef.md @@ -0,0 +1,49 @@ +--- +id: v2024-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDtoRef', 'V2024RequestedItemDtoRef'] +slug: /tools/sdk/powershell/v2024/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'V2024RequestedItemDtoRef'] +--- + + +# RequestedItemDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required] +**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required] +**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemDtoRef = Initialize-PSSailpoint.V2024RequestedItemDtoRef -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ` + -AccountSelection null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionPayload.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionPayload.md index eb29f0dee..44f335446 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionPayload.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionPayload.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes ```powershell $ScheduledActionPayload = Initialize-PSSailpoint.V2024ScheduledActionPayload -JobType BACKUP ` -StartTime 2024-08-16T14:16:58.389Z ` - -CronString 0 0 12 * * ? ` + -CronString 0 0 12 * * * * ` -TimeZoneId America/Chicago ` -Content null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionResponse.md index 479cf1ffc..b40f6bbee 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionResponse.md @@ -33,7 +33,7 @@ $ScheduledActionResponse = Initialize-PSSailpoint.V2024ScheduledActionResponse -JobType BACKUP ` -Content null ` -StartTime 2021-05-12T10:00Z ` - -CronString 0 0 12 * * ? ` + -CronString 0 0 12 * * * * ` -TimeZoneId America/Chicago ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..c13bd49ed --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfiguration.md @@ -0,0 +1,41 @@ +--- +id: v2024-service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceProviderConfiguration', 'V2024ServiceProviderConfiguration'] +slug: /tools/sdk/powershell/v2024/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'V2024ServiceProviderConfiguration'] +--- + + +# ServiceProviderConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **Boolean** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to $false] +**BypassIdp** | **Boolean** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to $false] +**SamlConfigurationValid** | **Boolean** | This indicates whether or not the SAML configuration is valid. | [optional] [default to $false] +**FederationProtocolDetails** | [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceProviderConfiguration = Initialize-PSSailpoint.V2024ServiceProviderConfiguration -Enabled true ` + -BypassIdp true ` + -SamlConfigurationValid true ` + -FederationProtocolDetails [{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] +``` + +- Convert the resource to JSON +```powershell +$ServiceProviderConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..59a78e523 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,67 @@ +--- +id: v2024-service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2024ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/powershell/v2024/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2024ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + + +# ServiceProviderConfigurationFederationProtocolDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | **String** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**NameId** | **String** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**CertificateExpirationDate** | **String** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | **String** | The name extracted from the certificate. | [optional] +**Alias** | **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**LegacyAcsUrl** | **String** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailpoint.V2024ServiceProviderConfigurationFederationProtocolDetailsInner -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` + -AuthnContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` + -IncludeAuthnContext false ` + -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` + -JitConfiguration null ` + -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` + -LoginUrlPost https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -MappingAttribute email ` + -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` + -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL ` + -Alias acme-sp ` + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ` + -LegacyAcsUrl https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp +``` + +- Convert the resource to JSON +```powershell +$ServiceProviderConfigurationFederationProtocolDetailsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SessionConfiguration.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SessionConfiguration.md new file mode 100644 index 000000000..2a2d13753 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SessionConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2024-session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SessionConfiguration', 'V2024SessionConfiguration'] +slug: /tools/sdk/powershell/v2024/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'V2024SessionConfiguration'] +--- + + +# SessionConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxIdleTime** | **Int32** | The maximum time in minutes a session can be idle. | [optional] +**RememberMe** | **Boolean** | Denotes if 'remember me' is enabled. | [optional] [default to $false] +**MaxSessionTime** | **Int32** | The maximum allowable session time in minutes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SessionConfiguration = Initialize-PSSailpoint.V2024SessionConfiguration -MaxIdleTime 15 ` + -RememberMe true ` + -MaxSessionTime 45 +``` + +- Convert the resource to JSON +```powershell +$SessionConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountSelections.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountSelections.md new file mode 100644 index 000000000..1a857818b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountSelections.md @@ -0,0 +1,41 @@ +--- +id: v2024-source-account-selections +title: SourceAccountSelections +pagination_label: SourceAccountSelections +sidebar_label: SourceAccountSelections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountSelections', 'V2024SourceAccountSelections'] +slug: /tools/sdk/powershell/v2024/models/source-account-selections +tags: ['SDK', 'Software Development Kit', 'SourceAccountSelections', 'V2024SourceAccountSelections'] +--- + + +# SourceAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | The source id | [optional] +**Name** | **String** | The source name | [optional] +**Accounts** | [**[]AccountInfoRef**](account-info-ref) | The accounts information for a particular source in the requested item | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountSelections = Initialize-PSSailpoint.V2024SourceAccountSelections -Type null ` + -Id 3ac3c43785a845fa9820b0c1ac767cd5 ` + -Name Test Source_Name ` + -Accounts null +``` + +- Convert the resource to JSON +```powershell +$SourceAccountSelections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceItemRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceItemRef.md new file mode 100644 index 000000000..9fa2cd569 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceItemRef.md @@ -0,0 +1,37 @@ +--- +id: v2024-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceItemRef', 'V2024SourceItemRef'] +slug: /tools/sdk/powershell/v2024/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'V2024SourceItemRef'] +--- + + +# SourceItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **String** | The id for the source on which account selections are made | [optional] +**Accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceItemRef = Initialize-PSSailpoint.V2024SourceItemRef -SourceId cb89bc2f1ee6445fbea12224c526ba3a ` + -Accounts null +``` + +- Convert the resource to JSON +```powershell +$SourceItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpDetails.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpDetails.md new file mode 100644 index 000000000..a43f2115c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpDetails.md @@ -0,0 +1,43 @@ +--- +id: v2024-sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpDetails', 'V2024SpDetails'] +slug: /tools/sdk/powershell/v2024/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'V2024SpDetails'] +--- + + +# SpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Alias** | **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**LegacyAcsUrl** | **String** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpDetails = Initialize-PSSailpoint.V2024SpDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Alias acme-sp ` + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ` + -LegacyAcsUrl https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp +``` + +- Convert the resource to JSON +```powershell +$SpDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md index 66cd70a82..66b9f3e20 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md @@ -38,8 +38,10 @@ Method | HTTP request | Description [**Close-V2025AccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request [**New-V2025AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit Access Request [**Get-V2025AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration +[**Get-V2025EntitlementDetailsForIdentity**](#get-entitlement-details-for-identity) | **GET** `/access-requests/revocable-objects` | Identity Entitlement Details [**Get-V2025AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status [**Get-V2025AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators +[**Invoke-V2025LoadAccountSelections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity [**Set-V2025AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration @@ -283,6 +285,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -293,6 +296,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-request) @@ -322,7 +326,7 @@ Code | Description | Data Type ### Example ```powershell $AccessRequest = @"{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -373,6 +377,133 @@ $AccessRequest = @"{ "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }"@ @@ -434,6 +565,59 @@ try { ``` [[Back to top]](#) +## get-entitlement-details-for-identity +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-details-for-identity) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. +Path | IdentityId | **String** | True | The identity ID. +Path | EntitlementId | **String** | True | The entitlement ID + +### Return type +[**IdentityEntitlementDetails**](../models/identity-entitlement-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Entitlement and Account Reference | IdentityEntitlementDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$IdentityId = "7025c863c2704ba6beeaedf3cb091573" # String | The identity ID. +$EntitlementId = "ef38f94347e94562b5bb8424a56397d8" # String | The entitlement ID + +# Identity Entitlement Details + +try { + Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementDetailsForIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## list-access-request-status Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. @@ -563,6 +747,118 @@ try { ``` [[Back to top]](#) +## load-account-selections +Use this API to fetch account information for an identity against the items in an access request. + +Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/load-account-selections) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccountsSelectionRequest | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True | + +### Return type +[**AccountsSelectionResponse**](../models/accounts-selection-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Accounts Selection Response | AccountsSelectionResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccountsSelectionRequest = @"{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] +}"@ + +# Get accounts selections for identity + +try { + $Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest + Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result + + # Below is a request that includes all optional parameters + # Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025LoadAccountSelections" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## set-access-request-config This endpoint replaces the current access-request configuration. diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConfigurationHubApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConfigurationHubApi.md index 0873cd672..cd3d4f0b8 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConfigurationHubApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConfigurationHubApi.md @@ -252,7 +252,7 @@ Code | Description | Data Type ### Example ```powershell $ScheduledActionPayload = @"{ - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GlobalTenantSecuritySettingsApi.md index 80d773c77..66f0b4ee6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GlobalTenantSecuritySettingsApi.md @@ -21,8 +21,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2025AuthOrgNetworkConfig**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. +[**Get-V2025AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. [**Get-V2025AuthOrgNetworkConfig**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. +[**Get-V2025AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**Get-V2025AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**Update-V2025AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration [**Update-V2025AuthOrgNetworkConfig**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. +[**Update-V2025AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**Update-V2025AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration ## create-auth-org-network-config @@ -76,6 +82,50 @@ try { ``` [[Back to top]](#) +## get-auth-org-lockout-config +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-lockout-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Lockout configuration for the tenant's auth org. | LockoutConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Auth Org Lockout Configuration. + +try { + Get-V2025AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgLockoutConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## get-auth-org-network-config This API returns the details of an org's network auth configuration. @@ -120,6 +170,147 @@ try { ``` [[Back to top]](#) +## get-auth-org-service-provider-config +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-service-provider-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Service provider configuration for the tenant. | ServiceProviderConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Service Provider Configuration. + +try { + Get-V2025AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgServiceProviderConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## get-auth-org-session-config +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-session-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Session configuration for the tenant's auth org. | SessionConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Auth Org Session Configuration. + +try { + Get-V2025AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgSessionConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgSessionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## patch-auth-org-lockout-config +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-lockout-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Auth Org lockout configuration. | LockoutConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + +# Update Auth Org Lockout Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgLockoutConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgLockoutConfig -JsonPatchOperation $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## patch-auth-org-network-config This API updates an existing network configuration for an org using PATCH Requires security scope of: 'sp:auth-org:manage' @@ -172,3 +363,107 @@ try { } ``` [[Back to top]](#) + +## patch-auth-org-service-provider-config +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-service-provider-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Auth Org Service Provider configuration updated. | ServiceProviderConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + +# Update Service Provider Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgServiceProviderConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgServiceProviderConfig -JsonPatchOperation $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## patch-auth-org-session-config +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-session-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Auth Org session configuration. | SessionConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | 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. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + +# Update Auth Org Session Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgSessionConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgSessionConfig -JsonPatchOperation $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgSessionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequest.md index 60fdac91e..bcaa08409 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequest.md @@ -20,15 +20,17 @@ Name | Type | Description | Notes **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] **RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] ## Examples - Prepare the resource ```powershell -$AccessRequest = Initialize-PSSailpoint.V2025AccessRequest -RequestedFor null ` +$AccessRequest = Initialize-PSSailpoint.V2025AccessRequest -RequestedFor 2c918084660f45d6016617daa9210584 ` -RequestType null ` -RequestedItems null ` - -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ` + -RequestedForWithRequestedItems null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem1.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem1.md new file mode 100644 index 000000000..9efb09947 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem1.md @@ -0,0 +1,47 @@ +--- +id: v2025-access-request-item1 +title: AccessRequestItem1 +pagination_label: AccessRequestItem1 +sidebar_label: AccessRequestItem1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItem1', 'V2025AccessRequestItem1'] +slug: /tools/sdk/powershell/v2025/models/access-request-item1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem1', 'V2025AccessRequestItem1'] +--- + + +# AccessRequestItem1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required] +**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required] +**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestItem1 = Initialize-PSSailpoint.V2025AccessRequestItem1 -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN +``` + +- Convert the resource to JSON +```powershell +$AccessRequestItem1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountInfoRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountInfoRef.md new file mode 100644 index 000000000..e18ebfcfb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountInfoRef.md @@ -0,0 +1,43 @@ +--- +id: v2025-account-info-ref +title: AccountInfoRef +pagination_label: AccountInfoRef +sidebar_label: AccountInfoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountInfoRef', 'V2025AccountInfoRef'] +slug: /tools/sdk/powershell/v2025/models/account-info-ref +tags: ['SDK', 'Software Development Kit', 'AccountInfoRef', 'V2025AccountInfoRef'] +--- + + +# AccountInfoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | **String** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' attribute for the account | [optional] +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | The account id | [optional] +**Name** | **String** | The account display name | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountInfoRef = Initialize-PSSailpoint.V2025AccountInfoRef -Uuid {fab7119e-004f-4822-9c33-b8d570d6c6a6} ` + -NativeIdentity CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local ` + -Type null ` + -Id f19d168c27374fd1aff3b483573f997f ` + -Name UserAccount.761a2248b +``` + +- Convert the resource to JSON +```powershell +$AccountInfoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountItemRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountItemRef.md new file mode 100644 index 000000000..7638fa51e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountItemRef.md @@ -0,0 +1,37 @@ +--- +id: v2025-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountItemRef', 'V2025AccountItemRef'] +slug: /tools/sdk/powershell/v2025/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'V2025AccountItemRef'] +--- + + +# AccountItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountUuid** | **String** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' attribute for the account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountItemRef = Initialize-PSSailpoint.V2025AccountItemRef -AccountUuid {fab7119e-004f-4822-9c33-b8d570d6c6a6} ` + -NativeIdentity CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local +``` + +- Convert the resource to JSON +```powershell +$AccountItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionRequest.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionRequest.md new file mode 100644 index 000000000..86b5c434c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionRequest.md @@ -0,0 +1,41 @@ +--- +id: v2025-accounts-selection-request +title: AccountsSelectionRequest +pagination_label: AccountsSelectionRequest +sidebar_label: AccountsSelectionRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsSelectionRequest', 'V2025AccountsSelectionRequest'] +slug: /tools/sdk/powershell/v2025/models/accounts-selection-request +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionRequest', 'V2025AccountsSelectionRequest'] +--- + + +# AccountsSelectionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | **[]String** | A list of Identity IDs for whom the Access is requested. | [required] +**RequestType** | [**AccessRequestType**](access-request-type) | | [optional] +**RequestedItems** | [**[]AccessRequestItem1**](access-request-item1) | | [required] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountsSelectionRequest = Initialize-PSSailpoint.V2025AccountsSelectionRequest -RequestedFor 2c918084660f45d6016617daa9210584 ` + -RequestType null ` + -RequestedItems null ` + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +``` + +- Convert the resource to JSON +```powershell +$AccountsSelectionRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionResponse.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionResponse.md new file mode 100644 index 000000000..0c62e83cc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionResponse.md @@ -0,0 +1,35 @@ +--- +id: v2025-accounts-selection-response +title: AccountsSelectionResponse +pagination_label: AccountsSelectionResponse +sidebar_label: AccountsSelectionResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsSelectionResponse', 'V2025AccountsSelectionResponse'] +slug: /tools/sdk/powershell/v2025/models/accounts-selection-response +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionResponse', 'V2025AccountsSelectionResponse'] +--- + + +# AccountsSelectionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identities** | [**[]IdentityAccountSelections**](identity-account-selections) | A list of available account selections per identity in the request, for all the requested items | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountsSelectionResponse = Initialize-PSSailpoint.V2025AccountsSelectionResponse -Identities null +``` + +- Convert the resource to JSON +```powershell +$AccountsSelectionResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/FederationProtocolDetails.md b/docs/tools/sdk/powershell/Reference/V2025/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..5456e3da6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/FederationProtocolDetails.md @@ -0,0 +1,37 @@ +--- +id: v2025-federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FederationProtocolDetails', 'V2025FederationProtocolDetails'] +slug: /tools/sdk/powershell/v2025/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'V2025FederationProtocolDetails'] +--- + + +# FederationProtocolDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] + +## Examples + +- Prepare the resource +```powershell +$FederationProtocolDetails = Initialize-PSSailpoint.V2025FederationProtocolDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 +``` + +- Convert the resource to JSON +```powershell +$FederationProtocolDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityAccountSelections.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityAccountSelections.md new file mode 100644 index 000000000..47ee9b9c0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityAccountSelections.md @@ -0,0 +1,43 @@ +--- +id: v2025-identity-account-selections +title: IdentityAccountSelections +pagination_label: IdentityAccountSelections +sidebar_label: IdentityAccountSelections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAccountSelections', 'V2025IdentityAccountSelections'] +slug: /tools/sdk/powershell/v2025/models/identity-account-selections +tags: ['SDK', 'Software Development Kit', 'IdentityAccountSelections', 'V2025IdentityAccountSelections'] +--- + + +# IdentityAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedItems** | [**[]RequestedItemAccountSelections**](requested-item-account-selections) | Available account selections for the identity, per requested item | [optional] +**AccountsSelectionRequired** | **Boolean** | A boolean indicating whether any account selections will be required for the user to raise an access request | [optional] [default to $false] +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | The identity id for the user | [optional] +**Name** | **String** | The name of the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAccountSelections = Initialize-PSSailpoint.V2025IdentityAccountSelections -RequestedItems null ` + -AccountsSelectionRequired false ` + -Type null ` + -Id 70016590f2df4b879bdb1313a9e4e19e ` + -Name User name +``` + +- Convert the resource to JSON +```powershell +$IdentityAccountSelections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetails.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetails.md new file mode 100644 index 000000000..1b024802e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetails.md @@ -0,0 +1,41 @@ +--- +id: v2025-identity-entitlement-details +title: IdentityEntitlementDetails +pagination_label: IdentityEntitlementDetails +sidebar_label: IdentityEntitlementDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlementDetails', 'V2025IdentityEntitlementDetails'] +slug: /tools/sdk/powershell/v2025/models/identity-entitlement-details +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetails', 'V2025IdentityEntitlementDetails'] +--- + + +# IdentityEntitlementDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | Id of Identity | [optional] +**Entitlement** | [**IdentityEntitlementDetailsEntitlementDto**](identity-entitlement-details-entitlement-dto) | | [optional] +**SourceId** | **String** | Id of Source | [optional] +**AccountTargets** | [**[]IdentityEntitlementDetailsAccountTarget**](identity-entitlement-details-account-target) | A list of account targets on the identity provisioned with the requested entitlement. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityEntitlementDetails = Initialize-PSSailpoint.V2025IdentityEntitlementDetails -IdentityId 5928c61f-3f2e-417a-8d65-f76451e2050a ` + -Entitlement null ` + -SourceId b56728da-a24d-4177-a207-2bc4d42cba27 ` + -AccountTargets [{accountId=e7ef11cee24542b78618ce017117699f, accountName=Adalberto.XYZ, accountUUID=null, sourceId=0108906b66634d9ab7819a03eb263a88, sourceName=ODS-AD-FF-Source [source-XYZ], removeDate=null, assignmentId=null, revocable=true}] +``` + +- Convert the resource to JSON +```powershell +$IdentityEntitlementDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md new file mode 100644 index 000000000..90d5be2d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md @@ -0,0 +1,49 @@ +--- +id: v2025-identity-entitlement-details-account-target +title: IdentityEntitlementDetailsAccountTarget +pagination_label: IdentityEntitlementDetailsAccountTarget +sidebar_label: IdentityEntitlementDetailsAccountTarget +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlementDetailsAccountTarget', 'V2025IdentityEntitlementDetailsAccountTarget'] +slug: /tools/sdk/powershell/v2025/models/identity-entitlement-details-account-target +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsAccountTarget', 'V2025IdentityEntitlementDetailsAccountTarget'] +--- + + +# IdentityEntitlementDetailsAccountTarget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | **String** | The id of account | [optional] +**AccountName** | **String** | The name of account | [optional] +**AccountUUID** | **String** | The UUID representation of the account if available | [optional] +**SourceId** | **String** | The id of Source | [optional] +**SourceName** | **String** | The name of Source | [optional] +**RemoveDate** | **String** | The removal date scheduled for the entitlement on the Identity | [optional] +**AssignmentId** | **String** | The assignmentId of the entitlement on the Identity | [optional] +**Revocable** | **Boolean** | If the entitlement can be revoked | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$IdentityEntitlementDetailsAccountTarget = Initialize-PSSailpoint.V2025IdentityEntitlementDetailsAccountTarget -AccountId c5ef070e-92c6-4276-a006-98490f132dec ` + -AccountName Adalberto.XYZ ` + -AccountUUID 2236c29e-68a6-494d-a469-d072172f46cf ` + -SourceId 9269d764-8358-4ab9-9748-d4b7418548ca ` + -SourceName JDBC XYZ Source ` + -RemoveDate 2035-01-01T12:00:00.000Z ` + -AssignmentId 77a5b7b4-262f-4b6a-a2aa-87f84f45f96f ` + -Revocable true +``` + +- Convert the resource to JSON +```powershell +$IdentityEntitlementDetailsAccountTarget | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md new file mode 100644 index 000000000..a06ceb6d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md @@ -0,0 +1,55 @@ +--- +id: v2025-identity-entitlement-details-entitlement-dto +title: IdentityEntitlementDetailsEntitlementDto +pagination_label: IdentityEntitlementDetailsEntitlementDto +sidebar_label: IdentityEntitlementDetailsEntitlementDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlementDetailsEntitlementDto', 'V2025IdentityEntitlementDetailsEntitlementDto'] +slug: /tools/sdk/powershell/v2025/models/identity-entitlement-details-entitlement-dto +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsEntitlementDto', 'V2025IdentityEntitlementDetailsEntitlementDto'] +--- + + +# IdentityEntitlementDetailsEntitlementDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The entitlement id | [optional] +**Name** | **String** | The entitlement name | [optional] +**Created** | **System.DateTime** | Time when the entitlement was last modified | [optional] +**Modified** | **System.DateTime** | Time when the entitlement was last modified | [optional] +**Description** | **String** | The description of the entitlement | [optional] +**Type** | **String** | The type of the object, will always be ""ENTITLEMENT"" | [optional] +**SourceId** | **String** | The source ID | [optional] +**SourceName** | **String** | The source name | [optional] +**Owner** | [**OwnerDto**](owner-dto) | | [optional] +**Value** | **String** | The value of the entitlement | [optional] +**Flags** | **[]String** | a list of properties informing the viewer about the entitlement | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityEntitlementDetailsEntitlementDto = Initialize-PSSailpoint.V2025IdentityEntitlementDetailsEntitlementDto -Id 2c91808874ff91550175097daaec161c ` + -Name LauncherTest2 ` + -Created 2020-10-08T18:33:52.029Z ` + -Modified 2020-10-08T18:33:52.029Z ` + -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Type ENTITLEMENT ` + -SourceId 2c9180827ca885d7017ca8ce28a000eb ` + -SourceName ODS-AD-Source ` + -Owner null ` + -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Flags [privileged] +``` + +- Convert the resource to JSON +```powershell +$IdentityEntitlementDetailsEntitlementDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdpDetails.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdpDetails.md new file mode 100644 index 000000000..3cc70f893 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdpDetails.md @@ -0,0 +1,61 @@ +--- +id: v2025-idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdpDetails', 'V2025IdpDetails'] +slug: /tools/sdk/powershell/v2025/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'V2025IdpDetails'] +--- + + +# IdpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | **String** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**NameId** | **String** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**CertificateExpirationDate** | **String** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | **String** | The name extracted from the certificate. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdpDetails = Initialize-PSSailpoint.V2025IdpDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` + -AuthnContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` + -IncludeAuthnContext false ` + -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` + -JitConfiguration null ` + -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` + -LoginUrlPost https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -MappingAttribute email ` + -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` + -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL +``` + +- Convert the resource to JSON +```powershell +$IdpDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/JITConfiguration.md b/docs/tools/sdk/powershell/Reference/V2025/Models/JITConfiguration.md new file mode 100644 index 000000000..7c7024077 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/JITConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2025-jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JITConfiguration', 'V2025JITConfiguration'] +slug: /tools/sdk/powershell/v2025/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'V2025JITConfiguration'] +--- + + +# JITConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **Boolean** | The indicator for just-in-time provisioning enabled | [optional] [default to $false] +**SourceId** | **String** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**SourceAttributeMappings** | **map[string]String** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] + +## Examples + +- Prepare the resource +```powershell +$JITConfiguration = Initialize-PSSailpoint.V2025JITConfiguration -Enabled false ` + -SourceId 2c9180857377ed2901739c12a2da5ac8 ` + -SourceAttributeMappings {firstName=okta.firstName, lastName=okta.lastName, email=okta.email} +``` + +- Convert the resource to JSON +```powershell +$JITConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/LockoutConfiguration.md b/docs/tools/sdk/powershell/Reference/V2025/Models/LockoutConfiguration.md new file mode 100644 index 000000000..2ca281e0c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/LockoutConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2025-lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LockoutConfiguration', 'V2025LockoutConfiguration'] +slug: /tools/sdk/powershell/v2025/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'V2025LockoutConfiguration'] +--- + + +# LockoutConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaximumAttempts** | **Int32** | The maximum attempts allowed before lockout occurs. | [optional] +**LockoutDuration** | **Int32** | The total time in minutes a user will be locked out. | [optional] +**LockoutWindow** | **Int32** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LockoutConfiguration = Initialize-PSSailpoint.V2025LockoutConfiguration -MaximumAttempts 5 ` + -LockoutDuration 15 ` + -LockoutWindow 5 +``` + +- Convert the resource to JSON +```powershell +$LockoutConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedForDtoRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..340d81b98 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedForDtoRef.md @@ -0,0 +1,37 @@ +--- +id: v2025-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedForDtoRef', 'V2025RequestedForDtoRef'] +slug: /tools/sdk/powershell/v2025/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'V2025RequestedForDtoRef'] +--- + + +# RequestedForDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | The identity id for which the access is requested | [required] +**RequestedItems** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] + +## Examples + +- Prepare the resource +```powershell +$RequestedForDtoRef = Initialize-PSSailpoint.V2025RequestedForDtoRef -IdentityId cb89bc2f1ee6445fbea12224c526ba3a ` + -RequestedItems null +``` + +- Convert the resource to JSON +```powershell +$RequestedForDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemAccountSelections.md b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemAccountSelections.md new file mode 100644 index 000000000..009ada1b1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemAccountSelections.md @@ -0,0 +1,47 @@ +--- +id: v2025-requested-item-account-selections +title: RequestedItemAccountSelections +pagination_label: RequestedItemAccountSelections +sidebar_label: RequestedItemAccountSelections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemAccountSelections', 'V2025RequestedItemAccountSelections'] +slug: /tools/sdk/powershell/v2025/models/requested-item-account-selections +tags: ['SDK', 'Software Development Kit', 'RequestedItemAccountSelections', 'V2025RequestedItemAccountSelections'] +--- + + +# RequestedItemAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **String** | The description for this requested item | [optional] +**AccountsSelectionBlocked** | **Boolean** | This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. | [optional] [default to $false] +**AccountsSelectionBlockedReason** | **String** | If account selections are not allowed for an item, this field will denote the reason. | [optional] +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [optional] +**Id** | **String** | The id of the requested item | [optional] +**Name** | **String** | The name of the requested item | [optional] +**Sources** | [**[]SourceAccountSelections**](source-account-selections) | The details for the sources and accounts for the requested item and identity combination | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemAccountSelections = Initialize-PSSailpoint.V2025RequestedItemAccountSelections -Description An access profile for the admins ` + -AccountsSelectionBlocked false ` + -AccountsSelectionBlockedReason ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT ` + -Type ACCESS_PROFILE ` + -Id 720fd239701344aea76c93ba91376aec ` + -Name Test Access Profile ` + -Sources null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemAccountSelections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemDtoRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..9de6d027f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemDtoRef.md @@ -0,0 +1,49 @@ +--- +id: v2025-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDtoRef', 'V2025RequestedItemDtoRef'] +slug: /tools/sdk/powershell/v2025/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'V2025RequestedItemDtoRef'] +--- + + +# RequestedItemDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required] +**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required] +**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemDtoRef = Initialize-PSSailpoint.V2025RequestedItemDtoRef -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ` + -AccountSelection null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionPayload.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionPayload.md index 0aa15c303..a65e270bd 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionPayload.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionPayload.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes ```powershell $ScheduledActionPayload = Initialize-PSSailpoint.V2025ScheduledActionPayload -JobType BACKUP ` -StartTime 2024-08-16T14:16:58.389Z ` - -CronString 0 0 12 * * ? ` + -CronString 0 0 * * * * ` -TimeZoneId America/Chicago ` -Content null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionResponse.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionResponse.md index da10ee1b4..8076806c5 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionResponse.md @@ -33,7 +33,7 @@ $ScheduledActionResponse = Initialize-PSSailpoint.V2025ScheduledActionResponse -JobType BACKUP ` -Content null ` -StartTime 2021-05-12T10:00Z ` - -CronString 0 0 12 * * ? ` + -CronString 0 0 * * * * ` -TimeZoneId America/Chicago ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..f55fb1485 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfiguration.md @@ -0,0 +1,41 @@ +--- +id: v2025-service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceProviderConfiguration', 'V2025ServiceProviderConfiguration'] +slug: /tools/sdk/powershell/v2025/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'V2025ServiceProviderConfiguration'] +--- + + +# ServiceProviderConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **Boolean** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to $false] +**BypassIdp** | **Boolean** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to $false] +**SamlConfigurationValid** | **Boolean** | This indicates whether or not the SAML configuration is valid. | [optional] [default to $false] +**FederationProtocolDetails** | [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceProviderConfiguration = Initialize-PSSailpoint.V2025ServiceProviderConfiguration -Enabled true ` + -BypassIdp true ` + -SamlConfigurationValid true ` + -FederationProtocolDetails [{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] +``` + +- Convert the resource to JSON +```powershell +$ServiceProviderConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..d00887538 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,67 @@ +--- +id: v2025-service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2025ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/powershell/v2025/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2025ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + + +# ServiceProviderConfigurationFederationProtocolDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | **String** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**NameId** | **String** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**CertificateExpirationDate** | **String** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | **String** | The name extracted from the certificate. | [optional] +**Alias** | **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**LegacyAcsUrl** | **String** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailpoint.V2025ServiceProviderConfigurationFederationProtocolDetailsInner -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` + -AuthnContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` + -IncludeAuthnContext false ` + -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` + -JitConfiguration null ` + -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` + -LoginUrlPost https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -MappingAttribute email ` + -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` + -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL ` + -Alias acme-sp ` + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ` + -LegacyAcsUrl https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp +``` + +- Convert the resource to JSON +```powershell +$ServiceProviderConfigurationFederationProtocolDetailsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SessionConfiguration.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SessionConfiguration.md new file mode 100644 index 000000000..9538a4d35 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SessionConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2025-session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SessionConfiguration', 'V2025SessionConfiguration'] +slug: /tools/sdk/powershell/v2025/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'V2025SessionConfiguration'] +--- + + +# SessionConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxIdleTime** | **Int32** | The maximum time in minutes a session can be idle. | [optional] +**RememberMe** | **Boolean** | Denotes if 'remember me' is enabled. | [optional] [default to $false] +**MaxSessionTime** | **Int32** | The maximum allowable session time in minutes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SessionConfiguration = Initialize-PSSailpoint.V2025SessionConfiguration -MaxIdleTime 15 ` + -RememberMe true ` + -MaxSessionTime 45 +``` + +- Convert the resource to JSON +```powershell +$SessionConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceAccountSelections.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceAccountSelections.md new file mode 100644 index 000000000..332394c96 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceAccountSelections.md @@ -0,0 +1,41 @@ +--- +id: v2025-source-account-selections +title: SourceAccountSelections +pagination_label: SourceAccountSelections +sidebar_label: SourceAccountSelections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountSelections', 'V2025SourceAccountSelections'] +slug: /tools/sdk/powershell/v2025/models/source-account-selections +tags: ['SDK', 'Software Development Kit', 'SourceAccountSelections', 'V2025SourceAccountSelections'] +--- + + +# SourceAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | The source id | [optional] +**Name** | **String** | The source name | [optional] +**Accounts** | [**[]AccountInfoRef**](account-info-ref) | The accounts information for a particular source in the requested item | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountSelections = Initialize-PSSailpoint.V2025SourceAccountSelections -Type null ` + -Id 3ac3c43785a845fa9820b0c1ac767cd5 ` + -Name Test Source_Name ` + -Accounts null +``` + +- Convert the resource to JSON +```powershell +$SourceAccountSelections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceItemRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceItemRef.md new file mode 100644 index 000000000..25d08b737 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceItemRef.md @@ -0,0 +1,37 @@ +--- +id: v2025-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceItemRef', 'V2025SourceItemRef'] +slug: /tools/sdk/powershell/v2025/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'V2025SourceItemRef'] +--- + + +# SourceItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **String** | The id for the source on which account selections are made | [optional] +**Accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceItemRef = Initialize-PSSailpoint.V2025SourceItemRef -SourceId cb89bc2f1ee6445fbea12224c526ba3a ` + -Accounts null +``` + +- Convert the resource to JSON +```powershell +$SourceItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SpDetails.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SpDetails.md new file mode 100644 index 000000000..f237646b2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SpDetails.md @@ -0,0 +1,43 @@ +--- +id: v2025-sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpDetails', 'V2025SpDetails'] +slug: /tools/sdk/powershell/v2025/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'V2025SpDetails'] +--- + + +# SpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Alias** | **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**LegacyAcsUrl** | **String** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpDetails = Initialize-PSSailpoint.V2025SpDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Alias acme-sp ` + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ` + -LegacyAcsUrl https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp +``` + +- Convert the resource to JSON +```powershell +$SpDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md index d21462142..66d8c0a83 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md @@ -111,6 +111,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -121,6 +122,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-request) @@ -150,7 +152,7 @@ Code | Description | Data Type ### Example ```powershell $AccessRequest = @"{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -211,6 +213,133 @@ $AccessRequest = @"{ "type" : "ACCESS_PROFILE", "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md index ac4546384..0f61c625d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md @@ -276,6 +276,7 @@ Get a single workflow by id. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Id of the workflow + Query | WorkflowMetrics | **Boolean** | (optional) (default to $true) | disable workflow metrics ### Return type [**Workflow**](../models/workflow) @@ -297,6 +298,7 @@ Code | Description | Data Type ### Example ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) # Get Workflow By Id @@ -304,7 +306,7 @@ try { Get-Workflow -Id $Id # Below is a request that includes all optional parameters - # Get-Workflow -Id $Id + # Get-Workflow -Id $Id -WorkflowMetrics $WorkflowMetrics } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" Write-Host $_.ErrorDetails @@ -664,6 +666,10 @@ List all workflows in the tenant. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- + Query | TriggerId | **String** | (optional) | Trigger ID + Query | ConnectorInstanceId | **String** | (optional) | Connector Instance ID + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. ### Return type [**Workflow[]**](../models/workflow) @@ -684,6 +690,10 @@ Code | Description | Data Type ### Example ```powershell +$TriggerId = "idn:identity-created" # String | Trigger ID (optional) +$ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # List Workflows @@ -691,7 +701,7 @@ try { Get-Workflows # Below is a request that includes all optional parameters - # Get-Workflows + # Get-Workflows -TriggerId $TriggerId -ConnectorInstanceId $ConnectorInstanceId -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md index 7f8384e07..b070bcccc 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md @@ -20,15 +20,17 @@ Name | Type | Description | Notes **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] **RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] ## Examples - Prepare the resource ```powershell -$AccessRequest = Initialize-PSSailpoint.V3AccessRequest -RequestedFor null ` +$AccessRequest = Initialize-PSSailpoint.V3AccessRequest -RequestedFor 2c918084660f45d6016617daa9210584 ` -RequestType null ` -RequestedItems null ` - -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ` + -RequestedForWithRequestedItems null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountItemRef.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountItemRef.md new file mode 100644 index 000000000..aa2e1dd3c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountItemRef.md @@ -0,0 +1,37 @@ +--- +id: account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountItemRef', 'AccountItemRef'] +slug: /tools/sdk/powershell/v3/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'AccountItemRef'] +--- + + +# AccountItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountUuid** | **String** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' attribute for the account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountItemRef = Initialize-PSSailpoint.V3AccountItemRef -AccountUuid {fab7119e-004f-4822-9c33-b8d570d6c6a6} ` + -NativeIdentity CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local +``` + +- Convert the resource to JSON +```powershell +$AccountItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdpDetails.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdpDetails.md index 56bfa5fd6..18faff740 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdpDetails.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdpDetails.md @@ -16,18 +16,18 @@ tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'IdpDetails'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Role** | **Enum** [ "SAML_IDP" ] | Federation protocol role | [optional] +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] **EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] **Binding** | **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] -**AuthContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**AuthnContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] **LogoutUrl** | **String** | The IDP logout URL. Used with IDP configurations. | [optional] -**IncludeAuthContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**IncludeAuthnContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] **NameId** | **String** | The name id format to use. Used with IDP configurations. | [optional] **JitConfiguration** | [**JITConfiguration**](jit-configuration) | | [optional] **Cert** | **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] **LoginUrlPost** | **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] **LoginUrlRedirect** | **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] -**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] +**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] **CertificateExpirationDate** | **String** | The expiration date extracted from the certificate. | [optional] **CertificateName** | **String** | The name extracted from the certificate. | [optional] @@ -38,9 +38,9 @@ Name | Type | Description | Notes $IdpDetails = Initialize-PSSailpoint.V3IdpDetails -Role SAML_IDP ` -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` - -AuthContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -AuthnContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` - -IncludeAuthContext false ` + -IncludeAuthnContext false ` -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` -JitConfiguration null ` -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RequestedForDtoRef.md b/docs/tools/sdk/powershell/Reference/V3/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..3e5d5a3d9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RequestedForDtoRef.md @@ -0,0 +1,37 @@ +--- +id: requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedForDtoRef', 'RequestedForDtoRef'] +slug: /tools/sdk/powershell/v3/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'RequestedForDtoRef'] +--- + + +# RequestedForDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | The identity id for which the access is requested | [required] +**RequestedItems** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] + +## Examples + +- Prepare the resource +```powershell +$RequestedForDtoRef = Initialize-PSSailpoint.V3RequestedForDtoRef -IdentityId cb89bc2f1ee6445fbea12224c526ba3a ` + -RequestedItems null +``` + +- Convert the resource to JSON +```powershell +$RequestedForDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemDtoRef.md b/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..231d2d20a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemDtoRef.md @@ -0,0 +1,49 @@ +--- +id: requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDtoRef', 'RequestedItemDtoRef'] +slug: /tools/sdk/powershell/v3/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'RequestedItemDtoRef'] +--- + + +# RequestedItemDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required] +**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required] +**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemDtoRef = Initialize-PSSailpoint.V3RequestedItemDtoRef -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ` + -AccountSelection null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md index 4ef2cb737..2834057b6 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -16,33 +16,34 @@ tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederatio Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Role** | **Enum** [ "SAML_SP" ] | Federation protocol role | [optional] +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] **EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] **Binding** | **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] -**AuthContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**AuthnContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] **LogoutUrl** | **String** | The IDP logout URL. Used with IDP configurations. | [optional] -**IncludeAuthContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**IncludeAuthnContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] **NameId** | **String** | The name id format to use. Used with IDP configurations. | [optional] **JitConfiguration** | [**JITConfiguration**](jit-configuration) | | [optional] **Cert** | **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] **LoginUrlPost** | **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] **LoginUrlRedirect** | **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] -**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] +**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] **CertificateExpirationDate** | **String** | The expiration date extracted from the certificate. | [optional] **CertificateName** | **String** | The name extracted from the certificate. | [optional] **Alias** | **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] -**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] +**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**LegacyAcsUrl** | **String** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] ## Examples - Prepare the resource ```powershell -$ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailpoint.V3ServiceProviderConfigurationFederationProtocolDetailsInner -Role SAML_SP ` +$ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailpoint.V3ServiceProviderConfigurationFederationProtocolDetailsInner -Role SAML_IDP ` -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` - -AuthContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -AuthnContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` - -IncludeAuthContext false ` + -IncludeAuthnContext false ` -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` -JitConfiguration null ` -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` @@ -52,7 +53,8 @@ $ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailp -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL ` -Alias acme-sp ` - -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ` + -LegacyAcsUrl https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SourceItemRef.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceItemRef.md new file mode 100644 index 000000000..fe4b46d36 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SourceItemRef.md @@ -0,0 +1,37 @@ +--- +id: source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceItemRef', 'SourceItemRef'] +slug: /tools/sdk/powershell/v3/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'SourceItemRef'] +--- + + +# SourceItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **String** | The id for the source on which account selections are made | [optional] +**Accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceItemRef = Initialize-PSSailpoint.V3SourceItemRef -SourceId cb89bc2f1ee6445fbea12224c526ba3a ` + -Accounts null +``` + +- Convert the resource to JSON +```powershell +$SourceItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SpDetails.md b/docs/tools/sdk/powershell/Reference/V3/Models/SpDetails.md index ea63bbae0..8750f2a07 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SpDetails.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SpDetails.md @@ -16,19 +16,21 @@ tags: ['SDK', 'Software Development Kit', 'SpDetails', 'SpDetails'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Role** | **Enum** [ "SAML_SP" ] | Federation protocol role | [optional] +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] **EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] **Alias** | **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] -**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] +**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**LegacyAcsUrl** | **String** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] ## Examples - Prepare the resource ```powershell -$SpDetails = Initialize-PSSailpoint.V3SpDetails -Role SAML_SP ` +$SpDetails = Initialize-PSSailpoint.V3SpDetails -Role SAML_IDP ` -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` -Alias acme-sp ` - -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ` + -LegacyAcsUrl https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp ``` - Convert the resource to JSON diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index aa9428e5c..5ed89184c 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -578,7 +578,7 @@ source: | $AccessRequest = @" { - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -639,6 +639,133 @@ "type" : "ACCESS_PROFILE", "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] } "@ @@ -14271,6 +14398,7 @@ label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) # Get Workflow By Id @@ -14278,7 +14406,7 @@ Get-BetaWorkflow -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkflow -Id $Id + # Get-BetaWorkflow -Id $Id -WorkflowMetrics $WorkflowMetrics } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" Write-Host $_.ErrorDetails @@ -14430,6 +14558,10 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $TriggerId = "idn:identity-created" # String | Trigger ID (optional) + $ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) # List Workflows @@ -14437,7 +14569,7 @@ Get-BetaWorkflows # Below is a request that includes all optional parameters - # Get-BetaWorkflows + # Get-BetaWorkflows -Limit $Limit -Offset $Offset -TriggerId $TriggerId -ConnectorInstanceId $ConnectorInstanceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" Write-Host $_.ErrorDetails @@ -14509,56 +14641,11 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-BetaExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" - Write-Host $_.ErrorDetails - } - path: /workflows/{id} method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow + label: SDK_tools/sdk/powershell/beta/methods/workflows#put-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow $WorkflowBody = @" @@ -14608,11 +14695,56 @@ try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Update-BetaWorkflow -Id $Id -WorkflowBody $Result + Send-BetaWorkflow -Id $Id -WorkflowBody $Result # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -WorkflowBody $Result + # Send-BetaWorkflow -Id $Id -WorkflowBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" Write-Host $_.ErrorDetails } diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index 1aac5da75..bab084b65 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -656,7 +656,7 @@ source: | $AccessRequest = @" { - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -717,6 +717,133 @@ "type" : "ACCESS_PROFILE", "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] } "@ @@ -807,6 +934,91 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus" Write-Host $_.ErrorDetails } +- path: /access-requests/accounts-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#load-account-selections + source: | + $AccountsSelectionRequest = @" + { + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } + "@ + + # Get accounts selections for identity + + try { + $Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest + Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024LoadAccountSelections" + Write-Host $_.ErrorDetails + } - path: /access-request-config method: PUT xCodeSample: @@ -3326,7 +3538,7 @@ source: | $ScheduledActionPayload = @" { - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 12 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", @@ -5640,6 +5852,24 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + + # Get Auth Org Lockout Configuration. + + try { + Get-V2024AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgLockoutConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } - path: /auth-org/network-config method: GET xCodeSample: @@ -5658,6 +5888,67 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + + # Get Service Provider Configuration. + + try { + Get-V2024AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgServiceProviderConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + + # Get Auth Org Session Configuration. + + try { + Get-V2024AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgSessionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Lockout Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } - path: /auth-org/network-config method: PATCH xCodeSample: @@ -5683,6 +5974,56 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Service Provider Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Session Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } - path: /workgroups method: POST xCodeSample: diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index 1cefc7ca9..d6d2b80a3 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -656,7 +656,7 @@ source: | $AccessRequest = @" { - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -707,6 +707,133 @@ "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] } "@ @@ -741,6 +868,27 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestConfig" Write-Host $_.ErrorDetails } +- path: /access-requests/revocable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#get-entitlement-details-for-identity + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityId = "7025c863c2704ba6beeaedf3cb091573" # String | The identity ID. + $EntitlementId = "ef38f94347e94562b5bb8424a56397d8" # String | The entitlement ID + + # Identity Entitlement Details + + try { + Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementDetailsForIdentity" + Write-Host $_.ErrorDetails + } - path: /access-request-status method: GET xCodeSample: @@ -797,6 +945,91 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AdministratorsAccessRequestStatus" Write-Host $_.ErrorDetails } +- path: /access-requests/accounts-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#load-account-selections + source: | + $AccountsSelectionRequest = @" + { + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } + "@ + + # Get accounts selections for identity + + try { + $Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest + Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result + + # Below is a request that includes all optional parameters + # Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025LoadAccountSelections" + Write-Host $_.ErrorDetails + } - path: /access-request-config method: PUT xCodeSample: @@ -3316,7 +3549,7 @@ source: | $ScheduledActionPayload = @" { - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", @@ -5630,6 +5863,24 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + + # Get Auth Org Lockout Configuration. + + try { + Get-V2025AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgLockoutConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } - path: /auth-org/network-config method: GET xCodeSample: @@ -5648,6 +5899,67 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + + # Get Service Provider Configuration. + + try { + Get-V2025AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgServiceProviderConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + + # Get Auth Org Session Configuration. + + try { + Get-V2025AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgSessionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Lockout Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgLockoutConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgLockoutConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } - path: /auth-org/network-config method: PATCH xCodeSample: @@ -5673,6 +5985,56 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Service Provider Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgServiceProviderConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgServiceProviderConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Session Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgSessionConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgSessionConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } - path: /workgroups method: POST xCodeSample: diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index b34657cb1..a55273a04 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -431,7 +431,7 @@ source: | $AccessRequest = @" { - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -492,6 +492,133 @@ "type" : "ACCESS_PROFILE", "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] } "@ @@ -9789,6 +9916,7 @@ label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) # Get Workflow By Id @@ -9796,7 +9924,7 @@ Get-Workflow -Id $Id # Below is a request that includes all optional parameters - # Get-Workflow -Id $Id + # Get-Workflow -Id $Id -WorkflowMetrics $WorkflowMetrics } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" Write-Host $_.ErrorDetails @@ -9948,6 +10076,10 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflows source: | + $TriggerId = "idn:identity-created" # String | Trigger ID (optional) + $ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # List Workflows @@ -9955,7 +10087,7 @@ Get-Workflows # Below is a request that includes all optional parameters - # Get-Workflows + # Get-Workflows -TriggerId $TriggerId -ConnectorInstanceId $ConnectorInstanceId -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" Write-Host $_.ErrorDetails From c1361992b7b4575ca7162645f74c2da3b2fdf928 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Mon, 14 Apr 2025 18:04:01 +0000 Subject: [PATCH 44/82] Automated commit by github action: 14452501581 --- static/api-specs/idn/beta/schemas/AttributeDefinition.yaml | 1 + static/api-specs/idn/beta/schemas/AttributeDefinitionType.yaml | 1 + static/api-specs/idn/beta/schemas/Schema.yaml | 3 +++ .../api-specs/idn/v2024/schemas/AttributeDefinitionType.yaml | 1 + .../api-specs/idn/v2025/schemas/AttributeDefinitionType.yaml | 1 + static/api-specs/idn/v3/schemas/AttributeDefinitionType.yaml | 1 + 6 files changed, 8 insertions(+) diff --git a/static/api-specs/idn/beta/schemas/AttributeDefinition.yaml b/static/api-specs/idn/beta/schemas/AttributeDefinition.yaml index ac1afd537..adc0728db 100644 --- a/static/api-specs/idn/beta/schemas/AttributeDefinition.yaml +++ b/static/api-specs/idn/beta/schemas/AttributeDefinition.yaml @@ -7,6 +7,7 @@ properties: type: $ref: './AttributeDefinitionType.yaml' schema: + nullable: true description: A reference to the schema on the source to the attribute values map to. type: object properties: diff --git a/static/api-specs/idn/beta/schemas/AttributeDefinitionType.yaml b/static/api-specs/idn/beta/schemas/AttributeDefinitionType.yaml index 505cb6d14..508befa17 100644 --- a/static/api-specs/idn/beta/schemas/AttributeDefinitionType.yaml +++ b/static/api-specs/idn/beta/schemas/AttributeDefinitionType.yaml @@ -5,5 +5,6 @@ enum: - LONG - INT - BOOLEAN + - DATE description: The underlying type of the value which an AttributeDefinition represents. example: STRING diff --git a/static/api-specs/idn/beta/schemas/Schema.yaml b/static/api-specs/idn/beta/schemas/Schema.yaml index 74d8b9a37..375cf2e33 100644 --- a/static/api-specs/idn/beta/schemas/Schema.yaml +++ b/static/api-specs/idn/beta/schemas/Schema.yaml @@ -21,6 +21,7 @@ properties: description: The name of the attribute used to calculate the display value for an object in the schema. example: distinguishedName hierarchyAttribute: + nullable: true type: string description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. example: memberOf @@ -28,6 +29,7 @@ properties: type: boolean description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. example: false + default: false features: $ref: '../../beta/schemas/SourceFeature.yaml' configuration: @@ -69,6 +71,7 @@ properties: format: 'date-time' example: '2019-12-24T22:32:58.104Z' modified: + nullable: true type: string description: The date the Schema was last modified. format: 'date-time' diff --git a/static/api-specs/idn/v2024/schemas/AttributeDefinitionType.yaml b/static/api-specs/idn/v2024/schemas/AttributeDefinitionType.yaml index a5f1e0759..016cf779b 100644 --- a/static/api-specs/idn/v2024/schemas/AttributeDefinitionType.yaml +++ b/static/api-specs/idn/v2024/schemas/AttributeDefinitionType.yaml @@ -4,6 +4,7 @@ enum: - LONG - INT - BOOLEAN + - DATE description: The underlying type of the value which an AttributeDefinition represents. example: STRING diff --git a/static/api-specs/idn/v2025/schemas/AttributeDefinitionType.yaml b/static/api-specs/idn/v2025/schemas/AttributeDefinitionType.yaml index a5f1e0759..016cf779b 100644 --- a/static/api-specs/idn/v2025/schemas/AttributeDefinitionType.yaml +++ b/static/api-specs/idn/v2025/schemas/AttributeDefinitionType.yaml @@ -4,6 +4,7 @@ enum: - LONG - INT - BOOLEAN + - DATE description: The underlying type of the value which an AttributeDefinition represents. example: STRING diff --git a/static/api-specs/idn/v3/schemas/AttributeDefinitionType.yaml b/static/api-specs/idn/v3/schemas/AttributeDefinitionType.yaml index a5f1e0759..016cf779b 100644 --- a/static/api-specs/idn/v3/schemas/AttributeDefinitionType.yaml +++ b/static/api-specs/idn/v3/schemas/AttributeDefinitionType.yaml @@ -4,6 +4,7 @@ enum: - LONG - INT - BOOLEAN + - DATE description: The underlying type of the value which an AttributeDefinition represents. example: STRING From 5111ee736862f07823634e806dcb98fa7759f931 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Mon, 14 Apr 2025 18:05:36 +0000 Subject: [PATCH 45/82] Update to powershell SDK docs: 14452534025 --- .../powershell/Reference/Beta/Models/AttributeDefinitionType.md | 2 ++ docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md | 2 +- .../Reference/V2024/Models/AttributeDefinitionType.md | 2 ++ .../Reference/V2025/Models/AttributeDefinitionType.md | 2 ++ .../powershell/Reference/V3/Models/AttributeDefinitionType.md | 2 ++ 5 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeDefinitionType.md index da8de7660..d9412be04 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeDefinitionType.md @@ -23,6 +23,8 @@ tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'BetaAttrib * `BOOLEAN` (value: `"BOOLEAN"`) +* `DATE` (value: `"DATE"`) + [[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md index c51a86b84..4dbf9cb83 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes **IdentityAttribute** | **String** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] **DisplayAttribute** | **String** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] **HierarchyAttribute** | **String** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] -**IncludePermissions** | **Boolean** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**IncludePermissions** | **Boolean** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] [default to $false] **Features** | **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * 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. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * 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. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * 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. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * 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. * 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. * 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. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] **Configuration** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Holds any extra configuration data that the schema may require. | [optional] **Attributes** | [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDefinitionType.md index 534e15d0e..178126ba7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDefinitionType.md @@ -23,6 +23,8 @@ tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'V2024Attri * `BOOLEAN` (value: `"BOOLEAN"`) +* `DATE` (value: `"DATE"`) + [[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AttributeDefinitionType.md index 14ab89bd7..b9543e0c5 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AttributeDefinitionType.md @@ -23,6 +23,8 @@ tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'V2025Attri * `BOOLEAN` (value: `"BOOLEAN"`) +* `DATE` (value: `"DATE"`) + [[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/Reference/V3/Models/AttributeDefinitionType.md index 970945808..65704a1c3 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AttributeDefinitionType.md @@ -23,6 +23,8 @@ tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'AttributeD * `BOOLEAN` (value: `"BOOLEAN"`) +* `DATE` (value: `"DATE"`) + [[Back to top]](#) From 59a220c8cd6a1369ac68facf62e0f488edecdc40 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Mon, 14 Apr 2025 20:23:46 +0000 Subject: [PATCH 46/82] Update to python SDK docs: 14455009748 --- .../Beta/Methods/AccessRequestsApi.md | 131 +- .../Reference/Beta/Methods/WorkflowsApi.md | 220 +- .../Reference/Beta/Models/AccessRequest.md | 30 +- .../Reference/Beta/Models/AccountItemRef.md | 35 + .../Reference/Beta/Models/AccountUsage.md | 2 +- .../Beta/Models/AttributeDefinitionType.md | 2 + .../Reference/Beta/Models/ModelSchema.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Beta/Models/RequestedForDtoRef.md | 53 + .../Beta/Models/RequestedItemDtoRef.md | 55 + .../Reference/Beta/Models/SourceItemRef.md | 39 + .../Reference/Beta/Models/SourceUsage.md | 2 +- .../V2024/Methods/AccessRequestsApi.md | 257 +- .../V2024/Methods/ConfigurationHubApi.md | 2 +- .../GlobalTenantSecuritySettingsApi.md | 352 ++ .../Reference/V2024/Models/AccessRequest.md | 30 +- .../Reference/V2024/Models/AccountInfoRef.md | 41 + .../Reference/V2024/Models/AccountItemRef.md | 35 + .../Reference/V2024/Models/AccountUsage.md | 2 +- .../V2024/Models/AccountsSelectionRequest.md | 48 + .../V2024/Models/AccountsSelectionResponse.md | 61 + .../V2024/Models/AttributeDefinitionType.md | 2 + .../V2024/Models/FederationProtocolDetails.md | 35 + .../V2024/Models/IdentityAccountSelections.md | 62 + .../Reference/V2024/Models/IdpDetails.md | 62 + .../V2024/Models/JITConfiguration.md | 37 + .../V2024/Models/LockoutConfiguration.md | 37 + .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../V2024/Models/RequestedForDtoRef.md | 53 + .../Models/RequestedItemAccountSelections.md | 57 + .../V2024/Models/RequestedItemDtoRef.md | 55 + .../V2024/Models/ScheduledActionPayload.md | 2 +- .../V2024/Models/ScheduledActionResponse.md | 2 +- .../Models/ServiceProviderConfiguration.md | 40 + ...igurationFederationProtocolDetailsInner.md | 68 + .../V2024/Models/SessionConfiguration.md | 37 + .../V2024/Models/SourceAccountSelections.md | 46 + .../Reference/V2024/Models/SourceItemRef.md | 39 + .../Reference/V2024/Models/SourceUsage.md | 2 +- .../Reference/V2024/Models/SpDetails.md | 41 + .../V2025/Methods/AccessRequestsApi.md | 333 +- .../V2025/Methods/ConfigurationHubApi.md | 2 +- .../GlobalTenantSecuritySettingsApi.md | 352 ++ .../Reference/V2025/Models/AccessRequest.md | 30 +- .../V2025/Models/AccessRequestItem1.md | 45 + .../Reference/V2025/Models/AccountInfoRef.md | 41 + .../Reference/V2025/Models/AccountItemRef.md | 35 + .../Reference/V2025/Models/AccountUsage.md | 2 +- .../V2025/Models/AccountsSelectionRequest.md | 48 + .../V2025/Models/AccountsSelectionResponse.md | 61 + .../V2025/Models/AttributeDefinitionType.md | 2 + .../V2025/Models/FederationProtocolDetails.md | 35 + .../V2025/Models/IdentityAccountSelections.md | 62 + .../Models/IdentityEntitlementDetails.md | 53 + ...IdentityEntitlementDetailsAccountTarget.md | 47 + ...dentityEntitlementDetailsEntitlementDto.md | 56 + .../Reference/V2025/Models/IdpDetails.md | 62 + .../V2025/Models/JITConfiguration.md | 37 + .../V2025/Models/LockoutConfiguration.md | 37 + .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../V2025/Models/RequestedForDtoRef.md | 53 + .../Models/RequestedItemAccountSelections.md | 57 + .../V2025/Models/RequestedItemDtoRef.md | 55 + .../V2025/Models/ScheduledActionPayload.md | 2 +- .../V2025/Models/ScheduledActionResponse.md | 2 +- .../Models/ServiceProviderConfiguration.md | 40 + ...igurationFederationProtocolDetailsInner.md | 68 + .../V2025/Models/SessionConfiguration.md | 37 + .../V2025/Models/SourceAccountSelections.md | 46 + .../Reference/V2025/Models/SourceItemRef.md | 39 + .../Reference/V2025/Models/SourceUsage.md | 2 +- .../Reference/V2025/Models/SpDetails.md | 41 + .../Reference/V3/Methods/AccessRequestsApi.md | 131 +- .../Reference/V3/Methods/WorkflowsApi.md | 18 +- .../Reference/V3/Models/AccessRequest.md | 30 +- .../Reference/V3/Models/AccountItemRef.md | 35 + .../Reference/V3/Models/AccountUsage.md | 2 +- .../V3/Models/AttributeDefinitionType.md | 2 + .../python/Reference/V3/Models/IdpDetails.md | 12 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V3/Models/RequestedForDtoRef.md | 53 + .../V3/Models/RequestedItemDtoRef.md | 55 + ...igurationFederationProtocolDetailsInner.md | 20 +- .../Reference/V3/Models/SourceItemRef.md | 39 + .../python/Reference/V3/Models/SourceUsage.md | 2 +- .../python/Reference/V3/Models/SpDetails.md | 10 +- .../beta/python_code_examples_overlay.yaml | 3260 ++++++------ .../v2024/python_code_examples_overlay.yaml | 4634 ++++++++-------- .../v2025/python_code_examples_overlay.yaml | 4662 +++++++++-------- .../v3/python_code_examples_overlay.yaml | 3468 ++++++------ 90 files changed, 12638 insertions(+), 7669 deletions(-) create mode 100644 docs/tools/sdk/python/Reference/Beta/Models/AccountItemRef.md create mode 100644 docs/tools/sdk/python/Reference/Beta/Models/RequestedForDtoRef.md create mode 100644 docs/tools/sdk/python/Reference/Beta/Models/RequestedItemDtoRef.md create mode 100644 docs/tools/sdk/python/Reference/Beta/Models/SourceItemRef.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/AccountInfoRef.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/AccountItemRef.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionRequest.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionResponse.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/FederationProtocolDetails.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/IdentityAccountSelections.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/IdpDetails.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/JITConfiguration.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/LockoutConfiguration.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/RequestedForDtoRef.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/RequestedItemAccountSelections.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/RequestedItemDtoRef.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfiguration.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/SessionConfiguration.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/SourceAccountSelections.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/SourceItemRef.md create mode 100644 docs/tools/sdk/python/Reference/V2024/Models/SpDetails.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/AccessRequestItem1.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/AccountInfoRef.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/AccountItemRef.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionRequest.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionResponse.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/FederationProtocolDetails.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/IdentityAccountSelections.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetails.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/IdpDetails.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/JITConfiguration.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/LockoutConfiguration.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/RequestedForDtoRef.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/RequestedItemAccountSelections.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/RequestedItemDtoRef.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfiguration.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/SessionConfiguration.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/SourceAccountSelections.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/SourceItemRef.md create mode 100644 docs/tools/sdk/python/Reference/V2025/Models/SpDetails.md create mode 100644 docs/tools/sdk/python/Reference/V3/Models/AccountItemRef.md create mode 100644 docs/tools/sdk/python/Reference/V3/Models/RequestedForDtoRef.md create mode 100644 docs/tools/sdk/python/Reference/V3/Models/RequestedItemDtoRef.md create mode 100644 docs/tools/sdk/python/Reference/V3/Models/SourceItemRef.md diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md index 5103a5c36..a5481ba0d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md @@ -197,6 +197,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -207,6 +208,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-request) @@ -247,7 +249,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -308,6 +310,133 @@ with ApiClient(configuration) as api_client: "type" : "ACCESS_PROFILE", "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md index cb1c03da1..be46768e2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md @@ -31,9 +31,9 @@ Method | HTTP request | Description [**patch-workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow [**post-external-execute-workflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger [**post-workflow-external-trigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**put-workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow [**test-external-execute-workflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger [**test-workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id -[**update-workflow**](#update-workflow) | **PUT** `/workflows/{id}` | Update Workflow ## cancel-workflow-execution @@ -217,6 +217,7 @@ Get a single workflow by id. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | Id of the workflow + Query | workflow_metrics | **bool** | (optional) (default to True) | disable workflow metrics ### Return type [**Workflow**](../models/workflow) @@ -247,13 +248,14 @@ configuration = Configuration() with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) try: # Get Workflow By Id results = WorkflowsApi(api_client).get_workflow(id=id) # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) + # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) print("The response of WorkflowsApi->get_workflow:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -709,7 +711,13 @@ List all workflows in the tenant. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflows) ### Parameters -This endpoint does not need any parameter. + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | trigger_id | **str** | (optional) | Trigger ID + Query | connector_instance_id | **str** | (optional) | Connector Instance ID ### Return type [**List[Workflow]**](../models/workflow) @@ -739,13 +747,17 @@ configuration = Configuration() with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) + connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) try: # List Workflows results = WorkflowsApi(api_client).list_workflows() # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() + # results = WorkflowsApi(api_client).list_workflows(limit, offset, trigger_id, connector_instance_id) print("The response of WorkflowsApi->list_workflows:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) @@ -935,6 +947,106 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## put-workflow +Update Workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Workflow + Body | workflow_body | [**WorkflowBody**](../models/workflow-body) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | Workflow | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +429 | 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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workflow import Workflow +from sailpoint.beta.models.workflow_body import WorkflowBody +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +``` + + + [[Back to top]](#) ## test-external-execute-workflow @@ -1059,106 +1171,6 @@ with ApiClient(configuration) as api_client: -[[Back to top]](#) - -## update-workflow -Update Workflow -Perform a full update of a workflow. The updated workflow object is returned in the response. - -[API Spec](https://developer.sailpoint.com/docs/api/beta/update-workflow) - -### Parameters - -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | id | **str** | True | Id of the Workflow - Body | workflow_body | [**WorkflowBody**](../models/workflow-body) | True | - -### Return type -[**Workflow**](../models/workflow) - -### Responses -Code | Description | Data Type | Response headers | -------------- | ------------- | ------------- |------------------| -200 | The Workflow object | Workflow | - | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | -429 | 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. | ListAccessModelMetadataAttribute429Response | - | -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | - -### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json - -### Example - -```python -from sailpoint.beta.api.workflows_api import WorkflowsApi -from sailpoint.beta.api_client import ApiClient -from sailpoint.beta.models.workflow import Workflow -from sailpoint.beta.models.workflow_body import WorkflowBody -from sailpoint.configuration import Configuration -configuration = Configuration() - - -with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).update_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).update_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->update_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) -``` - - - [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md index e4160f406..1b08f7214 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **request_type** | [**AccessRequestType**](access-request-type) | | [optional] **requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**requested_for_with_requested_items** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] } ## Example @@ -28,9 +29,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.access_request import AccessRequest access_request = AccessRequest( -requested_for=[ - '2c918084660f45d6016617daa9210584' - ], +requested_for=2c918084660f45d6016617daa9210584, request_type='GRANT_ACCESS', requested_items=[ sailpoint.beta.models.access_request_item.AccessRequestItem( @@ -42,7 +41,30 @@ requested_items=[ assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) ], -client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}, +requested_for_with_requested_items=[ + sailpoint.beta.models.requested_for_dto_ref.RequestedForDtoRef( + identity_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + requested_items = [ + sailpoint.beta.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.beta.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.beta.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ], ) + ] ) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountItemRef.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountItemRef.md new file mode 100644 index 000000000..becd53f3c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountItemRef.md @@ -0,0 +1,35 @@ +--- +id: beta-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountItemRef', 'BetaAccountItemRef'] +slug: /tools/sdk/python/beta/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'BetaAccountItemRef'] +--- + +# AccountItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_item_ref import AccountItemRef + +account_item_ref = AccountItemRef( +account_uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}', +native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md index dced03305..6d30198f2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionType.md b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionType.md index 8118f5155..253856179 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionType.md @@ -23,5 +23,7 @@ The underlying type of the value which an AttributeDefinition represents. * `BOOLEAN` (value: `'BOOLEAN'`) +* `DATE` (value: `'DATE'`) + [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ModelSchema.md b/docs/tools/sdk/python/Reference/Beta/Models/ModelSchema.md index a429c4c93..9be3659d5 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/ModelSchema.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/ModelSchema.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes **identity_attribute** | **str** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] **display_attribute** | **str** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] **hierarchy_attribute** | **str** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] -**include_permissions** | **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**include_permissions** | **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] [default to False] **features** | **[]str** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * 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. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * 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. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * 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. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * 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. * 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. * 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. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] **configuration** | **object** | Holds any extra configuration data that the schema may require. | [optional] **attributes** | [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index bffe6c49e..e0b91fdea 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedForDtoRef.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..c0bc8a9d4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedForDtoRef.md @@ -0,0 +1,53 @@ +--- +id: beta-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedForDtoRef', 'BetaRequestedForDtoRef'] +slug: /tools/sdk/python/beta/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'BetaRequestedForDtoRef'] +--- + +# RequestedForDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity id for which the access is requested | [required] +**requested_items** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] +} + +## Example + +```python +from sailpoint.beta.models.requested_for_dto_ref import RequestedForDtoRef + +requested_for_dto_ref = RequestedForDtoRef( +identity_id='cb89bc2f1ee6445fbea12224c526ba3a', +requested_items=[ + sailpoint.beta.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.beta.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.beta.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemDtoRef.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..9cf365484 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemDtoRef.md @@ -0,0 +1,55 @@ +--- +id: beta-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemDtoRef', 'BetaRequestedItemDtoRef'] +slug: /tools/sdk/python/beta/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'BetaRequestedItemDtoRef'] +--- + +# RequestedItemDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**account_selection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requested_item_dto_ref import RequestedItemDtoRef + +requested_item_dto_ref = RequestedItemDtoRef( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', +account_selection=[ + sailpoint.beta.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.beta.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceItemRef.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceItemRef.md new file mode 100644 index 000000000..b44807181 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceItemRef.md @@ -0,0 +1,39 @@ +--- +id: beta-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceItemRef', 'BetaSourceItemRef'] +slug: /tools/sdk/python/beta/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'BetaSourceItemRef'] +--- + +# SourceItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_id** | **str** | The id for the source on which account selections are made | [optional] +**accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source_item_ref import SourceItemRef + +source_item_ref = SourceItemRef( +source_id='cb89bc2f1ee6445fbea12224c526ba3a', +accounts=[ + sailpoint.beta.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md index fbcbd7a29..72badf0ff 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md index ba395e4a2..526a078b3 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md @@ -38,6 +38,7 @@ Method | HTTP request | Description [**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration [**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status [**list-administrators-access-request-status**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators +[**load-account-selections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity [**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration @@ -339,6 +340,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -349,6 +351,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-request) @@ -389,7 +392,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -450,6 +453,133 @@ with ApiClient(configuration) as api_client: "type" : "ACCESS_PROFILE", "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | @@ -678,6 +808,131 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## load-account-selections +Get accounts selections for identity +Use this API to fetch account information for an identity against the items in an access request. + +Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/load-account-selections) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | accounts_selection_request | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True | + +### Return type +[**AccountsSelectionResponse**](../models/accounts-selection-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Accounts Selection Response | AccountsSelectionResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.access_requests_api import AccessRequestsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.accounts_selection_request import AccountsSelectionRequest +from sailpoint.v2024.models.accounts_selection_response import AccountsSelectionResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + accounts_selection_request = '''{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }''' # AccountsSelectionRequest | + + try: + # Get accounts selections for identity + new_accounts_selection_request = AccountsSelectionRequest.from_json(accounts_selection_request) + results = AccessRequestsApi(api_client).load_account_selections(accounts_selection_request=new_accounts_selection_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).load_account_selections(new_accounts_selection_request) + print("The response of AccessRequestsApi->load_account_selections:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->load_account_selections: %s\n" % e) +``` + + + [[Back to top]](#) ## set-access-request-config diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md index 508268f87..c95651ff4 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md @@ -301,7 +301,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: scheduled_action_payload = '''{ - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 12 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md index a23bbf9fd..ad9463944 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md @@ -19,8 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-auth-org-network-config**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. +[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. [**get-auth-org-network-config**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. +[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**get-auth-org-session-config**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration [**patch-auth-org-network-config**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. +[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration ## create-auth-org-network-config @@ -84,6 +90,61 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## get-auth-org-lockout-config +Get Auth Org Lockout Configuration. +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-lockout-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Lockout configuration for the tenant's auth org. | LockoutConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.lockout_configuration import LockoutConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Auth Org Lockout Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) +``` + + + [[Back to top]](#) ## get-auth-org-network-config @@ -139,6 +200,177 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## get-auth-org-service-provider-config +Get Service Provider Configuration. +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-service-provider-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Service provider configuration for the tenant. | ServiceProviderConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.service_provider_configuration import ServiceProviderConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Service Provider Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-auth-org-session-config +Get Auth Org Session Configuration. +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-session-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Session configuration for the tenant's auth org. | SessionConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.session_configuration import SessionConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Auth Org Session Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-lockout-config +Update Auth Org Lockout Configuration +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-lockout-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Auth Org lockout configuration. | LockoutConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.lockout_configuration import LockoutConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]''' # List[JsonPatchOperation] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + try: + # Update Auth Org Lockout Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) +``` + + + [[Back to top]](#) ## patch-auth-org-network-config @@ -200,6 +432,126 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## patch-auth-org-service-provider-config +Update Service Provider Configuration +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-service-provider-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Auth Org Service Provider configuration updated. | ServiceProviderConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.service_provider_configuration import ServiceProviderConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]''' # List[JsonPatchOperation] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + try: + # Update Service Provider Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-session-config +Update Auth Org Session Configuration +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-session-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Auth Org session configuration. | SessionConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.session_configuration import SessionConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]''' # List[JsonPatchOperation] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + try: + # Update Auth Org Session Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) +``` + + + [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md index cc33bfb60..8d030216e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **request_type** | [**AccessRequestType**](access-request-type) | | [optional] **requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**requested_for_with_requested_items** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] } ## Example @@ -28,9 +29,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.access_request import AccessRequest access_request = AccessRequest( -requested_for=[ - '2c918084660f45d6016617daa9210584' - ], +requested_for=2c918084660f45d6016617daa9210584, request_type='GRANT_ACCESS', requested_items=[ sailpoint.v2024.models.access_request_item.AccessRequestItem( @@ -42,7 +41,30 @@ requested_items=[ assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) ], -client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}, +requested_for_with_requested_items=[ + sailpoint.v2024.models.requested_for_dto_ref.RequestedForDtoRef( + identity_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + requested_items = [ + sailpoint.v2024.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.v2024.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v2024.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ], ) + ] ) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountInfoRef.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountInfoRef.md new file mode 100644 index 000000000..3c1b8ff6e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountInfoRef.md @@ -0,0 +1,41 @@ +--- +id: v2024-account-info-ref +title: AccountInfoRef +pagination_label: AccountInfoRef +sidebar_label: AccountInfoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountInfoRef', 'V2024AccountInfoRef'] +slug: /tools/sdk/python/v2024/models/account-info-ref +tags: ['SDK', 'Software Development Kit', 'AccountInfoRef', 'V2024AccountInfoRef'] +--- + +# AccountInfoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The account id | [optional] +**name** | **str** | The account display name | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_info_ref import AccountInfoRef + +account_info_ref = AccountInfoRef( +uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}', +native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', +type='IDENTITY', +id='f19d168c27374fd1aff3b483573f997f', +name='UserAccount.761a2248b' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountItemRef.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountItemRef.md new file mode 100644 index 000000000..f1ca2121f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountItemRef.md @@ -0,0 +1,35 @@ +--- +id: v2024-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountItemRef', 'V2024AccountItemRef'] +slug: /tools/sdk/python/v2024/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'V2024AccountItemRef'] +--- + +# AccountItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_item_ref import AccountItemRef + +account_item_ref = AccountItemRef( +account_uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}', +native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md index 5353898b1..442faa748 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionRequest.md new file mode 100644 index 000000000..2bf6ba93f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionRequest.md @@ -0,0 +1,48 @@ +--- +id: v2024-accounts-selection-request +title: AccountsSelectionRequest +pagination_label: AccountsSelectionRequest +sidebar_label: AccountsSelectionRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsSelectionRequest', 'V2024AccountsSelectionRequest'] +slug: /tools/sdk/python/v2024/models/accounts-selection-request +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionRequest', 'V2024AccountsSelectionRequest'] +--- + +# AccountsSelectionRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_for** | **[]str** | A list of Identity IDs for whom the Access is requested. | [required] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.accounts_selection_request import AccountsSelectionRequest + +accounts_selection_request = AccountsSelectionRequest( +requested_for=2c918084660f45d6016617daa9210584, +request_type='GRANT_ACCESS', +requested_items=[ + sailpoint.v2024.models.access_request_item.AccessRequestItem( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) + ], +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionResponse.md new file mode 100644 index 000000000..ccb1116c1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionResponse.md @@ -0,0 +1,61 @@ +--- +id: v2024-accounts-selection-response +title: AccountsSelectionResponse +pagination_label: AccountsSelectionResponse +sidebar_label: AccountsSelectionResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsSelectionResponse', 'V2024AccountsSelectionResponse'] +slug: /tools/sdk/python/v2024/models/accounts-selection-response +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionResponse', 'V2024AccountsSelectionResponse'] +--- + +# AccountsSelectionResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identities** | [**[]IdentityAccountSelections**](identity-account-selections) | A list of available account selections per identity in the request, for all the requested items | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.accounts_selection_response import AccountsSelectionResponse + +accounts_selection_response = AccountsSelectionResponse( +identities=[ + sailpoint.v2024.models.identity_account_selections.IdentityAccountSelections( + requested_items = [ + sailpoint.v2024.models.requested_item_account_selections.RequestedItemAccountSelections( + description = 'An access profile for the admins', + accounts_selection_blocked = False, + accounts_selection_blocked_reason = 'ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT', + type = 'ACCESS_PROFILE', + id = '720fd239701344aea76c93ba91376aec', + name = 'Test Access Profile', + sources = [ + sailpoint.v2024.models.source_account_selections.SourceAccountSelections( + type = 'IDENTITY', + id = '3ac3c43785a845fa9820b0c1ac767cd5', + name = 'Test Source_Name', + accounts = [ + sailpoint.v2024.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ], ) + ], ) + ], + accounts_selection_required = False, + type = 'IDENTITY', + id = '70016590f2df4b879bdb1313a9e4e19e', + name = 'User name', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionType.md b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionType.md index 0a3920531..988dd6f7b 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionType.md @@ -23,5 +23,7 @@ The underlying type of the value which an AttributeDefinition represents. * `BOOLEAN` (value: `'BOOLEAN'`) +* `DATE` (value: `'DATE'`) + [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FederationProtocolDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..d227c547e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FederationProtocolDetails.md @@ -0,0 +1,35 @@ +--- +id: v2024-federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FederationProtocolDetails', 'V2024FederationProtocolDetails'] +slug: /tools/sdk/python/v2024/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'V2024FederationProtocolDetails'] +--- + +# FederationProtocolDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.federation_protocol_details import FederationProtocolDetails + +federation_protocol_details = FederationProtocolDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAccountSelections.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAccountSelections.md new file mode 100644 index 000000000..cc022a7ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAccountSelections.md @@ -0,0 +1,62 @@ +--- +id: v2024-identity-account-selections +title: IdentityAccountSelections +pagination_label: IdentityAccountSelections +sidebar_label: IdentityAccountSelections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAccountSelections', 'V2024IdentityAccountSelections'] +slug: /tools/sdk/python/v2024/models/identity-account-selections +tags: ['SDK', 'Software Development Kit', 'IdentityAccountSelections', 'V2024IdentityAccountSelections'] +--- + +# IdentityAccountSelections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_items** | [**[]RequestedItemAccountSelections**](requested-item-account-selections) | Available account selections for the identity, per requested item | [optional] +**accounts_selection_required** | **bool** | A boolean indicating whether any account selections will be required for the user to raise an access request | [optional] [default to False] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The identity id for the user | [optional] +**name** | **str** | The name of the identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_account_selections import IdentityAccountSelections + +identity_account_selections = IdentityAccountSelections( +requested_items=[ + sailpoint.v2024.models.requested_item_account_selections.RequestedItemAccountSelections( + description = 'An access profile for the admins', + accounts_selection_blocked = False, + accounts_selection_blocked_reason = 'ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT', + type = 'ACCESS_PROFILE', + id = '720fd239701344aea76c93ba91376aec', + name = 'Test Access Profile', + sources = [ + sailpoint.v2024.models.source_account_selections.SourceAccountSelections( + type = 'IDENTITY', + id = '3ac3c43785a845fa9820b0c1ac767cd5', + name = 'Test Source_Name', + accounts = [ + sailpoint.v2024.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ], ) + ], ) + ], +accounts_selection_required=False, +type='IDENTITY', +id='70016590f2df4b879bdb1313a9e4e19e', +name='User name' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdpDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/IdpDetails.md new file mode 100644 index 000000000..ed1b75e00 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdpDetails.md @@ -0,0 +1,62 @@ +--- +id: v2024-idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdpDetails', 'V2024IdpDetails'] +slug: /tools/sdk/python/v2024/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'V2024IdpDetails'] +--- + +# IdpDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**authn_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] +**include_authn_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] +**jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] +**cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] +**certificate_name** | **str** | The name extracted from the certificate. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.idp_details import IdpDetails + +idp_details = IdpDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', +authn_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +logout_url='https://dev-206445.oktapreview.com/login/signout', +include_authn_context=False, +name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', +jit_configuration=sailpoint.v2024.models.jit_configuration.JITConfiguration( + enabled = False, + source_id = '2c9180857377ed2901739c12a2da5ac8', + source_attribute_mappings = {firstName=okta.firstName, lastName=okta.lastName, email=okta.email}, ), +cert='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', +login_url_post='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +login_url_redirect='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +mapping_attribute='email', +certificate_expiration_date='Fri Mar 08 08:54:24 UTC 2013', +certificate_name='OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/JITConfiguration.md b/docs/tools/sdk/python/Reference/V2024/Models/JITConfiguration.md new file mode 100644 index 000000000..f37b8692f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/JITConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2024-jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JITConfiguration', 'V2024JITConfiguration'] +slug: /tools/sdk/python/v2024/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'V2024JITConfiguration'] +--- + +# JITConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | The indicator for just-in-time provisioning enabled | [optional] [default to False] +**source_id** | **str** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**source_attribute_mappings** | **map[string]str** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.jit_configuration import JITConfiguration + +jit_configuration = JITConfiguration( +enabled=False, +source_id='2c9180857377ed2901739c12a2da5ac8', +source_attribute_mappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LockoutConfiguration.md b/docs/tools/sdk/python/Reference/V2024/Models/LockoutConfiguration.md new file mode 100644 index 000000000..8afc71142 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LockoutConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2024-lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LockoutConfiguration', 'V2024LockoutConfiguration'] +slug: /tools/sdk/python/v2024/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'V2024LockoutConfiguration'] +--- + +# LockoutConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**maximum_attempts** | **int** | The maximum attempts allowed before lockout occurs. | [optional] +**lockout_duration** | **int** | The total time in minutes a user will be locked out. | [optional] +**lockout_window** | **int** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.lockout_configuration import LockoutConfiguration + +lockout_configuration = LockoutConfiguration( +maximum_attempts=5, +lockout_duration=15, +lockout_window=5 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index db5a37930..a37f38fea 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedForDtoRef.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..173645fa7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedForDtoRef.md @@ -0,0 +1,53 @@ +--- +id: v2024-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedForDtoRef', 'V2024RequestedForDtoRef'] +slug: /tools/sdk/python/v2024/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'V2024RequestedForDtoRef'] +--- + +# RequestedForDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity id for which the access is requested | [required] +**requested_items** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] +} + +## Example + +```python +from sailpoint.v2024.models.requested_for_dto_ref import RequestedForDtoRef + +requested_for_dto_ref = RequestedForDtoRef( +identity_id='cb89bc2f1ee6445fbea12224c526ba3a', +requested_items=[ + sailpoint.v2024.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.v2024.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v2024.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemAccountSelections.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemAccountSelections.md new file mode 100644 index 000000000..648ece503 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemAccountSelections.md @@ -0,0 +1,57 @@ +--- +id: v2024-requested-item-account-selections +title: RequestedItemAccountSelections +pagination_label: RequestedItemAccountSelections +sidebar_label: RequestedItemAccountSelections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemAccountSelections', 'V2024RequestedItemAccountSelections'] +slug: /tools/sdk/python/v2024/models/requested-item-account-selections +tags: ['SDK', 'Software Development Kit', 'RequestedItemAccountSelections', 'V2024RequestedItemAccountSelections'] +--- + +# RequestedItemAccountSelections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | The description for this requested item | [optional] +**accounts_selection_blocked** | **bool** | This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. | [optional] [default to False] +**accounts_selection_blocked_reason** | **str** | If account selections are not allowed for an item, this field will denote the reason. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [optional] +**id** | **str** | The id of the requested item | [optional] +**name** | **str** | The name of the requested item | [optional] +**sources** | [**[]SourceAccountSelections**](source-account-selections) | The details for the sources and accounts for the requested item and identity combination | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requested_item_account_selections import RequestedItemAccountSelections + +requested_item_account_selections = RequestedItemAccountSelections( +description='An access profile for the admins', +accounts_selection_blocked=False, +accounts_selection_blocked_reason='ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT', +type='ACCESS_PROFILE', +id='720fd239701344aea76c93ba91376aec', +name='Test Access Profile', +sources=[ + sailpoint.v2024.models.source_account_selections.SourceAccountSelections( + type = 'IDENTITY', + id = '3ac3c43785a845fa9820b0c1ac767cd5', + name = 'Test Source_Name', + accounts = [ + sailpoint.v2024.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemDtoRef.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..012b5e3b4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemDtoRef.md @@ -0,0 +1,55 @@ +--- +id: v2024-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemDtoRef', 'V2024RequestedItemDtoRef'] +slug: /tools/sdk/python/v2024/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'V2024RequestedItemDtoRef'] +--- + +# RequestedItemDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**account_selection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requested_item_dto_ref import RequestedItemDtoRef + +requested_item_dto_ref = RequestedItemDtoRef( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', +account_selection=[ + sailpoint.v2024.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v2024.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionPayload.md b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionPayload.md index 9f7a1351d..6ad80a33b 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionPayload.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionPayload.md @@ -31,7 +31,7 @@ from sailpoint.v2024.models.scheduled_action_payload import ScheduledActionPaylo scheduled_action_payload = ScheduledActionPayload( job_type='BACKUP', start_time='2024-08-16T14:16:58.389Z', -cron_string='0 0 12 * * ?', +cron_string='0 0 12 * * * *', time_zone_id='America/Chicago', content=sailpoint.v2024.models.scheduled_action_payload_content.ScheduledActionPayload_content( name = 'Daily Backup', diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionResponse.md index 8b43a1fc1..f689432a0 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionResponse.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionResponse.md @@ -43,7 +43,7 @@ content=sailpoint.v2024.models.scheduled_action_response_content.ScheduledAction source_tenant = 'tenant-name', draft_id = '9012b87d-48ca-439a-868f-2160001da8c3', ), start_time='2021-05-12T10:00Z', -cron_string='0 0 12 * * ?', +cron_string='0 0 12 * * * *', time_zone_id='America/Chicago' ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..ee4ba613a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfiguration.md @@ -0,0 +1,40 @@ +--- +id: v2024-service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceProviderConfiguration', 'V2024ServiceProviderConfiguration'] +slug: /tools/sdk/python/v2024/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'V2024ServiceProviderConfiguration'] +--- + +# ServiceProviderConfiguration + +Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to False] +**bypass_idp** | **bool** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to False] +**saml_configuration_valid** | **bool** | This indicates whether or not the SAML configuration is valid. | [optional] [default to False] +**federation_protocol_details** | [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.service_provider_configuration import ServiceProviderConfiguration + +service_provider_configuration = ServiceProviderConfiguration( +enabled=True, +bypass_idp=True, +saml_configuration_valid=True, +federation_protocol_details=[{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..f3d7aa3f3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,68 @@ +--- +id: v2024-service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2024ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/python/v2024/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2024ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + +# ServiceProviderConfigurationFederationProtocolDetailsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**authn_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] +**include_authn_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] +**jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] +**cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] +**certificate_name** | **str** | The name extracted from the certificate. | [optional] +**alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**legacy_acs_url** | **str** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.service_provider_configuration_federation_protocol_details_inner import ServiceProviderConfigurationFederationProtocolDetailsInner + +service_provider_configuration_federation_protocol_details_inner = ServiceProviderConfigurationFederationProtocolDetailsInner( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', +authn_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +logout_url='https://dev-206445.oktapreview.com/login/signout', +include_authn_context=False, +name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', +jit_configuration=sailpoint.v2024.models.jit_configuration.JITConfiguration( + enabled = False, + source_id = '2c9180857377ed2901739c12a2da5ac8', + source_attribute_mappings = {firstName=okta.firstName, lastName=okta.lastName, email=okta.email}, ), +cert='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', +login_url_post='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +login_url_redirect='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +mapping_attribute='email', +certificate_expiration_date='Fri Mar 08 08:54:24 UTC 2013', +certificate_name='OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL', +alias='acme-sp', +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp', +legacy_acs_url='https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SessionConfiguration.md b/docs/tools/sdk/python/Reference/V2024/Models/SessionConfiguration.md new file mode 100644 index 000000000..9e04f18e4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SessionConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2024-session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SessionConfiguration', 'V2024SessionConfiguration'] +slug: /tools/sdk/python/v2024/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'V2024SessionConfiguration'] +--- + +# SessionConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_idle_time** | **int** | The maximum time in minutes a session can be idle. | [optional] +**remember_me** | **bool** | Denotes if 'remember me' is enabled. | [optional] [default to False] +**max_session_time** | **int** | The maximum allowable session time in minutes. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.session_configuration import SessionConfiguration + +session_configuration = SessionConfiguration( +max_idle_time=15, +remember_me=True, +max_session_time=45 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountSelections.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountSelections.md new file mode 100644 index 000000000..1d80a112a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountSelections.md @@ -0,0 +1,46 @@ +--- +id: v2024-source-account-selections +title: SourceAccountSelections +pagination_label: SourceAccountSelections +sidebar_label: SourceAccountSelections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountSelections', 'V2024SourceAccountSelections'] +slug: /tools/sdk/python/v2024/models/source-account-selections +tags: ['SDK', 'Software Development Kit', 'SourceAccountSelections', 'V2024SourceAccountSelections'] +--- + +# SourceAccountSelections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The source id | [optional] +**name** | **str** | The source name | [optional] +**accounts** | [**[]AccountInfoRef**](account-info-ref) | The accounts information for a particular source in the requested item | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_account_selections import SourceAccountSelections + +source_account_selections = SourceAccountSelections( +type='IDENTITY', +id='3ac3c43785a845fa9820b0c1ac767cd5', +name='Test Source_Name', +accounts=[ + sailpoint.v2024.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + type = 'IDENTITY', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceItemRef.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceItemRef.md new file mode 100644 index 000000000..03e605c46 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceItemRef.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceItemRef', 'V2024SourceItemRef'] +slug: /tools/sdk/python/v2024/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'V2024SourceItemRef'] +--- + +# SourceItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_id** | **str** | The id for the source on which account selections are made | [optional] +**accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_item_ref import SourceItemRef + +source_item_ref = SourceItemRef( +source_id='cb89bc2f1ee6445fbea12224c526ba3a', +accounts=[ + sailpoint.v2024.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md index c57393c0d..ea8523f54 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/SpDetails.md new file mode 100644 index 000000000..53cd584b5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpDetails.md @@ -0,0 +1,41 @@ +--- +id: v2024-sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpDetails', 'V2024SpDetails'] +slug: /tools/sdk/python/v2024/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'V2024SpDetails'] +--- + +# SpDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**legacy_acs_url** | **str** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sp_details import SpDetails + +sp_details = SpDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +alias='acme-sp', +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp', +legacy_acs_url='https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md index f5f5c714e..414c1d18c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md @@ -36,8 +36,10 @@ Method | HTTP request | Description [**close-access-request**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request [**create-access-request**](#create-access-request) | **POST** `/access-requests` | Submit Access Request [**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration +[**get-entitlement-details-for-identity**](#get-entitlement-details-for-identity) | **GET** `/access-requests/revocable-objects` | Identity Entitlement Details [**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status [**list-administrators-access-request-status**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators +[**load-account-selections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity [**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration @@ -339,6 +341,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -349,6 +352,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-request) @@ -389,7 +393,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -440,6 +444,133 @@ with ApiClient(configuration) as api_client: "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | @@ -511,6 +642,81 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## get-entitlement-details-for-identity +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Identity Entitlement Details +Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-details-for-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. +Path | identity_id | **str** | True | The identity ID. +Path | entitlement_id | **str** | True | The entitlement ID + +### Return type +[**IdentityEntitlementDetails**](../models/identity-entitlement-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Entitlement and Account Reference | IdentityEntitlementDetails | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.access_requests_api import AccessRequestsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.identity_entitlement_details import IdentityEntitlementDetails +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identity_id = '7025c863c2704ba6beeaedf3cb091573' # str | The identity ID. # str | The identity ID. + entitlement_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The entitlement ID # str | The entitlement ID + + try: + # Identity Entitlement Details + + results = AccessRequestsApi(api_client).get_entitlement_details_for_identity(x_sail_point_experimental=x_sail_point_experimental, identity_id=identity_id, entitlement_id=entitlement_id) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).get_entitlement_details_for_identity(x_sail_point_experimental, identity_id, entitlement_id) + print("The response of AccessRequestsApi->get_entitlement_details_for_identity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_entitlement_details_for_identity: %s\n" % e) +``` + + + [[Back to top]](#) ## list-access-request-status @@ -668,6 +874,131 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## load-account-selections +Get accounts selections for identity +Use this API to fetch account information for an identity against the items in an access request. + +Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/load-account-selections) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | accounts_selection_request | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True | + +### Return type +[**AccountsSelectionResponse**](../models/accounts-selection-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Accounts Selection Response | AccountsSelectionResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.access_requests_api import AccessRequestsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.accounts_selection_request import AccountsSelectionRequest +from sailpoint.v2025.models.accounts_selection_response import AccountsSelectionResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + accounts_selection_request = '''{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }''' # AccountsSelectionRequest | + + try: + # Get accounts selections for identity + new_accounts_selection_request = AccountsSelectionRequest.from_json(accounts_selection_request) + results = AccessRequestsApi(api_client).load_account_selections(accounts_selection_request=new_accounts_selection_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).load_account_selections(new_accounts_selection_request) + print("The response of AccessRequestsApi->load_account_selections:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->load_account_selections: %s\n" % e) +``` + + + [[Back to top]](#) ## set-access-request-config diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ConfigurationHubApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ConfigurationHubApi.md index cd5f12e61..1cdb67c49 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ConfigurationHubApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ConfigurationHubApi.md @@ -301,7 +301,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: scheduled_action_payload = '''{ - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/GlobalTenantSecuritySettingsApi.md index b699008e7..b99d744dd 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/GlobalTenantSecuritySettingsApi.md @@ -19,8 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-auth-org-network-config**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. +[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. [**get-auth-org-network-config**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. +[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**get-auth-org-session-config**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration [**patch-auth-org-network-config**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. +[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration ## create-auth-org-network-config @@ -84,6 +90,61 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## get-auth-org-lockout-config +Get Auth Org Lockout Configuration. +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-lockout-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Lockout configuration for the tenant's auth org. | LockoutConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.lockout_configuration import LockoutConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Auth Org Lockout Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) +``` + + + [[Back to top]](#) ## get-auth-org-network-config @@ -139,6 +200,177 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## get-auth-org-service-provider-config +Get Service Provider Configuration. +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-service-provider-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Service provider configuration for the tenant. | ServiceProviderConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.service_provider_configuration import ServiceProviderConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Service Provider Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-auth-org-session-config +Get Auth Org Session Configuration. +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-session-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Session configuration for the tenant's auth org. | SessionConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.session_configuration import SessionConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Auth Org Session Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-lockout-config +Update Auth Org Lockout Configuration +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-lockout-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Auth Org lockout configuration. | LockoutConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2025.models.lockout_configuration import LockoutConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]''' # List[JsonPatchOperation] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + try: + # Update Auth Org Lockout Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) +``` + + + [[Back to top]](#) ## patch-auth-org-network-config @@ -200,6 +432,126 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## patch-auth-org-service-provider-config +Update Service Provider Configuration +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-service-provider-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Auth Org Service Provider configuration updated. | ServiceProviderConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2025.models.service_provider_configuration import ServiceProviderConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]''' # List[JsonPatchOperation] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + try: + # Update Service Provider Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-session-config +Update Auth Org Session Configuration +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-session-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Auth Org session configuration. | SessionConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | 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. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2025.models.session_configuration import SessionConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]''' # List[JsonPatchOperation] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + try: + # Update Auth Org Session Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) +``` + + + [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/V2025/Models/AccessRequest.md index a0df05179..e4666ee39 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccessRequest.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccessRequest.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **request_type** | [**AccessRequestType**](access-request-type) | | [optional] **requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**requested_for_with_requested_items** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] } ## Example @@ -28,9 +29,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.access_request import AccessRequest access_request = AccessRequest( -requested_for=[ - '2c918084660f45d6016617daa9210584' - ], +requested_for=2c918084660f45d6016617daa9210584, request_type='GRANT_ACCESS', requested_items=[ sailpoint.v2025.models.access_request_item.AccessRequestItem( @@ -40,7 +39,30 @@ requested_items=[ client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, remove_date = '2020-07-11T21:23:15Z', ) ], -client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}, +requested_for_with_requested_items=[ + sailpoint.v2025.models.requested_for_dto_ref.RequestedForDtoRef( + identity_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + requested_items = [ + sailpoint.v2025.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.v2025.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v2025.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ], ) + ] ) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccessRequestItem1.md b/docs/tools/sdk/python/Reference/V2025/Models/AccessRequestItem1.md new file mode 100644 index 000000000..db1914979 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccessRequestItem1.md @@ -0,0 +1,45 @@ +--- +id: v2025-access-request-item1 +title: AccessRequestItem1 +pagination_label: AccessRequestItem1 +sidebar_label: AccessRequestItem1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestItem1', 'V2025AccessRequestItem1'] +slug: /tools/sdk/python/v2025/models/access-request-item1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem1', 'V2025AccessRequestItem1'] +--- + +# AccessRequestItem1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.access_request_item1 import AccessRequestItem1 + +access_request_item1 = AccessRequestItem1( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountInfoRef.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountInfoRef.md new file mode 100644 index 000000000..bece23d72 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountInfoRef.md @@ -0,0 +1,41 @@ +--- +id: v2025-account-info-ref +title: AccountInfoRef +pagination_label: AccountInfoRef +sidebar_label: AccountInfoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountInfoRef', 'V2025AccountInfoRef'] +slug: /tools/sdk/python/v2025/models/account-info-ref +tags: ['SDK', 'Software Development Kit', 'AccountInfoRef', 'V2025AccountInfoRef'] +--- + +# AccountInfoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The account id | [optional] +**name** | **str** | The account display name | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.account_info_ref import AccountInfoRef + +account_info_ref = AccountInfoRef( +uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}', +native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', +type='IDENTITY', +id='f19d168c27374fd1aff3b483573f997f', +name='UserAccount.761a2248b' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountItemRef.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountItemRef.md new file mode 100644 index 000000000..e1b499d5a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountItemRef.md @@ -0,0 +1,35 @@ +--- +id: v2025-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountItemRef', 'V2025AccountItemRef'] +slug: /tools/sdk/python/v2025/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'V2025AccountItemRef'] +--- + +# AccountItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.account_item_ref import AccountItemRef + +account_item_ref = AccountItemRef( +account_uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}', +native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md index 626e62e2b..8403e7986 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionRequest.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionRequest.md new file mode 100644 index 000000000..17fd9d77c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionRequest.md @@ -0,0 +1,48 @@ +--- +id: v2025-accounts-selection-request +title: AccountsSelectionRequest +pagination_label: AccountsSelectionRequest +sidebar_label: AccountsSelectionRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsSelectionRequest', 'V2025AccountsSelectionRequest'] +slug: /tools/sdk/python/v2025/models/accounts-selection-request +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionRequest', 'V2025AccountsSelectionRequest'] +--- + +# AccountsSelectionRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_for** | **[]str** | A list of Identity IDs for whom the Access is requested. | [required] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requested_items** | [**[]AccessRequestItem1**](access-request-item1) | | [required] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.accounts_selection_request import AccountsSelectionRequest + +accounts_selection_request = AccountsSelectionRequest( +requested_for=2c918084660f45d6016617daa9210584, +request_type='GRANT_ACCESS', +requested_items=[ + sailpoint.v2025.models.access_request_item_1.AccessRequestItem_1( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) + ], +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionResponse.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionResponse.md new file mode 100644 index 000000000..647b0838f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionResponse.md @@ -0,0 +1,61 @@ +--- +id: v2025-accounts-selection-response +title: AccountsSelectionResponse +pagination_label: AccountsSelectionResponse +sidebar_label: AccountsSelectionResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsSelectionResponse', 'V2025AccountsSelectionResponse'] +slug: /tools/sdk/python/v2025/models/accounts-selection-response +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionResponse', 'V2025AccountsSelectionResponse'] +--- + +# AccountsSelectionResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identities** | [**[]IdentityAccountSelections**](identity-account-selections) | A list of available account selections per identity in the request, for all the requested items | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.accounts_selection_response import AccountsSelectionResponse + +accounts_selection_response = AccountsSelectionResponse( +identities=[ + sailpoint.v2025.models.identity_account_selections.IdentityAccountSelections( + requested_items = [ + sailpoint.v2025.models.requested_item_account_selections.RequestedItemAccountSelections( + description = 'An access profile for the admins', + accounts_selection_blocked = False, + accounts_selection_blocked_reason = 'ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT', + type = 'ACCESS_PROFILE', + id = '720fd239701344aea76c93ba91376aec', + name = 'Test Access Profile', + sources = [ + sailpoint.v2025.models.source_account_selections.SourceAccountSelections( + type = 'IDENTITY', + id = '3ac3c43785a845fa9820b0c1ac767cd5', + name = 'Test Source_Name', + accounts = [ + sailpoint.v2025.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ], ) + ], ) + ], + accounts_selection_required = False, + type = 'IDENTITY', + id = '70016590f2df4b879bdb1313a9e4e19e', + name = 'User name', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AttributeDefinitionType.md b/docs/tools/sdk/python/Reference/V2025/Models/AttributeDefinitionType.md index 9c0865349..0dca489e2 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AttributeDefinitionType.md @@ -23,5 +23,7 @@ The underlying type of the value which an AttributeDefinition represents. * `BOOLEAN` (value: `'BOOLEAN'`) +* `DATE` (value: `'DATE'`) + [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/FederationProtocolDetails.md b/docs/tools/sdk/python/Reference/V2025/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..2bc2fcb6f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/FederationProtocolDetails.md @@ -0,0 +1,35 @@ +--- +id: v2025-federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FederationProtocolDetails', 'V2025FederationProtocolDetails'] +slug: /tools/sdk/python/v2025/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'V2025FederationProtocolDetails'] +--- + +# FederationProtocolDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.federation_protocol_details import FederationProtocolDetails + +federation_protocol_details = FederationProtocolDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdentityAccountSelections.md b/docs/tools/sdk/python/Reference/V2025/Models/IdentityAccountSelections.md new file mode 100644 index 000000000..23f8702cd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/IdentityAccountSelections.md @@ -0,0 +1,62 @@ +--- +id: v2025-identity-account-selections +title: IdentityAccountSelections +pagination_label: IdentityAccountSelections +sidebar_label: IdentityAccountSelections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAccountSelections', 'V2025IdentityAccountSelections'] +slug: /tools/sdk/python/v2025/models/identity-account-selections +tags: ['SDK', 'Software Development Kit', 'IdentityAccountSelections', 'V2025IdentityAccountSelections'] +--- + +# IdentityAccountSelections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_items** | [**[]RequestedItemAccountSelections**](requested-item-account-selections) | Available account selections for the identity, per requested item | [optional] +**accounts_selection_required** | **bool** | A boolean indicating whether any account selections will be required for the user to raise an access request | [optional] [default to False] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The identity id for the user | [optional] +**name** | **str** | The name of the identity | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.identity_account_selections import IdentityAccountSelections + +identity_account_selections = IdentityAccountSelections( +requested_items=[ + sailpoint.v2025.models.requested_item_account_selections.RequestedItemAccountSelections( + description = 'An access profile for the admins', + accounts_selection_blocked = False, + accounts_selection_blocked_reason = 'ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT', + type = 'ACCESS_PROFILE', + id = '720fd239701344aea76c93ba91376aec', + name = 'Test Access Profile', + sources = [ + sailpoint.v2025.models.source_account_selections.SourceAccountSelections( + type = 'IDENTITY', + id = '3ac3c43785a845fa9820b0c1ac767cd5', + name = 'Test Source_Name', + accounts = [ + sailpoint.v2025.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ], ) + ], ) + ], +accounts_selection_required=False, +type='IDENTITY', +id='70016590f2df4b879bdb1313a9e4e19e', +name='User name' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetails.md b/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetails.md new file mode 100644 index 000000000..8480255be --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetails.md @@ -0,0 +1,53 @@ +--- +id: v2025-identity-entitlement-details +title: IdentityEntitlementDetails +pagination_label: IdentityEntitlementDetails +sidebar_label: IdentityEntitlementDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityEntitlementDetails', 'V2025IdentityEntitlementDetails'] +slug: /tools/sdk/python/v2025/models/identity-entitlement-details +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetails', 'V2025IdentityEntitlementDetails'] +--- + +# IdentityEntitlementDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | Id of Identity | [optional] +**entitlement** | [**IdentityEntitlementDetailsEntitlementDto**](identity-entitlement-details-entitlement-dto) | | [optional] +**source_id** | **str** | Id of Source | [optional] +**account_targets** | [**[]IdentityEntitlementDetailsAccountTarget**](identity-entitlement-details-account-target) | A list of account targets on the identity provisioned with the requested entitlement. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.identity_entitlement_details import IdentityEntitlementDetails + +identity_entitlement_details = IdentityEntitlementDetails( +identity_id='5928c61f-3f2e-417a-8d65-f76451e2050a', +entitlement=sailpoint.v2025.models.identity_entitlement_details_entitlement_dto.IdentityEntitlementDetailsEntitlementDto( + id = '2c91808874ff91550175097daaec161c', + name = 'LauncherTest2', + created = '2020-10-08T18:33:52.029Z', + modified = '2020-10-08T18:33:52.029Z', + description = 'CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', + type = 'ENTITLEMENT', + source_id = '2c9180827ca885d7017ca8ce28a000eb', + source_name = 'ODS-AD-Source', + owner = sailpoint.v2025.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), + value = 'CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', + flags = [privileged], ), +source_id='b56728da-a24d-4177-a207-2bc4d42cba27', +account_targets=[{accountId=e7ef11cee24542b78618ce017117699f, accountName=Adalberto.XYZ, accountUUID=null, sourceId=0108906b66634d9ab7819a03eb263a88, sourceName=ODS-AD-FF-Source [source-XYZ], removeDate=null, assignmentId=null, revocable=true}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md b/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md new file mode 100644 index 000000000..edf523219 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md @@ -0,0 +1,47 @@ +--- +id: v2025-identity-entitlement-details-account-target +title: IdentityEntitlementDetailsAccountTarget +pagination_label: IdentityEntitlementDetailsAccountTarget +sidebar_label: IdentityEntitlementDetailsAccountTarget +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityEntitlementDetailsAccountTarget', 'V2025IdentityEntitlementDetailsAccountTarget'] +slug: /tools/sdk/python/v2025/models/identity-entitlement-details-account-target +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsAccountTarget', 'V2025IdentityEntitlementDetailsAccountTarget'] +--- + +# IdentityEntitlementDetailsAccountTarget + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | The id of account | [optional] +**account_name** | **str** | The name of account | [optional] +**account_uuid** | **str** | The UUID representation of the account if available | [optional] +**source_id** | **str** | The id of Source | [optional] +**source_name** | **str** | The name of Source | [optional] +**remove_date** | **str** | The removal date scheduled for the entitlement on the Identity | [optional] +**assignment_id** | **str** | The assignmentId of the entitlement on the Identity | [optional] +**revocable** | **bool** | If the entitlement can be revoked | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2025.models.identity_entitlement_details_account_target import IdentityEntitlementDetailsAccountTarget + +identity_entitlement_details_account_target = IdentityEntitlementDetailsAccountTarget( +account_id='c5ef070e-92c6-4276-a006-98490f132dec', +account_name='Adalberto.XYZ', +account_uuid='2236c29e-68a6-494d-a469-d072172f46cf', +source_id='9269d764-8358-4ab9-9748-d4b7418548ca', +source_name='JDBC XYZ Source', +remove_date='2035-01-01T12:00:00.000Z', +assignment_id='77a5b7b4-262f-4b6a-a2aa-87f84f45f96f', +revocable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md b/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md new file mode 100644 index 000000000..d60a3ba63 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md @@ -0,0 +1,56 @@ +--- +id: v2025-identity-entitlement-details-entitlement-dto +title: IdentityEntitlementDetailsEntitlementDto +pagination_label: IdentityEntitlementDetailsEntitlementDto +sidebar_label: IdentityEntitlementDetailsEntitlementDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityEntitlementDetailsEntitlementDto', 'V2025IdentityEntitlementDetailsEntitlementDto'] +slug: /tools/sdk/python/v2025/models/identity-entitlement-details-entitlement-dto +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsEntitlementDto', 'V2025IdentityEntitlementDetailsEntitlementDto'] +--- + +# IdentityEntitlementDetailsEntitlementDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The entitlement id | [optional] +**name** | **str** | The entitlement name | [optional] +**created** | **datetime** | Time when the entitlement was last modified | [optional] +**modified** | **datetime** | Time when the entitlement was last modified | [optional] +**description** | **str** | The description of the entitlement | [optional] +**type** | **str** | The type of the object, will always be \"ENTITLEMENT\" | [optional] +**source_id** | **str** | The source ID | [optional] +**source_name** | **str** | The source name | [optional] +**owner** | [**OwnerDto**](owner-dto) | | [optional] +**value** | **str** | The value of the entitlement | [optional] +**flags** | **[]str** | a list of properties informing the viewer about the entitlement | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.identity_entitlement_details_entitlement_dto import IdentityEntitlementDetailsEntitlementDto + +identity_entitlement_details_entitlement_dto = IdentityEntitlementDetailsEntitlementDto( +id='2c91808874ff91550175097daaec161c', +name='LauncherTest2', +created='2020-10-08T18:33:52.029Z', +modified='2020-10-08T18:33:52.029Z', +description='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', +type='ENTITLEMENT', +source_id='2c9180827ca885d7017ca8ce28a000eb', +source_name='ODS-AD-Source', +owner=sailpoint.v2025.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +value='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', +flags=[privileged] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdpDetails.md b/docs/tools/sdk/python/Reference/V2025/Models/IdpDetails.md new file mode 100644 index 000000000..648f0a72f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/IdpDetails.md @@ -0,0 +1,62 @@ +--- +id: v2025-idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdpDetails', 'V2025IdpDetails'] +slug: /tools/sdk/python/v2025/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'V2025IdpDetails'] +--- + +# IdpDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**authn_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] +**include_authn_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] +**jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] +**cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] +**certificate_name** | **str** | The name extracted from the certificate. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.idp_details import IdpDetails + +idp_details = IdpDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', +authn_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +logout_url='https://dev-206445.oktapreview.com/login/signout', +include_authn_context=False, +name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', +jit_configuration=sailpoint.v2025.models.jit_configuration.JITConfiguration( + enabled = False, + source_id = '2c9180857377ed2901739c12a2da5ac8', + source_attribute_mappings = {firstName=okta.firstName, lastName=okta.lastName, email=okta.email}, ), +cert='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', +login_url_post='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +login_url_redirect='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +mapping_attribute='email', +certificate_expiration_date='Fri Mar 08 08:54:24 UTC 2013', +certificate_name='OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/JITConfiguration.md b/docs/tools/sdk/python/Reference/V2025/Models/JITConfiguration.md new file mode 100644 index 000000000..1d88f780d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/JITConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2025-jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JITConfiguration', 'V2025JITConfiguration'] +slug: /tools/sdk/python/v2025/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'V2025JITConfiguration'] +--- + +# JITConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | The indicator for just-in-time provisioning enabled | [optional] [default to False] +**source_id** | **str** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**source_attribute_mappings** | **map[string]str** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.jit_configuration import JITConfiguration + +jit_configuration = JITConfiguration( +enabled=False, +source_id='2c9180857377ed2901739c12a2da5ac8', +source_attribute_mappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/LockoutConfiguration.md b/docs/tools/sdk/python/Reference/V2025/Models/LockoutConfiguration.md new file mode 100644 index 000000000..d3e5503e4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/LockoutConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2025-lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LockoutConfiguration', 'V2025LockoutConfiguration'] +slug: /tools/sdk/python/v2025/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'V2025LockoutConfiguration'] +--- + +# LockoutConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**maximum_attempts** | **int** | The maximum attempts allowed before lockout occurs. | [optional] +**lockout_duration** | **int** | The total time in minutes a user will be locked out. | [optional] +**lockout_window** | **int** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.lockout_configuration import LockoutConfiguration + +lockout_configuration = LockoutConfiguration( +maximum_attempts=5, +lockout_duration=15, +lockout_window=5 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 33437e264..960d4b101 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/RequestedForDtoRef.md b/docs/tools/sdk/python/Reference/V2025/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..94471e330 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/RequestedForDtoRef.md @@ -0,0 +1,53 @@ +--- +id: v2025-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedForDtoRef', 'V2025RequestedForDtoRef'] +slug: /tools/sdk/python/v2025/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'V2025RequestedForDtoRef'] +--- + +# RequestedForDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity id for which the access is requested | [required] +**requested_items** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] +} + +## Example + +```python +from sailpoint.v2025.models.requested_for_dto_ref import RequestedForDtoRef + +requested_for_dto_ref = RequestedForDtoRef( +identity_id='cb89bc2f1ee6445fbea12224c526ba3a', +requested_items=[ + sailpoint.v2025.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.v2025.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v2025.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/RequestedItemAccountSelections.md b/docs/tools/sdk/python/Reference/V2025/Models/RequestedItemAccountSelections.md new file mode 100644 index 000000000..9bd7b88ed --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/RequestedItemAccountSelections.md @@ -0,0 +1,57 @@ +--- +id: v2025-requested-item-account-selections +title: RequestedItemAccountSelections +pagination_label: RequestedItemAccountSelections +sidebar_label: RequestedItemAccountSelections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemAccountSelections', 'V2025RequestedItemAccountSelections'] +slug: /tools/sdk/python/v2025/models/requested-item-account-selections +tags: ['SDK', 'Software Development Kit', 'RequestedItemAccountSelections', 'V2025RequestedItemAccountSelections'] +--- + +# RequestedItemAccountSelections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | The description for this requested item | [optional] +**accounts_selection_blocked** | **bool** | This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. | [optional] [default to False] +**accounts_selection_blocked_reason** | **str** | If account selections are not allowed for an item, this field will denote the reason. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [optional] +**id** | **str** | The id of the requested item | [optional] +**name** | **str** | The name of the requested item | [optional] +**sources** | [**[]SourceAccountSelections**](source-account-selections) | The details for the sources and accounts for the requested item and identity combination | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.requested_item_account_selections import RequestedItemAccountSelections + +requested_item_account_selections = RequestedItemAccountSelections( +description='An access profile for the admins', +accounts_selection_blocked=False, +accounts_selection_blocked_reason='ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT', +type='ACCESS_PROFILE', +id='720fd239701344aea76c93ba91376aec', +name='Test Access Profile', +sources=[ + sailpoint.v2025.models.source_account_selections.SourceAccountSelections( + type = 'IDENTITY', + id = '3ac3c43785a845fa9820b0c1ac767cd5', + name = 'Test Source_Name', + accounts = [ + sailpoint.v2025.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/RequestedItemDtoRef.md b/docs/tools/sdk/python/Reference/V2025/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..896b99e4d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/RequestedItemDtoRef.md @@ -0,0 +1,55 @@ +--- +id: v2025-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemDtoRef', 'V2025RequestedItemDtoRef'] +slug: /tools/sdk/python/v2025/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'V2025RequestedItemDtoRef'] +--- + +# RequestedItemDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**account_selection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.requested_item_dto_ref import RequestedItemDtoRef + +requested_item_dto_ref = RequestedItemDtoRef( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', +account_selection=[ + sailpoint.v2025.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v2025.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionPayload.md b/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionPayload.md index 9790d1153..64b263028 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionPayload.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionPayload.md @@ -31,7 +31,7 @@ from sailpoint.v2025.models.scheduled_action_payload import ScheduledActionPaylo scheduled_action_payload = ScheduledActionPayload( job_type='BACKUP', start_time='2024-08-16T14:16:58.389Z', -cron_string='0 0 12 * * ?', +cron_string='0 0 * * * *', time_zone_id='America/Chicago', content=sailpoint.v2025.models.scheduled_action_payload_content.ScheduledActionPayload_content( name = 'Daily Backup', diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionResponse.md b/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionResponse.md index ee65eac08..b833025c1 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionResponse.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionResponse.md @@ -43,7 +43,7 @@ content=sailpoint.v2025.models.scheduled_action_response_content.ScheduledAction source_tenant = 'tenant-name', draft_id = '9012b87d-48ca-439a-868f-2160001da8c3', ), start_time='2021-05-12T10:00Z', -cron_string='0 0 12 * * ?', +cron_string='0 0 * * * *', time_zone_id='America/Chicago' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..85940400e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfiguration.md @@ -0,0 +1,40 @@ +--- +id: v2025-service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceProviderConfiguration', 'V2025ServiceProviderConfiguration'] +slug: /tools/sdk/python/v2025/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'V2025ServiceProviderConfiguration'] +--- + +# ServiceProviderConfiguration + +Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to False] +**bypass_idp** | **bool** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to False] +**saml_configuration_valid** | **bool** | This indicates whether or not the SAML configuration is valid. | [optional] [default to False] +**federation_protocol_details** | [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.service_provider_configuration import ServiceProviderConfiguration + +service_provider_configuration = ServiceProviderConfiguration( +enabled=True, +bypass_idp=True, +saml_configuration_valid=True, +federation_protocol_details=[{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..857e74d03 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,68 @@ +--- +id: v2025-service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2025ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/python/v2025/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2025ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + +# ServiceProviderConfigurationFederationProtocolDetailsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**authn_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] +**include_authn_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] +**jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] +**cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] +**certificate_name** | **str** | The name extracted from the certificate. | [optional] +**alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**legacy_acs_url** | **str** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.service_provider_configuration_federation_protocol_details_inner import ServiceProviderConfigurationFederationProtocolDetailsInner + +service_provider_configuration_federation_protocol_details_inner = ServiceProviderConfigurationFederationProtocolDetailsInner( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', +authn_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +logout_url='https://dev-206445.oktapreview.com/login/signout', +include_authn_context=False, +name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', +jit_configuration=sailpoint.v2025.models.jit_configuration.JITConfiguration( + enabled = False, + source_id = '2c9180857377ed2901739c12a2da5ac8', + source_attribute_mappings = {firstName=okta.firstName, lastName=okta.lastName, email=okta.email}, ), +cert='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', +login_url_post='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +login_url_redirect='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +mapping_attribute='email', +certificate_expiration_date='Fri Mar 08 08:54:24 UTC 2013', +certificate_name='OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL', +alias='acme-sp', +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp', +legacy_acs_url='https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SessionConfiguration.md b/docs/tools/sdk/python/Reference/V2025/Models/SessionConfiguration.md new file mode 100644 index 000000000..6816a4b4a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/SessionConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2025-session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SessionConfiguration', 'V2025SessionConfiguration'] +slug: /tools/sdk/python/v2025/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'V2025SessionConfiguration'] +--- + +# SessionConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_idle_time** | **int** | The maximum time in minutes a session can be idle. | [optional] +**remember_me** | **bool** | Denotes if 'remember me' is enabled. | [optional] [default to False] +**max_session_time** | **int** | The maximum allowable session time in minutes. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.session_configuration import SessionConfiguration + +session_configuration = SessionConfiguration( +max_idle_time=15, +remember_me=True, +max_session_time=45 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceAccountSelections.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceAccountSelections.md new file mode 100644 index 000000000..1520a356f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceAccountSelections.md @@ -0,0 +1,46 @@ +--- +id: v2025-source-account-selections +title: SourceAccountSelections +pagination_label: SourceAccountSelections +sidebar_label: SourceAccountSelections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountSelections', 'V2025SourceAccountSelections'] +slug: /tools/sdk/python/v2025/models/source-account-selections +tags: ['SDK', 'Software Development Kit', 'SourceAccountSelections', 'V2025SourceAccountSelections'] +--- + +# SourceAccountSelections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The source id | [optional] +**name** | **str** | The source name | [optional] +**accounts** | [**[]AccountInfoRef**](account-info-ref) | The accounts information for a particular source in the requested item | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.source_account_selections import SourceAccountSelections + +source_account_selections = SourceAccountSelections( +type='IDENTITY', +id='3ac3c43785a845fa9820b0c1ac767cd5', +name='Test Source_Name', +accounts=[ + sailpoint.v2025.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + type = 'IDENTITY', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceItemRef.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceItemRef.md new file mode 100644 index 000000000..6a6d702ae --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceItemRef.md @@ -0,0 +1,39 @@ +--- +id: v2025-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceItemRef', 'V2025SourceItemRef'] +slug: /tools/sdk/python/v2025/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'V2025SourceItemRef'] +--- + +# SourceItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_id** | **str** | The id for the source on which account selections are made | [optional] +**accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.source_item_ref import SourceItemRef + +source_item_ref = SourceItemRef( +source_id='cb89bc2f1ee6445fbea12224c526ba3a', +accounts=[ + sailpoint.v2025.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md index 3091b3a26..3f731dad1 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SpDetails.md b/docs/tools/sdk/python/Reference/V2025/Models/SpDetails.md new file mode 100644 index 000000000..761d48c28 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/SpDetails.md @@ -0,0 +1,41 @@ +--- +id: v2025-sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpDetails', 'V2025SpDetails'] +slug: /tools/sdk/python/v2025/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'V2025SpDetails'] +--- + +# SpDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**legacy_acs_url** | **str** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.sp_details import SpDetails + +sp_details = SpDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +alias='acme-sp', +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp', +legacy_acs_url='https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md index 7a5946ccf..e75d744e6 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md @@ -122,6 +122,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -132,6 +133,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-request) @@ -172,7 +174,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -233,6 +235,133 @@ with ApiClient(configuration) as api_client: "type" : "ACCESS_PROFILE", "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | diff --git a/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md index 581f58442..a529e0d71 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md @@ -336,6 +336,7 @@ Get a single workflow by id. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | Id of the workflow + Query | workflow_metrics | **bool** | (optional) (default to True) | disable workflow metrics ### Return type [**Workflow**](../models/workflow) @@ -366,13 +367,14 @@ configuration = Configuration() with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) try: # Get Workflow By Id results = WorkflowsApi(api_client).get_workflow(id=id) # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) + # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) print("The response of WorkflowsApi->get_workflow:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -828,7 +830,13 @@ List all workflows in the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflows) ### Parameters -This endpoint does not need any parameter. + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | trigger_id | **str** | (optional) | Trigger ID + Query | connector_instance_id | **str** | (optional) | Connector Instance ID + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. ### Return type [**List[Workflow]**](../models/workflow) @@ -858,13 +866,17 @@ configuration = Configuration() with ApiClient(configuration) as api_client: + trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) + connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) try: # List Workflows results = WorkflowsApi(api_client).list_workflows() # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() + # results = WorkflowsApi(api_client).list_workflows(trigger_id, connector_instance_id, limit, offset) print("The response of WorkflowsApi->list_workflows:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md index 363037b89..06abde0b2 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **request_type** | [**AccessRequestType**](access-request-type) | | [optional] **requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**requested_for_with_requested_items** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] } ## Example @@ -28,9 +29,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.access_request import AccessRequest access_request = AccessRequest( -requested_for=[ - '2c918084660f45d6016617daa9210584' - ], +requested_for=2c918084660f45d6016617daa9210584, request_type='GRANT_ACCESS', requested_items=[ sailpoint.v3.models.access_request_item.AccessRequestItem( @@ -42,7 +41,30 @@ requested_items=[ assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) ], -client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}, +requested_for_with_requested_items=[ + sailpoint.v3.models.requested_for_dto_ref.RequestedForDtoRef( + identity_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + requested_items = [ + sailpoint.v3.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.v3.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v3.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ], ) + ] ) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountItemRef.md b/docs/tools/sdk/python/Reference/V3/Models/AccountItemRef.md new file mode 100644 index 000000000..f5ac3ddba --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountItemRef.md @@ -0,0 +1,35 @@ +--- +id: account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountItemRef', 'AccountItemRef'] +slug: /tools/sdk/python/v3/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'AccountItemRef'] +--- + +# AccountItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_item_ref import AccountItemRef + +account_item_ref = AccountItemRef( +account_uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}', +native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md index 211d1a3d1..a1615a57b 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionType.md b/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionType.md index bee04f772..515e4e804 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionType.md @@ -23,5 +23,7 @@ The underlying type of the value which an AttributeDefinition represents. * `BOOLEAN` (value: `'BOOLEAN'`) +* `DATE` (value: `'DATE'`) + [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdpDetails.md b/docs/tools/sdk/python/Reference/V3/Models/IdpDetails.md index 818249bce..fcb2de522 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/IdpDetails.md +++ b/docs/tools/sdk/python/Reference/V3/Models/IdpDetails.md @@ -16,18 +16,18 @@ tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'IdpDetails'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**role** | **Enum** [ 'SAML_IDP' ] | Federation protocol role | [optional] +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] **entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] **binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] -**auth_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**authn_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] **logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] -**include_auth_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**include_authn_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] **name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] **jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] **cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] **login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] **login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] -**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] **certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] **certificate_name** | **str** | The name extracted from the certificate. | [optional] } @@ -41,9 +41,9 @@ idp_details = IdpDetails( role='SAML_IDP', entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', -auth_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +authn_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', logout_url='https://dev-206445.oktapreview.com/login/signout', -include_auth_context=False, +include_authn_context=False, name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', jit_configuration=sailpoint.v3.models.jit_configuration.JITConfiguration( enabled = False, diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index 049a9aafe..a80904ad9 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedForDtoRef.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..f26bdb62f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedForDtoRef.md @@ -0,0 +1,53 @@ +--- +id: requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedForDtoRef', 'RequestedForDtoRef'] +slug: /tools/sdk/python/v3/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'RequestedForDtoRef'] +--- + +# RequestedForDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity id for which the access is requested | [required] +**requested_items** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] +} + +## Example + +```python +from sailpoint.v3.models.requested_for_dto_ref import RequestedForDtoRef + +requested_for_dto_ref = RequestedForDtoRef( +identity_id='cb89bc2f1ee6445fbea12224c526ba3a', +requested_items=[ + sailpoint.v3.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.v3.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v3.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedItemDtoRef.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..2e3bbdd3a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemDtoRef.md @@ -0,0 +1,55 @@ +--- +id: requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemDtoRef', 'RequestedItemDtoRef'] +slug: /tools/sdk/python/v3/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'RequestedItemDtoRef'] +--- + +# RequestedItemDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**account_selection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requested_item_dto_ref import RequestedItemDtoRef + +requested_item_dto_ref = RequestedItemDtoRef( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', +account_selection=[ + sailpoint.v3.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v3.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md index 0b8aa6a09..2eff3d315 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md +++ b/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -16,22 +16,23 @@ tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederatio Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**role** | **Enum** [ 'SAML_SP' ] | Federation protocol role | [optional] +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] **entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] **binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] -**auth_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**authn_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] **logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] -**include_auth_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**include_authn_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] **name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] **jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] **cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] **login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] **login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] -**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] **certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] **certificate_name** | **str** | The name extracted from the certificate. | [optional] **alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] -**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**legacy_acs_url** | **str** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] } ## Example @@ -40,12 +41,12 @@ Name | Type | Description | Notes from sailpoint.v3.models.service_provider_configuration_federation_protocol_details_inner import ServiceProviderConfigurationFederationProtocolDetailsInner service_provider_configuration_federation_protocol_details_inner = ServiceProviderConfigurationFederationProtocolDetailsInner( -role='SAML_SP', +role='SAML_IDP', entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', -auth_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +authn_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', logout_url='https://dev-206445.oktapreview.com/login/signout', -include_auth_context=False, +include_authn_context=False, name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', jit_configuration=sailpoint.v3.models.jit_configuration.JITConfiguration( enabled = False, @@ -58,7 +59,8 @@ mapping_attribute='email', certificate_expiration_date='Fri Mar 08 08:54:24 UTC 2013', certificate_name='OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL', alias='acme-sp', -callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp' +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp', +legacy_acs_url='https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp' ) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceItemRef.md b/docs/tools/sdk/python/Reference/V3/Models/SourceItemRef.md new file mode 100644 index 000000000..40f328598 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceItemRef.md @@ -0,0 +1,39 @@ +--- +id: source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceItemRef', 'SourceItemRef'] +slug: /tools/sdk/python/v3/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'SourceItemRef'] +--- + +# SourceItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_id** | **str** | The id for the source on which account selections are made | [optional] +**accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_item_ref import SourceItemRef + +source_item_ref = SourceItemRef( +source_id='cb89bc2f1ee6445fbea12224c526ba3a', +accounts=[ + sailpoint.v3.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md index 4d3443864..159a7ebe0 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/SpDetails.md b/docs/tools/sdk/python/Reference/V3/Models/SpDetails.md index 4166ee782..a79db2cd0 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SpDetails.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SpDetails.md @@ -16,10 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'SpDetails', 'SpDetails'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**role** | **Enum** [ 'SAML_SP' ] | Federation protocol role | [optional] +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] **entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] **alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] -**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**legacy_acs_url** | **str** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] } ## Example @@ -28,10 +29,11 @@ Name | Type | Description | Notes from sailpoint.v3.models.sp_details import SpDetails sp_details = SpDetails( -role='SAML_SP', +role='SAML_IDP', entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', alias='acme-sp', -callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp' +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp', +legacy_acs_url='https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp' ) ``` diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index b27e602ff..a14d2bfad 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -689,7 +689,7 @@ with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -750,6 +750,133 @@ "type" : "ACCESS_PROFILE", "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | try: @@ -955,36 +1082,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.beta.api.account_usages_api import AccountUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1437,6 +1534,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.beta.api.account_usages_api import AccountUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications/{id} method: GET xCodeSample: @@ -7735,6 +7862,196 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.beta.api.managed_clients_api import ManagedClientsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_client_status import ManagedClientStatus + from sailpoint.beta.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get + type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get + try: + # Specified Managed Client Status. + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status + source: | + from sailpoint.beta.api.managed_clients_api import ManagedClientsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_client_status import ManagedClientStatus + from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update + managed_client_status = '''{ + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + }''' # ManagedClientStatus | + try: + # Handle status request from client + new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) + results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) + print("The response of ManagedClientsApi->update_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for + try: + # Get managed cluster's log configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get + try: + # Get a specified ManagedCluster. + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq operation' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + try: + # Retrieve all Managed Clusters. + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for + client_log_configuration = '''{ + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + try: + # Update managed cluster's log configuration + + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -8123,196 +8440,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.beta.api.managed_clients_api import ManagedClientsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_client_status import ManagedClientStatus - from sailpoint.beta.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get - type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get - try: - # Specified Managed Client Status. - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status - source: | - from sailpoint.beta.api.managed_clients_api import ManagedClientsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_client_status import ManagedClientStatus - from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update - managed_client_status = '''{ - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - }''' # ManagedClientStatus | - try: - # Handle status request from client - new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) - results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) - print("The response of ManagedClientsApi->update_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for - try: - # Get managed cluster's log configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get - try: - # Get a specified ManagedCluster. - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq operation' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Retrieve all Managed Clusters. - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for - client_log_configuration = '''{ - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" - }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster - try: - # Update managed cluster's log configuration - - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -11598,6 +11725,606 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + search_attribute_config = '''{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }''' # SearchAttributeConfig | + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. + try: + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. + try: + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) +- path: /segments + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#create-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + segment = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }''' # Segment | + try: + # Create Segment + new_segment = Segment.from_json(segment) + results = SegmentsApi(api_client).create_segment(segment=new_segment) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).create_segment(new_segment) + print("The response of SegmentsApi->create_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#delete-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + SegmentsApi(api_client).delete_segment(id=id) + # Below is a request that includes all optional parameters + # SegmentsApi(api_client).delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) +- path: /segments/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#get-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + results = SegmentsApi(api_client).get_segment(id=id) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) +- path: /segments + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#list-segments + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # List Segments + + results = SegmentsApi(api_client).list_segments() + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#patch-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + try: + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).patch_segment(id, new_request_body) + print("The response of SegmentsApi->patch_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # List existing Service Desk integrations + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Service Desk integration types + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get the time check configuration + + results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + try: + # Patch a Service Desk Integration + new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }''' # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + queued_check_config_details = '''{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }''' # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) + results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) - path: /sim-integrations method: POST xCodeSample: @@ -12446,842 +13173,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.export_payload import ExportPayload - from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.import_options import ImportOptions - from sailpoint.beta.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - search_attribute_config = '''{ - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - }''' # SearchAttributeConfig | - try: - # Create Extended Search Attributes - new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) - results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) - print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. - try: - # Delete Extended Search Attribute - - SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) - # Below is a request that includes all optional parameters - # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Extended Search Attributes - - results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) - print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. - try: - # Get Extended Search Attribute - - results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) - print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.json_patch_operation import JsonPatchOperation - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. - json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | - try: - # Update Extended Search Attribute - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) - print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) -- path: /segments - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#create-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - segment = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - }''' # Segment | - try: - # Create Segment - new_segment = Segment.from_json(segment) - results = SegmentsApi(api_client).create_segment(segment=new_segment) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).create_segment(new_segment) - print("The response of SegmentsApi->create_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->create_segment: %s\n" % e) -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#delete-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. - try: - # Delete Segment by ID - - SegmentsApi(api_client).delete_segment(id=id) - # Below is a request that includes all optional parameters - # SegmentsApi(api_client).delete_segment(id) - except Exception as e: - print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) -- path: /segments/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#get-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. - try: - # Get Segment by ID - - results = SegmentsApi(api_client).get_segment(id=id) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).get_segment(id) - print("The response of SegmentsApi->get_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->get_segment: %s\n" % e) -- path: /segments - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#list-segments - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Segments - - results = SegmentsApi(api_client).list_segments() - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).list_segments(limit, offset, count) - print("The response of SegmentsApi->list_segments:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->list_segments: %s\n" % e) -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#patch-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. - request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - try: - # Update Segment - new_request_body = RequestBody.from_json(request_body) - results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).patch_segment(id, new_request_body) - print("The response of SegmentsApi->patch_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create - try: - # Create new Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete - try: - # Delete a Service Desk integration - - ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get - try: - # Get a Service Desk integration - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List existing Service Desk integrations - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get - try: - # Service Desk integration template by scriptName - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Service Desk integration types - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get the time check configuration - - results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - try: - # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) - print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of the integration to update - try: - # Update a Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - queued_check_config_details = '''{ - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - }''' # QueuedCheckConfigDetails | The modified time check configuration - try: - # Update the time check configuration - new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) - results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) - print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.beta.api.source_usages_api import SourceUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.beta.api.source_usages_api import SourceUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -14696,6 +14587,242 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.beta.api.source_usages_api import SourceUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.beta.api.source_usages_api import SourceUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.export_payload import ExportPayload + from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.import_options import ImportOptions + from sailpoint.beta.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -16058,6 +16185,518 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) + connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows(limit, offset, trigger_id, connector_instance_id) + print("The response of WorkflowsApi->list_workflows:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response + from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) + print("The response of WorkflowsApi->post_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) + print("The response of WorkflowsApi->post_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#put-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.beta.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -16648,510 +17287,3 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.json_patch_operation import JsonPatchOperation - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response - from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) - print("The response of WorkflowsApi->post_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) - print("The response of WorkflowsApi->post_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#update-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.beta.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).update_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).update_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->update_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index 17ab6baf8..d8fb8cad7 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -787,7 +787,7 @@ with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -848,6 +848,133 @@ "type" : "ACCESS_PROFILE", "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | try: @@ -954,6 +1081,95 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) +- path: /access-requests/accounts-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#load-account-selections + source: | + from sailpoint.v2024.api.access_requests_api import AccessRequestsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.accounts_selection_request import AccountsSelectionRequest + from sailpoint.v2024.models.accounts_selection_response import AccountsSelectionResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + accounts_selection_request = '''{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }''' # AccountsSelectionRequest | + try: + # Get accounts selections for identity + new_accounts_selection_request = AccountsSelectionRequest.from_json(accounts_selection_request) + results = AccessRequestsApi(api_client).load_account_selections(accounts_selection_request=new_accounts_selection_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).load_account_selections(new_accounts_selection_request) + print("The response of AccessRequestsApi->load_account_selections:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->load_account_selections: %s\n" % e) - path: /access-request-config method: PUT xCodeSample: @@ -1089,36 +1305,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2024.api.account_usages_api import AccountUsagesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1581,6 +1767,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2024.api.account_usages_api import AccountUsagesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -3409,121 +3625,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3857,6 +3958,121 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: @@ -3975,7 +4191,7 @@ with ApiClient(configuration) as api_client: scheduled_action_payload = '''{ - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 12 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", @@ -6752,6 +6968,30 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.lockout_configuration import LockoutConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Auth Org Lockout Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) - path: /auth-org/network-config method: GET xCodeSample: @@ -6776,6 +7016,80 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_provider_configuration import ServiceProviderConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Service Provider Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.session_configuration import SessionConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Auth Org Session Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.lockout_configuration import LockoutConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]''' # List[JsonPatchOperation] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + try: + # Update Auth Org Lockout Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) - path: /auth-org/network-config method: PATCH xCodeSample: @@ -6802,6 +7116,58 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.service_provider_configuration import ServiceProviderConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]''' # List[JsonPatchOperation] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + try: + # Update Service Provider Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.session_configuration import SessionConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]''' # List[JsonPatchOperation] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + try: + # Update Auth Org Session Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) - path: /workgroups method: POST xCodeSample: @@ -10191,198 +10557,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -10778,151 +10952,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # Get Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: @@ -11138,6 +11167,343 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#create-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_type = '''{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }''' # ManagedClusterType | + try: + # Create new Managed Cluster Type + new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) + results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) + print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#delete-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Delete a Managed Cluster Type + + ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Get a Managed Cluster Type + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) + print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-types + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) + pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) + org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + try: + # Get Managed Cluster Types + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) + print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#update-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JSONPatch payload used to update the schema. + try: + # Update a Managed Cluster Type + new_json_patch = JsonPatch.from_json(json_patch) + results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) + print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -14883,1122 +15249,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a SIM integration details. - - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - try: - # List SOD policies - - results = SODPoliciesApi(api_client).list_sod_policies() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2024.api.sod_violations_api import SODViolationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2024.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2024.api.sod_violations_api import SODViolationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2024.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.export_payload import ExportPayload - from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.import_options import ImportOptions - from sailpoint.v2024.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -17519,61 +16769,941 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration source: | - from sailpoint.v2024.api.source_usages_api import SourceUsagesApi + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.source_usage_status import SourceUsageStatus + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() + configuration.experimental = true with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration source: | - from sailpoint.v2024.api.source_usages_api import SourceUsagesApi + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() + configuration.experimental = true with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: - # Returns source usage insights + # Delete a SIM integration - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2024.api.sod_violations_api import SODViolationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2024.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2024.api.sod_violations_api import SODViolationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2024.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -19188,6 +19318,242 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.v2024.api.source_usages_api import SourceUsagesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.v2024.api.source_usages_api import SourceUsagesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.export_payload import ExportPayload + from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.import_options import ImportOptions + from sailpoint.v2024.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -20526,6 +20892,513 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = '''sailpoint.v2024.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.v2024.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.v2024.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -21135,510 +22008,3 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v2024.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.v2024.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v2024.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index 55e2fe7aa..08eefe941 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -787,7 +787,7 @@ with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -838,6 +838,133 @@ "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | try: @@ -874,6 +1001,34 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) +- path: /access-requests/revocable-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/access-requests#get-entitlement-details-for-identity + source: | + from sailpoint.v2025.api.access_requests_api import AccessRequestsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_entitlement_details import IdentityEntitlementDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identity_id = '7025c863c2704ba6beeaedf3cb091573' # str | The identity ID. # str | The identity ID. + entitlement_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The entitlement ID # str | The entitlement ID + try: + # Identity Entitlement Details + + results = AccessRequestsApi(api_client).get_entitlement_details_for_identity(x_sail_point_experimental=x_sail_point_experimental, identity_id=identity_id, entitlement_id=entitlement_id) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).get_entitlement_details_for_identity(x_sail_point_experimental, identity_id, entitlement_id) + print("The response of AccessRequestsApi->get_entitlement_details_for_identity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_entitlement_details_for_identity: %s\n" % e) - path: /access-request-status method: GET xCodeSample: @@ -944,6 +1099,95 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) +- path: /access-requests/accounts-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/access-requests#load-account-selections + source: | + from sailpoint.v2025.api.access_requests_api import AccessRequestsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.accounts_selection_request import AccountsSelectionRequest + from sailpoint.v2025.models.accounts_selection_response import AccountsSelectionResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + accounts_selection_request = '''{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }''' # AccountsSelectionRequest | + try: + # Get accounts selections for identity + new_accounts_selection_request = AccountsSelectionRequest.from_json(accounts_selection_request) + results = AccessRequestsApi(api_client).load_account_selections(accounts_selection_request=new_accounts_selection_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).load_account_selections(new_accounts_selection_request) + print("The response of AccessRequestsApi->load_account_selections:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->load_account_selections: %s\n" % e) - path: /access-request-config method: PUT xCodeSample: @@ -1079,36 +1323,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2025.api.account_usages_api import AccountUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1571,6 +1785,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2025.api.account_usages_api import AccountUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -3399,121 +3643,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3847,6 +3976,121 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: @@ -3965,7 +4209,7 @@ with ApiClient(configuration) as api_client: scheduled_action_payload = '''{ - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", @@ -6742,6 +6986,30 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.lockout_configuration import LockoutConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Auth Org Lockout Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) - path: /auth-org/network-config method: GET xCodeSample: @@ -6766,6 +7034,80 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_provider_configuration import ServiceProviderConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Service Provider Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.session_configuration import SessionConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Auth Org Session Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.lockout_configuration import LockoutConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]''' # List[JsonPatchOperation] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + try: + # Update Auth Org Lockout Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) - path: /auth-org/network-config method: PATCH xCodeSample: @@ -6792,6 +7134,58 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.service_provider_configuration import ServiceProviderConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]''' # List[JsonPatchOperation] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + try: + # Update Service Provider Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.session_configuration import SessionConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]''' # List[JsonPatchOperation] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + try: + # Update Auth Org Session Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) - path: /workgroups method: POST xCodeSample: @@ -10181,198 +10575,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -10768,151 +10970,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: @@ -11128,6 +11185,343 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_type = '''{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }''' # ManagedClusterType | + try: + # Create new Managed Cluster Type + new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) + results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) + print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Delete a Managed Cluster Type + + ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Get a Managed Cluster Type + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) + print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) + pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) + org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + try: + # List Managed Cluster Types + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) + print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JSONPatch payload used to update the schema. + try: + # Update a Managed Cluster Type + new_json_patch = JsonPatch.from_json(json_patch) + results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) + print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -14873,1122 +15267,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a SIM integration details. - - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - try: - # List SOD policies - - results = SODPoliciesApi(api_client).list_sod_policies() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2025.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2025.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.export_payload import ExportPayload - from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.import_options import ImportOptions - from sailpoint.v2025.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -17509,61 +16787,941 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage_status import SourceUsageStatus + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() + configuration.experimental = true with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() + configuration.experimental = true with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: - # Returns source usage insights + # Delete a SIM integration - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2025.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2025.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -19178,6 +19336,242 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.export_payload import ExportPayload + from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.import_options import ImportOptions + from sailpoint.v2025.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -20516,6 +20910,513 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.v2025.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -21125,510 +22026,3 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.v2025.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index 3f1a09070..70a2e8238 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -503,7 +503,7 @@ with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -564,6 +564,133 @@ "type" : "ACCESS_PROFILE", "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | try: @@ -743,36 +870,6 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v3.api.account_usages_api import AccountUsagesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1094,6 +1191,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v3.api.account_usages_api import AccountUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -2346,121 +2473,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2794,6 +2806,121 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -4122,6 +4249,357 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /managed-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.v3.models.managed_client_request import ManagedClientRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_client_request = '''{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }''' # ManagedClientRequest | + try: + # Create Managed Client + new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) + results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) + print("The response of ManagedClientsApi->create_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + ManagedClientsApi(api_client).delete_managed_client(id=id) + # Below is a request that includes all optional parameters + # ManagedClientsApi(api_client).delete_managed_client(id) + except Exception as e: + print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + results = ManagedClientsApi(api_client).get_managed_client(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client_status import ManagedClientStatus + from sailpoint.v3.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. + type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + try: + # Get Managed Client Status + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + try: + # Get Managed Clients + + results = ManagedClientsApi(api_client).get_managed_clients() + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) + print("The response of ManagedClientsApi->update_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-clusters + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_request = '''{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }''' # ManagedClusterRequest | + try: + # Create Create Managed Cluster + new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) + results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) + try: + # Delete Managed Cluster + + ManagedClustersApi(api_client).delete_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) + except Exception as e: + print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. + try: + # Get Managed Cluster Log Configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + try: + # Get Managed Clusters + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. + put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Cluster + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -4510,357 +4988,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) -- path: /managed-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.v3.models.managed_client_request import ManagedClientRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_client_request = '''{ - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - }''' # ManagedClientRequest | - try: - # Create Managed Client - new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) - results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) - print("The response of ManagedClientsApi->create_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Delete Managed Client - - ManagedClientsApi(api_client).delete_managed_client(id=id) - # Below is a request that includes all optional parameters - # ManagedClientsApi(api_client).delete_managed_client(id) - except Exception as e: - print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Get Managed Client - - results = ManagedClientsApi(api_client).get_managed_client(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client(id) - print("The response of ManagedClientsApi->get_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client_status import ManagedClientStatus - from sailpoint.v3.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. - type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. - try: - # Get Managed Client Status - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-clients - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - try: - # Get Managed Clients - - results = ManagedClientsApi(api_client).get_managed_clients() - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) - print("The response of ManagedClientsApi->get_managed_clients:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Client - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) - print("The response of ManagedClientsApi->update_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-clusters - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_request = '''{ - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - }''' # ManagedClusterRequest | - try: - # Create Create Managed Cluster - new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) - results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) - print("The response of ManagedClustersApi->create_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) - try: - # Delete Managed Cluster - - ManagedClustersApi(api_client).delete_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) - except Exception as e: - print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. - try: - # Get Managed Cluster Log Configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - try: - # Get Managed Cluster - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Get Managed Clusters - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration - from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. - put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. - try: - # Update Managed Cluster Log Configuration - new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Cluster - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) - print("The response of ManagedClustersApi->update_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -7137,646 +7264,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - try: - # List SOD policies - - results = SODPoliciesApi(api_client).list_sod_policies() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v3.api.sod_violations_api import SODViolationsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v3.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check - source: | - from sailpoint.v3.api.sod_violations_api import SODViolationsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v3.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -9240,61 +8727,646 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET +- path: /sod-policies + method: POST xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy source: | - from sailpoint.v3.api.source_usages_api import SourceUsagesApi + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.source_usage_status import SourceUsageStatus + from sailpoint.v3.models.sod_policy import SodPolicy from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy source: | - from sailpoint.v3.api.source_usages_api import SourceUsagesApi + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) try: - # Returns source usage insights + # List SOD policies - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + results = SODPoliciesApi(api_client).list_sod_policies() # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v3.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v3.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -10217,6 +10289,61 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.v3.api.source_usages_api import SourceUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.v3.api.source_usages_api import SourceUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -10720,6 +10847,518 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#create-external-execute-workflow + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + from sailpoint.v3.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = '''sailpoint.v3.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.v3.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow-external-trigger + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#delete-workflow + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-execution + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-executions + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflows + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) + connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows(trigger_id, connector_instance_id, limit, offset) + print("The response of WorkflowsApi->list_workflows:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#patch-workflow + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#put-workflow + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.workflow import Workflow + from sailpoint.v3.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.v3.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.v3.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#test-workflow + source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.v3.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -11060,510 +11699,3 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v3.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v3.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v3.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#delete-workflow - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-execution - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-executions - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#list-workflows - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#patch-workflow - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#put-workflow - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.workflow import Workflow - from sailpoint.v3.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v3.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v3.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/workflows#test-workflow - source: | - from sailpoint.v3.api.workflows_api import WorkflowsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v3.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) From fd8b796cb5087d2777cfb4b24c3a167be47138b6 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Fri, 18 Apr 2025 12:48:24 +0000 Subject: [PATCH 47/82] Automated commit by github action: 14535372567 --- static/api-specs/idn/v2025/schemas/AccessModelMetadata.yaml | 1 + static/api-specs/idn/v2025/schemas/Entitlement.yaml | 2 ++ static/api-specs/idn/v2025/schemas/PermissionDto.yaml | 1 + 3 files changed, 4 insertions(+) diff --git a/static/api-specs/idn/v2025/schemas/AccessModelMetadata.yaml b/static/api-specs/idn/v2025/schemas/AccessModelMetadata.yaml index 0daf91a0e..6214c24ef 100644 --- a/static/api-specs/idn/v2025/schemas/AccessModelMetadata.yaml +++ b/static/api-specs/idn/v2025/schemas/AccessModelMetadata.yaml @@ -25,6 +25,7 @@ properties: objectTypes: type: array description: The types of objects + example: ["general"] items: type: string example: general diff --git a/static/api-specs/idn/v2025/schemas/Entitlement.yaml b/static/api-specs/idn/v2025/schemas/Entitlement.yaml index 8c6437904..3fbc102ac 100644 --- a/static/api-specs/idn/v2025/schemas/Entitlement.yaml +++ b/static/api-specs/idn/v2025/schemas/Entitlement.yaml @@ -28,10 +28,12 @@ properties: privileged: type: boolean description: True if the entitlement is privileged + default: false example: true cloudGoverned: type: boolean description: True if the entitlement is cloud governed + default: false example: true requestable: type: boolean diff --git a/static/api-specs/idn/v2025/schemas/PermissionDto.yaml b/static/api-specs/idn/v2025/schemas/PermissionDto.yaml index 25eb8b837..8724979f2 100644 --- a/static/api-specs/idn/v2025/schemas/PermissionDto.yaml +++ b/static/api-specs/idn/v2025/schemas/PermissionDto.yaml @@ -5,6 +5,7 @@ properties: rights: type: array description: All the rights (e.g. actions) that this permission allows on the target + example: HereIsRight1 readOnly: true items: type: string From 254f62756cc22722f472e522e25fdc0dd45ea0bc Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Fri, 18 Apr 2025 12:49:51 +0000 Subject: [PATCH 48/82] Update to powershell SDK docs: 14535391935 --- .../powershell/Reference/V2025/Models/AccessModelMetadata.md | 2 +- .../sdk/powershell/Reference/V2025/Models/Entitlement.md | 4 ++-- .../sdk/powershell/Reference/V2025/Models/PermissionDto.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessModelMetadata.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessModelMetadata.md index ed5a8cb9f..926e54df5 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessModelMetadata.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessModelMetadata.md @@ -34,7 +34,7 @@ $AccessModelMetadata = Initialize-PSSailpoint.V2025AccessModelMetadata -Key isc -Multiselect true ` -Status active ` -Type governance ` - -ObjectTypes null ` + -ObjectTypes [general] ` -Description Indicates the type of deployment environment of an access item. ` -Values null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/Entitlement.md b/docs/tools/sdk/powershell/Reference/V2025/Models/Entitlement.md index 37cabb5b1..b2a667d19 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/Entitlement.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/Entitlement.md @@ -22,8 +22,8 @@ Name | Type | Description | Notes **Value** | **String** | The value of the entitlement | [optional] **SourceSchemaObjectType** | **String** | The object type of the entitlement from the source schema | [optional] **Description** | **String** | The description of the entitlement | [optional] -**Privileged** | **Boolean** | True if the entitlement is privileged | [optional] -**CloudGoverned** | **Boolean** | True if the entitlement is cloud governed | [optional] +**Privileged** | **Boolean** | True if the entitlement is privileged | [optional] [default to $false] +**CloudGoverned** | **Boolean** | True if the entitlement is cloud governed | [optional] [default to $false] **Requestable** | **Boolean** | True if the entitlement is able to be directly requested | [optional] [default to $false] **Owner** | [**EntitlementOwner**](entitlement-owner) | | [optional] **ManuallyUpdatedFields** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/PermissionDto.md b/docs/tools/sdk/powershell/Reference/V2025/Models/PermissionDto.md index e6f9ade01..95a573e32 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/PermissionDto.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/PermissionDto.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$PermissionDto = Initialize-PSSailpoint.V2025PermissionDto -Rights null ` +$PermissionDto = Initialize-PSSailpoint.V2025PermissionDto -Rights HereIsRight1 ` -Target SYS.GV_$TRANSACTION ``` From 6e750d81d3356a77d7a160a9b54187acc9d6d78c Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Fri, 18 Apr 2025 12:50:08 +0000 Subject: [PATCH 49/82] Update to python SDK docs: 14535395476 --- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../V2025/Models/AccessModelMetadata.md | 4 +- .../Reference/V2025/Models/AccountUsage.md | 2 +- .../Reference/V2025/Models/Entitlement.md | 12 +- .../Models/EntitlementAccessModelMetadata.md | 4 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2025/Models/PermissionDto.md | 4 +- .../Reference/V2025/Models/SourceUsage.md | 2 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../python/Reference/V3/Models/SourceUsage.md | 2 +- .../beta/python_code_examples_overlay.yaml | 3136 ++++++------ .../v2024/python_code_examples_overlay.yaml | 4252 ++++++++--------- .../v2025/python_code_examples_overlay.yaml | 4252 ++++++++--------- .../v3/python_code_examples_overlay.yaml | 2994 ++++++------ 20 files changed, 7340 insertions(+), 7350 deletions(-) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md index 6d30198f2..dced03305 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index e0b91fdea..bffe6c49e 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md index 72badf0ff..fbcbd7a29 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md index 442faa748..5353898b1 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index a37f38fea..db5a37930 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md index ea8523f54..c57393c0d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccessModelMetadata.md b/docs/tools/sdk/python/Reference/V2025/Models/AccessModelMetadata.md index ac6b6ac01..ed69bbfdd 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccessModelMetadata.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccessModelMetadata.md @@ -38,9 +38,7 @@ name='CSP', multiselect=True, status='active', type='governance', -object_types=[ - 'general' - ], +object_types=[general], description='Indicates the type of deployment environment of an access item.', values=[ sailpoint.v2025.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner( diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md index 8403e7986..626e62e2b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/Entitlement.md b/docs/tools/sdk/python/Reference/V2025/Models/Entitlement.md index 18e5b5bef..53dcc5ffe 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/Entitlement.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/Entitlement.md @@ -22,8 +22,8 @@ Name | Type | Description | Notes **value** | **str** | The value of the entitlement | [optional] **source_schema_object_type** | **str** | The object type of the entitlement from the source schema | [optional] **description** | **str** | The description of the entitlement | [optional] -**privileged** | **bool** | True if the entitlement is privileged | [optional] -**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional] +**privileged** | **bool** | True if the entitlement is privileged | [optional] [default to False] +**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional] [default to False] **requestable** | **bool** | True if the entitlement is able to be directly requested | [optional] [default to False] **owner** | [**EntitlementOwner**](entitlement-owner) | | [optional] **manually_updated_fields** | **map[string]object** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional] @@ -64,9 +64,7 @@ access_model_metadata=sailpoint.v2025.models.entitlement_access_model_metadata.E multiselect = True, status = 'active', type = 'governance', - object_types = [ - 'general' - ], + object_types = [general], description = 'Indicates the type of deployment environment of an access item.', values = [ sailpoint.v2025.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner( @@ -85,9 +83,7 @@ attributes={fieldName=fieldValue}, segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], direct_permissions=[ sailpoint.v2025.models.permission_dto.PermissionDto( - rights = [ - 'SELECT' - ], + rights = HereIsRight1, target = 'SYS.GV_$TRANSACTION', ) ] ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/EntitlementAccessModelMetadata.md b/docs/tools/sdk/python/Reference/V2025/Models/EntitlementAccessModelMetadata.md index 1a2029ae9..3e69c710b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/EntitlementAccessModelMetadata.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/EntitlementAccessModelMetadata.md @@ -33,9 +33,7 @@ attributes=[ multiselect = True, status = 'active', type = 'governance', - object_types = [ - 'general' - ], + object_types = [general], description = 'Indicates the type of deployment environment of an access item.', values = [ sailpoint.v2025.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner( diff --git a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 960d4b101..33437e264 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/PermissionDto.md b/docs/tools/sdk/python/Reference/V2025/Models/PermissionDto.md index ac9d1d0bb..7ac6221a2 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/PermissionDto.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/PermissionDto.md @@ -27,9 +27,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.permission_dto import PermissionDto permission_dto = PermissionDto( -rights=[ - 'SELECT' - ], +rights=HereIsRight1, target='SYS.GV_$TRANSACTION' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md index 3f731dad1..3091b3a26 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md index a1615a57b..211d1a3d1 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index a80904ad9..049a9aafe 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md index 159a7ebe0..4d3443864 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index a14d2bfad..07a699304 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -1082,6 +1082,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.beta.api.account_usages_api import AccountUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1534,36 +1564,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.beta.api.account_usages_api import AccountUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications/{id} method: GET xCodeSample: @@ -7862,196 +7862,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.beta.api.managed_clients_api import ManagedClientsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_client_status import ManagedClientStatus - from sailpoint.beta.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get - type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get - try: - # Specified Managed Client Status. - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status - source: | - from sailpoint.beta.api.managed_clients_api import ManagedClientsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_client_status import ManagedClientStatus - from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update - managed_client_status = '''{ - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - }''' # ManagedClientStatus | - try: - # Handle status request from client - new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) - results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) - print("The response of ManagedClientsApi->update_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for - try: - # Get managed cluster's log configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get - try: - # Get a specified ManagedCluster. - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq operation' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Retrieve all Managed Clusters. - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for - client_log_configuration = '''{ - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" - }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster - try: - # Update managed cluster's log configuration - - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -8440,6 +8250,196 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.beta.api.managed_clients_api import ManagedClientsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_client_status import ManagedClientStatus + from sailpoint.beta.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get + type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get + try: + # Specified Managed Client Status. + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status + source: | + from sailpoint.beta.api.managed_clients_api import ManagedClientsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_client_status import ManagedClientStatus + from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update + managed_client_status = '''{ + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + }''' # ManagedClientStatus | + try: + # Handle status request from client + new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) + results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) + print("The response of ManagedClientsApi->update_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for + try: + # Get managed cluster's log configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get + try: + # Get a specified ManagedCluster. + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq operation' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + try: + # Retrieve all Managed Clusters. + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for + client_log_configuration = '''{ + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + try: + # Update managed cluster's log configuration + + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -11725,606 +11725,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - search_attribute_config = '''{ - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - }''' # SearchAttributeConfig | - try: - # Create Extended Search Attributes - new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) - results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) - print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. - try: - # Delete Extended Search Attribute - - SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) - # Below is a request that includes all optional parameters - # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Extended Search Attributes - - results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) - print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. - try: - # Get Extended Search Attribute - - results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) - print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.json_patch_operation import JsonPatchOperation - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. - json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | - try: - # Update Extended Search Attribute - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) - print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) -- path: /segments - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#create-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - segment = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - }''' # Segment | - try: - # Create Segment - new_segment = Segment.from_json(segment) - results = SegmentsApi(api_client).create_segment(segment=new_segment) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).create_segment(new_segment) - print("The response of SegmentsApi->create_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->create_segment: %s\n" % e) -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#delete-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. - try: - # Delete Segment by ID - - SegmentsApi(api_client).delete_segment(id=id) - # Below is a request that includes all optional parameters - # SegmentsApi(api_client).delete_segment(id) - except Exception as e: - print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) -- path: /segments/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#get-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. - try: - # Get Segment by ID - - results = SegmentsApi(api_client).get_segment(id=id) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).get_segment(id) - print("The response of SegmentsApi->get_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->get_segment: %s\n" % e) -- path: /segments - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#list-segments - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Segments - - results = SegmentsApi(api_client).list_segments() - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).list_segments(limit, offset, count) - print("The response of SegmentsApi->list_segments:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->list_segments: %s\n" % e) -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#patch-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. - request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - try: - # Update Segment - new_request_body = RequestBody.from_json(request_body) - results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).patch_segment(id, new_request_body) - print("The response of SegmentsApi->patch_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create - try: - # Create new Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete - try: - # Delete a Service Desk integration - - ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get - try: - # Get a Service Desk integration - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List existing Service Desk integrations - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get - try: - # Service Desk integration template by scriptName - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Service Desk integration types - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get the time check configuration - - results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - try: - # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) - print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of the integration to update - try: - # Update a Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - queued_check_config_details = '''{ - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - }''' # QueuedCheckConfigDetails | The modified time check configuration - try: - # Update the time check configuration - new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) - results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) - print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) - path: /sim-integrations method: POST xCodeSample: @@ -13173,6 +12573,842 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.export_payload import ExportPayload + from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.import_options import ImportOptions + from sailpoint.beta.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + search_attribute_config = '''{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }''' # SearchAttributeConfig | + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. + try: + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. + try: + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) +- path: /segments + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#create-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + segment = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }''' # Segment | + try: + # Create Segment + new_segment = Segment.from_json(segment) + results = SegmentsApi(api_client).create_segment(segment=new_segment) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).create_segment(new_segment) + print("The response of SegmentsApi->create_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#delete-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + SegmentsApi(api_client).delete_segment(id=id) + # Below is a request that includes all optional parameters + # SegmentsApi(api_client).delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) +- path: /segments/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#get-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + results = SegmentsApi(api_client).get_segment(id=id) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) +- path: /segments + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#list-segments + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # List Segments + + results = SegmentsApi(api_client).list_segments() + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#patch-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + try: + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).patch_segment(id, new_request_body) + print("The response of SegmentsApi->patch_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # List existing Service Desk integrations + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Service Desk integration types + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get the time check configuration + + results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + try: + # Patch a Service Desk Integration + new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }''' # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + queued_check_config_details = '''{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }''' # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) + results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.beta.api.source_usages_api import SourceUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.beta.api.source_usages_api import SourceUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -14587,242 +14823,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.beta.api.source_usages_api import SourceUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.beta.api.source_usages_api import SourceUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.export_payload import ExportPayload - from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.import_options import ImportOptions - from sailpoint.beta.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -16185,518 +16185,6 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) - connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows(limit, offset, trigger_id, connector_instance_id) - print("The response of WorkflowsApi->list_workflows:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.json_patch_operation import JsonPatchOperation - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response - from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) - print("The response of WorkflowsApi->post_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) - print("The response of WorkflowsApi->post_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#put-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.beta.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -17287,3 +16775,515 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) + connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows(limit, offset, trigger_id, connector_instance_id) + print("The response of WorkflowsApi->list_workflows:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response + from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) + print("The response of WorkflowsApi->post_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) + print("The response of WorkflowsApi->post_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#put-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.beta.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index d8fb8cad7..b06deade8 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -1305,6 +1305,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2024.api.account_usages_api import AccountUsagesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1767,36 +1797,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2024.api.account_usages_api import AccountUsagesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -3625,6 +3625,121 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3958,121 +4073,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: @@ -10557,6 +10557,198 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -10952,6 +11144,151 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#create-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_type = '''{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }''' # ManagedClusterType | + try: + # Create new Managed Cluster Type + new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) + results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) + print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#delete-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Delete a Managed Cluster Type + + ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Get a Managed Cluster Type + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) + print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-types + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) + pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) + org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + try: + # Get Managed Cluster Types + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) + print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#update-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JSONPatch payload used to update the schema. + try: + # Update a Managed Cluster Type + new_json_patch = JsonPatch.from_json(json_patch) + results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) + print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: @@ -11167,343 +11504,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # Get Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -15249,6 +15249,1122 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) +- path: /sim-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration + try: + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2024.api.sod_violations_api import SODViolationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2024.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2024.api.sod_violations_api import SODViolationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2024.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.export_payload import ExportPayload + from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.import_options import ImportOptions + from sailpoint.v2024.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -16769,941 +17885,61 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api.source_usages_api import SourceUsagesApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.source_usage_status import SourceUsageStatus from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source try: - # Get a SIM integration details. + # Finds status of source usage - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api.source_usages_api import SourceUsagesApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.v2024.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) try: - # List SOD policies + # Returns source usage insights - results = SODPoliciesApi(api_client).list_sod_policies() + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2024.api.sod_violations_api import SODViolationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2024.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2024.api.sod_violations_api import SODViolationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2024.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -19318,242 +19554,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.v2024.api.source_usages_api import SourceUsagesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.v2024.api.source_usages_api import SourceUsagesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.export_payload import ExportPayload - from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.import_options import ImportOptions - from sailpoint.v2024.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -20892,513 +20892,6 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v2024.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.v2024.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v2024.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -22008,3 +21501,510 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = '''sailpoint.v2024.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.v2024.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.v2024.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index 08eefe941..f0b696aaf 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -1323,6 +1323,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2025.api.account_usages_api import AccountUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1785,36 +1815,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2025.api.account_usages_api import AccountUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -3643,6 +3643,121 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3976,121 +4091,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: @@ -10575,6 +10575,198 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -10970,6 +11162,151 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_type = '''{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }''' # ManagedClusterType | + try: + # Create new Managed Cluster Type + new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) + results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) + print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Delete a Managed Cluster Type + + ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Get a Managed Cluster Type + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) + print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) + pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) + org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + try: + # List Managed Cluster Types + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) + print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JSONPatch payload used to update the schema. + try: + # Update a Managed Cluster Type + new_json_patch = JsonPatch.from_json(json_patch) + results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) + print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: @@ -11185,343 +11522,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -15267,6 +15267,1122 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) +- path: /sim-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration + try: + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2025.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2025.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.export_payload import ExportPayload + from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.import_options import ImportOptions + from sailpoint.v2025.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -16787,941 +17903,61 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.source_usage_status import SourceUsageStatus from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source try: - # Get a SIM integration details. + # Finds status of source usage - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.v2025.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) try: - # List SOD policies + # Returns source usage insights - results = SODPoliciesApi(api_client).list_sod_policies() + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2025.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2025.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -19336,242 +19572,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.export_payload import ExportPayload - from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.import_options import ImportOptions - from sailpoint.v2025.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -20910,513 +20910,6 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.v2025.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -22026,3 +21519,510 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.v2025.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index 70a2e8238..ab44b0ed6 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -870,6 +870,36 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v3.api.account_usages_api import AccountUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1191,36 +1221,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v3.api.account_usages_api import AccountUsagesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -2473,6 +2473,121 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2806,121 +2921,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -4249,357 +4249,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /managed-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.v3.models.managed_client_request import ManagedClientRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_client_request = '''{ - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - }''' # ManagedClientRequest | - try: - # Create Managed Client - new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) - results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) - print("The response of ManagedClientsApi->create_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Delete Managed Client - - ManagedClientsApi(api_client).delete_managed_client(id=id) - # Below is a request that includes all optional parameters - # ManagedClientsApi(api_client).delete_managed_client(id) - except Exception as e: - print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Get Managed Client - - results = ManagedClientsApi(api_client).get_managed_client(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client(id) - print("The response of ManagedClientsApi->get_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client_status import ManagedClientStatus - from sailpoint.v3.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. - type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. - try: - # Get Managed Client Status - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-clients - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - try: - # Get Managed Clients - - results = ManagedClientsApi(api_client).get_managed_clients() - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) - print("The response of ManagedClientsApi->get_managed_clients:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Client - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) - print("The response of ManagedClientsApi->update_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-clusters - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_request = '''{ - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - }''' # ManagedClusterRequest | - try: - # Create Create Managed Cluster - new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) - results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) - print("The response of ManagedClustersApi->create_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) - try: - # Delete Managed Cluster - - ManagedClustersApi(api_client).delete_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) - except Exception as e: - print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. - try: - # Get Managed Cluster Log Configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - try: - # Get Managed Cluster - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Get Managed Clusters - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration - from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. - put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. - try: - # Update Managed Cluster Log Configuration - new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Cluster - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) - print("The response of ManagedClustersApi->update_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -4988,6 +4637,357 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) +- path: /managed-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.v3.models.managed_client_request import ManagedClientRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_client_request = '''{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }''' # ManagedClientRequest | + try: + # Create Managed Client + new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) + results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) + print("The response of ManagedClientsApi->create_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + ManagedClientsApi(api_client).delete_managed_client(id=id) + # Below is a request that includes all optional parameters + # ManagedClientsApi(api_client).delete_managed_client(id) + except Exception as e: + print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + results = ManagedClientsApi(api_client).get_managed_client(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client_status import ManagedClientStatus + from sailpoint.v3.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. + type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + try: + # Get Managed Client Status + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + try: + # Get Managed Clients + + results = ManagedClientsApi(api_client).get_managed_clients() + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) + print("The response of ManagedClientsApi->update_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-clusters + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_request = '''{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }''' # ManagedClusterRequest | + try: + # Create Create Managed Cluster + new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) + results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) + try: + # Delete Managed Cluster + + ManagedClustersApi(api_client).delete_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) + except Exception as e: + print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. + try: + # Get Managed Cluster Log Configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + try: + # Get Managed Clusters + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. + put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Cluster + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -7264,6 +7264,646 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v3.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v3.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -8727,646 +9367,61 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report + label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api.source_usages_api import SourceUsagesApi from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source_usage_status import SourceUsageStatus from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source try: - # Download custom violation report + # Finds status of source usage - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report + label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api.source_usages_api import SourceUsagesApi from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) try: - # List SOD policies + # Returns source usage insights - results = SODPoliciesApi(api_client).list_sod_policies() + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v3.api.sod_violations_api import SODViolationsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v3.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check - source: | - from sailpoint.v3.api.sod_violations_api import SODViolationsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v3.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -10289,61 +10344,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.v3.api.source_usages_api import SourceUsagesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.v3.api.source_usages_api import SourceUsagesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -10847,6 +10847,346 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Approve an Approval Item + + results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) + try: + # Complete a Work Item + + results = WorkItemsApi(api_client).complete_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id, new_body) + print("The response of WorkItemsApi->complete_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # Completed Work Items + + results = WorkItemsApi(api_client).get_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Completed Work Items + + results = WorkItemsApi(api_client).get_count_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + results = WorkItemsApi(api_client).get_count_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + results = WorkItemsApi(api_client).get_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_summary import WorkItemsSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + results = WorkItemsApi(api_client).get_work_items_summary() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + results = WorkItemsApi(api_client).list_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Reject an Approval Item + + results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_item_forward import WorkItemForward + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + work_item_forward = '''{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }''' # WorkItemForward | + try: + # Forward a Work Item + new_work_item_forward = WorkItemForward.from_json(work_item_forward) + WorkItemsApi(api_client).send_work_item_forward(id=id, work_item_forward=new_work_item_forward) + # Below is a request that includes all optional parameters + # WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward) + except Exception as e: + print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName + try: + # Submit Account Selections + new_request_body = RequestBody.from_json(request_body) + results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) + print("The response of WorkItemsApi->submit_account_selection:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -11359,343 +11699,3 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Approve an Approval Item - - results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->approve_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk approve Approval Items - - results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) - print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) - try: - # Complete a Work Item - - results = WorkItemsApi(api_client).complete_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).complete_work_item(id, new_body) - print("The response of WorkItemsApi->complete_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) -- path: /work-items/completed - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Completed Work Items - - results = WorkItemsApi(api_client).get_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) - print("The response of WorkItemsApi->get_completed_work_items:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Completed Work Items - - results = WorkItemsApi(api_client).get_count_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) - print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) -- path: /work-items/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Work Items - - results = WorkItemsApi(api_client).get_count_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_work_items(owner_id) - print("The response of WorkItemsApi->get_count_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. - try: - # Get a Work Item - - results = WorkItemsApi(api_client).get_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_item(id) - print("The response of WorkItemsApi->get_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) -- path: /work-items/summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_summary import WorkItemsSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Work Items Summary - - results = WorkItemsApi(api_client).get_work_items_summary() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) - print("The response of WorkItemsApi->get_work_items_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) -- path: /work-items - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # List Work Items - - results = WorkItemsApi(api_client).list_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) - print("The response of WorkItemsApi->list_work_items:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Reject an Approval Item - - results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->reject_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk reject Approval Items - - results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) - print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_item_forward import WorkItemForward - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - work_item_forward = '''{ - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - }''' # WorkItemForward | - try: - # Forward a Work Item - new_work_item_forward = WorkItemForward.from_json(work_item_forward) - WorkItemsApi(api_client).send_work_item_forward(id=id, work_item_forward=new_work_item_forward) - # Below is a request that includes all optional parameters - # WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward) - except Exception as e: - print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName - try: - # Submit Account Selections - new_request_body = RequestBody.from_json(request_body) - results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) - print("The response of WorkItemsApi->submit_account_selection:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) From c09302d1468d18d6b1c20b3d99c8ffb34b68df30 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Fri, 18 Apr 2025 11:20:08 -0400 Subject: [PATCH 50/82] add v2025 url --- src/theme/ParamsItem/index.tsx | 1 + 1 file changed, 1 insertion(+) diff --git a/src/theme/ParamsItem/index.tsx b/src/theme/ParamsItem/index.tsx index 4dcb027de..59dd5e18a 100644 --- a/src/theme/ParamsItem/index.tsx +++ b/src/theme/ParamsItem/index.tsx @@ -410,6 +410,7 @@ function ParamsItem({ param, ...rest }: Props) { useEffect(() => { async function fetchAvailableUrl() { const baseUrls = [ + `https://developer.sailpoint.com/docs/api/v2025/${camelToKebab(operationId)}`, `https://developer.sailpoint.com/docs/api/v2024/${camelToKebab(operationId)}`, `https://developer.sailpoint.com/docs/api/v3/${camelToKebab(operationId)}`, `https://developer.sailpoint.com/docs/api/beta/${camelToKebab(operationId)}`, From 3e410e6717c623ec83d8c7600b29322270e8f249 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Mon, 21 Apr 2025 14:52:10 +0000 Subject: [PATCH 51/82] Automated commit by github action: 14575569134 --- .../idn/v2024/paths/pending-access-request-approvals.yaml | 3 +++ .../idn/v2025/paths/pending-access-request-approvals.yaml | 3 +++ .../idn/v3/paths/pending-access-request-approvals.yaml | 3 +++ 3 files changed, 9 insertions(+) diff --git a/static/api-specs/idn/v2024/paths/pending-access-request-approvals.yaml b/static/api-specs/idn/v2024/paths/pending-access-request-approvals.yaml index efa716a28..bb0534730 100644 --- a/static/api-specs/idn/v2024/paths/pending-access-request-approvals.yaml +++ b/static/api-specs/idn/v2024/paths/pending-access-request-approvals.yaml @@ -48,6 +48,9 @@ get: **accessRequestId**: *eq, in* + + + **created**: *gt, lt, ge, le, eq, in* example: id eq "2c91808568c529c60168cca6f90c1313" - in: query name: sorters diff --git a/static/api-specs/idn/v2025/paths/pending-access-request-approvals.yaml b/static/api-specs/idn/v2025/paths/pending-access-request-approvals.yaml index efa716a28..bb0534730 100644 --- a/static/api-specs/idn/v2025/paths/pending-access-request-approvals.yaml +++ b/static/api-specs/idn/v2025/paths/pending-access-request-approvals.yaml @@ -48,6 +48,9 @@ get: **accessRequestId**: *eq, in* + + + **created**: *gt, lt, ge, le, eq, in* example: id eq "2c91808568c529c60168cca6f90c1313" - in: query name: sorters diff --git a/static/api-specs/idn/v3/paths/pending-access-request-approvals.yaml b/static/api-specs/idn/v3/paths/pending-access-request-approvals.yaml index efa716a28..bb0534730 100644 --- a/static/api-specs/idn/v3/paths/pending-access-request-approvals.yaml +++ b/static/api-specs/idn/v3/paths/pending-access-request-approvals.yaml @@ -48,6 +48,9 @@ get: **accessRequestId**: *eq, in* + + + **created**: *gt, lt, ge, le, eq, in* example: id eq "2c91808568c529c60168cca6f90c1313" - in: query name: sorters From 6ca0602a5b8e90d36a68201bac12ecf2d90ef308 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Mon, 21 Apr 2025 14:53:35 +0000 Subject: [PATCH 52/82] Update to powershell SDK docs: 14575593835 --- .../Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md | 4 ++-- .../Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md | 4 ++-- .../Reference/V3/Methods/AccessRequestApprovalsApi.md | 4 ++-- .../code-examples/v2024/powershell_code_examples_overlay.yaml | 2 +- .../code-examples/v2025/powershell_code_examples_overlay.yaml | 2 +- static/code-examples/v3/powershell_code_examples_overlay.yaml | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md index 8a803a23d..a46c8341e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md @@ -318,7 +318,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** ### Return type @@ -344,7 +344,7 @@ $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value r $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) +$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # Pending Access Request Approvals List diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md index 0a200c455..34c06f1a6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md @@ -318,7 +318,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** ### Return type @@ -344,7 +344,7 @@ $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value r $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) +$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # Pending Access Request Approvals List diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md index 1c37e9979..31afadf3f 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md @@ -264,7 +264,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** ### Return type @@ -290,7 +290,7 @@ $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value r $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) +$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # Pending Access Request Approvals List diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index bab084b65..0e2bc76b1 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -479,7 +479,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # Pending Access Request Approvals List diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index d6d2b80a3..720362c97 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -479,7 +479,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # Pending Access Request Approvals List diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index a55273a04..cfcfaeb4d 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -353,7 +353,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # Pending Access Request Approvals List From 8af722fe872cd9b4a2d1abf181761a9d6fd2b080 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Mon, 21 Apr 2025 14:54:09 +0000 Subject: [PATCH 53/82] Update to python SDK docs: 14575601983 --- .../Reference/V2024/Methods/AccessRequestApprovalsApi.md | 4 ++-- .../Reference/V2025/Methods/AccessRequestApprovalsApi.md | 4 ++-- .../python/Reference/V3/Methods/AccessRequestApprovalsApi.md | 4 ++-- static/code-examples/v2024/python_code_examples_overlay.yaml | 2 +- static/code-examples/v2025/python_code_examples_overlay.yaml | 2 +- static/code-examples/v3/python_code_examples_overlay.yaml | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md index 920ab3270..afedabf98 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md @@ -384,7 +384,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** ### Return type @@ -419,7 +419,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestApprovalsApi.md index 347962833..16d91af7a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestApprovalsApi.md @@ -384,7 +384,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** ### Return type @@ -419,7 +419,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md index 4161d1145..dfc465b1f 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md @@ -316,7 +316,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** ### Return type @@ -351,7 +351,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index b06deade8..4d964affd 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -582,7 +582,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: # Pending Access Request Approvals List diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index f0b696aaf..971268b3c 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -582,7 +582,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: # Pending Access Request Approvals List diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index ab44b0ed6..2880bec27 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -412,7 +412,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: # Pending Access Request Approvals List From ca08f46fb51160c36e079508c770e839ec930ec0 Mon Sep 17 00:00:00 2001 From: Tyler Mairose Date: Tue, 22 Apr 2025 07:11:36 -0500 Subject: [PATCH 54/82] Add api and reassign documentation --- docs/tools/cli/api.md | 150 +++++++++++++++++++++++++++++++++++++ docs/tools/cli/reassign.md | 136 +++++++++++++++++++++++++++++++++ 2 files changed, 286 insertions(+) create mode 100644 docs/tools/cli/api.md create mode 100644 docs/tools/cli/reassign.md diff --git a/docs/tools/cli/api.md b/docs/tools/cli/api.md new file mode 100644 index 000000000..ba7ae969f --- /dev/null +++ b/docs/tools/cli/api.md @@ -0,0 +1,150 @@ +--- +id: cli-api +title: API +pagination_label: CLI API +sidebar_label: API +sidebar_position: 10 +sidebar_class_name: cli-api +keywords: ['cli', 'cli api', 'api'] +description: Learn how to use the CLI to make generic api calls in this guide. +slug: /tools/cli/api +tags: ['CLI'] +--- + +Learn how to use the SailPoint CLI to make generic api calls in this guide. + +The `api` command makes it easy to call SailPoint APIs and parse the results using JSONPath queries if needed. + +- [get](#get-requests) +- [post](#post-requests) +- [patch](#patch-requests) +- [put](#put-requests) +- [delete](#delete-requests) + +## Get Requests + +Run this command to get a list of transforms using the v2025 API: + +```shell +sail api get /v2025/transforms +``` + +You can filter the results using the `--jsonpath` flag or `-j` for short. The following command returns just the names of the transforms: + +```shell +sail api get /v2025/transforms --jsonpath "$.*.name" +``` + +For better readability, you can pretty-print the response using the `--pretty` flag or `-p` for short: + +```shell +sail api get /v2025/transforms --jsonpath "$.*.name" --pretty +``` + +### Headers + +To include headers with your API call—such as calling an experimental endpoint—use the `--headers` or `-H` flag: + +```shell +sail api get /v2025/entitlements/ -H "X-SailPoint-Experimental:true" +``` + +### Query Parameters + +Use the `--query` or `-q` flag to provide query parameters. + +For example, to retrieve a list of entitlements owned by a specific identity: + +:::tip +Query parameters may need to be escaped depending on their use. +::: + +```shell +sail api get /v2025/entitlements -q filters="owner.id eq\"\"" -H "X-SailPoint-Experimental:true" +``` + +### Multiple Query Parameters + +The `--query` flag can be used multiple times to provide additional query parameters. + +Use the following command to return a single entitlement owned by a specific identity: + +```shell +sail api get /v2025/entitlements -q filters="owner.id eq\"\"" -q limit=1 -H "X-SailPoint-Experimental:true" +``` + +## Post Requests + +Use the `post` subcommand to create resources. + +Run the following command to create a basic transform, passing the request body as a string: + +```shell +sail api post /v2025/transforms --body '{"name":"ToLowerCase","type":"lower","attributes":{}}' +``` + +Alternatively, use the `--body-file` or `-f` flag to provide the request body from a file: + +```shell +sail api post /v2025/transforms --file-body ./transform.json +``` + +## Patch Requests + +Use the `patch` sub command to update resources. + +Run the following command to update the owner of an access profile. + +```shell + sail api patch /v2025/access-profiles/ --body '[{"op":"replace","path":"/owner/id","value":""}]' +``` + +## Put Requests + +Run this command to replace a transform object using the v2025 api: + +```shell +sail api put /v2025/transforms/ --body '{"name":"ToLowerCase","type":"lower","attributes":{}}' +``` + +Use the `--body-file` or `-f` flag to provide the body of the request via a file. + +```shell +sail api put /v2025/transforms --file-body ./updated-transform.json +``` + +## Delete Requests + +Use this command to remove resources from Identity Security Cloud. + +Run the following command to remove a transform from your tenant. + +```shell +sail api delete /v2025/transforms/ +``` + +## Changing commands together + +You can combine the `--jsonpath` flag with tools like [jq](https://jqlang.org/) to chain commands and perform complex operations. + +For example, the following script reassigns roles from one owner to another. It uses `--jsonpath` to extract role IDs owned by the source identity, then updates each role with the new owner using sail api patch. + +```shell +#!/bin/bash + +from=$1 +to=$2 + +if [[ -z "$from" || -z "$to" ]]; then + echo "Usage: $0 " + exit 1 +fi + +ids=$(sail api get /v2025/roles -q "filters=owner.id eq \"$from\"" --jsonpath '$.*.id') + +for id in $(echo "$ids" | jq -r '.[]'); do + echo "Patching role ID: $id" + sail api patch /v2025/roles/"$id" \ + --body "[{\"op\":\"replace\",\"path\":\"/owner/id\",\"value\":\"$to\"}]" +done +``` diff --git a/docs/tools/cli/reassign.md b/docs/tools/cli/reassign.md new file mode 100644 index 000000000..67474b901 --- /dev/null +++ b/docs/tools/cli/reassign.md @@ -0,0 +1,136 @@ +--- +id: cli-reassign +title: Reassign +pagination_label: CLI Reassign +sidebar_label: Reassign +sidebar_position: 10 +sidebar_class_name: cli-reassign +keywords: ['cli', 'cli reassign', 'reassign'] +description: Learn how to use the CLI to reassign the owner on objects in Identity Security Cloud. +slug: /tools/cli/reassign +tags: ['CLI'] +--- + +Learn how to use the SailPoint CLI to reassign the owner on objects in Identity Security Cloud. + +The `reassign` command makes it easy to reassign ownership for the following supported object types: + +* sources +* roles +* access profiles +* entitlements +* identity profiles +* governance groups +* workflows + +## Reassign all object types + +Use the following command to reassign all supported object types from one identity to another. + +:::caution +It is recommended to use the `--dry-run` flag first to make sure the objects gathered are in fact the ones you wish to modify. +::: + +```shell +sail reassign --from --to --dry-run +``` + +The command will gather the supported object types, then display a simple report to show you a summary of which objects will be reassigned. + +You also have the ability to save the full report to a file in which you can view the objects in detail. + +```text +Reassignment Preview +==================== +From Owner: 2c918089796ba06c01798018af8d4161 (Tyler Mairose) +To Owner: (Darrell Thobe) +Object Types: source, role, access-profile, entitlement, identity-profile, governance-group, workflow +Dry Run: true + +Objects to Reassign: +--------------------- +Object Type Count +----------- ----- +role 2 +access-profile 0 +entitlement 1 +identity-profile 0 +governance-group 1 +workflow 1 +source 6 + +Total: 11 objects + +No changes have been made. Run the command without --dry-run to proceed. +Would you like to save the full report to a file (y/n): +``` + +### Reassign all object types without confirmation + +Run the following command to reassign all supported object types from one identity to another without being asked for confirmation. + +```shell +sail reassign --from --to --force +``` + +## Reassign specific object types + +Use the following command to reassign only workflows and roles from one identity to another. + +```shell +sail reassign --from --to --object-types workflow,role --dry-run +``` + +```text +Reassignment Preview +==================== +From Owner: 2c918089796ba06c01798018af8d4161 (Tyler Mairose) +To Owner: c701d93655854f1ea583622e7103e468 (Darrell Thobe) +Object Types: workflow, role +Dry Run: true + +Objects to Reassign: +--------------------- +Object Type Count +----------- ----- +role 2 +workflow 1 + +Total: 3 objects + +No changes have been made. Run the command without --dry-run to proceed. +``` + +Run the command without `--dry-run` to proceed with the reassignment. + +```shell +sail reassign --from --to --object-types workflow,role +``` + +You will still be asked if you wish to save the full report and confirm that you wish to reassign the objects. + +### Reassign specific object types without confirmation + +Run the following command to reassign all workflows and roles from one identity to another without being asked for confirmation. + +```shell +sail reassign --from --to --object-types workflow,role --force +``` + +## Reassign a single object + +Use the reassign command with the `--object-id` flag, passing in the id of the object you wish to reassign. The command will determine its object type and generate the preview. + +```shell +sail reassign --from --to --object-id +``` + +To continue with the reassignment, call the command again without `--dry-run` and follow the prompts. + +### Reassign a single object without confirmation + +Run the following command to reassign a single object from one identity to another without being asked for confirmation. + +```shell +sail reassign --from --to --object-id --force +``` From 356ec64cc92b9e8319897bb391a7672822531c03 Mon Sep 17 00:00:00 2001 From: Tyler Mairose Date: Tue, 22 Apr 2025 07:26:44 -0500 Subject: [PATCH 55/82] edits --- docs/tools/cli/api.md | 12 ++++++------ docs/tools/cli/reassign.md | 14 +++++++------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/tools/cli/api.md b/docs/tools/cli/api.md index ba7ae969f..4f796c460 100644 --- a/docs/tools/cli/api.md +++ b/docs/tools/cli/api.md @@ -11,7 +11,7 @@ slug: /tools/cli/api tags: ['CLI'] --- -Learn how to use the SailPoint CLI to make generic api calls in this guide. +Learn how to use the SailPoint CLI to make generic API calls in this guide. The `api` command makes it easy to call SailPoint APIs and parse the results using JSONPath queries if needed. @@ -53,7 +53,7 @@ sail api get /v2025/entitlements/ -H "X-SailPoint-Experimental:true" Use the `--query` or `-q` flag to provide query parameters. -For example, to retrieve a list of entitlements owned by a specific identity: +For example, run this command to retrieve a list of entitlements owned by a specific identity: :::tip Query parameters may need to be escaped depending on their use. @@ -93,7 +93,7 @@ sail api post /v2025/transforms --file-body ./transform.json Use the `patch` sub command to update resources. -Run the following command to update the owner of an access profile. +Run the following command to update the owner of an access profile: ```shell sail api patch /v2025/access-profiles/ --body '[{"op":"replace","path":"/owner/id","value":""}]' @@ -101,7 +101,7 @@ Run the following command to update the owner of an access profile. ## Put Requests -Run this command to replace a transform object using the v2025 api: +Run this command to replace a transform object using the v2025 API: ```shell sail api put /v2025/transforms/ --body '{"name":"ToLowerCase","type":"lower","attributes":{}}' @@ -117,7 +117,7 @@ sail api put /v2025/transforms --file-body ./updated-transform.json Use this command to remove resources from Identity Security Cloud. -Run the following command to remove a transform from your tenant. +Run the following command to remove a transform from your tenant: ```shell sail api delete /v2025/transforms/ @@ -127,7 +127,7 @@ sail api delete /v2025/transforms/ You can combine the `--jsonpath` flag with tools like [jq](https://jqlang.org/) to chain commands and perform complex operations. -For example, the following script reassigns roles from one owner to another. It uses `--jsonpath` to extract role IDs owned by the source identity, then updates each role with the new owner using sail api patch. +For example, the following script reassigns roles from one owner to another. It uses `--jsonpath` to extract role IDs owned by the source identity, then updates each role with the new owner using `sail api patch`. ```shell #!/bin/bash diff --git a/docs/tools/cli/reassign.md b/docs/tools/cli/reassign.md index 67474b901..07a96e7ee 100644 --- a/docs/tools/cli/reassign.md +++ b/docs/tools/cli/reassign.md @@ -25,7 +25,7 @@ The `reassign` command makes it easy to reassign ownership for the following sup ## Reassign all object types -Use the following command to reassign all supported object types from one identity to another. +Use the following command to reassign all supported object types from one identity to another: :::caution It is recommended to use the `--dry-run` flag first to make sure the objects gathered are in fact the ones you wish to modify. @@ -35,7 +35,7 @@ It is recommended to use the `--dry-run` flag first to make sure the objects gat sail reassign --from --to --dry-run ``` -The command will gather the supported object types, then display a simple report to show you a summary of which objects will be reassigned. +The command will gather the supported object types and then display a simple report to show you a summary of which objects will be reassigned. You also have the ability to save the full report to a file in which you can view the objects in detail. @@ -75,7 +75,7 @@ sail reassign --from --to --force ## Reassign specific object types -Use the following command to reassign only workflows and roles from one identity to another. +Use the following command to reassign only workflows and roles from one identity to another: ```shell sail reassign --from --to --object-types workflow,role --dry-run @@ -101,7 +101,7 @@ Total: 3 objects No changes have been made. Run the command without --dry-run to proceed. ``` -Run the command without `--dry-run` to proceed with the reassignment. +Run the command without `--dry-run` to proceed with the reassignment: ```shell sail reassign --from --to --object-types workflow,role @@ -111,7 +111,7 @@ You will still be asked if you wish to save the full report and confirm that you ### Reassign specific object types without confirmation -Run the following command to reassign all workflows and roles from one identity to another without being asked for confirmation. +Run the following command to reassign all workflows and roles from one identity to another without being asked for confirmation: ```shell sail reassign --from --to --object-types workflow,role --force @@ -119,7 +119,7 @@ sail reassign --from --to --object-types workflow, ## Reassign a single object -Use the reassign command with the `--object-id` flag, passing in the id of the object you wish to reassign. The command will determine its object type and generate the preview. +Use the reassign command with the `--object-id` flag, passing in the id of the object you wish to reassign. The command will determine its object type and generate the preview: ```shell sail reassign --from --to --object-id @@ -129,7 +129,7 @@ To continue with the reassignment, call the command again without `--dry-run` an ### Reassign a single object without confirmation -Run the following command to reassign a single object from one identity to another without being asked for confirmation. +Run the following command to reassign a single object from one identity to another without being asked for confirmation: ```shell sail reassign --from --to --object-id --force From bfe361920eb36bc08c9ebf85abe22b6df3030ca5 Mon Sep 17 00:00:00 2001 From: con-docs Date: Tue, 22 Apr 2025 14:19:43 -0500 Subject: [PATCH 56/82] devrel-1198 --- .../preparing-a-subscriber-service.md | 14 ++++++++++++++ .../event-triggers/testing-triggers.md | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/extensibility/event-triggers/preparing-a-subscriber-service.md b/docs/extensibility/event-triggers/preparing-a-subscriber-service.md index 2ee818473..99570cea8 100644 --- a/docs/extensibility/event-triggers/preparing-a-subscriber-service.md +++ b/docs/extensibility/event-triggers/preparing-a-subscriber-service.md @@ -36,3 +36,17 @@ No-code/low-code providers, like Zapier and Microsoft Power Automate, make it ea ## Custom Application A custom application is one you write in a language of your choosing and host in your own infrastructure, cloud, or on-premise. This is the most advanced option for implementing an event trigger client service. Although it requires a great deal of skill and knowledge to build, deploy, and operate your own service that can consume requests over HTTP, a custom application offers the most power and flexibility to implement your use cases. You can learn more about custom applications by checking out our [Event Trigger Example Application](https://github.com/sailpoint-oss/event-trigger-examples). + +### Visual Studio Code Port Forwarding + +When you're developing a custom application that can consume event triggers, ISC needs a public URL (Integration URL) it can send event data to. However, you may want to test your custom application locally. If you're using Visual Studio Code (VSCode), you can use its [built-in port forwarding feature](https://code.visualstudio.com/docs/debugtest/port-forwarding) to generate a public URL and then forward its web traffic into your local web service. + +Follow these steps to set up port forwarding in your custom application: + +1. Open the terminal in VSCode and select the 'Ports' tab. +2. Select 'Forward a Port'. +3. Specify the port that your application is using to listen for event data. In the event trigger examples project, the port is 8081 by default. Click 'Enter' to create a port. +4. VSCode will prompt you to log in to GitHub. Log in, and VS Code will create a URL in the 'Forwarded Address' column. This is the URL you will make public for ISC to send event data to. +5. Right click the URL, select 'Visibility', and set the visibility to 'Public'. ISC needs the URL to be public to send it event data. + +You now have a public URL you can provide to ISC as an 'Integration URL' when you subscribe to an event trigger. Copy the URL and paste it into the 'Integration URL' when you subscribe to an event trigger. Then add the event trigger endpoint to the end of the URL so that your application reads the correct event data. For example, you would use a URL like https://w6wl7kkz-8081.usw3.devtunnels.ms/form-submitted to consume the [Form Submitted](https://developer.sailpoint.com/docs/api/v2025/form-submitted-event) event trigger. diff --git a/docs/extensibility/event-triggers/testing-triggers.md b/docs/extensibility/event-triggers/testing-triggers.md index 742e4cefa..af5281725 100644 --- a/docs/extensibility/event-triggers/testing-triggers.md +++ b/docs/extensibility/event-triggers/testing-triggers.md @@ -11,7 +11,7 @@ slug: /extensibility/event-triggers/testing-triggers tags: ['Event Triggers'] --- -It is important to test your trigger subscription configuration with your actual subscribing service (not a test site like [webhook.site](https://webhook.site)) before enabling your subscription for production use. Testing subscriptions ensures that your subscribing service can successfully receive events and that you are receiving the correct events based on the filter you have provided. +It is important to test your trigger subscription configuration with your actual subscribing service (not a test site like [webhook.site](https://webhook.site)) before enabling your subscription for production use. Testing subscriptions ensures that your subscribing service can successfully receive events and that you are receiving the correct events based on the filter you have provided. If you're using Visual Studio Code (VSCode), you can use [VSCode Port Forwarding](./preparing-a-subscriber-service.md/#visual-studio-code-port-forwarding) to forward event data from a public URL to your local service to test your subscriber service properly. ## Sending Test Invocations From c39bca9cc58d4d692780bdcbcbc0e2818821b3a3 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Tue, 22 Apr 2025 17:12:09 -0400 Subject: [PATCH 57/82] updating broken link --- docs/extensibility/event-triggers/testing-triggers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/extensibility/event-triggers/testing-triggers.md b/docs/extensibility/event-triggers/testing-triggers.md index af5281725..dab4d7c72 100644 --- a/docs/extensibility/event-triggers/testing-triggers.md +++ b/docs/extensibility/event-triggers/testing-triggers.md @@ -11,7 +11,7 @@ slug: /extensibility/event-triggers/testing-triggers tags: ['Event Triggers'] --- -It is important to test your trigger subscription configuration with your actual subscribing service (not a test site like [webhook.site](https://webhook.site)) before enabling your subscription for production use. Testing subscriptions ensures that your subscribing service can successfully receive events and that you are receiving the correct events based on the filter you have provided. If you're using Visual Studio Code (VSCode), you can use [VSCode Port Forwarding](./preparing-a-subscriber-service.md/#visual-studio-code-port-forwarding) to forward event data from a public URL to your local service to test your subscriber service properly. +It is important to test your trigger subscription configuration with your actual subscribing service (not a test site like [webhook.site](https://webhook.site)) before enabling your subscription for production use. Testing subscriptions ensures that your subscribing service can successfully receive events and that you are receiving the correct events based on the filter you have provided. If you're using Visual Studio Code (VSCode), you can use [VSCode Port Forwarding](/docs/extensibility/event-triggers/preparing-subscriber-service#visual-studio-code-port-forwarding) to forward event data from a public URL to your local service to test your subscriber service properly. ## Sending Test Invocations From 810f417bae8008919c60931867f8f5318b5cc346 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Wed, 23 Apr 2025 08:03:59 -0400 Subject: [PATCH 58/82] updating dependencies --- package-lock.json | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/package-lock.json b/package-lock.json index 60ab339c1..4b9618d67 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11559,9 +11559,9 @@ } }, "node_modules/estree-util-value-to-estree": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/estree-util-value-to-estree/-/estree-util-value-to-estree-3.2.1.tgz", - "integrity": "sha512-Vt2UOjyPbNQQgT5eJh+K5aATti0OjCIAGc9SgMdOFYbohuifsWclR74l0iZTJwePMgWYdX1hlVS+dedH9XV8kw==", + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/estree-util-value-to-estree/-/estree-util-value-to-estree-3.3.3.tgz", + "integrity": "sha512-Db+m1WSD4+mUO7UgMeKkAwdbfNWwIxLt48XF2oFU9emPfXkIu+k5/nlOj313v7wqtAPo0f9REhUvznFrPkG8CQ==", "license": "MIT", "dependencies": { "@types/estree": "^1.0.0" @@ -13299,10 +13299,9 @@ } }, "node_modules/http-proxy-middleware": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.7.tgz", - "integrity": "sha512-fgVY8AV7qU7z/MmXJ/rxwbrtQH4jBQ9m7kp3llF0liB7glmFeVZFBepQb32T3y8n8k2+AEYuMPCpinYW+/CuRA==", - "license": "MIT", + "version": "2.0.9", + "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz", + "integrity": "sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q==", "dependencies": { "@types/http-proxy": "^1.17.8", "http-proxy": "^1.18.1", @@ -13450,9 +13449,9 @@ } }, "node_modules/image-size": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/image-size/-/image-size-1.2.0.tgz", - "integrity": "sha512-4S8fwbO6w3GeCVN6OPtA9I5IGKkcDMPcKndtUlpJuCwu7JLjtj7JZpwqLuyY2nrmQT3AWsCJLSKPsc2mPBSl3w==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/image-size/-/image-size-1.2.1.tgz", + "integrity": "sha512-rH+46sQJ2dlwfjfhCyNx5thzrv+dtmBIhPHk0zgRUukHzZ/kRueTJXoYYsclBaKcSMBWuGbOFXtioLpzTb5euw==", "license": "MIT", "dependencies": { "queue": "6.0.2" From e4d28a7f9485725ac9d75ccf6a8acf2dfc2c044a Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 23 Apr 2025 12:55:15 +0000 Subject: [PATCH 59/82] Update to python SDK docs: 14618578457 --- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../V2024/Methods/AccessModelMetadataApi.md | 8 +- .../V2024/Methods/AccessProfilesApi.md | 2 +- .../V2024/Methods/AccessRequestsApi.md | 2 +- .../V2024/Methods/AccountAggregationsApi.md | 2 +- .../Reference/V2024/Methods/AccountsApi.md | 10 +- .../Reference/V2024/Methods/ApprovalsApi.md | 4 +- .../python/Reference/V2024/Methods/AppsApi.md | 28 +- .../Reference/V2024/Methods/AuthProfileApi.md | 6 +- .../Methods/CustomPasswordInstructionsApi.md | 6 +- .../V2024/Methods/DataSegmentationApi.md | 14 +- .../V2024/Methods/EntitlementsApi.md | 24 +- .../V2024/Methods/GovernanceGroupsApi.md | 20 +- .../IAIAccessRequestRecommendationsApi.md | 20 +- .../V2024/Methods/IAICommonAccessApi.md | 6 +- .../Reference/V2024/Methods/IAIOutliersApi.md | 18 +- .../Methods/IAIPeerGroupStrategiesApi.md | 2 +- .../V2024/Methods/IAIRecommendationsApi.md | 6 +- .../V2024/Methods/IAIRoleMiningApi.md | 50 +- .../Reference/V2024/Methods/IconsApi.md | 4 +- .../Reference/V2024/Methods/IdentitiesApi.md | 22 +- .../V2024/Methods/IdentityAttributesApi.md | 12 +- .../V2024/Methods/IdentityHistoryApi.md | 22 +- .../V2024/Methods/IdentityProfilesApi.md | 2 +- .../V2024/Methods/MachineAccountsApi.md | 6 +- .../V2024/Methods/MachineIdentitiesApi.md | 10 +- .../V2024/Methods/NotificationsApi.md | 30 +- .../Reference/V2024/Methods/OrgConfigApi.md | 6 +- .../V2024/Methods/PasswordManagementApi.md | 2 +- .../V2024/Methods/RoleInsightsApi.md | 18 +- .../Reference/V2024/Methods/RolesApi.md | 2 +- .../V2024/Methods/SIMIntegrationsApi.md | 14 +- .../SearchAttributeConfigurationApi.md | 10 +- .../Reference/V2024/Methods/SourcesApi.md | 22 +- .../V2024/Methods/TaskManagementApi.md | 10 +- .../V2024/Methods/TenantContextApi.md | 4 +- .../Reference/V2024/Methods/TriggersApi.md | 20 +- .../Reference/V2024/Methods/UIMetadataApi.md | 4 +- .../Reference/V2024/Methods/WorkItemsApi.md | 4 +- .../V2024/Methods/WorkReassignmentApi.md | 18 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../V2025/Methods/AccessModelMetadataApi.md | 8 +- .../V2025/Methods/AccessProfilesApi.md | 2 +- .../V2025/Methods/AccessRequestsApi.md | 4 +- .../V2025/Methods/AccountAggregationsApi.md | 2 +- .../Reference/V2025/Methods/AccountsApi.md | 10 +- .../Reference/V2025/Methods/ApprovalsApi.md | 4 +- .../python/Reference/V2025/Methods/AppsApi.md | 28 +- .../Reference/V2025/Methods/AuthProfileApi.md | 6 +- .../Methods/CustomPasswordInstructionsApi.md | 6 +- .../V2025/Methods/DataSegmentationApi.md | 14 +- .../V2025/Methods/EntitlementsApi.md | 24 +- .../V2025/Methods/GovernanceGroupsApi.md | 20 +- .../IAIAccessRequestRecommendationsApi.md | 20 +- .../V2025/Methods/IAICommonAccessApi.md | 6 +- .../Reference/V2025/Methods/IAIOutliersApi.md | 18 +- .../Methods/IAIPeerGroupStrategiesApi.md | 2 +- .../V2025/Methods/IAIRecommendationsApi.md | 6 +- .../V2025/Methods/IAIRoleMiningApi.md | 50 +- .../Reference/V2025/Methods/IconsApi.md | 4 +- .../Reference/V2025/Methods/IdentitiesApi.md | 22 +- .../V2025/Methods/IdentityAttributesApi.md | 12 +- .../V2025/Methods/IdentityHistoryApi.md | 22 +- .../V2025/Methods/IdentityProfilesApi.md | 2 +- .../V2025/Methods/MachineAccountsApi.md | 6 +- .../V2025/Methods/MachineIdentitiesApi.md | 10 +- .../V2025/Methods/NotificationsApi.md | 30 +- .../Reference/V2025/Methods/OrgConfigApi.md | 6 +- .../V2025/Methods/PasswordManagementApi.md | 2 +- .../V2025/Methods/RoleInsightsApi.md | 18 +- .../Reference/V2025/Methods/RolesApi.md | 2 +- .../V2025/Methods/SIMIntegrationsApi.md | 14 +- .../SearchAttributeConfigurationApi.md | 10 +- .../Reference/V2025/Methods/SourcesApi.md | 22 +- .../V2025/Methods/TaskManagementApi.md | 10 +- .../V2025/Methods/TenantContextApi.md | 4 +- .../Reference/V2025/Methods/TriggersApi.md | 20 +- .../Reference/V2025/Methods/UIMetadataApi.md | 4 +- .../Reference/V2025/Methods/WorkItemsApi.md | 4 +- .../V2025/Methods/WorkReassignmentApi.md | 18 +- .../Reference/V2025/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2025/Models/SourceUsage.md | 2 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../python/Reference/V3/Models/SourceUsage.md | 2 +- .../beta/python_code_examples_overlay.yaml | 3136 +++++------ .../v2024/python_code_examples_overlay.yaml | 4902 ++++++++-------- .../v2025/python_code_examples_overlay.yaml | 4904 ++++++++--------- .../v3/python_code_examples_overlay.yaml | 3000 +++++----- 94 files changed, 8458 insertions(+), 8458 deletions(-) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md index dced03305..6d30198f2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index bffe6c49e..e0b91fdea 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md index fbcbd7a29..72badf0ff 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md index 72e332675..1cdcf8236 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md @@ -81,7 +81,7 @@ from sailpoint.v2024.models.attribute_dto import AttributeDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -154,7 +154,7 @@ from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -227,7 +227,7 @@ from sailpoint.v2024.models.attribute_dto import AttributeDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -300,7 +300,7 @@ from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md index 4acc8015a..39452b630 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md @@ -681,7 +681,7 @@ from sailpoint.v2024.models.access_profile_update_item import AccessProfileUpdat from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md index 526a078b3..3fbc05074 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md @@ -291,7 +291,7 @@ from sailpoint.v2024.models.close_access_request import CloseAccessRequest from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md index 0b66de402..686bd725d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md @@ -85,7 +85,7 @@ from sailpoint.v2024.models.account_aggregation_status import AccountAggregation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md index e7422eaa4..4a5f5e174 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md @@ -257,7 +257,7 @@ from sailpoint.v2024.models.task_result_dto import TaskResultDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id @@ -394,7 +394,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -467,7 +467,7 @@ from sailpoint.v2024.models.identities_accounts_bulk_request import IdentitiesAc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -607,7 +607,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -680,7 +680,7 @@ from sailpoint.v2024.models.identities_accounts_bulk_request import IdentitiesAc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md index 160f35465..7d2446425 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md @@ -72,7 +72,7 @@ from sailpoint.v2024.models.approval import Approval from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned @@ -147,7 +147,7 @@ from sailpoint.v2024.models.approval import Approval from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md index f83e92254..d5dd6419c 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md @@ -84,7 +84,7 @@ from sailpoint.v2024.models.source_app_create_dto import SourceAppCreateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -167,7 +167,7 @@ from sailpoint.v2024.models.access_profile_details import AccessProfileDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -242,7 +242,7 @@ from sailpoint.v2024.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. @@ -315,7 +315,7 @@ from sailpoint.v2024.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -390,7 +390,7 @@ from sailpoint.v2024.models.access_profile_details import AccessProfileDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -470,7 +470,7 @@ from sailpoint.v2024.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -551,7 +551,7 @@ from sailpoint.v2024.models.user_app import UserApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* @@ -631,7 +631,7 @@ from sailpoint.v2024.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -710,7 +710,7 @@ from sailpoint.v2024.models.app_account_details import AppAccountDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app @@ -789,7 +789,7 @@ from sailpoint.v2024.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -869,7 +869,7 @@ from sailpoint.v2024.models.user_app import UserApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -950,7 +950,7 @@ from sailpoint.v2024.models.source_app_patch_dto import SourceAppPatchDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch @@ -1027,7 +1027,7 @@ from sailpoint.v2024.models.user_app import UserApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch @@ -1103,7 +1103,7 @@ from sailpoint.v2024.models.source_app_bulk_update_request import SourceAppBulkU from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md index 3dbd53124..6d1478f0e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md @@ -77,7 +77,7 @@ from sailpoint.v2024.models.auth_profile import AuthProfile from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -148,7 +148,7 @@ from sailpoint.v2024.models.auth_profile_summary import AuthProfileSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -223,7 +223,7 @@ from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md index 7c050b668..8941160fe 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md @@ -79,7 +79,7 @@ from sailpoint.v2024.models.custom_password_instruction import CustomPasswordIns from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -154,7 +154,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. @@ -225,7 +225,7 @@ from sailpoint.v2024.models.custom_password_instruction import CustomPasswordIns from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md index 969c7beb8..f2156b9d0 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md @@ -137,7 +137,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. @@ -209,7 +209,7 @@ from sailpoint.v2024.models.data_segment import DataSegment from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. @@ -281,7 +281,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. @@ -353,7 +353,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. @@ -432,7 +432,7 @@ from sailpoint.v2024.models.data_segment import DataSegment from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -513,7 +513,7 @@ from sailpoint.v2024.models.data_segment import DataSegment from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. @@ -587,7 +587,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md index 949e8abd8..e33d11ad8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md @@ -130,7 +130,7 @@ from sailpoint.v2024.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -205,7 +205,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -278,7 +278,7 @@ from sailpoint.v2024.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID @@ -351,7 +351,7 @@ from sailpoint.v2024.models.entitlement_request_config import EntitlementRequest from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -431,7 +431,7 @@ from sailpoint.v2024.models.load_entitlement_task import LoadEntitlementTask from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -510,7 +510,7 @@ from sailpoint.v2024.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -594,7 +594,7 @@ from sailpoint.v2024.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id @@ -684,7 +684,7 @@ from sailpoint.v2024.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -772,7 +772,7 @@ from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch @@ -847,7 +847,7 @@ from sailpoint.v2024.models.entitlement_request_config import EntitlementRequest from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID @@ -926,7 +926,7 @@ from sailpoint.v2024.models.entitlement_source_reset_base_reference_dto import E from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset @@ -1004,7 +1004,7 @@ from sailpoint.v2024.models.entitlement_bulk_update_request import EntitlementBu from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md index 84507523c..a041e7954 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md @@ -82,7 +82,7 @@ from sailpoint.v2024.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -168,7 +168,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -243,7 +243,7 @@ from sailpoint.v2024.models.workgroup_member_delete_item import WorkgroupMemberD from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -329,7 +329,7 @@ from sailpoint.v2024.models.workgroup_delete_item import WorkgroupDeleteItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -404,7 +404,7 @@ from sailpoint.v2024.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -480,7 +480,7 @@ from sailpoint.v2024.models.workgroup_connection_dto import WorkgroupConnectionD from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -561,7 +561,7 @@ from sailpoint.v2024.models.list_workgroup_members200_response_inner import List from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -642,7 +642,7 @@ from sailpoint.v2024.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -724,7 +724,7 @@ from sailpoint.v2024.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -803,7 +803,7 @@ from sailpoint.v2024.models.workgroup_member_add_item import WorkgroupMemberAddI from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md index 366500211..12f4b6d2c 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md @@ -78,7 +78,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -157,7 +157,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -236,7 +236,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -315,7 +315,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -394,7 +394,7 @@ from sailpoint.v2024.models.access_request_recommendation_item_detail import Acc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -472,7 +472,7 @@ from sailpoint.v2024.models.access_request_recommendation_config_dto import Acce from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -547,7 +547,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -628,7 +628,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -709,7 +709,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -786,7 +786,7 @@ from sailpoint.v2024.models.access_request_recommendation_config_dto import Acce from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md index 2efd10569..e548f95d9 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md @@ -71,7 +71,7 @@ from sailpoint.v2024.models.common_access_item_response import CommonAccessItemR from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -156,7 +156,7 @@ from sailpoint.v2024.models.common_access_response import CommonAccessResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -233,7 +233,7 @@ from sailpoint.v2024.models.common_access_id_status import CommonAccessIDStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md index 816aa5023..ab3e06643 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md @@ -78,7 +78,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -155,7 +155,7 @@ from sailpoint.v2024.models.outlier_summary import OutlierSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -237,7 +237,7 @@ from sailpoint.v2024.models.outlier import Outlier from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -316,7 +316,7 @@ from sailpoint.v2024.models.latest_outlier_summary import LatestOutlierSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -393,7 +393,7 @@ from sailpoint.v2024.models.outlier_feature_summary import OutlierFeatureSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id @@ -474,7 +474,7 @@ from sailpoint.v2024.models.outlier_contributing_feature import OutlierContribut from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -551,7 +551,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -631,7 +631,7 @@ from sailpoint.v2024.models.outliers_contributing_feature_access_items import Ou from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -709,7 +709,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md index 39b51af0c..c169d0f08 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md @@ -74,7 +74,7 @@ from sailpoint.v2024.models.peer_group_member import PeerGroupMember from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md index 46773e0c8..beaef5c68 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md @@ -71,7 +71,7 @@ from sailpoint.v2024.models.recommendation_response_dto import RecommendationRes from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -160,7 +160,7 @@ from sailpoint.v2024.models.recommendation_config_dto import RecommendationConfi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -231,7 +231,7 @@ from sailpoint.v2024.models.recommendation_config_dto import RecommendationConfi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md index c85fff2f5..cf6e99b87 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md @@ -97,7 +97,7 @@ from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -180,7 +180,7 @@ from sailpoint.v2024.models.role_mining_session_response import RoleMiningSessio from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -283,7 +283,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -356,7 +356,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -431,7 +431,7 @@ from sailpoint.v2024.models.role_mining_potential_role_export_response import Ro from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -509,7 +509,7 @@ from sailpoint.v2024.models.role_mining_potential_role_export_response import Ro from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -587,7 +587,7 @@ from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -664,7 +664,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -745,7 +745,7 @@ from sailpoint.v2024.models.role_mining_entitlement import RoleMiningEntitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -830,7 +830,7 @@ from sailpoint.v2024.models.role_mining_entitlement import RoleMiningEntitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -914,7 +914,7 @@ from sailpoint.v2024.models.role_mining_identity import RoleMiningIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -994,7 +994,7 @@ from sailpoint.v2024.models.role_mining_potential_role import RoleMiningPotentia from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1072,7 +1072,7 @@ from sailpoint.v2024.models.role_mining_potential_role_application import RoleMi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1155,7 +1155,7 @@ from sailpoint.v2024.models.role_mining_potential_role_entitlements import RoleM from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1238,7 +1238,7 @@ from sailpoint.v2024.models.role_mining_potential_role_source_usage import RoleM from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id @@ -1321,7 +1321,7 @@ from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1399,7 +1399,7 @@ from sailpoint.v2024.models.role_mining_potential_role import RoleMiningPotentia from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id @@ -1472,7 +1472,7 @@ from sailpoint.v2024.models.role_mining_session_response import RoleMiningSessio from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved. @@ -1543,7 +1543,7 @@ from sailpoint.v2024.models.role_mining_session_status import RoleMiningSessionS from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1619,7 +1619,7 @@ from sailpoint.v2024.models.role_mining_session_dto import RoleMiningSessionDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1699,7 +1699,7 @@ from sailpoint.v2024.models.role_mining_session_draft_role_dto import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1790,7 +1790,7 @@ from sailpoint.v2024.models.patch_potential_role_request_inner import PatchPoten from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1879,7 +1879,7 @@ from sailpoint.v2024.models.patch_potential_role_request_inner import PatchPoten from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1955,7 +1955,7 @@ from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched @@ -2030,7 +2030,7 @@ from sailpoint.v2024.models.role_mining_potential_role_edit_entitlements import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md index 39f08369a..8997ea118 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md @@ -72,7 +72,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] @@ -146,7 +146,7 @@ from sailpoint.v2024.models.set_icon200_response import SetIcon200Response from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md index 8dd8e7501..c1c21a163 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md @@ -93,7 +93,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -164,7 +164,7 @@ from sailpoint.v2024.models.identity import Identity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -239,7 +239,7 @@ from sailpoint.v2024.models.identity_ownership_association_details import Identi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. @@ -313,7 +313,7 @@ from sailpoint.v2024.models.role_assignment_dto import RoleAssignmentDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -389,7 +389,7 @@ from sailpoint.v2024.models.get_role_assignments200_response_inner import GetRol from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for @@ -469,7 +469,7 @@ from sailpoint.v2024.models.identity import Identity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -547,7 +547,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -620,7 +620,7 @@ from sailpoint.v2024.models.send_account_verification_request import SendAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -701,7 +701,7 @@ from sailpoint.v2024.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -785,7 +785,7 @@ from sailpoint.v2024.models.task_result_response import TaskResultResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -860,7 +860,7 @@ from sailpoint.v2024.models.identity_sync_job import IdentitySyncJob from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md index 76d010e2e..7de807ad8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md @@ -74,7 +74,7 @@ from sailpoint.v2024.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -167,7 +167,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -238,7 +238,7 @@ from sailpoint.v2024.models.identity_attribute_names import IdentityAttributeNam from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -311,7 +311,7 @@ from sailpoint.v2024.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -386,7 +386,7 @@ from sailpoint.v2024.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -464,7 +464,7 @@ from sailpoint.v2024.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md index 6909110f7..fc2930927 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md @@ -84,7 +84,7 @@ from sailpoint.v2024.models.identity_compare_response import IdentityCompareResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -170,7 +170,7 @@ from sailpoint.v2024.models.access_item_diff import AccessItemDiff from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -250,7 +250,7 @@ from sailpoint.v2024.models.identity_history_response import IdentityHistoryResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -329,7 +329,7 @@ from sailpoint.v2024.models.get_historical_identity_events200_response_inner imp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -409,7 +409,7 @@ from sailpoint.v2024.models.identity_history_response import IdentityHistoryResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -488,7 +488,7 @@ from sailpoint.v2024.models.metric_response import MetricResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -566,7 +566,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -642,7 +642,7 @@ from sailpoint.v2024.models.identity_list_item import IdentityListItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -725,7 +725,7 @@ from sailpoint.v2024.models.list_identity_access_items200_response_inner import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -804,7 +804,7 @@ from sailpoint.v2024.models.list_identity_access_items200_response_inner import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -884,7 +884,7 @@ from sailpoint.v2024.models.identity_snapshot_summary_response import IdentitySn from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md index 8594ec3f3..894dc1179 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md @@ -384,7 +384,7 @@ from sailpoint.v2024.models.identity_preview_response import IdentityPreviewResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md index 1d6aca07f..8d84e6ff0 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md @@ -71,7 +71,7 @@ from sailpoint.v2024.models.machine_account import MachineAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. @@ -148,7 +148,7 @@ from sailpoint.v2024.models.machine_account import MachineAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -228,7 +228,7 @@ from sailpoint.v2024.models.machine_account import MachineAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md index a16b6ef7c..15fc9a7f3 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md @@ -74,7 +74,7 @@ from sailpoint.v2024.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -155,7 +155,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -226,7 +226,7 @@ from sailpoint.v2024.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -303,7 +303,7 @@ from sailpoint.v2024.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -383,7 +383,7 @@ from sailpoint.v2024.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md index 7caf4b3f1..b18e0d16a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md @@ -84,7 +84,7 @@ from sailpoint.v2024.models.domain_status_dto import DomainStatusDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -160,7 +160,7 @@ from sailpoint.v2024.models.template_dto import TemplateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -249,7 +249,7 @@ from sailpoint.v2024.models.email_status_dto import EmailStatusDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -326,7 +326,7 @@ from sailpoint.v2024.models.template_bulk_delete_dto import TemplateBulkDeleteDt from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -396,7 +396,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | # str | @@ -465,7 +465,7 @@ from sailpoint.v2024.models.dkim_attributes import DkimAttributes from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -537,7 +537,7 @@ from sailpoint.v2024.models.mail_from_attributes import MailFromAttributes from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status @@ -609,7 +609,7 @@ from sailpoint.v2024.models.template_dto import TemplateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template @@ -681,7 +681,7 @@ from sailpoint.v2024.models.notification_template_context import NotificationTem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -755,7 +755,7 @@ from sailpoint.v2024.models.email_status_dto import EmailStatusDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -832,7 +832,7 @@ from sailpoint.v2024.models.preferences_dto import PreferencesDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -905,7 +905,7 @@ from sailpoint.v2024.models.template_dto_default import TemplateDtoDefault from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -982,7 +982,7 @@ from sailpoint.v2024.models.template_dto import TemplateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1058,7 +1058,7 @@ from sailpoint.v2024.models.mail_from_attributes_dto import MailFromAttributesDt from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1134,7 +1134,7 @@ from sailpoint.v2024.models.send_test_notification_request_dto import SendTestNo from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md index 7d1485f9d..09e52079b 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md @@ -72,7 +72,7 @@ from sailpoint.v2024.models.org_config import OrgConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -144,7 +144,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -221,7 +221,7 @@ from sailpoint.v2024.models.org_config import OrgConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md index bd02d467d..6d3dcc663 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md @@ -96,7 +96,7 @@ from sailpoint.v2024.models.password_digit_token_reset import PasswordDigitToken from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md index a7242c555..2275372c9 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md @@ -78,7 +78,7 @@ from sailpoint.v2024.models.role_insights_response import RoleInsightsResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -149,7 +149,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -229,7 +229,7 @@ from sailpoint.v2024.models.role_insights_identities import RoleInsightsIdentiti from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -308,7 +308,7 @@ from sailpoint.v2024.models.role_insight import RoleInsight from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -383,7 +383,7 @@ from sailpoint.v2024.models.role_insight import RoleInsight from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -460,7 +460,7 @@ from sailpoint.v2024.models.role_insights_entitlement import RoleInsightsEntitle from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -535,7 +535,7 @@ from sailpoint.v2024.models.role_insights_entitlement_changes import RoleInsight from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -613,7 +613,7 @@ from sailpoint.v2024.models.role_insights_response import RoleInsightsResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id @@ -683,7 +683,7 @@ from sailpoint.v2024.models.role_insights_summary import RoleInsightsSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md index 8eb895a24..eb1f4eab7 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md @@ -770,7 +770,7 @@ from sailpoint.v2024.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md index 779da7c9f..edf0ef35a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md @@ -83,7 +83,7 @@ from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -172,7 +172,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. @@ -243,7 +243,7 @@ from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration. # str | The id of the integration. @@ -315,7 +315,7 @@ from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -390,7 +390,7 @@ from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | SIM integration id # str | SIM integration id @@ -476,7 +476,7 @@ from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | SIM integration id # str | SIM integration id @@ -562,7 +562,7 @@ from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration. # str | The id of the integration. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md index eaf25c05a..cfbc8ba68 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md @@ -92,7 +92,7 @@ from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -170,7 +170,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. @@ -241,7 +241,7 @@ from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -316,7 +316,7 @@ from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. @@ -393,7 +393,7 @@ from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md index 8cadc35f3..24509f2a0 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md @@ -546,7 +546,7 @@ from sailpoint.v2024.models.task_result_dto import TaskResultDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id @@ -618,7 +618,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -1100,7 +1100,7 @@ from sailpoint.v2024.models.native_change_detection_config import NativeChangeDe from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -1294,7 +1294,7 @@ from sailpoint.v2024.models.attr_sync_source_config import AttrSyncSourceConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -1489,7 +1489,7 @@ from sailpoint.v2024.models.source_entitlement_request_config import SourceEntit from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1879,7 +1879,7 @@ from sailpoint.v2024.models.load_accounts_task import LoadAccountsTask from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -2148,7 +2148,7 @@ from sailpoint.v2024.models.load_uncorrelated_accounts_task import LoadUncorrela from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id @@ -2495,7 +2495,7 @@ from sailpoint.v2024.models.native_change_detection_config import NativeChangeDe from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -2838,7 +2838,7 @@ from sailpoint.v2024.models.attr_sync_source_config import AttrSyncSourceConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -3067,7 +3067,7 @@ from sailpoint.v2024.models.source_sync_job import SourceSyncJob from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | The Source id # str | The Source id @@ -3531,7 +3531,7 @@ from sailpoint.v2024.models.source_entitlement_request_config import SourceEntit from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md index e98ababce..0494c5f85 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md @@ -74,7 +74,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -149,7 +149,7 @@ from sailpoint.v2024.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -225,7 +225,7 @@ from sailpoint.v2024.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. @@ -303,7 +303,7 @@ from sailpoint.v2024.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -383,7 +383,7 @@ from sailpoint.v2024.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TenantContextApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TenantContextApi.md index b2fcc91fb..fe528bd4b 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TenantContextApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TenantContextApi.md @@ -71,7 +71,7 @@ from sailpoint.v2024.models.get_tenant_context200_response_inner import GetTenan from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -149,7 +149,7 @@ from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md index 980404a38..87b91f9be 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md @@ -119,7 +119,7 @@ from sailpoint.v2024.models.complete_invocation import CompleteInvocation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. @@ -199,7 +199,7 @@ from sailpoint.v2024.models.subscription_post_request import SubscriptionPostReq from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -295,7 +295,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID @@ -369,7 +369,7 @@ from sailpoint.v2024.models.subscription import Subscription from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -452,7 +452,7 @@ from sailpoint.v2024.models.invocation_status import InvocationStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -533,7 +533,7 @@ from sailpoint.v2024.models.trigger import Trigger from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -615,7 +615,7 @@ from sailpoint.v2024.models.subscription_patch_request_inner import Subscription from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch @@ -690,7 +690,7 @@ from sailpoint.v2024.models.test_invocation import TestInvocation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -774,7 +774,7 @@ from sailpoint.v2024.models.validate_filter_output_dto import ValidateFilterOutp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -863,7 +863,7 @@ from sailpoint.v2024.models.subscription_put_request import SubscriptionPutReque from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md index 51c6e6798..0ef846c8f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md @@ -70,7 +70,7 @@ from sailpoint.v2024.models.tenant_ui_metadata_item_response import TenantUiMeta from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -143,7 +143,7 @@ from sailpoint.v2024.models.tenant_ui_metadata_item_update_request import Tenant from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md index bdc447643..a3206abda 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md @@ -276,7 +276,7 @@ from sailpoint.v2024.models.work_item_forward import WorkItemForward from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item @@ -414,7 +414,7 @@ from sailpoint.v2024.models.work_items_count import WorkItemsCount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md index 157dfc40d..b7f695173 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md @@ -87,7 +87,7 @@ from sailpoint.v2024.models.configuration_item_response import ConfigurationItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -166,7 +166,7 @@ from sailpoint.v2024.models.config_type_enum import ConfigTypeEnum from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -240,7 +240,7 @@ from sailpoint.v2024.models.evaluate_response import EvaluateResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -314,7 +314,7 @@ from sailpoint.v2024.models.config_type import ConfigType from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -387,7 +387,7 @@ from sailpoint.v2024.models.configuration_response import ConfigurationResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id @@ -459,7 +459,7 @@ from sailpoint.v2024.models.tenant_configuration_response import TenantConfigura from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -530,7 +530,7 @@ from sailpoint.v2024.models.configuration_response import ConfigurationResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -604,7 +604,7 @@ from sailpoint.v2024.models.configuration_item_response import ConfigurationItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -684,7 +684,7 @@ from sailpoint.v2024.models.tenant_configuration_response import TenantConfigura from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md index 5353898b1..442faa748 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index db5a37930..a37f38fea 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md index c57393c0d..ea8523f54 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md index 2782bcd64..ed042a74d 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md @@ -81,7 +81,7 @@ from sailpoint.v2025.models.attribute_dto import AttributeDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -154,7 +154,7 @@ from sailpoint.v2025.models.attribute_value_dto import AttributeValueDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -227,7 +227,7 @@ from sailpoint.v2025.models.attribute_dto import AttributeDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -300,7 +300,7 @@ from sailpoint.v2025.models.attribute_value_dto import AttributeValueDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md index 94a99b1bc..44928f4d4 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md @@ -681,7 +681,7 @@ from sailpoint.v2025.models.access_profile_update_item import AccessProfileUpdat from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md index 414c1d18c..50f63a3d8 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md @@ -292,7 +292,7 @@ from sailpoint.v2025.models.close_access_request import CloseAccessRequest from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -696,7 +696,7 @@ from sailpoint.v2025.models.identity_entitlement_details import IdentityEntitlem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccountAggregationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccountAggregationsApi.md index ced4213dd..7d8230414 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccountAggregationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccountAggregationsApi.md @@ -85,7 +85,7 @@ from sailpoint.v2025.models.account_aggregation_status import AccountAggregation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccountsApi.md index 496e7ebf3..ea1c23b9e 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccountsApi.md @@ -257,7 +257,7 @@ from sailpoint.v2025.models.task_result_dto import TaskResultDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id @@ -394,7 +394,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -467,7 +467,7 @@ from sailpoint.v2025.models.identities_accounts_bulk_request import IdentitiesAc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -607,7 +607,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -680,7 +680,7 @@ from sailpoint.v2025.models.identities_accounts_bulk_request import IdentitiesAc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md index d7a816774..f4193e06f 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md @@ -72,7 +72,7 @@ from sailpoint.v2025.models.approval import Approval from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned @@ -147,7 +147,7 @@ from sailpoint.v2025.models.approval import Approval from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AppsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AppsApi.md index 0ef47ac97..a2946d0b3 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AppsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AppsApi.md @@ -84,7 +84,7 @@ from sailpoint.v2025.models.source_app_create_dto import SourceAppCreateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -167,7 +167,7 @@ from sailpoint.v2025.models.access_profile_details import AccessProfileDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -242,7 +242,7 @@ from sailpoint.v2025.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. @@ -315,7 +315,7 @@ from sailpoint.v2025.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -390,7 +390,7 @@ from sailpoint.v2025.models.access_profile_details import AccessProfileDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -470,7 +470,7 @@ from sailpoint.v2025.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -551,7 +551,7 @@ from sailpoint.v2025.models.user_app import UserApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* @@ -631,7 +631,7 @@ from sailpoint.v2025.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -710,7 +710,7 @@ from sailpoint.v2025.models.app_account_details import AppAccountDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app @@ -789,7 +789,7 @@ from sailpoint.v2025.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -869,7 +869,7 @@ from sailpoint.v2025.models.user_app import UserApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -950,7 +950,7 @@ from sailpoint.v2025.models.source_app_patch_dto import SourceAppPatchDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch @@ -1027,7 +1027,7 @@ from sailpoint.v2025.models.user_app import UserApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch @@ -1103,7 +1103,7 @@ from sailpoint.v2025.models.source_app_bulk_update_request import SourceAppBulkU from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AuthProfileApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AuthProfileApi.md index 132f725c3..29fd3801f 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AuthProfileApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AuthProfileApi.md @@ -77,7 +77,7 @@ from sailpoint.v2025.models.auth_profile import AuthProfile from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -148,7 +148,7 @@ from sailpoint.v2025.models.auth_profile_summary import AuthProfileSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -223,7 +223,7 @@ from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/CustomPasswordInstructionsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/CustomPasswordInstructionsApi.md index fd222d6ce..5ceefa692 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/CustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/CustomPasswordInstructionsApi.md @@ -79,7 +79,7 @@ from sailpoint.v2025.models.custom_password_instruction import CustomPasswordIns from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -154,7 +154,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. @@ -225,7 +225,7 @@ from sailpoint.v2025.models.custom_password_instruction import CustomPasswordIns from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/DataSegmentationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/DataSegmentationApi.md index 2e31bc3d2..5f0947a5a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/DataSegmentationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/DataSegmentationApi.md @@ -137,7 +137,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. @@ -209,7 +209,7 @@ from sailpoint.v2025.models.data_segment import DataSegment from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. @@ -281,7 +281,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. @@ -353,7 +353,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. @@ -432,7 +432,7 @@ from sailpoint.v2025.models.data_segment import DataSegment from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -513,7 +513,7 @@ from sailpoint.v2025.models.data_segment import DataSegment from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. @@ -587,7 +587,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/EntitlementsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/EntitlementsApi.md index bfefc3a1f..969516035 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/EntitlementsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/EntitlementsApi.md @@ -130,7 +130,7 @@ from sailpoint.v2025.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -205,7 +205,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -278,7 +278,7 @@ from sailpoint.v2025.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID @@ -351,7 +351,7 @@ from sailpoint.v2025.models.entitlement_request_config import EntitlementRequest from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -431,7 +431,7 @@ from sailpoint.v2025.models.load_entitlement_task import LoadEntitlementTask from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -510,7 +510,7 @@ from sailpoint.v2025.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -594,7 +594,7 @@ from sailpoint.v2025.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id @@ -684,7 +684,7 @@ from sailpoint.v2025.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -772,7 +772,7 @@ from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch @@ -847,7 +847,7 @@ from sailpoint.v2025.models.entitlement_request_config import EntitlementRequest from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID @@ -926,7 +926,7 @@ from sailpoint.v2025.models.entitlement_source_reset_base_reference_dto import E from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset @@ -1004,7 +1004,7 @@ from sailpoint.v2025.models.entitlement_bulk_update_request import EntitlementBu from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/GovernanceGroupsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/GovernanceGroupsApi.md index 92116b4e0..813976afb 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/GovernanceGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/GovernanceGroupsApi.md @@ -82,7 +82,7 @@ from sailpoint.v2025.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -168,7 +168,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -243,7 +243,7 @@ from sailpoint.v2025.models.workgroup_member_delete_item import WorkgroupMemberD from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -329,7 +329,7 @@ from sailpoint.v2025.models.workgroup_delete_item import WorkgroupDeleteItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -404,7 +404,7 @@ from sailpoint.v2025.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -480,7 +480,7 @@ from sailpoint.v2025.models.workgroup_connection_dto import WorkgroupConnectionD from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -561,7 +561,7 @@ from sailpoint.v2025.models.list_workgroup_members200_response_inner import List from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -642,7 +642,7 @@ from sailpoint.v2025.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -724,7 +724,7 @@ from sailpoint.v2025.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -803,7 +803,7 @@ from sailpoint.v2025.models.workgroup_member_add_item import WorkgroupMemberAddI from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIAccessRequestRecommendationsApi.md index 06fc82052..be157d7cc 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIAccessRequestRecommendationsApi.md @@ -78,7 +78,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -157,7 +157,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -236,7 +236,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -315,7 +315,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -394,7 +394,7 @@ from sailpoint.v2025.models.access_request_recommendation_item_detail import Acc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -472,7 +472,7 @@ from sailpoint.v2025.models.access_request_recommendation_config_dto import Acce from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -547,7 +547,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -628,7 +628,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -709,7 +709,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -786,7 +786,7 @@ from sailpoint.v2025.models.access_request_recommendation_config_dto import Acce from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAICommonAccessApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAICommonAccessApi.md index febaf3831..34bc9f4c2 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAICommonAccessApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAICommonAccessApi.md @@ -71,7 +71,7 @@ from sailpoint.v2025.models.common_access_item_response import CommonAccessItemR from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -156,7 +156,7 @@ from sailpoint.v2025.models.common_access_response import CommonAccessResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -233,7 +233,7 @@ from sailpoint.v2025.models.common_access_id_status import CommonAccessIDStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIOutliersApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIOutliersApi.md index d87fda828..f342c9071 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIOutliersApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIOutliersApi.md @@ -78,7 +78,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -155,7 +155,7 @@ from sailpoint.v2025.models.outlier_summary import OutlierSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -237,7 +237,7 @@ from sailpoint.v2025.models.outlier import Outlier from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -316,7 +316,7 @@ from sailpoint.v2025.models.latest_outlier_summary import LatestOutlierSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -393,7 +393,7 @@ from sailpoint.v2025.models.outlier_feature_summary import OutlierFeatureSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id @@ -474,7 +474,7 @@ from sailpoint.v2025.models.outlier_contributing_feature import OutlierContribut from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -551,7 +551,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -631,7 +631,7 @@ from sailpoint.v2025.models.outliers_contributing_feature_access_items import Ou from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -709,7 +709,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIPeerGroupStrategiesApi.md index 15093b5d7..36f366065 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIPeerGroupStrategiesApi.md @@ -74,7 +74,7 @@ from sailpoint.v2025.models.peer_group_member import PeerGroupMember from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIRecommendationsApi.md index 84995152d..942621bbc 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIRecommendationsApi.md @@ -71,7 +71,7 @@ from sailpoint.v2025.models.recommendation_response_dto import RecommendationRes from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -160,7 +160,7 @@ from sailpoint.v2025.models.recommendation_config_dto import RecommendationConfi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -231,7 +231,7 @@ from sailpoint.v2025.models.recommendation_config_dto import RecommendationConfi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIRoleMiningApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIRoleMiningApi.md index 16696cd70..0059be7cf 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIRoleMiningApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIRoleMiningApi.md @@ -97,7 +97,7 @@ from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -180,7 +180,7 @@ from sailpoint.v2025.models.role_mining_session_response import RoleMiningSessio from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -283,7 +283,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -356,7 +356,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -431,7 +431,7 @@ from sailpoint.v2025.models.role_mining_potential_role_export_response import Ro from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -509,7 +509,7 @@ from sailpoint.v2025.models.role_mining_potential_role_export_response import Ro from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -587,7 +587,7 @@ from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -664,7 +664,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -745,7 +745,7 @@ from sailpoint.v2025.models.role_mining_entitlement import RoleMiningEntitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -830,7 +830,7 @@ from sailpoint.v2025.models.role_mining_entitlement import RoleMiningEntitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -914,7 +914,7 @@ from sailpoint.v2025.models.role_mining_identity import RoleMiningIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -994,7 +994,7 @@ from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentia from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1072,7 +1072,7 @@ from sailpoint.v2025.models.role_mining_potential_role_application import RoleMi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1155,7 +1155,7 @@ from sailpoint.v2025.models.role_mining_potential_role_entitlements import RoleM from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1238,7 +1238,7 @@ from sailpoint.v2025.models.role_mining_potential_role_source_usage import RoleM from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id @@ -1321,7 +1321,7 @@ from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1399,7 +1399,7 @@ from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentia from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id @@ -1472,7 +1472,7 @@ from sailpoint.v2025.models.role_mining_session_response import RoleMiningSessio from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved. @@ -1543,7 +1543,7 @@ from sailpoint.v2025.models.role_mining_session_status import RoleMiningSessionS from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1619,7 +1619,7 @@ from sailpoint.v2025.models.role_mining_session_dto import RoleMiningSessionDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1699,7 +1699,7 @@ from sailpoint.v2025.models.role_mining_session_draft_role_dto import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1790,7 +1790,7 @@ from sailpoint.v2025.models.patch_potential_role_request_inner import PatchPoten from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1879,7 +1879,7 @@ from sailpoint.v2025.models.patch_potential_role_request_inner import PatchPoten from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1955,7 +1955,7 @@ from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched @@ -2030,7 +2030,7 @@ from sailpoint.v2025.models.role_mining_potential_role_edit_entitlements import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IconsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IconsApi.md index 0eefeba15..fb75615e3 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IconsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IconsApi.md @@ -72,7 +72,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] @@ -146,7 +146,7 @@ from sailpoint.v2025.models.set_icon200_response import SetIcon200Response from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md index 748eeec82..79ca2ed87 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md @@ -93,7 +93,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -164,7 +164,7 @@ from sailpoint.v2025.models.identity import Identity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -239,7 +239,7 @@ from sailpoint.v2025.models.identity_ownership_association_details import Identi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. @@ -313,7 +313,7 @@ from sailpoint.v2025.models.role_assignment_dto import RoleAssignmentDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -389,7 +389,7 @@ from sailpoint.v2025.models.get_role_assignments200_response_inner import GetRol from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for @@ -469,7 +469,7 @@ from sailpoint.v2025.models.identity import Identity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -547,7 +547,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -620,7 +620,7 @@ from sailpoint.v2025.models.send_account_verification_request import SendAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -701,7 +701,7 @@ from sailpoint.v2025.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -785,7 +785,7 @@ from sailpoint.v2025.models.task_result_response import TaskResultResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -860,7 +860,7 @@ from sailpoint.v2025.models.identity_sync_job import IdentitySyncJob from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityAttributesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityAttributesApi.md index 9c850deaa..51bb8907b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityAttributesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityAttributesApi.md @@ -74,7 +74,7 @@ from sailpoint.v2025.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -167,7 +167,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -238,7 +238,7 @@ from sailpoint.v2025.models.identity_attribute_names import IdentityAttributeNam from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -311,7 +311,7 @@ from sailpoint.v2025.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -386,7 +386,7 @@ from sailpoint.v2025.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -464,7 +464,7 @@ from sailpoint.v2025.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityHistoryApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityHistoryApi.md index 389f83945..c264e88f4 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityHistoryApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityHistoryApi.md @@ -84,7 +84,7 @@ from sailpoint.v2025.models.identity_compare_response import IdentityCompareResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -170,7 +170,7 @@ from sailpoint.v2025.models.access_item_diff import AccessItemDiff from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -250,7 +250,7 @@ from sailpoint.v2025.models.identity_history_response import IdentityHistoryResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -329,7 +329,7 @@ from sailpoint.v2025.models.get_historical_identity_events200_response_inner imp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -409,7 +409,7 @@ from sailpoint.v2025.models.identity_history_response import IdentityHistoryResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -488,7 +488,7 @@ from sailpoint.v2025.models.metric_response import MetricResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -566,7 +566,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -642,7 +642,7 @@ from sailpoint.v2025.models.identity_list_item import IdentityListItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -725,7 +725,7 @@ from sailpoint.v2025.models.list_identity_access_items200_response_inner import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -804,7 +804,7 @@ from sailpoint.v2025.models.list_identity_access_items200_response_inner import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -884,7 +884,7 @@ from sailpoint.v2025.models.identity_snapshot_summary_response import IdentitySn from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md index 7c20e9f5d..2194e9232 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md @@ -384,7 +384,7 @@ from sailpoint.v2025.models.identity_preview_response import IdentityPreviewResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md index 2232330ef..b7a7c0978 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md @@ -71,7 +71,7 @@ from sailpoint.v2025.models.machine_account import MachineAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. @@ -148,7 +148,7 @@ from sailpoint.v2025.models.machine_account import MachineAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -228,7 +228,7 @@ from sailpoint.v2025.models.machine_account import MachineAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md index 0a2db8c3e..d6fb93287 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md @@ -74,7 +74,7 @@ from sailpoint.v2025.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -155,7 +155,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -226,7 +226,7 @@ from sailpoint.v2025.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -303,7 +303,7 @@ from sailpoint.v2025.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -383,7 +383,7 @@ from sailpoint.v2025.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/NotificationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/NotificationsApi.md index cf94205a0..f1220d285 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/NotificationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/NotificationsApi.md @@ -84,7 +84,7 @@ from sailpoint.v2025.models.domain_status_dto import DomainStatusDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -160,7 +160,7 @@ from sailpoint.v2025.models.template_dto import TemplateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -249,7 +249,7 @@ from sailpoint.v2025.models.email_status_dto import EmailStatusDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -326,7 +326,7 @@ from sailpoint.v2025.models.template_bulk_delete_dto import TemplateBulkDeleteDt from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -396,7 +396,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | # str | @@ -465,7 +465,7 @@ from sailpoint.v2025.models.dkim_attributes import DkimAttributes from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -537,7 +537,7 @@ from sailpoint.v2025.models.mail_from_attributes import MailFromAttributes from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status @@ -609,7 +609,7 @@ from sailpoint.v2025.models.template_dto import TemplateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template @@ -681,7 +681,7 @@ from sailpoint.v2025.models.notification_template_context import NotificationTem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -755,7 +755,7 @@ from sailpoint.v2025.models.email_status_dto import EmailStatusDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -832,7 +832,7 @@ from sailpoint.v2025.models.preferences_dto import PreferencesDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -905,7 +905,7 @@ from sailpoint.v2025.models.template_dto_default import TemplateDtoDefault from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -982,7 +982,7 @@ from sailpoint.v2025.models.template_dto import TemplateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1058,7 +1058,7 @@ from sailpoint.v2025.models.mail_from_attributes_dto import MailFromAttributesDt from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1134,7 +1134,7 @@ from sailpoint.v2025.models.send_test_notification_request_dto import SendTestNo from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/OrgConfigApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/OrgConfigApi.md index 2fc2a20af..442fbc13b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/OrgConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/OrgConfigApi.md @@ -72,7 +72,7 @@ from sailpoint.v2025.models.org_config import OrgConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -144,7 +144,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -221,7 +221,7 @@ from sailpoint.v2025.models.org_config import OrgConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/PasswordManagementApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/PasswordManagementApi.md index e217f8d7d..93cd668f0 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/PasswordManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/PasswordManagementApi.md @@ -96,7 +96,7 @@ from sailpoint.v2025.models.password_digit_token_reset import PasswordDigitToken from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/RoleInsightsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/RoleInsightsApi.md index 73536c434..ebaa1de10 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/RoleInsightsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/RoleInsightsApi.md @@ -78,7 +78,7 @@ from sailpoint.v2025.models.role_insights_response import RoleInsightsResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -149,7 +149,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -229,7 +229,7 @@ from sailpoint.v2025.models.role_insights_identities import RoleInsightsIdentiti from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -308,7 +308,7 @@ from sailpoint.v2025.models.role_insight import RoleInsight from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -383,7 +383,7 @@ from sailpoint.v2025.models.role_insight import RoleInsight from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -460,7 +460,7 @@ from sailpoint.v2025.models.role_insights_entitlement import RoleInsightsEntitle from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -535,7 +535,7 @@ from sailpoint.v2025.models.role_insights_entitlement_changes import RoleInsight from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -613,7 +613,7 @@ from sailpoint.v2025.models.role_insights_response import RoleInsightsResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id @@ -683,7 +683,7 @@ from sailpoint.v2025.models.role_insights_summary import RoleInsightsSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md index 40c24cab7..6eca10a82 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md @@ -770,7 +770,7 @@ from sailpoint.v2025.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SIMIntegrationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SIMIntegrationsApi.md index 8e6a3345e..d70668deb 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SIMIntegrationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SIMIntegrationsApi.md @@ -83,7 +83,7 @@ from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -172,7 +172,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. @@ -243,7 +243,7 @@ from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration. # str | The id of the integration. @@ -315,7 +315,7 @@ from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -390,7 +390,7 @@ from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | SIM integration id # str | SIM integration id @@ -476,7 +476,7 @@ from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | SIM integration id # str | SIM integration id @@ -562,7 +562,7 @@ from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration. # str | The id of the integration. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SearchAttributeConfigurationApi.md index 88b772262..5ed54960c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SearchAttributeConfigurationApi.md @@ -92,7 +92,7 @@ from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -170,7 +170,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. @@ -241,7 +241,7 @@ from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -316,7 +316,7 @@ from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. @@ -393,7 +393,7 @@ from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md index 6522af83d..63e94ef60 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md @@ -546,7 +546,7 @@ from sailpoint.v2025.models.task_result_dto import TaskResultDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id @@ -618,7 +618,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -1100,7 +1100,7 @@ from sailpoint.v2025.models.native_change_detection_config import NativeChangeDe from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -1294,7 +1294,7 @@ from sailpoint.v2025.models.attr_sync_source_config import AttrSyncSourceConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -1489,7 +1489,7 @@ from sailpoint.v2025.models.source_entitlement_request_config import SourceEntit from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1879,7 +1879,7 @@ from sailpoint.v2025.models.load_accounts_task import LoadAccountsTask from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -2148,7 +2148,7 @@ from sailpoint.v2025.models.load_uncorrelated_accounts_task import LoadUncorrela from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id @@ -2495,7 +2495,7 @@ from sailpoint.v2025.models.native_change_detection_config import NativeChangeDe from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -2838,7 +2838,7 @@ from sailpoint.v2025.models.attr_sync_source_config import AttrSyncSourceConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -3067,7 +3067,7 @@ from sailpoint.v2025.models.source_sync_job import SourceSyncJob from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | The Source id # str | The Source id @@ -3531,7 +3531,7 @@ from sailpoint.v2025.models.source_entitlement_request_config import SourceEntit from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TaskManagementApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TaskManagementApi.md index f241a3c72..513b2ea5c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TaskManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TaskManagementApi.md @@ -74,7 +74,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -149,7 +149,7 @@ from sailpoint.v2025.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -225,7 +225,7 @@ from sailpoint.v2025.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. @@ -303,7 +303,7 @@ from sailpoint.v2025.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -383,7 +383,7 @@ from sailpoint.v2025.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TenantContextApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TenantContextApi.md index b9e35c288..8b44de4b4 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TenantContextApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TenantContextApi.md @@ -71,7 +71,7 @@ from sailpoint.v2025.models.get_tenant_context200_response_inner import GetTenan from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -149,7 +149,7 @@ from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TriggersApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TriggersApi.md index a05008a26..086216b16 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TriggersApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TriggersApi.md @@ -119,7 +119,7 @@ from sailpoint.v2025.models.complete_invocation import CompleteInvocation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. @@ -199,7 +199,7 @@ from sailpoint.v2025.models.subscription_post_request import SubscriptionPostReq from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -295,7 +295,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID @@ -369,7 +369,7 @@ from sailpoint.v2025.models.subscription import Subscription from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -452,7 +452,7 @@ from sailpoint.v2025.models.invocation_status import InvocationStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -533,7 +533,7 @@ from sailpoint.v2025.models.trigger import Trigger from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -615,7 +615,7 @@ from sailpoint.v2025.models.subscription_patch_request_inner import Subscription from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch @@ -690,7 +690,7 @@ from sailpoint.v2025.models.test_invocation import TestInvocation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -774,7 +774,7 @@ from sailpoint.v2025.models.validate_filter_output_dto import ValidateFilterOutp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -863,7 +863,7 @@ from sailpoint.v2025.models.subscription_put_request import SubscriptionPutReque from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/UIMetadataApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/UIMetadataApi.md index 3255901c7..bec17846b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/UIMetadataApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/UIMetadataApi.md @@ -70,7 +70,7 @@ from sailpoint.v2025.models.tenant_ui_metadata_item_response import TenantUiMeta from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -143,7 +143,7 @@ from sailpoint.v2025.models.tenant_ui_metadata_item_update_request import Tenant from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/WorkItemsApi.md index 0cc3a6ee2..439afdf2c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/WorkItemsApi.md @@ -276,7 +276,7 @@ from sailpoint.v2025.models.work_item_forward import WorkItemForward from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item @@ -414,7 +414,7 @@ from sailpoint.v2025.models.work_items_count import WorkItemsCount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/WorkReassignmentApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/WorkReassignmentApi.md index fa837f5b3..a3a234b3b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/WorkReassignmentApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/WorkReassignmentApi.md @@ -87,7 +87,7 @@ from sailpoint.v2025.models.configuration_item_response import ConfigurationItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -166,7 +166,7 @@ from sailpoint.v2025.models.config_type_enum import ConfigTypeEnum from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -240,7 +240,7 @@ from sailpoint.v2025.models.evaluate_response import EvaluateResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -314,7 +314,7 @@ from sailpoint.v2025.models.config_type import ConfigType from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -387,7 +387,7 @@ from sailpoint.v2025.models.configuration_response import ConfigurationResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id @@ -459,7 +459,7 @@ from sailpoint.v2025.models.tenant_configuration_response import TenantConfigura from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -530,7 +530,7 @@ from sailpoint.v2025.models.configuration_response import ConfigurationResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -604,7 +604,7 @@ from sailpoint.v2025.models.configuration_item_response import ConfigurationItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -684,7 +684,7 @@ from sailpoint.v2025.models.tenant_configuration_response import TenantConfigura from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md index 626e62e2b..8403e7986 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 33437e264..960d4b101 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md index 3091b3a26..3f731dad1 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md index 211d1a3d1..a1615a57b 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index 049a9aafe..a80904ad9 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md index 4d3443864..159a7ebe0 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index 07a699304..a14d2bfad 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -1082,36 +1082,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.beta.api.account_usages_api import AccountUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1564,6 +1534,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.beta.api.account_usages_api import AccountUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications/{id} method: GET xCodeSample: @@ -7862,6 +7862,196 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.beta.api.managed_clients_api import ManagedClientsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_client_status import ManagedClientStatus + from sailpoint.beta.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get + type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get + try: + # Specified Managed Client Status. + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status + source: | + from sailpoint.beta.api.managed_clients_api import ManagedClientsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_client_status import ManagedClientStatus + from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update + managed_client_status = '''{ + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + }''' # ManagedClientStatus | + try: + # Handle status request from client + new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) + results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) + print("The response of ManagedClientsApi->update_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for + try: + # Get managed cluster's log configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get + try: + # Get a specified ManagedCluster. + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq operation' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + try: + # Retrieve all Managed Clusters. + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for + client_log_configuration = '''{ + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + try: + # Update managed cluster's log configuration + + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -8250,196 +8440,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.beta.api.managed_clients_api import ManagedClientsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_client_status import ManagedClientStatus - from sailpoint.beta.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get - type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get - try: - # Specified Managed Client Status. - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status - source: | - from sailpoint.beta.api.managed_clients_api import ManagedClientsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_client_status import ManagedClientStatus - from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update - managed_client_status = '''{ - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - }''' # ManagedClientStatus | - try: - # Handle status request from client - new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) - results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) - print("The response of ManagedClientsApi->update_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for - try: - # Get managed cluster's log configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get - try: - # Get a specified ManagedCluster. - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq operation' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Retrieve all Managed Clusters. - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for - client_log_configuration = '''{ - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" - }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster - try: - # Update managed cluster's log configuration - - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -11725,6 +11725,606 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + search_attribute_config = '''{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }''' # SearchAttributeConfig | + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. + try: + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. + try: + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) +- path: /segments + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#create-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + segment = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }''' # Segment | + try: + # Create Segment + new_segment = Segment.from_json(segment) + results = SegmentsApi(api_client).create_segment(segment=new_segment) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).create_segment(new_segment) + print("The response of SegmentsApi->create_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#delete-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + SegmentsApi(api_client).delete_segment(id=id) + # Below is a request that includes all optional parameters + # SegmentsApi(api_client).delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) +- path: /segments/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#get-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + results = SegmentsApi(api_client).get_segment(id=id) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) +- path: /segments + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#list-segments + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # List Segments + + results = SegmentsApi(api_client).list_segments() + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#patch-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + try: + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).patch_segment(id, new_request_body) + print("The response of SegmentsApi->patch_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # List existing Service Desk integrations + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Service Desk integration types + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get the time check configuration + + results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + try: + # Patch a Service Desk Integration + new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }''' # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + queued_check_config_details = '''{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }''' # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) + results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) - path: /sim-integrations method: POST xCodeSample: @@ -12573,842 +13173,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.export_payload import ExportPayload - from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.import_options import ImportOptions - from sailpoint.beta.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - search_attribute_config = '''{ - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - }''' # SearchAttributeConfig | - try: - # Create Extended Search Attributes - new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) - results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) - print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. - try: - # Delete Extended Search Attribute - - SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) - # Below is a request that includes all optional parameters - # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Extended Search Attributes - - results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) - print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. - try: - # Get Extended Search Attribute - - results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) - print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.json_patch_operation import JsonPatchOperation - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. - json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | - try: - # Update Extended Search Attribute - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) - print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) -- path: /segments - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#create-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - segment = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - }''' # Segment | - try: - # Create Segment - new_segment = Segment.from_json(segment) - results = SegmentsApi(api_client).create_segment(segment=new_segment) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).create_segment(new_segment) - print("The response of SegmentsApi->create_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->create_segment: %s\n" % e) -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#delete-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. - try: - # Delete Segment by ID - - SegmentsApi(api_client).delete_segment(id=id) - # Below is a request that includes all optional parameters - # SegmentsApi(api_client).delete_segment(id) - except Exception as e: - print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) -- path: /segments/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#get-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. - try: - # Get Segment by ID - - results = SegmentsApi(api_client).get_segment(id=id) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).get_segment(id) - print("The response of SegmentsApi->get_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->get_segment: %s\n" % e) -- path: /segments - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#list-segments - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Segments - - results = SegmentsApi(api_client).list_segments() - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).list_segments(limit, offset, count) - print("The response of SegmentsApi->list_segments:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->list_segments: %s\n" % e) -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#patch-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. - request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - try: - # Update Segment - new_request_body = RequestBody.from_json(request_body) - results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).patch_segment(id, new_request_body) - print("The response of SegmentsApi->patch_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create - try: - # Create new Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete - try: - # Delete a Service Desk integration - - ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get - try: - # Get a Service Desk integration - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List existing Service Desk integrations - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get - try: - # Service Desk integration template by scriptName - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Service Desk integration types - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get the time check configuration - - results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - try: - # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) - print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of the integration to update - try: - # Update a Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - queued_check_config_details = '''{ - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - }''' # QueuedCheckConfigDetails | The modified time check configuration - try: - # Update the time check configuration - new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) - results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) - print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.beta.api.source_usages_api import SourceUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.beta.api.source_usages_api import SourceUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -14823,6 +14587,242 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.beta.api.source_usages_api import SourceUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.beta.api.source_usages_api import SourceUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.export_payload import ExportPayload + from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.import_options import ImportOptions + from sailpoint.beta.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -16185,6 +16185,518 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) + connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows(limit, offset, trigger_id, connector_instance_id) + print("The response of WorkflowsApi->list_workflows:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response + from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) + print("The response of WorkflowsApi->post_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) + print("The response of WorkflowsApi->post_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#put-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.beta.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -16775,515 +17287,3 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) - connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows(limit, offset, trigger_id, connector_instance_id) - print("The response of WorkflowsApi->list_workflows:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.json_patch_operation import JsonPatchOperation - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response - from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) - print("The response of WorkflowsApi->post_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) - print("The response of WorkflowsApi->post_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#put-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.beta.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index 4d964affd..6cc408673 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -10,7 +10,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -37,7 +37,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -65,7 +65,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -93,7 +93,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -399,7 +399,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -751,7 +751,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1290,7 +1290,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id @@ -1305,36 +1305,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2024.api.account_usages_api import AccountUsagesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1407,7 +1377,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id @@ -1463,7 +1433,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -1491,7 +1461,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1550,7 +1520,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -1578,7 +1548,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1797,6 +1767,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2024.api.account_usages_api import AccountUsagesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -1885,7 +1885,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned @@ -1912,7 +1912,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1943,7 +1943,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1979,7 +1979,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -2009,7 +2009,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. @@ -2036,7 +2036,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -2063,7 +2063,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -2094,7 +2094,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2126,7 +2126,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* @@ -2157,7 +2157,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2189,7 +2189,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app @@ -2219,7 +2219,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2251,7 +2251,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2283,7 +2283,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch @@ -2312,7 +2312,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch @@ -2340,7 +2340,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2376,7 +2376,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2403,7 +2403,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2431,7 +2431,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. @@ -3625,121 +3625,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -4073,6 +3958,121 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: @@ -5973,7 +5973,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6003,7 +6003,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. @@ -6029,7 +6029,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. @@ -6081,7 +6081,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. @@ -6107,7 +6107,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. @@ -6133,7 +6133,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. @@ -6159,7 +6159,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. @@ -6186,7 +6186,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6220,7 +6220,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. @@ -6247,7 +6247,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6587,7 +6587,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -6615,7 +6615,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -6642,7 +6642,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID @@ -6669,7 +6669,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -6696,7 +6696,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -6724,7 +6724,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -6757,7 +6757,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id @@ -6790,7 +6790,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6827,7 +6827,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch @@ -6855,7 +6855,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID @@ -6888,7 +6888,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset @@ -6915,7 +6915,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7180,7 +7180,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7221,7 +7221,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -7247,7 +7247,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -7277,7 +7277,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7307,7 +7307,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -7334,7 +7334,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -7366,7 +7366,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -7398,7 +7398,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7431,7 +7431,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -7460,7 +7460,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -7490,7 +7490,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7524,7 +7524,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7558,7 +7558,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7592,7 +7592,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7620,7 +7620,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7654,7 +7654,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7680,7 +7680,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7712,7 +7712,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7744,7 +7744,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7776,7 +7776,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7811,7 +7811,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7848,7 +7848,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7880,7 +7880,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7906,7 +7906,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7933,7 +7933,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7965,7 +7965,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7998,7 +7998,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8026,7 +8026,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id @@ -8053,7 +8053,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -8085,7 +8085,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8110,7 +8110,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -8143,7 +8143,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8168,7 +8168,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. @@ -8200,7 +8200,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8245,7 +8245,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8271,7 +8271,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8304,7 +8304,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8342,7 +8342,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8399,7 +8399,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8427,7 +8427,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8456,7 +8456,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8488,7 +8488,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8517,7 +8517,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8548,7 +8548,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8577,7 +8577,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8612,7 +8612,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8646,7 +8646,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8680,7 +8680,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8708,7 +8708,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8741,7 +8741,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8774,7 +8774,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id @@ -8807,7 +8807,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8840,7 +8840,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id @@ -8867,7 +8867,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved. @@ -8894,7 +8894,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8921,7 +8921,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8953,7 +8953,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8984,7 +8984,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -9013,7 +9013,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -9042,7 +9042,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched @@ -9071,7 +9071,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -9102,7 +9102,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] @@ -9128,7 +9128,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] @@ -9156,7 +9156,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -9181,7 +9181,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -9208,7 +9208,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. @@ -9235,7 +9235,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -9263,7 +9263,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for @@ -9293,7 +9293,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9325,7 +9325,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -9350,7 +9350,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9380,7 +9380,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9411,7 +9411,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9440,7 +9440,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id @@ -9467,7 +9467,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9514,7 +9514,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -9539,7 +9539,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9566,7 +9566,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -9593,7 +9593,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9624,7 +9624,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -9673,7 +9673,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9707,7 +9707,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9742,7 +9742,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9769,7 +9769,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9803,7 +9803,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9831,7 +9831,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9864,7 +9864,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9891,7 +9891,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9923,7 +9923,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9955,7 +9955,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9985,7 +9985,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -10172,7 +10172,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10557,198 +10557,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -10761,7 +10569,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. @@ -10788,7 +10596,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10820,7 +10628,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. @@ -10848,7 +10656,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10883,7 +10691,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -10908,7 +10716,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -10935,7 +10743,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10967,7 +10775,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. @@ -11144,151 +10952,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # Get Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: @@ -11504,6 +11167,343 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#create-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_type = '''{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }''' # ManagedClusterType | + try: + # Create new Managed Cluster Type + new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) + results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) + print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#delete-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Delete a Managed Cluster Type + + ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Get a Managed Cluster Type + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) + print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-types + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) + pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) + org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + try: + # Get Managed Cluster Types + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) + print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#update-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JSONPatch payload used to update the schema. + try: + # Update a Managed Cluster Type + new_json_patch = JsonPatch.from_json(json_patch) + results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) + print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -12778,7 +12778,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12807,7 +12807,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12851,7 +12851,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12883,7 +12883,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12907,7 +12907,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | # str | @@ -12932,7 +12932,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12959,7 +12959,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status @@ -12986,7 +12986,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template @@ -13013,7 +13013,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13039,7 +13039,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13071,7 +13071,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13097,7 +13097,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13127,7 +13127,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13158,7 +13158,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13188,7 +13188,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13359,7 +13359,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13384,7 +13384,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13415,7 +13415,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13572,7 +13572,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14362,7 +14362,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14387,7 +14387,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14416,7 +14416,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14451,7 +14451,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14478,7 +14478,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14510,7 +14510,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14539,7 +14539,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14569,7 +14569,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id @@ -14596,7 +14596,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14985,7 +14985,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID. @@ -15249,1122 +15249,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a SIM integration details. - - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - try: - # List SOD policies - - results = SODPoliciesApi(api_client).list_sod_policies() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2024.api.sod_violations_api import SODViolationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2024.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2024.api.sod_violations_api import SODViolationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2024.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.export_payload import ExportPayload - from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.import_options import ImportOptions - from sailpoint.v2024.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -17282,7 +16166,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -17315,7 +16199,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. @@ -17340,7 +16224,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -17369,7 +16253,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. @@ -17397,7 +16281,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. @@ -17885,61 +16769,941 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration source: | - from sailpoint.v2024.api.source_usages_api import SourceUsagesApi + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.source_usage_status import SourceUsageStatus + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() + configuration.experimental = True with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration source: | - from sailpoint.v2024.api.source_usages_api import SourceUsagesApi + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() + configuration.experimental = True with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: - # Returns source usage insights + # Delete a SIM integration - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2024.api.sod_violations_api import SODViolationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2024.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2024.api.sod_violations_api import SODViolationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2024.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -18177,7 +17941,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id @@ -18203,7 +17967,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -18393,7 +18157,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -18472,7 +18236,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -18550,7 +18314,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -18707,7 +18471,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -18815,7 +18579,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id @@ -18972,7 +18736,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -19182,7 +18946,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -19284,7 +19048,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | The Source id # str | The Source id @@ -19471,7 +19235,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19554,6 +19318,242 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.v2024.api.source_usages_api import SourceUsagesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.v2024.api.source_usages_api import SourceUsagesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.export_payload import ExportPayload + from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.import_options import ImportOptions + from sailpoint.v2024.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -20007,7 +20007,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20034,7 +20034,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20064,7 +20064,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. @@ -20091,7 +20091,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20124,7 +20124,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. @@ -20176,7 +20176,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20203,7 +20203,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20370,7 +20370,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. @@ -20403,7 +20403,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20453,7 +20453,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID @@ -20478,7 +20478,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20510,7 +20510,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20542,7 +20542,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20575,7 +20575,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch @@ -20604,7 +20604,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20642,7 +20642,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20675,7 +20675,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID @@ -20726,7 +20726,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20753,7 +20753,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20892,615 +20892,6 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-item - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Approve an Approval Item - - results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->approve_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-items-in-bulk - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk approve Approval Items - - results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) - print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#complete-work-item - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) - try: - # Complete a Work Item - - results = WorkItemsApi(api_client).complete_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).complete_work_item(id, new_body) - print("The response of WorkItemsApi->complete_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#forward-work-item - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_item_forward import WorkItemForward - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - work_item_forward = '''{ - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - }''' # WorkItemForward | - try: - # Forward a Work Item - new_work_item_forward = WorkItemForward.from_json(work_item_forward) - WorkItemsApi(api_client).forward_work_item(id=id, x_sail_point_experimental=x_sail_point_experimental, work_item_forward=new_work_item_forward) - # Below is a request that includes all optional parameters - # WorkItemsApi(api_client).forward_work_item(id, x_sail_point_experimental, new_work_item_forward) - except Exception as e: - print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) -- path: /work-items/completed - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#get-completed-work-items - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Completed Work Items - - results = WorkItemsApi(api_client).get_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) - print("The response of WorkItemsApi->get_completed_work_items:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-completed-work-items - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Completed Work Items - - results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental, owner_id) - print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) -- path: /work-items/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-work-items - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Work Items - - results = WorkItemsApi(api_client).get_count_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_work_items(owner_id) - print("The response of WorkItemsApi->get_count_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-item - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. - try: - # Get a Work Item - - results = WorkItemsApi(api_client).get_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_item(id) - print("The response of WorkItemsApi->get_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) -- path: /work-items/summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-items-summary - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_items_summary import WorkItemsSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Work Items Summary - - results = WorkItemsApi(api_client).get_work_items_summary() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) - print("The response of WorkItemsApi->get_work_items_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) -- path: /work-items - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#list-work-items - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # List Work Items - - results = WorkItemsApi(api_client).list_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) - print("The response of WorkItemsApi->list_work_items:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-item - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Reject an Approval Item - - results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->reject_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-items-in-bulk - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk reject Approval Items - - results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) - print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-items#submit-account-selection - source: | - from sailpoint.v2024.api.work_items_api import WorkItemsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName - try: - # Submit Account Selections - new_request_body = RequestBody.from_json(request_body) - results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) - print("The response of WorkItemsApi->submit_account_selection:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) -- path: /reassignment-configurations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-reassignment#create-reassignment-configuration - source: | - from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.configuration_item_request import ConfigurationItemRequest - from sailpoint.v2024.models.configuration_item_response import ConfigurationItemResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - configuration_item_request = '''{ - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - }''' # ConfigurationItemRequest | - try: - # Create a Reassignment Configuration - new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) - results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental, new_configuration_item_request) - print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) -- path: /reassignment-configurations/{identityId}/{configType} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-reassignment#delete-reassignment-configuration - source: | - from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.config_type_enum import ConfigTypeEnum - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - config_type = sailpoint.v2024.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete Reassignment Configuration - - WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental) - except Exception as e: - print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) -- path: /reassignment-configurations/{identityId}/evaluate/{configType} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration - source: | - from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.config_type_enum import ConfigTypeEnum - from sailpoint.v2024.models.evaluate_response import EvaluateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - config_type = sailpoint.v2024.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - exclusion_filters = '''['SELF_REVIEW_DELEGATION']''' # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - try: - # Evaluate Reassignment Configuration - - results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) - print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) -- path: /reassignment-configurations/types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-config-types - source: | - from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.config_type import ConfigType - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List Reassignment Config Types - - results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) -- path: /reassignment-configurations/{identityId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-configuration - source: | - from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.configuration_response import ConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Reassignment Configuration - - results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id, x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) -- path: /reassignment-configurations/tenant-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-tenant-config-configuration - source: | - from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.tenant_configuration_response import TenantConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Tenant-wide Reassignment Configuration settings - - results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) -- path: /reassignment-configurations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-reassignment#list-reassignment-configurations - source: | - from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.configuration_response import ConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List Reassignment Configurations - - results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) - print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) -- path: /reassignment-configurations/{identityId} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-reassignment-config - source: | - from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.configuration_item_request import ConfigurationItemRequest - from sailpoint.v2024.models.configuration_item_response import ConfigurationItemResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - configuration_item_request = '''{ - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - }''' # ConfigurationItemRequest | - try: - # Update Reassignment Configuration - new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) - results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id, x_sail_point_experimental, new_configuration_item_request) - print("The response of WorkReassignmentApi->put_reassignment_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) -- path: /reassignment-configurations/tenant-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-tenant-configuration - source: | - from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.tenant_configuration_request import TenantConfigurationRequest - from sailpoint.v2024.models.tenant_configuration_response import TenantConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - tenant_configuration_request = '''{ - "configDetails" : { - "disabled" : true - } - }''' # TenantConfigurationRequest | - try: - # Update Tenant-wide Reassignment Configuration settings - new_tenant_configuration_request = TenantConfigurationRequest.from_json(tenant_configuration_request) - results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental=x_sail_point_experimental, tenant_configuration_request=new_tenant_configuration_request) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental, new_tenant_configuration_request) - print("The response of WorkReassignmentApi->put_tenant_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -22008,3 +21399,612 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-item + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Approve an Approval Item + + results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-items-in-bulk + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#complete-work-item + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) + try: + # Complete a Work Item + + results = WorkItemsApi(api_client).complete_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id, new_body) + print("The response of WorkItemsApi->complete_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#forward-work-item + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_item_forward import WorkItemForward + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + work_item_forward = '''{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }''' # WorkItemForward | + try: + # Forward a Work Item + new_work_item_forward = WorkItemForward.from_json(work_item_forward) + WorkItemsApi(api_client).forward_work_item(id=id, x_sail_point_experimental=x_sail_point_experimental, work_item_forward=new_work_item_forward) + # Below is a request that includes all optional parameters + # WorkItemsApi(api_client).forward_work_item(id, x_sail_point_experimental, new_work_item_forward) + except Exception as e: + print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-completed-work-items + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # Completed Work Items + + results = WorkItemsApi(api_client).get_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-completed-work-items + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Completed Work Items + + results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental, owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-work-items + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + results = WorkItemsApi(api_client).get_count_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-item + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + results = WorkItemsApi(api_client).get_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-items-summary + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_items_summary import WorkItemsSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + results = WorkItemsApi(api_client).get_work_items_summary() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#list-work-items + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + results = WorkItemsApi(api_client).list_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-item + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Reject an Approval Item + + results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-items-in-bulk + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#submit-account-selection + source: | + from sailpoint.v2024.api.work_items_api import WorkItemsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName + try: + # Submit Account Selections + new_request_body = RequestBody.from_json(request_body) + results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) + print("The response of WorkItemsApi->submit_account_selection:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#create-reassignment-configuration + source: | + from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.configuration_item_request import ConfigurationItemRequest + from sailpoint.v2024.models.configuration_item_response import ConfigurationItemResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + configuration_item_request = '''{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }''' # ConfigurationItemRequest | + try: + # Create a Reassignment Configuration + new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) + results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental, new_configuration_item_request) + print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#delete-reassignment-configuration + source: | + from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.config_type_enum import ConfigTypeEnum + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2024.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete Reassignment Configuration + + WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental) + except Exception as e: + print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.config_type_enum import ConfigTypeEnum + from sailpoint.v2024.models.evaluate_response import EvaluateResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2024.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + exclusion_filters = '''['SELF_REVIEW_DELEGATION']''' # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + try: + # Evaluate Reassignment Configuration + + results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) + print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-config-types + source: | + from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.config_type import ConfigType + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List Reassignment Config Types + + results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-configuration + source: | + from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.configuration_response import ConfigurationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Reassignment Configuration + + results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id, x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-tenant-config-configuration + source: | + from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.tenant_configuration_response import TenantConfigurationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Tenant-wide Reassignment Configuration settings + + results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#list-reassignment-configurations + source: | + from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.configuration_response import ConfigurationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List Reassignment Configurations + + results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) + print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-reassignment-config + source: | + from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.configuration_item_request import ConfigurationItemRequest + from sailpoint.v2024.models.configuration_item_response import ConfigurationItemResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + configuration_item_request = '''{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }''' # ConfigurationItemRequest | + try: + # Update Reassignment Configuration + new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) + results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id, x_sail_point_experimental, new_configuration_item_request) + print("The response of WorkReassignmentApi->put_reassignment_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-tenant-configuration + source: | + from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.tenant_configuration_request import TenantConfigurationRequest + from sailpoint.v2024.models.tenant_configuration_response import TenantConfigurationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + tenant_configuration_request = '''{ + "configDetails" : { + "disabled" : true + } + }''' # TenantConfigurationRequest | + try: + # Update Tenant-wide Reassignment Configuration settings + new_tenant_configuration_request = TenantConfigurationRequest.from_json(tenant_configuration_request) + results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental=x_sail_point_experimental, tenant_configuration_request=new_tenant_configuration_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental, new_tenant_configuration_request) + print("The response of WorkReassignmentApi->put_tenant_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index 971268b3c..86d8ab9b0 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -10,7 +10,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -37,7 +37,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -65,7 +65,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -93,7 +93,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -399,7 +399,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -751,7 +751,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1013,7 +1013,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1308,7 +1308,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id @@ -1323,36 +1323,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2025.api.account_usages_api import AccountUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1425,7 +1395,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id @@ -1481,7 +1451,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -1509,7 +1479,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1568,7 +1538,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -1596,7 +1566,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1815,6 +1785,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2025.api.account_usages_api import AccountUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -1903,7 +1903,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned @@ -1930,7 +1930,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1961,7 +1961,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1997,7 +1997,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -2027,7 +2027,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. @@ -2054,7 +2054,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -2081,7 +2081,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -2112,7 +2112,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2144,7 +2144,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* @@ -2175,7 +2175,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2207,7 +2207,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app @@ -2237,7 +2237,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2269,7 +2269,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2301,7 +2301,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch @@ -2330,7 +2330,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch @@ -2358,7 +2358,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2394,7 +2394,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2421,7 +2421,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2449,7 +2449,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. @@ -3643,121 +3643,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -4091,6 +3976,121 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: @@ -5991,7 +5991,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6021,7 +6021,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. @@ -6047,7 +6047,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. @@ -6099,7 +6099,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. @@ -6125,7 +6125,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. @@ -6151,7 +6151,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. @@ -6177,7 +6177,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. @@ -6204,7 +6204,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6238,7 +6238,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. @@ -6265,7 +6265,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6605,7 +6605,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -6633,7 +6633,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -6660,7 +6660,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID @@ -6687,7 +6687,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -6714,7 +6714,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -6742,7 +6742,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -6775,7 +6775,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id @@ -6808,7 +6808,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6845,7 +6845,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch @@ -6873,7 +6873,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID @@ -6906,7 +6906,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset @@ -6933,7 +6933,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7198,7 +7198,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7239,7 +7239,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -7265,7 +7265,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -7295,7 +7295,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7325,7 +7325,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -7352,7 +7352,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -7384,7 +7384,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -7416,7 +7416,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7449,7 +7449,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -7478,7 +7478,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -7508,7 +7508,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7542,7 +7542,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7576,7 +7576,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7610,7 +7610,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7638,7 +7638,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7672,7 +7672,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7698,7 +7698,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7730,7 +7730,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7762,7 +7762,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7794,7 +7794,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7829,7 +7829,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7866,7 +7866,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7898,7 +7898,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7924,7 +7924,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7951,7 +7951,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7983,7 +7983,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8016,7 +8016,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8044,7 +8044,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id @@ -8071,7 +8071,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -8103,7 +8103,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8128,7 +8128,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -8161,7 +8161,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8186,7 +8186,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. @@ -8218,7 +8218,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8263,7 +8263,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8289,7 +8289,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8322,7 +8322,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8360,7 +8360,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8417,7 +8417,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8445,7 +8445,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8474,7 +8474,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8506,7 +8506,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8535,7 +8535,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8566,7 +8566,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8595,7 +8595,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8630,7 +8630,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8664,7 +8664,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8698,7 +8698,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8726,7 +8726,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8759,7 +8759,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8792,7 +8792,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id @@ -8825,7 +8825,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8858,7 +8858,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id @@ -8885,7 +8885,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved. @@ -8912,7 +8912,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8939,7 +8939,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8971,7 +8971,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9002,7 +9002,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -9031,7 +9031,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -9060,7 +9060,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched @@ -9089,7 +9089,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -9120,7 +9120,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] @@ -9146,7 +9146,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] @@ -9174,7 +9174,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -9199,7 +9199,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -9226,7 +9226,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. @@ -9253,7 +9253,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -9281,7 +9281,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for @@ -9311,7 +9311,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9343,7 +9343,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -9368,7 +9368,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9398,7 +9398,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9429,7 +9429,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9458,7 +9458,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id @@ -9485,7 +9485,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9532,7 +9532,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -9557,7 +9557,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9584,7 +9584,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -9611,7 +9611,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9642,7 +9642,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -9691,7 +9691,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9725,7 +9725,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9760,7 +9760,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9787,7 +9787,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9821,7 +9821,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9849,7 +9849,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9882,7 +9882,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9909,7 +9909,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9941,7 +9941,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9973,7 +9973,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -10003,7 +10003,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -10190,7 +10190,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10575,198 +10575,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -10779,7 +10587,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. @@ -10806,7 +10614,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10838,7 +10646,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. @@ -10866,7 +10674,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10901,7 +10709,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -10926,7 +10734,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -10953,7 +10761,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10985,7 +10793,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. @@ -11162,151 +10970,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: @@ -11522,6 +11185,343 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_type = '''{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }''' # ManagedClusterType | + try: + # Create new Managed Cluster Type + new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) + results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) + print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Delete a Managed Cluster Type + + ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Get a Managed Cluster Type + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) + print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) + pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) + org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + try: + # List Managed Cluster Types + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) + print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JSONPatch payload used to update the schema. + try: + # Update a Managed Cluster Type + new_json_patch = JsonPatch.from_json(json_patch) + results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) + print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -12796,7 +12796,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12825,7 +12825,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12869,7 +12869,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12901,7 +12901,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12925,7 +12925,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | # str | @@ -12950,7 +12950,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12977,7 +12977,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status @@ -13004,7 +13004,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template @@ -13031,7 +13031,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13057,7 +13057,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13089,7 +13089,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13115,7 +13115,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13145,7 +13145,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13176,7 +13176,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13206,7 +13206,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13377,7 +13377,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13402,7 +13402,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13433,7 +13433,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13590,7 +13590,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14380,7 +14380,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14405,7 +14405,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14434,7 +14434,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14469,7 +14469,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14496,7 +14496,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14528,7 +14528,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14557,7 +14557,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14587,7 +14587,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id @@ -14614,7 +14614,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -15003,7 +15003,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID. @@ -15267,1122 +15267,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get a SIM integration details. - - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - try: - # List SOD policies - - results = SODPoliciesApi(api_client).list_sod_policies() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2025.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2025.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.export_payload import ExportPayload - from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.import_options import ImportOptions - from sailpoint.v2025.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -17300,7 +16184,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -17333,7 +16217,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. @@ -17358,7 +16242,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -17387,7 +16271,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. @@ -17415,7 +16299,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. @@ -17903,61 +16787,941 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage_status import SourceUsageStatus + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() + configuration.experimental = True with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() + configuration.experimental = True with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: - # Returns source usage insights + # Delete a SIM integration - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2025.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2025.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -18195,7 +17959,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id @@ -18221,7 +17985,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -18411,7 +18175,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -18490,7 +18254,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -18568,7 +18332,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -18725,7 +18489,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -18833,7 +18597,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id @@ -18990,7 +18754,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -19200,7 +18964,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -19302,7 +19066,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | The Source id # str | The Source id @@ -19489,7 +19253,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19572,6 +19336,242 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.export_payload import ExportPayload + from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.import_options import ImportOptions + from sailpoint.v2025.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -20025,7 +20025,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20052,7 +20052,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20082,7 +20082,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. @@ -20109,7 +20109,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20142,7 +20142,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. @@ -20194,7 +20194,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20221,7 +20221,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20388,7 +20388,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. @@ -20421,7 +20421,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20471,7 +20471,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID @@ -20496,7 +20496,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20528,7 +20528,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20560,7 +20560,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20593,7 +20593,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch @@ -20622,7 +20622,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20660,7 +20660,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20693,7 +20693,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID @@ -20744,7 +20744,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20771,7 +20771,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20910,615 +20910,6 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#approve-approval-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Approve an Approval Item - - results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->approve_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#approve-approval-items-in-bulk - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk approve Approval Items - - results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) - print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#complete-work-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) - try: - # Complete a Work Item - - results = WorkItemsApi(api_client).complete_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).complete_work_item(id, new_body) - print("The response of WorkItemsApi->complete_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#forward-work-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_item_forward import WorkItemForward - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - work_item_forward = '''{ - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - }''' # WorkItemForward | - try: - # Forward a Work Item - new_work_item_forward = WorkItemForward.from_json(work_item_forward) - WorkItemsApi(api_client).forward_work_item(id=id, x_sail_point_experimental=x_sail_point_experimental, work_item_forward=new_work_item_forward) - # Below is a request that includes all optional parameters - # WorkItemsApi(api_client).forward_work_item(id, x_sail_point_experimental, new_work_item_forward) - except Exception as e: - print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) -- path: /work-items/completed - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-completed-work-items - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Completed Work Items - - results = WorkItemsApi(api_client).get_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) - print("The response of WorkItemsApi->get_completed_work_items:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-count-completed-work-items - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Completed Work Items - - results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental, owner_id) - print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) -- path: /work-items/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-count-work-items - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Work Items - - results = WorkItemsApi(api_client).get_count_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_work_items(owner_id) - print("The response of WorkItemsApi->get_count_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-work-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. - try: - # Get a Work Item - - results = WorkItemsApi(api_client).get_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_item(id) - print("The response of WorkItemsApi->get_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) -- path: /work-items/summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#get-work-items-summary - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items_summary import WorkItemsSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Work Items Summary - - results = WorkItemsApi(api_client).get_work_items_summary() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) - print("The response of WorkItemsApi->get_work_items_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) -- path: /work-items - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#list-work-items - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # List Work Items - - results = WorkItemsApi(api_client).list_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) - print("The response of WorkItemsApi->list_work_items:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#reject-approval-item - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Reject an Approval Item - - results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->reject_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#reject-approval-items-in-bulk - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk reject Approval Items - - results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) - print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-items#submit-account-selection - source: | - from sailpoint.v2025.api.work_items_api import WorkItemsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName - try: - # Submit Account Selections - new_request_body = RequestBody.from_json(request_body) - results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) - print("The response of WorkItemsApi->submit_account_selection:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) -- path: /reassignment-configurations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#create-reassignment-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.configuration_item_request import ConfigurationItemRequest - from sailpoint.v2025.models.configuration_item_response import ConfigurationItemResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - configuration_item_request = '''{ - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - }''' # ConfigurationItemRequest | - try: - # Create a Reassignment Configuration - new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) - results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental, new_configuration_item_request) - print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) -- path: /reassignment-configurations/{identityId}/{configType} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#delete-reassignment-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.config_type_enum import ConfigTypeEnum - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - config_type = sailpoint.v2025.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete Reassignment Configuration - - WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental) - except Exception as e: - print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) -- path: /reassignment-configurations/{identityId}/evaluate/{configType} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-evaluate-reassignment-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.config_type_enum import ConfigTypeEnum - from sailpoint.v2025.models.evaluate_response import EvaluateResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - config_type = sailpoint.v2025.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - exclusion_filters = '''['SELF_REVIEW_DELEGATION']''' # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - try: - # Evaluate Reassignment Configuration - - results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) - print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) -- path: /reassignment-configurations/types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-reassignment-config-types - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.config_type import ConfigType - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List Reassignment Config Types - - results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) -- path: /reassignment-configurations/{identityId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-reassignment-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.configuration_response import ConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Reassignment Configuration - - results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id, x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) -- path: /reassignment-configurations/tenant-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-tenant-config-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tenant_configuration_response import TenantConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Get Tenant-wide Reassignment Configuration settings - - results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) -- path: /reassignment-configurations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#list-reassignment-configurations - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.configuration_response import ConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List Reassignment Configurations - - results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) - print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) -- path: /reassignment-configurations/{identityId} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#put-reassignment-config - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.configuration_item_request import ConfigurationItemRequest - from sailpoint.v2025.models.configuration_item_response import ConfigurationItemResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - configuration_item_request = '''{ - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - }''' # ConfigurationItemRequest | - try: - # Update Reassignment Configuration - new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) - results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id, x_sail_point_experimental, new_configuration_item_request) - print("The response of WorkReassignmentApi->put_reassignment_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) -- path: /reassignment-configurations/tenant-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/work-reassignment#put-tenant-configuration - source: | - from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.tenant_configuration_request import TenantConfigurationRequest - from sailpoint.v2025.models.tenant_configuration_response import TenantConfigurationResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = true - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - tenant_configuration_request = '''{ - "configDetails" : { - "disabled" : true - } - }''' # TenantConfigurationRequest | - try: - # Update Tenant-wide Reassignment Configuration settings - new_tenant_configuration_request = TenantConfigurationRequest.from_json(tenant_configuration_request) - results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental=x_sail_point_experimental, tenant_configuration_request=new_tenant_configuration_request) - # Below is a request that includes all optional parameters - # results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental, new_tenant_configuration_request) - print("The response of WorkReassignmentApi->put_tenant_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -22026,3 +21417,612 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#approve-approval-item + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Approve an Approval Item + + results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#approve-approval-items-in-bulk + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#complete-work-item + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) + try: + # Complete a Work Item + + results = WorkItemsApi(api_client).complete_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id, new_body) + print("The response of WorkItemsApi->complete_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#forward-work-item + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_item_forward import WorkItemForward + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + work_item_forward = '''{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }''' # WorkItemForward | + try: + # Forward a Work Item + new_work_item_forward = WorkItemForward.from_json(work_item_forward) + WorkItemsApi(api_client).forward_work_item(id=id, x_sail_point_experimental=x_sail_point_experimental, work_item_forward=new_work_item_forward) + # Below is a request that includes all optional parameters + # WorkItemsApi(api_client).forward_work_item(id, x_sail_point_experimental, new_work_item_forward) + except Exception as e: + print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#get-completed-work-items + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # Completed Work Items + + results = WorkItemsApi(api_client).get_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#get-count-completed-work-items + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Completed Work Items + + results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental, owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#get-count-work-items + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + results = WorkItemsApi(api_client).get_count_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#get-work-item + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + results = WorkItemsApi(api_client).get_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#get-work-items-summary + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items_summary import WorkItemsSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + results = WorkItemsApi(api_client).get_work_items_summary() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#list-work-items + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + results = WorkItemsApi(api_client).list_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#reject-approval-item + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Reject an Approval Item + + results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#reject-approval-items-in-bulk + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#submit-account-selection + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName + try: + # Submit Account Selections + new_request_body = RequestBody.from_json(request_body) + results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) + print("The response of WorkItemsApi->submit_account_selection:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#create-reassignment-configuration + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.configuration_item_request import ConfigurationItemRequest + from sailpoint.v2025.models.configuration_item_response import ConfigurationItemResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + configuration_item_request = '''{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }''' # ConfigurationItemRequest | + try: + # Create a Reassignment Configuration + new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) + results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental, new_configuration_item_request) + print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#delete-reassignment-configuration + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.config_type_enum import ConfigTypeEnum + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2025.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete Reassignment Configuration + + WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental) + except Exception as e: + print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.config_type_enum import ConfigTypeEnum + from sailpoint.v2025.models.evaluate_response import EvaluateResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2025.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + exclusion_filters = '''['SELF_REVIEW_DELEGATION']''' # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + try: + # Evaluate Reassignment Configuration + + results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) + print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-reassignment-config-types + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.config_type import ConfigType + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List Reassignment Config Types + + results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-reassignment-configuration + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.configuration_response import ConfigurationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Reassignment Configuration + + results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id, x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-tenant-config-configuration + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.tenant_configuration_response import TenantConfigurationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Tenant-wide Reassignment Configuration settings + + results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#list-reassignment-configurations + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.configuration_response import ConfigurationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List Reassignment Configurations + + results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) + print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#put-reassignment-config + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.configuration_item_request import ConfigurationItemRequest + from sailpoint.v2025.models.configuration_item_response import ConfigurationItemResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + configuration_item_request = '''{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }''' # ConfigurationItemRequest | + try: + # Update Reassignment Configuration + new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) + results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id, x_sail_point_experimental, new_configuration_item_request) + print("The response of WorkReassignmentApi->put_reassignment_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#put-tenant-configuration + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.tenant_configuration_request import TenantConfigurationRequest + from sailpoint.v2025.models.tenant_configuration_response import TenantConfigurationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + tenant_configuration_request = '''{ + "configDetails" : { + "disabled" : true + } + }''' # TenantConfigurationRequest | + try: + # Update Tenant-wide Reassignment Configuration settings + new_tenant_configuration_request = TenantConfigurationRequest.from_json(tenant_configuration_request) + results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental=x_sail_point_experimental, tenant_configuration_request=new_tenant_configuration_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental, new_tenant_configuration_request) + print("The response of WorkReassignmentApi->put_tenant_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index 2880bec27..8193b2bc8 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -870,36 +870,6 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v3.api.account_usages_api import AccountUsagesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1221,6 +1191,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v3.api.account_usages_api import AccountUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -2473,121 +2473,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2921,6 +2806,121 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -4249,6 +4249,357 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /managed-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.v3.models.managed_client_request import ManagedClientRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_client_request = '''{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }''' # ManagedClientRequest | + try: + # Create Managed Client + new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) + results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) + print("The response of ManagedClientsApi->create_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + ManagedClientsApi(api_client).delete_managed_client(id=id) + # Below is a request that includes all optional parameters + # ManagedClientsApi(api_client).delete_managed_client(id) + except Exception as e: + print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + results = ManagedClientsApi(api_client).get_managed_client(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client_status import ManagedClientStatus + from sailpoint.v3.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. + type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + try: + # Get Managed Client Status + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + try: + # Get Managed Clients + + results = ManagedClientsApi(api_client).get_managed_clients() + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) + print("The response of ManagedClientsApi->update_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-clusters + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_request = '''{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }''' # ManagedClusterRequest | + try: + # Create Create Managed Cluster + new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) + results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) + try: + # Delete Managed Cluster + + ManagedClustersApi(api_client).delete_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) + except Exception as e: + print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. + try: + # Get Managed Cluster Log Configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + try: + # Get Managed Clusters + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. + put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Cluster + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -4637,357 +4988,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) -- path: /managed-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.v3.models.managed_client_request import ManagedClientRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_client_request = '''{ - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - }''' # ManagedClientRequest | - try: - # Create Managed Client - new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) - results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) - print("The response of ManagedClientsApi->create_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Delete Managed Client - - ManagedClientsApi(api_client).delete_managed_client(id=id) - # Below is a request that includes all optional parameters - # ManagedClientsApi(api_client).delete_managed_client(id) - except Exception as e: - print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Get Managed Client - - results = ManagedClientsApi(api_client).get_managed_client(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client(id) - print("The response of ManagedClientsApi->get_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client_status import ManagedClientStatus - from sailpoint.v3.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. - type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. - try: - # Get Managed Client Status - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-clients - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - try: - # Get Managed Clients - - results = ManagedClientsApi(api_client).get_managed_clients() - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) - print("The response of ManagedClientsApi->get_managed_clients:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Client - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) - print("The response of ManagedClientsApi->update_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-clusters - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_request = '''{ - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - }''' # ManagedClusterRequest | - try: - # Create Create Managed Cluster - new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) - results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) - print("The response of ManagedClustersApi->create_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) - try: - # Delete Managed Cluster - - ManagedClustersApi(api_client).delete_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) - except Exception as e: - print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. - try: - # Get Managed Cluster Log Configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - try: - # Get Managed Cluster - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Get Managed Clusters - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration - from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. - put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. - try: - # Update Managed Cluster Log Configuration - new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Cluster - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) - print("The response of ManagedClustersApi->update_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -7264,646 +7264,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - try: - # List SOD policies - - results = SODPoliciesApi(api_client).list_sod_policies() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v3.api.sod_violations_api import SODViolationsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v3.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check - source: | - from sailpoint.v3.api.sod_violations_api import SODViolationsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v3.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -9367,61 +8727,646 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET +- path: /sod-policies + method: POST xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy source: | - from sailpoint.v3.api.source_usages_api import SourceUsagesApi + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.source_usage_status import SourceUsageStatus + from sailpoint.v3.models.sod_policy import SodPolicy from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy source: | - from sailpoint.v3.api.source_usages_api import SourceUsagesApi + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) try: - # Returns source usage insights + # List SOD policies - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + results = SODPoliciesApi(api_client).list_sod_policies() # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v3.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v3.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -10344,6 +10289,61 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.v3.api.source_usages_api import SourceUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.v3.api.source_usages_api import SourceUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -10847,346 +10847,6 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Approve an Approval Item - - results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->approve_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk approve Approval Items - - results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) - print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) - try: - # Complete a Work Item - - results = WorkItemsApi(api_client).complete_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).complete_work_item(id, new_body) - print("The response of WorkItemsApi->complete_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) -- path: /work-items/completed - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Completed Work Items - - results = WorkItemsApi(api_client).get_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) - print("The response of WorkItemsApi->get_completed_work_items:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Completed Work Items - - results = WorkItemsApi(api_client).get_count_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) - print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) -- path: /work-items/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Work Items - - results = WorkItemsApi(api_client).get_count_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_work_items(owner_id) - print("The response of WorkItemsApi->get_count_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. - try: - # Get a Work Item - - results = WorkItemsApi(api_client).get_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_item(id) - print("The response of WorkItemsApi->get_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) -- path: /work-items/summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_summary import WorkItemsSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Work Items Summary - - results = WorkItemsApi(api_client).get_work_items_summary() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) - print("The response of WorkItemsApi->get_work_items_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) -- path: /work-items - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # List Work Items - - results = WorkItemsApi(api_client).list_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) - print("The response of WorkItemsApi->list_work_items:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Reject an Approval Item - - results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->reject_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk reject Approval Items - - results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) - print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_item_forward import WorkItemForward - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - work_item_forward = '''{ - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - }''' # WorkItemForward | - try: - # Forward a Work Item - new_work_item_forward = WorkItemForward.from_json(work_item_forward) - WorkItemsApi(api_client).send_work_item_forward(id=id, work_item_forward=new_work_item_forward) - # Below is a request that includes all optional parameters - # WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward) - except Exception as e: - print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName - try: - # Submit Account Selections - new_request_body = RequestBody.from_json(request_body) - results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) - print("The response of WorkItemsApi->submit_account_selection:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -11699,3 +11359,343 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Approve an Approval Item + + results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) + try: + # Complete a Work Item + + results = WorkItemsApi(api_client).complete_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id, new_body) + print("The response of WorkItemsApi->complete_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # Completed Work Items + + results = WorkItemsApi(api_client).get_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Completed Work Items + + results = WorkItemsApi(api_client).get_count_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + results = WorkItemsApi(api_client).get_count_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + results = WorkItemsApi(api_client).get_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_summary import WorkItemsSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + results = WorkItemsApi(api_client).get_work_items_summary() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + results = WorkItemsApi(api_client).list_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Reject an Approval Item + + results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_item_forward import WorkItemForward + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + work_item_forward = '''{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }''' # WorkItemForward | + try: + # Forward a Work Item + new_work_item_forward = WorkItemForward.from_json(work_item_forward) + WorkItemsApi(api_client).send_work_item_forward(id=id, work_item_forward=new_work_item_forward) + # Below is a request that includes all optional parameters + # WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward) + except Exception as e: + print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName + try: + # Submit Account Selections + new_request_body = RequestBody.from_json(request_body) + results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) + print("The response of WorkItemsApi->submit_account_selection:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) From f9867c09a27ae464077204a208eb2f6e34e82ce6 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Wed, 23 Apr 2025 10:34:01 -0400 Subject: [PATCH 60/82] update go docs to fix imports --- docs/tools/sdk/go/creating-resources.md | 6 +++--- docs/tools/sdk/go/deleting-resources.md | 5 +++-- docs/tools/sdk/go/error-handling.md | 4 ++-- docs/tools/sdk/go/getting-started.md | 3 ++- docs/tools/sdk/go/pagination.md | 8 ++++---- docs/tools/sdk/go/retries.md | 3 ++- docs/tools/sdk/go/search.md | 4 ++-- docs/tools/sdk/go/updating-resources.md | 6 +++--- 8 files changed, 21 insertions(+), 18 deletions(-) diff --git a/docs/tools/sdk/go/creating-resources.md b/docs/tools/sdk/go/creating-resources.md index 869170bce..448efbc3d 100644 --- a/docs/tools/sdk/go/creating-resources.md +++ b/docs/tools/sdk/go/creating-resources.md @@ -23,7 +23,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" - "github.com/sailpoint-oss/golang-sdk/beta" + beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta" ) func main() { @@ -32,7 +32,7 @@ func main() { configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) - resp, _, err := apiClient.V3.PublicIdentitiesApi.GetPublicIdentities(ctx).Limit(1).Execute() + resp, _, err := apiClient.V3.PublicIdentitiesAPI.GetPublicIdentities(ctx).Limit(1).Execute() identity := "IDENTITY" workgroupName := "DB Access Governance Group" @@ -48,7 +48,7 @@ func main() { }, } - newWorkgroup, request, errMessage := apiClient.Beta.GovernanceGroupsApi.CreateWorkgroup(ctx).WorkgroupDto(workgroup).Execute() + newWorkgroup, request, errMessage := apiClient.Beta.GovernanceGroupsAPI.CreateWorkgroup(ctx).WorkgroupDto(workgroup).Execute() if errMessage != nil { fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsApi.CreateWorkgroup``: %v\n", err) diff --git a/docs/tools/sdk/go/deleting-resources.md b/docs/tools/sdk/go/deleting-resources.md index f789238de..d38e4e68a 100644 --- a/docs/tools/sdk/go/deleting-resources.md +++ b/docs/tools/sdk/go/deleting-resources.md @@ -22,6 +22,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" + beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta" ) func main() { @@ -30,14 +31,14 @@ func main() { configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) - workgroup, r, err := apiClient.Beta.GovernanceGroupsApi.ListWorkgroups(ctx).Filters(`name eq "DB Access Governance Group"`).Execute() + workgroup, r, err := apiClient.Beta.GovernanceGroupsAPI.ListWorkgroups(ctx).Filters(`name eq "DB Access Governance Group"`).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when retrieving workgroup`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - response, errorMessage := apiClient.Beta.GovernanceGroupsApi.DeleteWorkgroup(ctx, *workgroup[0].Id).Execute() + response, errorMessage := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroup(ctx, *workgroup[0].Id).Execute() if errorMessage != nil { fmt.Fprintf(os.Stderr, "Error when updating workgroup`: %v\n", errorMessage) diff --git a/docs/tools/sdk/go/error-handling.md b/docs/tools/sdk/go/error-handling.md index a57cc1d2b..2a9827afc 100644 --- a/docs/tools/sdk/go/error-handling.md +++ b/docs/tools/sdk/go/error-handling.md @@ -16,7 +16,7 @@ The SDK returns the response object, request and error object for each method. T You can use an `if` statement to check whether there are any errors with the request and take actions on the results, such as logging the message or performing additional actions before exiting the program: ```go -resp, r, err := apiClient.V3.TransformsApi.ListTransforms(ctx).Filters("This is an incorrect string").Execute() +resp, r, err := apiClient.V3.TransformsAPI.ListTransforms(ctx).Filters("This is an incorrect string").Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TransformsApi.ListTransforms``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -26,7 +26,7 @@ if err != nil { The program will continue running unless you specify to end it. Use `os.Exit(0)` within the error check to stop execution after an error is found. ```go -resp, r, err := apiClient.V3.TransformsApi.ListTransforms(ctx).Filters("This is an incorrect string").Execute() +resp, r, err := apiClient.V3.TransformsAPI.ListTransforms(ctx).Filters("This is an incorrect string").Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TransformsApi.ListTransforms``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) diff --git a/docs/tools/sdk/go/getting-started.md b/docs/tools/sdk/go/getting-started.md index 2756c1c25..6941d7d19 100644 --- a/docs/tools/sdk/go/getting-started.md +++ b/docs/tools/sdk/go/getting-started.md @@ -26,6 +26,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" ) func main() { @@ -34,7 +35,7 @@ func main() { configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) - resp, r, err := apiClient.V3.TransformsApi.ListTransforms(ctx).Execute() + resp, r, err := apiClient.V3.TransformsAPI.ListTransforms(ctx).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TransformsApi.ListTransforms``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) diff --git a/docs/tools/sdk/go/pagination.md b/docs/tools/sdk/go/pagination.md index 42bfbd361..f39c9b48d 100644 --- a/docs/tools/sdk/go/pagination.md +++ b/docs/tools/sdk/go/pagination.md @@ -24,7 +24,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" - v3 "github.com/sailpoint-oss/golang-sdk/v3" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" ) func main() { @@ -33,7 +33,7 @@ func main() { configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) - resp, r, err := sailpoint.PaginateWithDefaults[v3.Account](apiClient.V3.AccountsApi.ListAccounts(ctx)) + resp, r, err := sailpoint.PaginateWithDefaults[v3.Account](apiClient.V3.AccountsAPI.ListAccounts(ctx)) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `PaginateWithDefaults[v3.Account]``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -56,7 +56,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" - v3 "github.com/sailpoint-oss/golang-sdk/v3" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" ) func main() { @@ -65,7 +65,7 @@ func main() { configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) - resp, r, err := sailpoint.Paginate[v3.Account](apiClient.V3.AccountsApi.ListAccounts(ctx), 0, 250, 150000) + resp, r, err := sailpoint.Paginate[v3.Account](apiClient.V3.AccountsAPI.ListAccounts(ctx), 0, 250, 150000) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `Paginate[v3.Account]``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) diff --git a/docs/tools/sdk/go/retries.md b/docs/tools/sdk/go/retries.md index c7f24c0ad..ac978948d 100644 --- a/docs/tools/sdk/go/retries.md +++ b/docs/tools/sdk/go/retries.md @@ -24,6 +24,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" ) func main() { @@ -35,7 +36,7 @@ func main() { configuration.HTTPClient.RetryMax = 10 configuration.HTTPClient.RetryWaitMax = time.Second * 2 - resp, r, err := apiClient.V3.TransformsApi.ListTransforms(ctx).Filters("This is an incorrect string").Execute() + resp, r, err := apiClient.V3.TransformsAPI.ListTransforms(ctx).Filters("This is an incorrect string").Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TransformsApi.ListTransforms``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) diff --git a/docs/tools/sdk/go/search.md b/docs/tools/sdk/go/search.md index 90c12558f..4d82eb48d 100644 --- a/docs/tools/sdk/go/search.md +++ b/docs/tools/sdk/go/search.md @@ -31,7 +31,7 @@ func getSearchResults(ctx context.Context, apiClient *sailpoint.APIClient) { } `) search.UnmarshalJSON(searchString) - resp, r, err := sailpoint.PaginateSearchApi(ctx, apiClient, *search, 0, 10, 10000) + resp, r, err := sailpoint.PaginateSearchAPI(ctx, apiClient, *search, 0, 10, 10000) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `PaginateSearchApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -80,7 +80,7 @@ In this example, the `"identities"` string represents an unmarshalled JSON. Chan The search example includes the syntax you can use to paginate search results. Edit this line to configure the search result pagination: ```go -resp, r, err := sailpoint.PaginateSearchApi(ctx, apiClient, *search, 0, 10, 10000) +resp, r, err := sailpoint.PaginateSearchAPI(ctx, apiClient, *search, 0, 10, 10000) ``` The first value refers to the `initialOffset`, the starting number for the results, the second refers to the `increment`, the number of records per page, and the third refers to the `limit`, the last record that can be returned. diff --git a/docs/tools/sdk/go/updating-resources.md b/docs/tools/sdk/go/updating-resources.md index 5fc4530d7..d92397785 100644 --- a/docs/tools/sdk/go/updating-resources.md +++ b/docs/tools/sdk/go/updating-resources.md @@ -23,7 +23,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" - "github.com/sailpoint-oss/golang-sdk/beta" + beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta" ) func main() { @@ -32,7 +32,7 @@ func main() { configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) - workgroup, r, err := apiClient.Beta.GovernanceGroupsApi.ListWorkgroups(ctx).Filters(`name eq "DB Access Governance Group"`).Execute() + workgroup, r, err := apiClient.Beta.GovernanceGroupsAPI.ListWorkgroups(ctx).Filters(`name eq "DB Access Governance Group"`).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when retrieving workgroup`: %v\n", err) @@ -43,7 +43,7 @@ func main() { newDescriptionValue := beta.JsonPatchOperationValue{String: &updatedDescription} patchArray := []beta.JsonPatchOperation{{Op: "replace", Path: "/description", Value: &newDescriptionValue}} - updatedWorkgroup, request, errorMessage := apiClient.Beta.GovernanceGroupsApi.PatchWorkgroup(ctx, *workgroup[0].Id).JsonPatchOperation(patchArray).Execute() + updatedWorkgroup, request, errorMessage := apiClient.Beta.GovernanceGroupsAPI.PatchWorkgroup(ctx, *workgroup[0].Id).JsonPatchOperation(patchArray).Execute() if errorMessage != nil { fmt.Fprintf(os.Stderr, "Error when updating workgroup`: %v\n", errorMessage) From cf6a544a01344ddc3ccbb82bb5038a28e6802675 Mon Sep 17 00:00:00 2001 From: Philip Ellis Date: Wed, 23 Apr 2025 10:39:37 -0400 Subject: [PATCH 61/82] added new schema to entitlement docs --- .../connector-commands/entitlement-list.md | 17 +++++++++++++++-- .../connector-commands/entitlement-read.md | 13 +++++++++++-- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md b/docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md index c663e60d3..ab723d290 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md +++ b/docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md @@ -18,7 +18,15 @@ tags: ['Connectivity', 'Connector Command'] ```javascript { - "type": "group" + "type": "group", + "stateful": "true", + "state": { + "date": "4/23/2024" + }, + "schema": { + "type": "string", + "includePermissions": true + } } ``` @@ -33,10 +41,15 @@ tags: ['Connectivity', 'Connector Command'] } }, "type": "group", + "deleted": false, "attributes": { "id": "administrator", "name": "Administrator" - } + }, + "permissions": [ + "target": "SYSADMIN", + "rights": "useAccounts,retrieveAccounts" + ] } ``` diff --git a/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md b/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md index a42bbe969..7fd88c461 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md +++ b/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md @@ -32,7 +32,11 @@ To use this command, you must specify this value in the `commands` array: `std:e "id": "john.doe" } }, - "type": "group" + "type": "group", + "schema": { + "type": "string", + "includePermissions": true + } } ``` @@ -47,10 +51,15 @@ To use this command, you must specify this value in the `commands` array: `std:e } }, "type": "group", + "deleted": false, "attributes": { "id": "administrator", "name": "Administrator" - } + }, + "permissions": [ + "target": "SYSADMIN", + "rights": "useAccounts,retrieveAccounts" + ] } ``` From 1baa42b58afe997c8a549b17ccd7474c845f865d Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Wed, 23 Apr 2025 16:48:24 +0000 Subject: [PATCH 62/82] Automated commit by github action: 14623568323 --- .../idn/v3/paths/access-profiles.yaml | 6 +-- static/api-specs/idn/v3/paths/role.yaml | 48 +++++++++---------- static/api-specs/idn/v3/paths/roles.yaml | 7 ++- .../paths/workflows/workflow-execution.yaml | 5 +- .../idn/v3/schemas/access/AccessProfile.yaml | 32 ++++++------- .../access/AccessProfileApprovalScheme.yaml | 4 +- .../access/AccessProfileSourceRef.yaml | 6 +-- .../idn/v3/schemas/access/OwnerReference.yaml | 6 +-- .../access/ProvisioningCriteriaLevel1.yaml | 14 +++--- .../access/ProvisioningCriteriaLevel2.yaml | 14 +++--- .../access/ProvisioningCriteriaLevel3.yaml | 18 +++---- .../access/ProvisioningCriteriaOperation.yaml | 2 +- .../idn/v3/schemas/access/Requestability.yaml | 12 +++-- .../schemas/access/RequestabilityForRole.yaml | 6 +++ .../idn/v3/schemas/access/Revocability.yaml | 2 +- .../schemas/workflows/WorkflowExecution.yaml | 1 + 16 files changed, 101 insertions(+), 82 deletions(-) diff --git a/static/api-specs/idn/v3/paths/access-profiles.yaml b/static/api-specs/idn/v3/paths/access-profiles.yaml index c4001dca6..6bbad4262 100644 --- a/static/api-specs/idn/v3/paths/access-profiles.yaml +++ b/static/api-specs/idn/v3/paths/access-profiles.yaml @@ -41,7 +41,7 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* @@ -131,7 +131,7 @@ post: description: >- Create an access profile. - A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the + A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. @@ -162,7 +162,7 @@ post: $ref: '../../v3/responses/500.yaml' security: - userAuth: [idn:access-profile:manage] - - applicationAuth: [idn:access-profile:manage] + - applicationAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] x-sailpoint-userLevels: - ORG_ADMIN - ROLE_ADMIN diff --git a/static/api-specs/idn/v3/paths/role.yaml b/static/api-specs/idn/v3/paths/role.yaml index cc70f27a9..616acc602 100644 --- a/static/api-specs/idn/v3/paths/role.yaml +++ b/static/api-specs/idn/v3/paths/role.yaml @@ -2,12 +2,12 @@ get: operationId: getRole tags: - Roles - summary: Get a Role + summary: Get Role description: >- - This API returns a Role by its ID. + Get a role by ID. - A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated - to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated + to sources with management workgroups of the ROLE_SUBADMIN is a member of. parameters: - in: path name: id @@ -16,11 +16,11 @@ get: schema: type: string description: >- - ID of the Role + Role ID. example: 2c91808a7813090a017814121e121518 responses: '200': - description: List of all Roles + description: List of all roles content: application/json: schema: @@ -45,9 +45,9 @@ patch: operationId: patchRole tags: - Roles - summary: Patch a specified Role + summary: Patch Role description: >- - This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: @@ -77,18 +77,18 @@ patch: A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated - to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + to sources with management workgroups of the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. - Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. parameters: - name: id in: path - description: ID of the Role to patch + description: Role ID to patch required: true x-sailpoint-resource-operation-id: listRoles schema: @@ -120,8 +120,8 @@ patch: Assign a Role to a Segment: description: >- - This example illustrates the use of patch to assign a Role to a Segment by adding the Segment's ID to the - Role's segments array. + This example illustrates the use of patch to assign a role to a segment by adding the segment's ID to the + role's segments array. value: [ { @@ -133,7 +133,7 @@ patch: Set the Membership Selection Criteria to a List of Identities: description: >- - This example shows how to define a Role's membershp by providing a list of Identities, referenced by their + This example shows how to define a role's membershp by providing a list of identities, referenced by their IDs. value: [ @@ -156,8 +156,8 @@ patch: Set the Membership Selection Criteria to a Standard Expression: description: >- - This example shows how to define a Role's membership using STANDARD criteria. In this case, the Role - will be granted to all Identities which have the *Engineering* attribute from the indicated Source. + This example shows how to define a role's membership, using `STANDARD` criteria. In this case, ISC will grant the role + to all identities that have the *Engineering* attribute from the indicated source. value: [ { @@ -185,7 +185,7 @@ patch: Add a New Clause as the Child of an Existing Standard Expression: description: >- - This example shows how to add a child clause to an existing STANDARD criteria expression. + This example shows how to add a child clause to an existing `STANDARD` criteria expression. value: [ { @@ -203,7 +203,7 @@ patch: ] Assign a Access Model Metadata to a Role: - description: This example shows how to assign a existing metadata to a role. + description: This example shows how to assign existing metadata to a role. value: [ { @@ -250,7 +250,7 @@ patch: required: true responses: '200': - description: Responds with the Role as updated. + description: Response with the updated role. content: application/json: schema: @@ -275,13 +275,13 @@ delete: operationId: deleteRole tags: - Roles - summary: Delete a Role + summary: Delete Role description: >- - This API deletes a Role by its ID. + Delete a role by ID. - A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated - to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated + to sources with management workgroups the ROLE_SUBADMIN is a member of. parameters: - in: path name: id @@ -290,7 +290,7 @@ delete: schema: type: string description: >- - ID of the Role + Role ID. example: 2c91808a7813090a017814121e121518 responses: '204': diff --git a/static/api-specs/idn/v3/paths/roles.yaml b/static/api-specs/idn/v3/paths/roles.yaml index 3167d2be0..5475e9c7b 100644 --- a/static/api-specs/idn/v3/paths/roles.yaml +++ b/static/api-specs/idn/v3/paths/roles.yaml @@ -38,16 +38,19 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* - **modified**: *gt, lt, ge, le* + **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + + + **dimensional**: *eq* example: requestable eq false required: false - in: query diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-execution.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-execution.yaml index c8bd7fbd5..cdc994341 100644 --- a/static/api-specs/idn/v3/paths/workflows/workflow-execution.yaml +++ b/static/api-specs/idn/v3/paths/workflows/workflow-execution.yaml @@ -4,13 +4,16 @@ get: - Workflows summary: Get Workflow Execution description: >- - Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + x-sailpoint-userLevels: + - ORG_ADMIN security: - userAuth: [sp:workflow:read] parameters: - name: id in: path description: Workflow execution ID. + x-sailpoint-resource-operation-id: listWorkflows required: true style: simple explode: false diff --git a/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml b/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml index 9be2b29d0..46c444239 100644 --- a/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml +++ b/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml @@ -1,71 +1,71 @@ type: object -description: Access Profile +description: Access profile. properties: id: type: string - description: The ID of the Access Profile + description: Access profile ID. example: 2c91808a7190d06e01719938fcd20792 readOnly: true name: type: string - description: Name of the Access Profile + description: Access profile name. example: Employee-database-read-write description: type: string nullable: true - description: Information about the Access Profile + description: Access profile description. example: Collection of entitlements to read/write the employee database created: type: string - description: Date the Access Profile was created + description: Date and time when the access profile was created. format: 'date-time' example: '2021-03-01T22:32:58.104Z' readOnly: true modified: type: string - description: Date the Access Profile was last modified. + description: Date and time when the access profile was last modified. format: 'date-time' example: '2021-03-02T20:22:28.104Z' readOnly: true enabled: type: boolean default: false - description: Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. + description: Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. example: true owner: $ref: './OwnerReference.yaml' - description: Owner of the Access Profile + description: Access profile owner. source: $ref: './AccessProfileSourceRef.yaml' entitlements: type: array nullable: true - description: A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + description: List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. items: $ref: './EntitlementRef.yaml' requestable: type: boolean default: true description: >- - Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported - for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value + Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported + for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. example: true accessRequestConfig: $ref: './Requestability.yaml' nullable: true - description: Access request configuration for this object + description: Access request configuration for the object. revocationRequestConfig: $ref: './Revocability.yaml' nullable: true description: >- - Revocation request configuration for this object. + Revocation request configuration for the object. segments: type: array nullable: true items: type: string - description: List of IDs of segments, if any, to which this Access Profile is assigned. + description: List of segment IDs, if any, that the access profile is assigned to. example: [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" @@ -73,8 +73,8 @@ properties: provisioningCriteria: $ref: './ProvisioningCriteriaLevel1.yaml' description: >- - When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression - is evaluated against those Accounts to choose one to provision with the Access Profile. + When an identity has multiple accounts on the source the access profile is associated with, the API evaluates this expression + against those accounts to choose one to provision with the access profile. nullable: true example: { "operation": "OR", diff --git a/static/api-specs/idn/v3/schemas/access/AccessProfileApprovalScheme.yaml b/static/api-specs/idn/v3/schemas/access/AccessProfileApprovalScheme.yaml index 9691e9a96..64849c3e9 100644 --- a/static/api-specs/idn/v3/schemas/access/AccessProfileApprovalScheme.yaml +++ b/static/api-specs/idn/v3/schemas/access/AccessProfileApprovalScheme.yaml @@ -9,7 +9,7 @@ properties: - MANAGER - GOVERNANCE_GROUP description: >- - Describes the individual or group that is responsible for an approval step. Values are as follows. + Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application @@ -29,7 +29,7 @@ properties: approverId: type: string nullable: true - description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP + description: Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. example: 46c79819-a69f-49a2-becb-12c971ae66c6 diff --git a/static/api-specs/idn/v3/schemas/access/AccessProfileSourceRef.yaml b/static/api-specs/idn/v3/schemas/access/AccessProfileSourceRef.yaml index 7de02a342..dd0866bb7 100644 --- a/static/api-specs/idn/v3/schemas/access/AccessProfileSourceRef.yaml +++ b/static/api-specs/idn/v3/schemas/access/AccessProfileSourceRef.yaml @@ -2,15 +2,15 @@ type: object properties: id: type: string - description: The ID of the Source with with which the Access Profile is associated + description: ID of the source the access profile is associated with. example: 2c91809773dee3610173fdb0b6061ef4 type: type: string enum: - SOURCE - description: The type of the Source, will always be SOURCE + description: Source's DTO type. example: SOURCE name: type: string - description: The display name of the associated Source + description: Source name. example: "ODS-AD-SOURCE" diff --git a/static/api-specs/idn/v3/schemas/access/OwnerReference.yaml b/static/api-specs/idn/v3/schemas/access/OwnerReference.yaml index eed01a878..32b171536 100644 --- a/static/api-specs/idn/v3/schemas/access/OwnerReference.yaml +++ b/static/api-specs/idn/v3/schemas/access/OwnerReference.yaml @@ -1,6 +1,6 @@ type: object nullable: false -description: The owner of this object. +description: Owner of the object. properties: type: type: string @@ -10,9 +10,9 @@ properties: example: 'IDENTITY' id: type: string - description: Identity id + description: Owner's identity ID. example: '2c9180a46faadee4016fb4e018c20639' name: type: string - description: Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. + description: Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. example: 'support' diff --git a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel1.yaml b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel1.yaml index 7a5c05e2b..27b78a08c 100644 --- a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel1.yaml +++ b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel1.yaml @@ -1,23 +1,23 @@ type: object nullable: true -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: array @@ -25,7 +25,7 @@ properties: $ref: './ProvisioningCriteriaLevel2.yaml' nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null diff --git a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel2.yaml b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel2.yaml index 02f0a3730..063b605ff 100644 --- a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel2.yaml +++ b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel2.yaml @@ -1,22 +1,22 @@ type: object -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: array @@ -24,7 +24,7 @@ properties: $ref: './ProvisioningCriteriaLevel3.yaml' nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null diff --git a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel3.yaml b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel3.yaml index 97dd2b61d..8ab352c4d 100644 --- a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel3.yaml +++ b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel3.yaml @@ -1,28 +1,28 @@ type: object -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string + nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: string + nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null - nullable: true - diff --git a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaOperation.yaml b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaOperation.yaml index 45cd8346e..5ebc9c606 100644 --- a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaOperation.yaml +++ b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaOperation.yaml @@ -6,6 +6,6 @@ enum: - HAS - AND - OR -description: Supported operations on ProvisioningCriteria +description: Supported operations on `ProvisioningCriteria`. example: EQUALS diff --git a/static/api-specs/idn/v3/schemas/access/Requestability.yaml b/static/api-specs/idn/v3/schemas/access/Requestability.yaml index 48091512e..81796c57c 100644 --- a/static/api-specs/idn/v3/schemas/access/Requestability.yaml +++ b/static/api-specs/idn/v3/schemas/access/Requestability.yaml @@ -3,20 +3,26 @@ nullable : true properties: commentsRequired: type: boolean - description: Whether the requester of the containing object must provide comments justifying the request + description: Indicates whether the requester of the containing object must provide comments justifying the request. example: true nullable: true default: false denialCommentsRequired: type: boolean - description: Whether an approver must provide comments when denying the request + description: Indicates whether an approver must provide comments when denying the request. + example: true + nullable: true + default: false + reauthorizationRequired: + type: boolean + description: Indicates whether reauthorization is required for the request. example: true nullable: true default: false approvalSchemes: type: array nullable : true - description: List describing the steps in approving the request + description: List describing the steps involved in approving the request. items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v3/schemas/access/RequestabilityForRole.yaml b/static/api-specs/idn/v3/schemas/access/RequestabilityForRole.yaml index 5e26e325b..4b0e9d5cf 100644 --- a/static/api-specs/idn/v3/schemas/access/RequestabilityForRole.yaml +++ b/static/api-specs/idn/v3/schemas/access/RequestabilityForRole.yaml @@ -12,6 +12,12 @@ properties: example: true nullable: true default: false + reauthorizationRequired: + type: boolean + description: Indicates whether reauthorization is required for the request. + example: true + nullable: true + default: false approvalSchemes: type: array description: List describing the steps in approving the request diff --git a/static/api-specs/idn/v3/schemas/access/Revocability.yaml b/static/api-specs/idn/v3/schemas/access/Revocability.yaml index 505d191b1..657e27745 100644 --- a/static/api-specs/idn/v3/schemas/access/Revocability.yaml +++ b/static/api-specs/idn/v3/schemas/access/Revocability.yaml @@ -4,7 +4,7 @@ properties: approvalSchemes: type: array nullable: true - description: List describing the steps in approving the revocation request + description: List describing the steps involved in approving the revocation request. items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v3/schemas/workflows/WorkflowExecution.yaml b/static/api-specs/idn/v3/schemas/workflows/WorkflowExecution.yaml index aae416a11..a928a7894 100644 --- a/static/api-specs/idn/v3/schemas/workflows/WorkflowExecution.yaml +++ b/static/api-specs/idn/v3/schemas/workflows/WorkflowExecution.yaml @@ -29,5 +29,6 @@ properties: - "Completed" - "Failed" - "Canceled" + - "Queued" - "Running" example: "Completed" From e25d7361eb0b797d712bfd621d39737b478c887e Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 23 Apr 2025 16:48:54 +0000 Subject: [PATCH 63/82] Update to python SDK docs: 14623604263 --- .../Beta/Methods/AccessProfilesApi.md | 1 + .../python/Reference/Beta/Methods/RolesApi.md | 1 + .../Reference/Beta/Models/AccessProfile.md | 21 +- .../Models/AccessProfileApprovalScheme.md | 4 +- .../Beta/Models/AccessProfileSourceRef.md | 6 +- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/Beta/Models/OwnerReference.md | 6 +- .../Beta/Models/ProvisioningCriteriaLevel1.md | 8 +- .../Beta/Models/ProvisioningCriteriaLevel2.md | 8 +- .../Beta/Models/ProvisioningCriteriaLevel3.md | 8 +- .../Models/ProvisioningCriteriaOperation.md | 2 +- .../Reference/Beta/Models/Requestability.md | 8 +- .../Beta/Models/RequestabilityForRole.md | 2 + .../Reference/Beta/Models/Revocability.md | 2 +- .../sdk/python/Reference/Beta/Models/Role.md | 1 + .../Reference/Beta/Models/SourceUsage.md | 2 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../Reference/V2025/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2025/Models/SourceUsage.md | 2 +- .../Reference/V3/Methods/AccessProfilesApi.md | 7 +- .../python/Reference/V3/Methods/RolesApi.md | 53 +- .../Reference/V3/Methods/WorkflowsApi.md | 2 +- .../Reference/V3/Models/AccessProfile.md | 21 +- .../V3/Models/AccessProfileApprovalScheme.md | 4 +- .../V3/Models/AccessProfileSourceRef.md | 6 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V3/Models/OwnerReference.md | 6 +- .../V3/Models/ProvisioningCriteriaLevel1.md | 8 +- .../V3/Models/ProvisioningCriteriaLevel2.md | 8 +- .../V3/Models/ProvisioningCriteriaLevel3.md | 8 +- .../Models/ProvisioningCriteriaOperation.md | 2 +- .../Reference/V3/Models/Requestability.md | 8 +- .../V3/Models/RequestabilityForRole.md | 2 + .../Reference/V3/Models/Revocability.md | 2 +- .../sdk/python/Reference/V3/Models/Role.md | 1 + .../python/Reference/V3/Models/SourceUsage.md | 2 +- .../Reference/V3/Models/WorkflowExecution.md | 2 +- .../beta/python_code_examples_overlay.yaml | 3138 ++++++------ .../v2024/python_code_examples_overlay.yaml | 4252 ++++++++--------- .../v2025/python_code_examples_overlay.yaml | 4252 ++++++++--------- .../v3/python_code_examples_overlay.yaml | 3012 ++++++------ 46 files changed, 7462 insertions(+), 7442 deletions(-) diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md index 832d4965e..d82c6288f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md @@ -136,6 +136,7 @@ with ApiClient(configuration) as api_client: "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md index 2daaf8666..fecd90d83 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md @@ -227,6 +227,7 @@ with ApiClient(configuration) as api_client: }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md index 89888049c..00cd77db8 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md @@ -11,25 +11,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'BetaAccessProfile'] # AccessProfile -Access Profile +Access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Access Profile | [optional] [readonly] -**name** | **str** | Name of the Access Profile | [required] -**description** | **str** | Information about the Access Profile | [optional] -**created** | **datetime** | Date the Access Profile was created | [optional] [readonly] -**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly] -**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to False] +**id** | **str** | Access profile ID. | [optional] [readonly] +**name** | **str** | Access profile name. | [required] +**description** | **str** | Access profile description. | [optional] +**created** | **datetime** | Date and time when the access profile was created. | [optional] [readonly] +**modified** | **datetime** | Date and time when the access profile was last modified. | [optional] [readonly] +**enabled** | **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to False] **owner** | [**OwnerReference**](owner-reference) | | [required] **source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**requestable** | **bool** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to True] **access_request_config** | [**Requestability**](requestability) | | [optional] **revocation_request_config** | [**Revocability**](revocability) | | [optional] -**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**segments** | **[]str** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] } @@ -63,6 +63,7 @@ requestable=True, access_request_config=sailpoint.beta.models.requestability.Requestability( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.beta.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileApprovalScheme.md index 3e7d081df..0490e74b2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'BetaAc Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**approver_id** | **str** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md index 02afdf188..b27679d3f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'BetaAccessP Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional] -**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional] -**name** | **str** | The display name of the associated Source | [optional] +**id** | **str** | ID of the source the access profile is associated with. | [optional] +**type** | **Enum** [ 'SOURCE' ] | Source's DTO type. | [optional] +**name** | **str** | Source name. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md index 6d30198f2..dced03305 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index e0b91fdea..bffe6c49e 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OwnerReference.md b/docs/tools/sdk/python/Reference/Beta/Models/OwnerReference.md index b1a989e36..8fdf9e895 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/OwnerReference.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/OwnerReference.md @@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'BetaOwnerReference' # OwnerReference -The owner of this object. +Owner of the object. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**id** | **str** | Identity id | [optional] -**name** | **str** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel1.md index a106efe63..9aaff6283 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel1.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'BetaPro # ProvisioningCriteriaLevel1 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel2.md index 643f0537d..bcc4246cc 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel2.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'BetaPro # ProvisioningCriteriaLevel2 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel3.md index cb802348e..fe764576f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel3.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'BetaPro # ProvisioningCriteriaLevel3 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | **str** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | **str** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaOperation.md index 157e25264..26872b35f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaOperation.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaOperation.md @@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'Beta # ProvisioningCriteriaOperation -Supported operations on ProvisioningCriteria +Supported operations on `ProvisioningCriteria`. ## Enum diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Requestability.md b/docs/tools/sdk/python/Reference/Beta/Models/Requestability.md index 445144075..e5ae72c59 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/Requestability.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'BetaRequestability' Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] -**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**comments_required** | **bool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to False] +**denial_comments_required** | **bool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] } ## Example @@ -29,6 +30,7 @@ from sailpoint.beta.models.requestability import Requestability requestability = Requestability( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.beta.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestabilityForRole.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestabilityForRole.md index 6c3e1c781..22792e5e7 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] **denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] **approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] } @@ -29,6 +30,7 @@ from sailpoint.beta.models.requestability_for_role import RequestabilityForRole requestability_for_role = RequestabilityForRole( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.beta.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Revocability.md b/docs/tools/sdk/python/Reference/Beta/Models/Revocability.md index fa768f1b8..d88c10ffa 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/Revocability.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'BetaRevocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Role.md b/docs/tools/sdk/python/Reference/Beta/Models/Role.md index cc5132cea..b7a1db5fc 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/Role.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/Role.md @@ -89,6 +89,7 @@ requestable=True, access_request_config=sailpoint.beta.models.requestability_for_role.RequestabilityForRole( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.beta.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md index 72badf0ff..fbcbd7a29 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md index 442faa748..5353898b1 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index a37f38fea..db5a37930 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md index ea8523f54..c57393c0d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md index 8403e7986..626e62e2b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 960d4b101..33437e264 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md index 3f731dad1..3091b3a26 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md index 19199e33c..41910079d 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md @@ -61,7 +61,7 @@ Method | HTTP request | Description ## create-access-profile Create Access Profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-profile) @@ -135,6 +135,7 @@ with ApiClient(configuration) as api_client: "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -472,7 +473,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -509,7 +510,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) diff --git a/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md index f54a23bc0..f8a1042e4 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md @@ -54,11 +54,11 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create-role**](#create-role) | **POST** `/roles` | Create a Role [**delete-bulk-roles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) -[**delete-role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role -[**get-role**](#get-role) | **GET** `/roles/{id}` | Get a Role +[**delete-role**](#delete-role) | **DELETE** `/roles/{id}` | Delete Role +[**get-role**](#get-role) | **GET** `/roles/{id}` | Get Role [**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role [**list-roles**](#list-roles) | **GET** `/roles` | List Roles -[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role +[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch Role ## create-role @@ -223,6 +223,7 @@ with ApiClient(configuration) as api_client: }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -344,10 +345,10 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## delete-role -Delete a Role -This API deletes a Role by its ID. +Delete Role +Delete a role by ID. -A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-role) @@ -355,7 +356,7 @@ A user with ROLE_SUBADMIN authority may only call this API if all Access Profile Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | id | **str** | True | ID of the Role +Path | id | **str** | True | Role ID. ### Return type (empty response body) @@ -384,10 +385,10 @@ configuration = Configuration() with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + id = '2c91808a7813090a017814121e121518' # str | Role ID. # str | Role ID. try: - # Delete a Role + # Delete Role RolesApi(api_client).delete_role(id=id) # Below is a request that includes all optional parameters @@ -401,9 +402,9 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## get-role -Get a Role -This API returns a Role by its ID. -A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +Get Role +Get a role by ID. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-role) @@ -411,7 +412,7 @@ A user with ROLE_SUBADMIN authority may only call this API if all Access Profile Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | id | **str** | True | ID of the Role +Path | id | **str** | True | Role ID. ### Return type [**Role**](../models/role) @@ -419,7 +420,7 @@ Path | id | **str** | True | ID of the Role ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | List of all Roles | Role | - | +200 | List of all roles | Role | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | @@ -441,10 +442,10 @@ configuration = Configuration() with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + id = '2c91808a7813090a017814121e121518' # str | Role ID. # str | Role ID. try: - # Get a Role + # Get Role results = RolesApi(api_client).get_role(id=id) # Below is a request that includes all optional parameters @@ -542,7 +543,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -579,7 +580,7 @@ with ApiClient(configuration) as api_client: limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) @@ -602,8 +603,8 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## patch-role -Patch a specified Role -This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +Patch Role +Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description @@ -618,9 +619,9 @@ The following fields are patchable: * segments * accessModelMetadata -A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. -The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. +The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. @@ -630,7 +631,7 @@ When you use this API to modify a role's membership identities, you can only mod Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | id | **str** | True | ID of the Role to patch +Path | id | **str** | True | Role ID to patch Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | ### Return type @@ -639,7 +640,7 @@ Path | id | **str** | True | ID of the Role to patch ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | Responds with the Role as updated. | Role | - | +200 | Response with the updated role. | Role | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | @@ -662,11 +663,11 @@ configuration = Configuration() with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + id = '2c91808a7813090a017814121e121518' # str | Role ID to patch # str | Role ID to patch json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | try: - # Patch a specified Role + # Patch Role new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters diff --git a/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md index a529e0d71..cdbd4d0d1 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md @@ -387,7 +387,7 @@ with ApiClient(configuration) as api_client: ## get-workflow-execution Get Workflow Execution -Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. +Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution) diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md index d2ed1fc01..55b601e1d 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md @@ -11,25 +11,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'AccessProfile'] # AccessProfile -Access Profile +Access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Access Profile | [optional] [readonly] -**name** | **str** | Name of the Access Profile | [required] -**description** | **str** | Information about the Access Profile | [optional] -**created** | **datetime** | Date the Access Profile was created | [optional] [readonly] -**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly] -**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to False] +**id** | **str** | Access profile ID. | [optional] [readonly] +**name** | **str** | Access profile name. | [required] +**description** | **str** | Access profile description. | [optional] +**created** | **datetime** | Date and time when the access profile was created. | [optional] [readonly] +**modified** | **datetime** | Date and time when the access profile was last modified. | [optional] [readonly] +**enabled** | **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to False] **owner** | [**OwnerReference**](owner-reference) | | [required] **source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**requestable** | **bool** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to True] **access_request_config** | [**Requestability**](requestability) | | [optional] **revocation_request_config** | [**Revocability**](revocability) | | [optional] -**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**segments** | **[]str** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] } @@ -63,6 +63,7 @@ requestable=True, access_request_config=sailpoint.v3.models.requestability.Requestability( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.v3.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileApprovalScheme.md index 3fc05a28b..e80d189a3 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**approver_id** | **str** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSourceRef.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSourceRef.md index c7295f9ae..282691f32 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'AccessProfi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional] -**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional] -**name** | **str** | The display name of the associated Source | [optional] +**id** | **str** | ID of the source the access profile is associated with. | [optional] +**type** | **Enum** [ 'SOURCE' ] | Source's DTO type. | [optional] +**name** | **str** | Source name. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md index a1615a57b..211d1a3d1 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index a80904ad9..049a9aafe 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/OwnerReference.md b/docs/tools/sdk/python/Reference/V3/Models/OwnerReference.md index 20380c19a..b6750d95c 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/OwnerReference.md +++ b/docs/tools/sdk/python/Reference/V3/Models/OwnerReference.md @@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'OwnerReference'] # OwnerReference -The owner of this object. +Owner of the object. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**id** | **str** | Identity id | [optional] -**name** | **str** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel1.md index d73c263e0..aa3845b8c 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel1.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'Provisi # ProvisioningCriteriaLevel1 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel2.md index 7ce71c0b1..f3ebe4c6a 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel2.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'Provisi # ProvisioningCriteriaLevel2 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel3.md index 0d028757e..1a8a70634 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel3.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'Provisi # ProvisioningCriteriaLevel3 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | **str** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | **str** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaOperation.md index 662a48b87..187bd9d34 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaOperation.md +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaOperation.md @@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'Prov # ProvisioningCriteriaOperation -Supported operations on ProvisioningCriteria +Supported operations on `ProvisioningCriteria`. ## Enum diff --git a/docs/tools/sdk/python/Reference/V3/Models/Requestability.md b/docs/tools/sdk/python/Reference/V3/Models/Requestability.md index 6388fd106..25d92cf58 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/Requestability.md +++ b/docs/tools/sdk/python/Reference/V3/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'Requestability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] -**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**comments_required** | **bool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to False] +**denial_comments_required** | **bool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] } ## Example @@ -29,6 +30,7 @@ from sailpoint.v3.models.requestability import Requestability requestability = Requestability( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.v3.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestabilityForRole.md b/docs/tools/sdk/python/Reference/V3/Models/RequestabilityForRole.md index f554dbd48..27fd8a0ad 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] **denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] **approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] } @@ -29,6 +30,7 @@ from sailpoint.v3.models.requestability_for_role import RequestabilityForRole requestability_for_role = RequestabilityForRole( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.v3.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V3/Models/Revocability.md b/docs/tools/sdk/python/Reference/V3/Models/Revocability.md index b0c12624f..cb5802958 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/Revocability.md +++ b/docs/tools/sdk/python/Reference/V3/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/Role.md b/docs/tools/sdk/python/Reference/V3/Models/Role.md index 30ef8193b..4d8c2526d 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/Role.md +++ b/docs/tools/sdk/python/Reference/V3/Models/Role.md @@ -89,6 +89,7 @@ requestable=True, access_request_config=sailpoint.v3.models.requestability_for_role.RequestabilityForRole( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.v3.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md index 159a7ebe0..4d3443864 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecution.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecution.md index f2c4be952..3ef02b7ca 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecution.md +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **start_time** | **datetime** | Date/time when the workflow started. | [optional] **close_time** | **datetime** | Date/time when the workflow ended. | [optional] -**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional] +**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Queued', 'Running' ] | Workflow execution status. | [optional] } ## Example diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index a14d2bfad..b9ee41129 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -150,6 +150,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -1082,6 +1083,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.beta.api.account_usages_api import AccountUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1534,36 +1565,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.beta.api.account_usages_api import AccountUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications/{id} method: GET xCodeSample: @@ -7862,196 +7863,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.beta.api.managed_clients_api import ManagedClientsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_client_status import ManagedClientStatus - from sailpoint.beta.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get - type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get - try: - # Specified Managed Client Status. - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status - source: | - from sailpoint.beta.api.managed_clients_api import ManagedClientsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_client_status import ManagedClientStatus - from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update - managed_client_status = '''{ - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - }''' # ManagedClientStatus | - try: - # Handle status request from client - new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) - results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) - print("The response of ManagedClientsApi->update_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for - try: - # Get managed cluster's log configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get - try: - # Get a specified ManagedCluster. - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq operation' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Retrieve all Managed Clusters. - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for - client_log_configuration = '''{ - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" - }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster - try: - # Update managed cluster's log configuration - - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -8440,6 +8251,196 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.beta.api.managed_clients_api import ManagedClientsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_client_status import ManagedClientStatus + from sailpoint.beta.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get + type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get + try: + # Specified Managed Client Status. + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status + source: | + from sailpoint.beta.api.managed_clients_api import ManagedClientsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_client_status import ManagedClientStatus + from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update + managed_client_status = '''{ + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + }''' # ManagedClientStatus | + try: + # Handle status request from client + new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) + results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) + print("The response of ManagedClientsApi->update_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for + try: + # Get managed cluster's log configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get + try: + # Get a specified ManagedCluster. + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq operation' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + try: + # Retrieve all Managed Clusters. + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for + client_log_configuration = '''{ + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + try: + # Update managed cluster's log configuration + + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -11479,6 +11480,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -11725,606 +11727,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - search_attribute_config = '''{ - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - }''' # SearchAttributeConfig | - try: - # Create Extended Search Attributes - new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) - results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) - print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. - try: - # Delete Extended Search Attribute - - SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) - # Below is a request that includes all optional parameters - # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Extended Search Attributes - - results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) - print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. - try: - # Get Extended Search Attribute - - results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) - print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config - source: | - from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.json_patch_operation import JsonPatchOperation - from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. - json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | - try: - # Update Extended Search Attribute - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) - print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) -- path: /segments - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#create-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - segment = '''{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - }''' # Segment | - try: - # Create Segment - new_segment = Segment.from_json(segment) - results = SegmentsApi(api_client).create_segment(segment=new_segment) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).create_segment(new_segment) - print("The response of SegmentsApi->create_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->create_segment: %s\n" % e) -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#delete-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. - try: - # Delete Segment by ID - - SegmentsApi(api_client).delete_segment(id=id) - # Below is a request that includes all optional parameters - # SegmentsApi(api_client).delete_segment(id) - except Exception as e: - print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) -- path: /segments/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#get-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. - try: - # Get Segment by ID - - results = SegmentsApi(api_client).get_segment(id=id) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).get_segment(id) - print("The response of SegmentsApi->get_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->get_segment: %s\n" % e) -- path: /segments - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#list-segments - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List Segments - - results = SegmentsApi(api_client).list_segments() - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).list_segments(limit, offset, count) - print("The response of SegmentsApi->list_segments:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->list_segments: %s\n" % e) -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/segments#patch-segment - source: | - from sailpoint.beta.api.segments_api import SegmentsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.segment import Segment - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. - request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - try: - # Update Segment - new_request_body = RequestBody.from_json(request_body) - results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = SegmentsApi(api_client).patch_segment(id, new_request_body) - print("The response of SegmentsApi->patch_segment:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create - try: - # Create new Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete - try: - # Delete a Service Desk integration - - ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get - try: - # Get a Service Desk integration - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # List existing Service Desk integrations - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get - try: - # Service Desk integration template by scriptName - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Service Desk integration types - - results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get the time check configuration - - results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() - print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - try: - # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) - print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - service_desk_integration_dto = '''{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - }''' # ServiceDeskIntegrationDto | The specifics of the integration to update - try: - # Update a Service Desk integration - new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) - results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) - print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details - source: | - from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - queued_check_config_details = '''{ - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - }''' # QueuedCheckConfigDetails | The modified time check configuration - try: - # Update the time check configuration - new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) - results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) - # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) - print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) - path: /sim-integrations method: POST xCodeSample: @@ -13173,6 +12575,842 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.export_payload import ExportPayload + from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.import_options import ImportOptions + from sailpoint.beta.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.beta.api.sp_config_api import SPConfigApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + search_attribute_config = '''{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }''' # SearchAttributeConfig | + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. + try: + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. + try: + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) +- path: /segments + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#create-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + segment = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }''' # Segment | + try: + # Create Segment + new_segment = Segment.from_json(segment) + results = SegmentsApi(api_client).create_segment(segment=new_segment) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).create_segment(new_segment) + print("The response of SegmentsApi->create_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#delete-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + SegmentsApi(api_client).delete_segment(id=id) + # Below is a request that includes all optional parameters + # SegmentsApi(api_client).delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) +- path: /segments/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#get-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + results = SegmentsApi(api_client).get_segment(id=id) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) +- path: /segments + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#list-segments + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # List Segments + + results = SegmentsApi(api_client).list_segments() + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#patch-segment + source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + try: + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).patch_segment(id, new_request_body) + print("The response of SegmentsApi->patch_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # List existing Service Desk integrations + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Service Desk integration types + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get the time check configuration + + results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + try: + # Patch a Service Desk Integration + new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }''' # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details + source: | + from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + queued_check_config_details = '''{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }''' # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) + results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.beta.api.source_usages_api import SourceUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.beta.api.source_usages_api import SourceUsagesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -14587,242 +14825,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.beta.api.source_usages_api import SourceUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.beta.api.source_usages_api import SourceUsagesApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.export_payload import ExportPayload - from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.import_options import ImportOptions - from sailpoint.beta.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.beta.api.sp_config_api import SPConfigApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -16185,518 +16187,6 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) - connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows(limit, offset, trigger_id, connector_instance_id) - print("The response of WorkflowsApi->list_workflows:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.json_patch_operation import JsonPatchOperation - from sailpoint.beta.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response - from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) - print("The response of WorkflowsApi->post_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) - print("The response of WorkflowsApi->post_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#put-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.workflow import Workflow - from sailpoint.beta.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -17287,3 +16777,515 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) + connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows(limit, offset, trigger_id, connector_instance_id) + print("The response of WorkflowsApi->list_workflows:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from sailpoint.beta.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response + from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) + print("The response of WorkflowsApi->post_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) + print("The response of WorkflowsApi->post_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#put-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from sailpoint.beta.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index 6cc408673..39a2d0711 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -1305,6 +1305,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2024.api.account_usages_api import AccountUsagesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1767,36 +1797,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2024.api.account_usages_api import AccountUsagesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -3625,6 +3625,121 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3958,121 +4073,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: @@ -10557,6 +10557,198 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -10952,6 +11144,151 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#create-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_type = '''{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }''' # ManagedClusterType | + try: + # Create new Managed Cluster Type + new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) + results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) + print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#delete-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Delete a Managed Cluster Type + + ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Get a Managed Cluster Type + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) + print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-types + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) + pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) + org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + try: + # Get Managed Cluster Types + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) + print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#update-managed-cluster-type + source: | + from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JSONPatch payload used to update the schema. + try: + # Update a Managed Cluster Type + new_json_patch = JsonPatch.from_json(json_patch) + results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) + print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: @@ -11167,343 +11504,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # Get Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -15249,6 +15249,1122 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) +- path: /sim-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration + try: + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch import JsonPatch + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2024.api.sod_violations_api import SODViolationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2024.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2024.api.sod_violations_api import SODViolationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2024.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.export_payload import ExportPayload + from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.import_options import ImportOptions + from sailpoint.v2024.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2024.api.sp_config_api import SPConfigApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -16769,941 +17885,61 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = True - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = True - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api.source_usages_api import SourceUsagesApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.source_usage_status import SourceUsageStatus from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = True with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source try: - # Get a SIM integration details. + # Finds status of source usage - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api.source_usages_api import SourceUsagesApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = True - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = True - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch import JsonPatch - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = True - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = True - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy + from sailpoint.v2024.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) try: - # List SOD policies + # Returns source usage insights - results = SODPoliciesApi(api_client).list_sod_policies() + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2024.api.sod_violations_api import SODViolationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2024.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2024.api.sod_violations_api import SODViolationsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2024.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -19318,242 +19554,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.v2024.api.source_usages_api import SourceUsagesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.v2024.api.source_usages_api import SourceUsagesApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.export_payload import ExportPayload - from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.import_options import ImportOptions - from sailpoint.v2024.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2024.api.sp_config_api import SPConfigApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -20892,513 +20892,6 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v2024.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.workflow import Workflow - from sailpoint.v2024.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v2024.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow - source: | - from sailpoint.v2024.api.workflows_api import WorkflowsApi - from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -22008,3 +21501,510 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = '''sailpoint.v2024.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from sailpoint.v2024.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.v2024.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow + source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index 86d8ab9b0..158145c20 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -1323,6 +1323,36 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2025.api.account_usages_api import AccountUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1785,36 +1815,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v2025.api.account_usages_api import AccountUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -3643,6 +3643,121 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3976,121 +4091,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v2025.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: @@ -10575,6 +10575,198 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -10970,6 +11162,151 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_type = '''{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }''' # ManagedClusterType | + try: + # Create new Managed Cluster Type + new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) + results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) + print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Delete a Managed Cluster Type + + ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + try: + # Get a Managed Cluster Type + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) + print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) + pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) + org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + try: + # List Managed Cluster Types + + results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) + print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type + source: | + from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JSONPatch payload used to update the schema. + try: + # Update a Managed Cluster Type + new_json_patch = JsonPatch.from_json(json_patch) + results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) + print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: @@ -11185,343 +11522,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_type = '''{ - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - }''' # ManagedClusterType | - try: - # Create new Managed Cluster Type - new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type) - results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type) - print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Delete a Managed Cluster Type - - ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - try: - # Get a Managed Cluster Type - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id) - print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e) -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional) - pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional) - org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - try: - # List Managed Cluster Types - - results = ManagedClusterTypesApi(api_client).get_managed_cluster_types() - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) - print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - from sailpoint.v2025.api.managed_cluster_types_api import ManagedClusterTypesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.managed_cluster_type import ManagedClusterType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JSONPatch payload used to update the schema. - try: - # Update a Managed Cluster Type - new_json_patch = JsonPatch.from_json(json_patch) - results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch) - print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e) -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Duo MFA method - - results = MFAConfigurationApi(api_client).get_mfa_duo_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_question import KbaQuestion - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - try: - # Configuration of KBA MFA method - - results = MFAConfigurationApi(api_client).get_mfa_kba_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Configuration of Okta MFA method - - results = MFAConfigurationApi(api_client).get_mfa_okta_config() - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_duo_config import MfaDuoConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_duo_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaDuoConfig | - try: - # Set Duo MFA configuration - new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) - results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_okta_config import MfaOktaConfig - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - mfa_okta_config = '''{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - }''' # MfaOktaConfig | - try: - # Set Okta MFA configuration - new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) - results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#set-mfakba-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.kba_answer_request_item import KbaAnswerRequestItem - from sailpoint.v2025.models.kba_answer_response_item import KbaAnswerResponseItem - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | - try: - # Set MFA KBA configuration - new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) - results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/mfa-configuration#test-mfa-config - source: | - from sailpoint.v2025.api.mfa_configuration_api import MFAConfigurationApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.mfa_config_test_response import MfaConfigTestResponse - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - try: - # MFA method's test configuration - - results = MFAConfigurationApi(api_client).test_mfa_config(method=method) - # Below is a request that includes all optional parameters - # results = MFAConfigurationApi(api_client).test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /multihosts method: POST xCodeSample: @@ -15267,6 +15267,1122 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) +- path: /sim-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration + try: + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2025.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2025.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.export_payload import ExportPayload + from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.import_options import ImportOptions + from sailpoint.v2025.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Config Objects + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -16787,941 +17903,61 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /sim-integrations - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = True - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = True - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # Delete a SIM integration - - SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) -- path: /sim-integrations/{id} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.source_usage_status import SourceUsageStatus from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = True with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source try: - # Get a SIM integration details. + # Finds status of source usage - results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) -- path: /sim-integrations + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = True - - with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - try: - # List the existing SIM integrations. - - results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = True - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - try: - # Patch a SIM beforeProvisioningRule attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch import JsonPatch - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = True - - with ApiClient(configuration) as api_client: - id = '12345' # str | SIM integration id # str | SIM integration id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - json_patch = '''{ - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - }''' # JsonPatch | The JsonPatch object that describes the changes of SIM - try: - # Patch a SIM attribute. - new_json_patch = JsonPatch.from_json(json_patch) - results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration - source: | - from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto - from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails - from sailpoint.configuration import Configuration - configuration = Configuration() - - configuration.experimental = True - - with ApiClient(configuration) as api_client: - id = '12345' # str | The id of the integration. # str | The id of the integration. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - sim_integration_details = '''{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) - results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) - # Below is a request that includes all optional parameters - # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. - try: - # Download custom violation report - - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.v2025.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) try: - # List SOD policies + # Returns source usage insights - results = SODPoliciesApi(api_client).list_sod_policies() + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v2025.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check - source: | - from sailpoint.v2025.api.sod_violations_api import SODViolationsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v2025.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -19336,242 +19572,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.v2025.api.source_usages_api import SourceUsagesApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) -- path: /sp-config/export - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.export_payload import ExportPayload - from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - export_payload = '''{ - "description" : "Export Job 1 Test" - }''' # ExportPayload | Export options control what will be included in the export. - try: - # Initiates configuration objects export job - new_export_payload = ExportPayload.from_json(export_payload) - results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).export_sp_config(new_export_payload) - print("The response of SPConfigApi->export_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. - try: - # Download export job result. - - results = SPConfigApi(api_client).get_sp_config_export(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. - try: - # Get export job status - - results = SPConfigApi(api_client).get_sp_config_export_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. - try: - # Download import job result - - results = SPConfigApi(api_client).get_sp_config_import(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. - try: - # Get import job status - - results = SPConfigApi(api_client).get_sp_config_import_status(id=id) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) -- path: /sp-config/import - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.import_options import ImportOptions - from sailpoint.v2025.models.sp_config_job import SpConfigJob - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. - preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) - options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - results = SPConfigApi(api_client).import_sp_config(data=data) - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects - source: | - from sailpoint.v2025.api.sp_config_api import SPConfigApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.sp_config_object import SpConfigObject - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Config Objects - - results = SPConfigApi(api_client).list_sp_config_objects() - # Below is a request that includes all optional parameters - # results = SPConfigApi(api_client).list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -20910,513 +20910,6 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID - try: - # Cancel Workflow Execution by ID - - WorkflowsApi(api_client).cancel_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).cancel_workflow_execution(id) - except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response - from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) - try: - # Execute Workflow via External Trigger - - results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) -- path: /workflows - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | - try: - # Create Workflow - new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) - results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) - print("The response of WorkflowsApi->create_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Generate External Trigger OAuth Client - - results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - try: - # Delete Workflow By Id - - WorkflowsApi(api_client).delete_workflow(id=id) - # Below is a request that includes all optional parameters - # WorkflowsApi(api_client).delete_workflow(id) - except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - try: - # Get Workflow By Id - - results = WorkflowsApi(api_client).get_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. - try: - # Get Workflow Execution - - results = WorkflowsApi(api_client).get_workflow_execution(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution - try: - # Get Workflow Execution History - - results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_execution import WorkflowExecution - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - try: - # List Workflow Executions - - results = WorkflowsApi(api_client).get_workflow_executions(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) - print("The response of WorkflowsApi->get_workflow_executions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) -- path: /workflow-library - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - try: - # List Complete Workflow Library - - results = WorkflowsApi(api_client).list_complete_workflow_library() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Actions - - results = WorkflowsApi(api_client).list_workflow_library_actions() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflow Library Operators - - results = WorkflowsApi(api_client).list_workflow_library_operators() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - try: - # List Workflow Library Triggers - - results = WorkflowsApi(api_client).list_workflow_library_triggers() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) -- path: /workflows - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # List Workflows - - results = WorkflowsApi(api_client).list_workflows() - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | - try: - # Patch Workflow - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) - print("The response of WorkflowsApi->patch_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.workflow import Workflow - from sailpoint.v2025.models.workflow_body import WorkflowBody - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->put_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow - source: | - from sailpoint.v2025.api.workflows_api import WorkflowsApi - from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -22026,3 +21519,510 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'status eq \"Failed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.v2025.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index 8193b2bc8..130b65bb8 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -47,6 +47,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -232,7 +233,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) @@ -870,6 +871,36 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v3.api.account_usages_api import AccountUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts method: POST xCodeSample: @@ -1191,36 +1222,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id - source: | - from sailpoint.v3.api.account_usages_api import AccountUsagesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.account_usage import AccountUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns account usage insights - - results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) - # Below is a request that includes all optional parameters - # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -2473,6 +2474,121 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2806,121 +2922,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.access_summary import AccessSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - try: - # Access Summaries - - results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID - filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - try: - # Summary of Certification Decisions - - results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - try: - # Identity Summaries for Campaign Certification - - results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary - source: | - from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID - try: - # Summary for Identity - - results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) - # Below is a request that includes all optional parameters - # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -4249,357 +4250,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) -- path: /managed-clients - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.v3.models.managed_client_request import ManagedClientRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_client_request = '''{ - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - }''' # ManagedClientRequest | - try: - # Create Managed Client - new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) - results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) - print("The response of ManagedClientsApi->create_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Delete Managed Client - - ManagedClientsApi(api_client).delete_managed_client(id=id) - # Below is a request that includes all optional parameters - # ManagedClientsApi(api_client).delete_managed_client(id) - except Exception as e: - print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - try: - # Get Managed Client - - results = ManagedClientsApi(api_client).get_managed_client(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client(id) - print("The response of ManagedClientsApi->get_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client_status import ManagedClientStatus - from sailpoint.v3.models.managed_client_type import ManagedClientType - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. - type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. - try: - # Get Managed Client Status - - results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) -- path: /managed-clients - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - try: - # Get Managed Clients - - results = ManagedClientsApi(api_client).get_managed_clients() - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) - print("The response of ManagedClientsApi->get_managed_clients:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client - source: | - from sailpoint.v3.api.managed_clients_api import ManagedClientsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.managed_client import ManagedClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. - json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Client - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) - print("The response of ManagedClientsApi->update_managed_client:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) -- path: /managed-clusters - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - managed_cluster_request = '''{ - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - }''' # ManagedClusterRequest | - try: - # Create Create Managed Cluster - new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) - results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) - print("The response of ManagedClustersApi->create_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) - try: - # Delete Managed Cluster - - ManagedClustersApi(api_client).delete_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) - except Exception as e: - print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. - try: - # Get Managed Cluster Log Configuration - - results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - try: - # Get Managed Cluster - - results = ManagedClustersApi(api_client).get_managed_cluster(id=id) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) -- path: /managed-clusters - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - try: - # Get Managed Clusters - - results = ManagedClustersApi(api_client).get_managed_clusters() - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration - from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. - put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. - try: - # Update Managed Cluster Log Configuration - new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) - results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster - source: | - from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.managed_cluster import ManagedCluster - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. - json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. - try: - # Update Managed Cluster - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) - print("The response of ManagedClustersApi->update_managed_cluster:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -4988,6 +4638,357 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) +- path: /managed-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.v3.models.managed_client_request import ManagedClientRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_client_request = '''{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }''' # ManagedClientRequest | + try: + # Create Managed Client + new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) + results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) + print("The response of ManagedClientsApi->create_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + ManagedClientsApi(api_client).delete_managed_client(id=id) + # Below is a request that includes all optional parameters + # ManagedClientsApi(api_client).delete_managed_client(id) + except Exception as e: + print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + results = ManagedClientsApi(api_client).get_managed_client(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client_status import ManagedClientStatus + from sailpoint.v3.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. + type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + try: + # Get Managed Client Status + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'name eq \"client name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + try: + # Get Managed Clients + + results = ManagedClientsApi(api_client).get_managed_clients() + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) + print("The response of ManagedClientsApi->update_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-clusters + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_request = '''{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }''' # ManagedClusterRequest | + try: + # Create Create Managed Cluster + new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) + results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) + try: + # Delete Managed Cluster + + ManagedClustersApi(api_client).delete_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) + except Exception as e: + print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. + try: + # Get Managed Cluster Log Configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + try: + # Get Managed Clusters + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. + put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Cluster + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -7049,6 +7050,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -7139,9 +7141,9 @@ with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + id = '2c91808a7813090a017814121e121518' # str | Role ID. # str | Role ID. try: - # Delete a Role + # Delete Role RolesApi(api_client).delete_role(id=id) # Below is a request that includes all optional parameters @@ -7162,9 +7164,9 @@ with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + id = '2c91808a7813090a017814121e121518' # str | Role ID. # str | Role ID. try: - # Get a Role + # Get Role results = RolesApi(api_client).get_role(id=id) # Below is a request that includes all optional parameters @@ -7222,7 +7224,7 @@ limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) @@ -7252,10 +7254,10 @@ with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + id = '2c91808a7813090a017814121e121518' # str | Role ID to patch # str | Role ID to patch json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | try: - # Patch a specified Role + # Patch Role new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters @@ -7264,6 +7266,646 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v3.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v3.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /saved-searches method: POST xCodeSample: @@ -8727,646 +9369,61 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) -- path: /sod-policies - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Create SOD policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) - print("The response of SODPoliciesApi->create_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. - logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) - try: - # Delete SOD policy by ID - - SODPoliciesApi(api_client).delete_sod_policy(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy(id, logical) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. - try: - # Delete SOD policy schedule - - SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) - except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download/{fileName} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report + label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api.source_usages_api import SourceUsagesApi from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source_usage_status import SourceUsageStatus from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source try: - # Download custom violation report + # Finds status of source usage - results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) -- path: /sod-violation-report/{reportResultId}/download + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report + label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api.source_usages_api import SourceUsagesApi from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source_usage import SourceUsage from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. - try: - # Download violation report - - results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - try: - # Get multi-report run task status - - results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. - try: - # Get SOD policy by ID - - results = SODPoliciesApi(api_client).get_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. - try: - # Get SOD policy schedule - - results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. - try: - # Get violation report run status - - results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. - try: - # Get SOD violation report status - - results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) -- path: /sod-policies - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) try: - # List SOD policies + # Returns source usage insights - results = SODPoliciesApi(api_client).list_sod_policies() + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") for item in results: print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. - json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - try: - # Patch SOD policy by ID - new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) - results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. - sod_policy_schedule = '''{ - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - }''' # SodPolicySchedule | - try: - # Update SOD Policy schedule - new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) - results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | - try: - # Update SOD policy by ID - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) - print("The response of SODPoliciesApi->put_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Evaluate one policy by ID - - results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - multi_policy_request = '''{ - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - }''' # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy - source: | - from sailpoint.v3.api.sod_policies_api import SODPoliciesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.report_result_reference import ReportResultReference - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. - try: - # Runs SOD policy violation report - - results = SODPoliciesApi(api_client).start_sod_policy(id=id) - # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations - source: | - from sailpoint.v3.api.sod_violations_api import SODViolationsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess - from sailpoint.v3.models.violation_prediction import ViolationPrediction - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access = '''{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - }''' # IdentityWithNewAccess | - try: - # Predict SOD violations for identity. - new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) - results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check - source: | - from sailpoint.v3.api.sod_violations_api import SODViolationsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 - from sailpoint.v3.models.sod_violation_check import SodViolationCheck - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | - try: - # Check SOD violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) - # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) - print("The response of SODViolationsApi->start_violation_check:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -10289,61 +10346,6 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id - source: | - from sailpoint.v3.api.source_usages_api import SourceUsagesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.source_usage_status import SourceUsageStatus - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - try: - # Finds status of source usage - - results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id - source: | - from sailpoint.v3.api.source_usages_api import SourceUsagesApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.source_usage import SourceUsage - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - try: - # Returns source usage insights - - results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) - # Below is a request that includes all optional parameters - # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -10847,6 +10849,346 @@ print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Approve an Approval Item + + results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) + try: + # Complete a Work Item + + results = WorkItemsApi(api_client).complete_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id, new_body) + print("The response of WorkItemsApi->complete_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + try: + # Completed Work Items + + results = WorkItemsApi(api_client).get_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Completed Work Items + + results = WorkItemsApi(api_client).get_count_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + results = WorkItemsApi(api_client).get_count_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + results = WorkItemsApi(api_client).get_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items_summary import WorkItemsSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + results = WorkItemsApi(api_client).get_work_items_summary() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + results = WorkItemsApi(api_client).list_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Reject an Approval Item + + results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_item_forward import WorkItemForward + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + work_item_forward = '''{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }''' # WorkItemForward | + try: + # Forward a Work Item + new_work_item_forward = WorkItemForward.from_json(work_item_forward) + WorkItemsApi(api_client).send_work_item_forward(id=id, work_item_forward=new_work_item_forward) + # Below is a request that includes all optional parameters + # WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward) + except Exception as e: + print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection + source: | + from sailpoint.v3.api.work_items_api import WorkItemsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName + try: + # Submit Account Selections + new_request_body = RequestBody.from_json(request_body) + results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) + print("The response of WorkItemsApi->submit_account_selection:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -11359,343 +11701,3 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Approve an Approval Item - - results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->approve_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk approve Approval Items - - results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) - print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) - try: - # Complete a Work Item - - results = WorkItemsApi(api_client).complete_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).complete_work_item(id, new_body) - print("The response of WorkItemsApi->complete_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) -- path: /work-items/completed - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - try: - # Completed Work Items - - results = WorkItemsApi(api_client).get_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) - print("The response of WorkItemsApi->get_completed_work_items:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Completed Work Items - - results = WorkItemsApi(api_client).get_count_completed_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) - print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) -- path: /work-items/count - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_count import WorkItemsCount - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Count Work Items - - results = WorkItemsApi(api_client).get_count_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_count_work_items(owner_id) - print("The response of WorkItemsApi->get_count_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. - try: - # Get a Work Item - - results = WorkItemsApi(api_client).get_work_item(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_item(id) - print("The response of WorkItemsApi->get_work_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) -- path: /work-items/summary - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items_summary import WorkItemsSummary - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # Work Items Summary - - results = WorkItemsApi(api_client).get_work_items_summary() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) - print("The response of WorkItemsApi->get_work_items_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) -- path: /work-items - method: GET - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) - try: - # List Work Items - - results = WorkItemsApi(api_client).list_work_items() - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) - print("The response of WorkItemsApi->list_work_items:\n") - for item in results: - print(item.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. - try: - # Reject an Approval Item - - results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->reject_approval_item:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - try: - # Bulk reject Approval Items - - results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) - print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_item_forward import WorkItemForward - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - work_item_forward = '''{ - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - }''' # WorkItemForward | - try: - # Forward a Work Item - new_work_item_forward = WorkItemForward.from_json(work_item_forward) - WorkItemsApi(api_client).send_work_item_forward(id=id, work_item_forward=new_work_item_forward) - # Below is a request that includes all optional parameters - # WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward) - except Exception as e: - print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection - source: | - from sailpoint.v3.api.work_items_api import WorkItemsApi - from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.work_items import WorkItems - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName - try: - # Submit Account Selections - new_request_body = RequestBody.from_json(request_body) - results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) - # Below is a request that includes all optional parameters - # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) - print("The response of WorkItemsApi->submit_account_selection:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) From 61cee5e3b2202742ce73703cddedd0ebbdbbbe5a Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Wed, 23 Apr 2025 21:07:11 +0000 Subject: [PATCH 64/82] Automated commit by github action: 14628121021 --- static/api-specs/nerm/parameters/query/after_id.yaml | 4 ++-- static/api-specs/nerm/parameters/query/metadata.yaml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/static/api-specs/nerm/parameters/query/after_id.yaml b/static/api-specs/nerm/parameters/query/after_id.yaml index 5b521c547..824530f10 100644 --- a/static/api-specs/nerm/parameters/query/after_id.yaml +++ b/static/api-specs/nerm/parameters/query/after_id.yaml @@ -1,8 +1,8 @@ name: after_id in: query -description: Represents the ID where the query should begin from. If blank, it represents the first ID. When used, forces sorting by ID ascending and does not allow use of `offset`. When after_id is specified it changes the mode of the API such that any filter parameters other than profile_type_id, limit, and offset are not supported and will be either silently ignored or result in an HTTP 400 error. For example you can not include and after_id along with an archived=false in the same request. +description: Represents the ID where the query should begin from. If blank, it represents the first ID. When used, forces sorting by ID ascending and does not allow use of `offset`. When `after_id` is specified it changes the mode of the API such that any filter parameters other than `profile_type_id`, `limit`, and `offset` are not supported and will be either silently ignored or result in an HTTP 400 error. For example you can not include an `after_id` along with an `archived=false` in the same request. Can be used alongside `metadata` parameter. required: false schema: type: string format: uuid - example: 4eaa719f-4312-4c5b-9264-d0eb04d4a02a \ No newline at end of file + example: 4eaa719f-4312-4c5b-9264-d0eb04d4a02a diff --git a/static/api-specs/nerm/parameters/query/metadata.yaml b/static/api-specs/nerm/parameters/query/metadata.yaml index 040b24bbd..7c70dd6b9 100644 --- a/static/api-specs/nerm/parameters/query/metadata.yaml +++ b/static/api-specs/nerm/parameters/query/metadata.yaml @@ -1,8 +1,8 @@ name: metadata in: query -description: Returns batching metadata in the response +description: Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last "page"). required: false schema: type: boolean default: false - example: true \ No newline at end of file + example: true From e3e5778d4f71822764238fa82e6890749db463d4 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 23 Apr 2025 22:20:59 +0000 Subject: [PATCH 65/82] Update to python SDK docs: 14629204656 --- docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md | 2 +- .../Beta/Models/NonEmployeeRequestWithoutApprovalItem.md | 4 ++-- docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md | 2 +- docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md | 2 +- .../V2024/Models/NonEmployeeRequestWithoutApprovalItem.md | 4 ++-- docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md | 2 +- docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md | 2 +- .../V2025/Models/NonEmployeeRequestWithoutApprovalItem.md | 4 ++-- docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md | 2 +- docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md | 2 +- .../V3/Models/NonEmployeeRequestWithoutApprovalItem.md | 4 ++-- docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md | 2 +- static/code-examples/beta/python_code_examples_overlay.yaml | 1 + static/code-examples/v2024/python_code_examples_overlay.yaml | 1 + static/code-examples/v2025/python_code_examples_overlay.yaml | 1 + static/code-examples/v3/python_code_examples_overlay.yaml | 1 + 16 files changed, 20 insertions(+), 16 deletions(-) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md index dced03305..6d30198f2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index bffe6c49e..e0b91fdea 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md index fbcbd7a29..72badf0ff 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md index 5353898b1..442faa748 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index db5a37930..a37f38fea 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md index c57393c0d..ea8523f54 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md index 626e62e2b..8403e7986 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 33437e264..960d4b101 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md index 3091b3a26..3f731dad1 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md index 211d1a3d1..a1615a57b 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index 049a9aafe..a80904ad9 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Tue Mar 24 00:00:00 UTC 2020', -end_date='Thu Mar 25 00:00:00 UTC 2021', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md index 4d3443864..159a7ebe0 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Fri Apr 21 00:00:00 UTC 2023', +var_date='Thu Apr 20 20:00:00 EDT 2023', count=10.45 ) diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index b9ee41129..4aab27707 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -17289,3 +17289,4 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) + diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index 39a2d0711..0fd76ddd0 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -22008,3 +22008,4 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) + diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index 158145c20..fdecb0cf9 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -22026,3 +22026,4 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) + diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index 130b65bb8..b17ef427b 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -11701,3 +11701,4 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) + From 2d8c424f87063f83441b8b6b1f8f3f4f68cb91d9 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Thu, 24 Apr 2025 19:30:00 +0000 Subject: [PATCH 66/82] Automated commit by github action: 14650063189 --- .../api-specs/idn/v2024/schemas/workflows/WorkflowExecution.yaml | 1 + .../api-specs/idn/v2025/schemas/workflows/WorkflowExecution.yaml | 1 + 2 files changed, 2 insertions(+) diff --git a/static/api-specs/idn/v2024/schemas/workflows/WorkflowExecution.yaml b/static/api-specs/idn/v2024/schemas/workflows/WorkflowExecution.yaml index aae416a11..a928a7894 100644 --- a/static/api-specs/idn/v2024/schemas/workflows/WorkflowExecution.yaml +++ b/static/api-specs/idn/v2024/schemas/workflows/WorkflowExecution.yaml @@ -29,5 +29,6 @@ properties: - "Completed" - "Failed" - "Canceled" + - "Queued" - "Running" example: "Completed" diff --git a/static/api-specs/idn/v2025/schemas/workflows/WorkflowExecution.yaml b/static/api-specs/idn/v2025/schemas/workflows/WorkflowExecution.yaml index aae416a11..ff9649126 100644 --- a/static/api-specs/idn/v2025/schemas/workflows/WorkflowExecution.yaml +++ b/static/api-specs/idn/v2025/schemas/workflows/WorkflowExecution.yaml @@ -30,4 +30,5 @@ properties: - "Failed" - "Canceled" - "Running" + - "Queued" example: "Completed" From 1d38bbfeab2ebf42ea935d35cc600b6a0706fb41 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Thu, 24 Apr 2025 19:31:33 +0000 Subject: [PATCH 67/82] Update to powershell SDK docs: 14650095265 --- .../Beta/Methods/BetaAccessProfilesApi.md | 1 + .../Reference/Beta/Methods/BetaRolesApi.md | 1 + .../Reference/Beta/Models/AccessProfile.md | 18 +++---- .../Models/AccessProfileApprovalScheme.md | 4 +- .../Beta/Models/AccessProfileSourceRef.md | 6 +-- .../Reference/Beta/Models/OwnerReference.md | 4 +- .../Beta/Models/ProvisioningCriteriaLevel1.md | 6 +-- .../Beta/Models/ProvisioningCriteriaLevel2.md | 6 +-- .../Beta/Models/ProvisioningCriteriaLevel3.md | 6 +-- .../Reference/Beta/Models/Requestability.md | 8 ++-- .../Beta/Models/RequestabilityForRole.md | 2 + .../Reference/Beta/Models/Revocability.md | 2 +- .../V2024/Models/WorkflowExecution.md | 2 +- .../V2025/Models/WorkflowExecution.md | 2 +- .../Reference/V3/Methods/AccessProfilesApi.md | 7 +-- .../Reference/V3/Methods/RolesApi.md | 47 ++++++++++--------- .../Reference/V3/Methods/WorkflowsApi.md | 2 +- .../Reference/V3/Models/AccessProfile.md | 18 +++---- .../V3/Models/AccessProfileApprovalScheme.md | 4 +- .../V3/Models/AccessProfileSourceRef.md | 6 +-- .../Reference/V3/Models/OwnerReference.md | 4 +- .../V3/Models/ProvisioningCriteriaLevel1.md | 6 +-- .../V3/Models/ProvisioningCriteriaLevel2.md | 6 +-- .../V3/Models/ProvisioningCriteriaLevel3.md | 6 +-- .../Reference/V3/Models/Requestability.md | 8 ++-- .../V3/Models/RequestabilityForRole.md | 2 + .../Reference/V3/Models/Revocability.md | 2 +- .../Reference/V3/Models/WorkflowExecution.md | 2 +- .../powershell_code_examples_overlay.yaml | 2 + .../v3/powershell_code_examples_overlay.yaml | 18 +++---- 30 files changed, 112 insertions(+), 96 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md index f4aad6090..8be810d93 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md @@ -127,6 +127,7 @@ $AccessProfile = @"{ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md index 69eb7f771..6af3701e7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md @@ -218,6 +218,7 @@ $Role = @"{ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfile.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfile.md index 50304a33e..e1abd6bc6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfile.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfile.md @@ -16,19 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'BetaAccessProfile'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Access Profile | [optional] [readonly] -**Name** | **String** | Name of the Access Profile | [required] -**Description** | **String** | Information about the Access Profile | [optional] -**Created** | **System.DateTime** | Date the Access Profile was created | [optional] [readonly] -**Modified** | **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly] -**Enabled** | **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $false] +**Id** | **String** | Access profile ID. | [optional] [readonly] +**Name** | **String** | Access profile name. | [required] +**Description** | **String** | Access profile description. | [optional] +**Created** | **System.DateTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | **System.DateTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | **Boolean** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to $false] **Owner** | [**OwnerReference**](owner-reference) | | [required] **Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**Requestable** | **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] +**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | **Boolean** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] **AccessRequestConfig** | [**Requestability**](requestability) | | [optional] **RevocationRequestConfig** | [**Revocability**](revocability) | | [optional] -**Segments** | **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**Segments** | **[]String** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **ProvisioningCriteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileApprovalScheme.md index 22713259b..7ff1fe820 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'BetaAc Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**ApproverId** | **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | **String** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileSourceRef.md index b386e2a32..46221c674 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'BetaAccessP Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Source with with which the Access Profile is associated | [optional] -**Type** | **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional] -**Name** | **String** | The display name of the associated Source | [optional] +**Id** | **String** | ID of the source the access profile is associated with. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Source's DTO type. | [optional] +**Name** | **String** | Source name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/OwnerReference.md b/docs/tools/sdk/powershell/Reference/Beta/Models/OwnerReference.md index bd8f9cf55..f7459e1af 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/OwnerReference.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/OwnerReference.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'BetaOwnerReference' Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Type** | **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | **String** | Identity id | [optional] -**Name** | **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**Id** | **String** | Owner's identity ID. | [optional] +**Name** | **String** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel1.md index 4e996a6ff..d54e117dd 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel1.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'BetaPro Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel2.md index 635641e72..ff736544e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel2.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'BetaPro Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel3.md index e2ca6dd45..1bf975af1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel3.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'BetaPro Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | **String** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Requestability.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Requestability.md index 870415301..1800f701c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Requestability.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'BetaRequestability' Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**CommentsRequired** | **Boolean** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to $false] +**DenialCommentsRequired** | **Boolean** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $Requestability = Initialize-PSSailpoint.BetaRequestability -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestabilityForRole.md index a275aa874..ca539e6a7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] **DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] **ApprovalSchemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $RequestabilityForRole = Initialize-PSSailpoint.BetaRequestabilityForRole -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Revocability.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Revocability.md index 43bc7c20f..1ee5482d1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Revocability.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'BetaRevocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md index 534e28991..b375e7b22 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Queued", "Running" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V2025/Models/WorkflowExecution.md index ab2df3d36..27d4417ae 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running", "Queued" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md index 5e066c614..bc88ae0ab 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md @@ -62,7 +62,7 @@ Method | HTTP request | Description ## create-access-profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-profile) @@ -126,6 +126,7 @@ $AccessProfile = @"{ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -410,7 +411,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -438,7 +439,7 @@ $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returne $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md index 5b7efe094..4bf961d67 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md @@ -56,11 +56,11 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**New-Role**](#create-role) | **POST** `/roles` | Create a Role [**Remove-BulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) -[**Remove-Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role -[**Get-Role**](#get-role) | **GET** `/roles/{id}` | Get a Role +[**Remove-Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete Role +[**Get-Role**](#get-role) | **GET** `/roles/{id}` | Get Role [**Get-RoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role [**Get-Roles**](#list-roles) | **GET** `/roles` | List Roles -[**Update-Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role +[**Update-Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch Role ## create-role @@ -214,6 +214,7 @@ $Role = @"{ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -321,16 +322,16 @@ try { [[Back to top]](#) ## delete-role -This API deletes a Role by its ID. +Delete a role by ID. -A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-role) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Role +Path | Id | **String** | True | Role ID. ### Return type (empty response body) @@ -351,9 +352,9 @@ Code | Description | Data Type ### Example ```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role +$Id = "2c91808a7813090a017814121e121518" # String | Role ID. -# Delete a Role +# Delete Role try { Remove-Role -Id $Id @@ -368,15 +369,15 @@ try { [[Back to top]](#) ## get-role -This API returns a Role by its ID. -A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +Get a role by ID. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-role) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Role +Path | Id | **String** | True | Role ID. ### Return type [**Role**](../models/role) @@ -384,7 +385,7 @@ Path | Id | **String** | True | ID of the Role ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of all Roles | Role +200 | List of all roles | Role 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -397,9 +398,9 @@ Code | Description | Data Type ### Example ```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role +$Id = "2c91808a7813090a017814121e121518" # String | Role ID. -# Get a Role +# Get Role try { Get-Role -Id $Id @@ -480,7 +481,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -508,7 +509,7 @@ $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filter $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) +$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) @@ -528,7 +529,7 @@ try { [[Back to top]](#) ## patch-role -This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description @@ -543,9 +544,9 @@ The following fields are patchable: * segments * accessModelMetadata -A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. -The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. +The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. @@ -554,7 +555,7 @@ When you use this API to modify a role's membership identities, you can only mod ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Role to patch +Path | Id | **String** | True | Role ID to patch Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | ### Return type @@ -563,7 +564,7 @@ Path | Id | **String** | True | ID of the Role to patch ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Responds with the Role as updated. | Role +200 | Response with the updated role. | Role 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -576,7 +577,7 @@ Code | Description | Data Type ### Example ```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch +$Id = "2c91808a7813090a017814121e121518" # String | Role ID to patch $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -584,7 +585,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch }"@ # JsonPatchOperation[] | -# Patch a specified Role +# Patch Role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md index 0f61c625d..4fac5d581 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md @@ -315,7 +315,7 @@ try { [[Back to top]](#) ## get-workflow-execution -Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. +Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution) diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfile.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfile.md index 38e5821f0..19e668c86 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfile.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfile.md @@ -16,19 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'AccessProfile'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Access Profile | [optional] [readonly] -**Name** | **String** | Name of the Access Profile | [required] -**Description** | **String** | Information about the Access Profile | [optional] -**Created** | **System.DateTime** | Date the Access Profile was created | [optional] [readonly] -**Modified** | **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly] -**Enabled** | **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $false] +**Id** | **String** | Access profile ID. | [optional] [readonly] +**Name** | **String** | Access profile name. | [required] +**Description** | **String** | Access profile description. | [optional] +**Created** | **System.DateTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | **System.DateTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | **Boolean** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to $false] **Owner** | [**OwnerReference**](owner-reference) | | [required] **Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**Requestable** | **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] +**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | **Boolean** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] **AccessRequestConfig** | [**Requestability**](requestability) | | [optional] **RevocationRequestConfig** | [**Revocability**](revocability) | | [optional] -**Segments** | **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**Segments** | **[]String** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **ProvisioningCriteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileApprovalScheme.md index 83ed0dad4..9a8176e14 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**ApproverId** | **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | **String** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileSourceRef.md index bb27e9bb0..76618e047 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'AccessProfi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Source with with which the Access Profile is associated | [optional] -**Type** | **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional] -**Name** | **String** | The display name of the associated Source | [optional] +**Id** | **String** | ID of the source the access profile is associated with. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Source's DTO type. | [optional] +**Name** | **String** | Source name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/OwnerReference.md b/docs/tools/sdk/powershell/Reference/V3/Models/OwnerReference.md index 1d27aa717..13a2f546f 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/OwnerReference.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/OwnerReference.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'OwnerReference'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Type** | **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | **String** | Identity id | [optional] -**Name** | **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**Id** | **String** | Owner's identity ID. | [optional] +**Name** | **String** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel1.md index 15299a7c2..d84117039 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel1.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'Provisi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel2.md index ae1689ff9..917115baa 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel2.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'Provisi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel3.md index 554695db2..7d7bbfcf9 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel3.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'Provisi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | **String** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Requestability.md b/docs/tools/sdk/powershell/Reference/V3/Models/Requestability.md index 511927a65..03031aa1e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Requestability.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'Requestability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**CommentsRequired** | **Boolean** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to $false] +**DenialCommentsRequired** | **Boolean** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $Requestability = Initialize-PSSailpoint.V3Requestability -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/Reference/V3/Models/RequestabilityForRole.md index b61345a0c..e0a62daf6 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] **DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] **ApprovalSchemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $RequestabilityForRole = Initialize-PSSailpoint.V3RequestabilityForRole -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Revocability.md b/docs/tools/sdk/powershell/Reference/V3/Models/Revocability.md index b4779c98c..6c8a772f7 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Revocability.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md index b8adc8865..f3b2ccd91 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Queued", "Running" ] | Workflow execution status. | [optional] ## Examples diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index 5ed89184c..236a5c4b3 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -117,6 +117,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -9718,6 +9719,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index cfcfaeb4d..17fd1c924 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -40,6 +40,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -201,7 +202,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) @@ -6074,6 +6075,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -6157,9 +6159,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/roles#delete-role source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + $Id = "2c91808a7813090a017814121e121518" # String | Role ID. - # Delete a Role + # Delete Role try { Remove-Role -Id $Id @@ -6176,9 +6178,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/roles#get-role source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + $Id = "2c91808a7813090a017814121e121518" # String | Role ID. - # Get a Role + # Get Role try { Get-Role -Id $Id @@ -6223,7 +6225,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) @@ -6245,7 +6247,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/roles#patch-role source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $Id = "2c91808a7813090a017814121e121518" # String | Role ID to patch $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -6253,7 +6255,7 @@ }"@ - # Patch a specified Role + # Patch Role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation From 6c80449c5a7612c33359198948cc0a73676b6b7f Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Thu, 24 Apr 2025 19:32:50 +0000 Subject: [PATCH 68/82] Automated commit by github action: 14650113874 --- static/api-specs/idn/v3/paths/access-profiles.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/static/api-specs/idn/v3/paths/access-profiles.yaml b/static/api-specs/idn/v3/paths/access-profiles.yaml index 6bbad4262..df358c56e 100644 --- a/static/api-specs/idn/v3/paths/access-profiles.yaml +++ b/static/api-specs/idn/v3/paths/access-profiles.yaml @@ -4,7 +4,7 @@ get: - Access Profiles summary: List Access Profiles description: >- - Get a list of access profiles. + Get a list of access profiles. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. parameters: @@ -137,6 +137,8 @@ post: The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. + + >**Note:** To use this endpoint, you need all the listed scopes. requestBody: required: true content: @@ -161,7 +163,7 @@ post: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:access-profile:manage] + - userAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] - applicationAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] x-sailpoint-userLevels: - ORG_ADMIN From 25b07e3b0903665049e55112727fdea45aa5eca6 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Thu, 24 Apr 2025 19:34:17 +0000 Subject: [PATCH 69/82] Update to powershell SDK docs: 14650140688 --- .../sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md index bc88ae0ab..4eef9e6d7 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md @@ -64,6 +64,7 @@ Method | HTTP request | Description Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-profile) @@ -399,7 +400,7 @@ try { [[Back to top]](#) ## list-access-profiles -Get a list of access profiles. +Get a list of access profiles. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-access-profiles) From deedbbd4abde4f107cc60b684dad5e29d32bc9d6 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Thu, 24 Apr 2025 19:56:58 +0000 Subject: [PATCH 70/82] Automated commit by github action: 14650504020 --- static/api-specs/idn/beta/paths/access-profiles.yaml | 2 ++ static/api-specs/idn/v2024/paths/access-profiles.yaml | 2 ++ static/api-specs/idn/v2025/paths/access-profiles.yaml | 2 ++ 3 files changed, 6 insertions(+) diff --git a/static/api-specs/idn/beta/paths/access-profiles.yaml b/static/api-specs/idn/beta/paths/access-profiles.yaml index 67f6656c4..999773440 100644 --- a/static/api-specs/idn/beta/paths/access-profiles.yaml +++ b/static/api-specs/idn/beta/paths/access-profiles.yaml @@ -133,6 +133,8 @@ post: The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. + + >**Note:** To use this endpoint, you need all the listed scopes. requestBody: required: true content: diff --git a/static/api-specs/idn/v2024/paths/access-profiles.yaml b/static/api-specs/idn/v2024/paths/access-profiles.yaml index e4bdd4fad..7cda878e0 100644 --- a/static/api-specs/idn/v2024/paths/access-profiles.yaml +++ b/static/api-specs/idn/v2024/paths/access-profiles.yaml @@ -136,6 +136,8 @@ post: The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. + + >**Note:** To use this endpoint, you need all the listed scopes. requestBody: required: true content: diff --git a/static/api-specs/idn/v2025/paths/access-profiles.yaml b/static/api-specs/idn/v2025/paths/access-profiles.yaml index e4bdd4fad..7cda878e0 100644 --- a/static/api-specs/idn/v2025/paths/access-profiles.yaml +++ b/static/api-specs/idn/v2025/paths/access-profiles.yaml @@ -136,6 +136,8 @@ post: The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. + + >**Note:** To use this endpoint, you need all the listed scopes. requestBody: required: true content: From 7426a043d2bac083ecb56eb9ad908e52accbd4cf Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Thu, 24 Apr 2025 19:58:46 +0000 Subject: [PATCH 71/82] Update to python SDK docs: 14650531569 --- .../sdk/python/Reference/Beta/Methods/AccessProfilesApi.md | 1 + docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md | 2 +- .../Beta/Models/NonEmployeeRequestWithoutApprovalItem.md | 4 ++-- docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md | 2 +- .../sdk/python/Reference/V2024/Methods/AccessProfilesApi.md | 1 + docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md | 2 +- .../V2024/Models/NonEmployeeRequestWithoutApprovalItem.md | 4 ++-- docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md | 2 +- .../sdk/python/Reference/V2024/Models/WorkflowExecution.md | 2 +- .../sdk/python/Reference/V2025/Methods/AccessProfilesApi.md | 1 + docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md | 2 +- .../V2025/Models/NonEmployeeRequestWithoutApprovalItem.md | 4 ++-- docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md | 2 +- .../sdk/python/Reference/V2025/Models/WorkflowExecution.md | 2 +- .../sdk/python/Reference/V3/Methods/AccessProfilesApi.md | 3 ++- docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md | 2 +- .../V3/Models/NonEmployeeRequestWithoutApprovalItem.md | 4 ++-- docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md | 2 +- 18 files changed, 23 insertions(+), 19 deletions(-) diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md index d82c6288f..48dd0f81a 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md @@ -64,6 +64,7 @@ Create Access Profile Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-profile) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md index 6d30198f2..dced03305 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index e0b91fdea..bffe6c49e 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md index 72badf0ff..fbcbd7a29 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md index 39452b630..83000b2b4 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md @@ -64,6 +64,7 @@ Create Access Profile Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-profile) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md index 442faa748..5353898b1 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index a37f38fea..db5a37930 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md index ea8523f54..c57393c0d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecution.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecution.md index f0ff7ce47..d13df73cd 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecution.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **start_time** | **datetime** | Date/time when the workflow started. | [optional] **close_time** | **datetime** | Date/time when the workflow ended. | [optional] -**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional] +**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Queued', 'Running' ] | Workflow execution status. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md index 44928f4d4..edf919c30 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md @@ -64,6 +64,7 @@ Create Access Profile Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-profile) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md index 8403e7986..626e62e2b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 960d4b101..33437e264 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md index 3f731dad1..3091b3a26 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/WorkflowExecution.md b/docs/tools/sdk/python/Reference/V2025/Models/WorkflowExecution.md index 76f57eb97..9325418e3 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/WorkflowExecution.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **start_time** | **datetime** | Date/time when the workflow started. | [optional] **close_time** | **datetime** | Date/time when the workflow ended. | [optional] -**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional] +**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running', 'Queued' ] | Workflow execution status. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md index 41910079d..5972eb832 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md @@ -63,6 +63,7 @@ Create Access Profile Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-profile) @@ -460,7 +461,7 @@ with ApiClient(configuration) as api_client: ## list-access-profiles List Access Profiles -Get a list of access profiles. +Get a list of access profiles. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-access-profiles) diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md index a1615a57b..211d1a3d1 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index a80904ad9..049a9aafe 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md index 159a7ebe0..4d3443864 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) From 79d4d5134dbe874118e3face9ca70a6c126a3b54 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Fri, 25 Apr 2025 12:51:33 -0400 Subject: [PATCH 72/82] add sdk init docs for CLI and update json path implementation dropdown values --- docs/tools/cli/sdk.md | 162 ++++++++++++++++++ .../jsonpath/ImplementationDropdown/index.tsx | 2 +- 2 files changed, 163 insertions(+), 1 deletion(-) create mode 100644 docs/tools/cli/sdk.md diff --git a/docs/tools/cli/sdk.md b/docs/tools/cli/sdk.md new file mode 100644 index 000000000..c1d5e7b25 --- /dev/null +++ b/docs/tools/cli/sdk.md @@ -0,0 +1,162 @@ +--- +id: cli-sdk-init +title: SDK +pagination_label: CLI SDK +sidebar_label: SDK +sidebar_position: 20 +sidebar_class_name: cli-sdk +keywords: ['cli', 'sdk init', 'sailpoint sdk', 'sdk setup'] +description: Learn how to initialize a SailPoint SDK project using the CLI. +slug: /tools/cli/sdk +tags: ['CLI'] +--- + +Learn how to use the SailPoint CLI to setup an SDK project. This command helps you initialize SDK projects across supported languages including Python, Go, PowerShell, and TypeScript. + + +- [Golang](#golang) +- [Python](#python) +- [PowerShell](#powershell) +- [TypeScript](#typescript) + + +## Golang + +Setting Up Golang SDK project + +The SailPoint CLI offers a few commands that will allow you to quickly get started with the Go SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli). + +Once the CLI is installed and configured, run this command to create a new Go project with the Go SDK: + +```bash +sail sdk init golang go-example +``` + +Running the command will create the structure for your project: + +```text +|-- go-example +| |-- go.mod +| |-- go.sum +| |-- sdk.go +``` + +Navigate into your project folder and run this command to install the required dependencies: + +```bash +go mod tidy +``` + +The SDK is now installed. To learn how to configure the SDK, refer to the [Configure section](#configure). + + + + +## Python + +Setting Up Python SDK project + +The SailPoint CLI offers a few commands that will allow you to quickly get started with the Python SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli). + +Once the CLI is installed and configured, run this command to create a new Python project with the Python SDK: + +```bash +sail sdk init python python-example +``` + +Running this command will create the structure for your project: + +```text +|-- python-example +| |-- requirements.txt +| |-- sdk.py +``` + +Navigate into your project folder and run this command to install the required dependencies: + +```bash +pip install -r requirements.txt +``` + +The SDK is now installed. To learn how to configure the SDK, refer to the [Configure section](#configure). + + + +## PowerShell + +Setting Up PowerShell SDK project + +The SailPoint CLI offers a few commands that will allow you to quickly get started with the PowerShell SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli). + +Once the CLI is installed and configured, run this command to create a new PowerShell project with the PowerShell SDK: + +```bash +sail sdk init powershell +``` + +Running the command create the structure for your project: + +```text +|-- powershell-template +| |-- paginate.ps1 +| |-- paginateAccounts.ps1 +| |-- patchEntitlement.ps1 +| |-- sdk.ps1 +| |-- search.ps1 +| |-- transform.ps1 +``` + +Run this command to install the required dependencies: + +```powershell +Install-Module -Name PSSailpoint +Install-Module -Name PSSailpoint.Beta +Install-Module -Name PSSailpoint.V3 +Install-Module -Name PSSailpoint.V2024 +``` + +The command installs the SailPoint PowerShell SDK module. You will be prompted to confirm that you want to install the module from 'PSGallery'. Enter "A" to say "Yes to All". + +If you already have a version of the PowerShell SDK installed, you can install a new version side-by-side with it by adding the `-Force` parameter to the end of your `Install-Module` commmand: + +```powershell +Install-Module -Name PSSailpoint -Force +Install-Module -Name PSSailpoint.Beta -Force +Install-Module -Name PSSailpoint.V3 -Force +Install-Module -Name PSSailpoint.V2024 -Force +``` + +To validate that the module is installed, run this command, `Get-Module -ListAvailable PSSailpoint`, and verify that the module is listed. Additionally, you can run this command, `Get-Command -Module PSSailpoint`, to see the available commands included in the module. + +The SDK is now installed. To learn how to configure the SDK, refer to the [Configure section](#configure). + + +## TypeScript + +Setting Up TypeScript SDK project + +The SailPoint CLI offers a few commands that will allow you to quickly get started with the Typescript SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli). + +Once the CLI is installed and configured, run this command to create a new Typescript project with the Typescript SDK: + +```bash +sail sdk init typescript typescript-example +``` + +Running the command creates the structure for your project: + +```text +|-- typescript-example +| |-- package.json +| |-- src +| | |-- index.ts +| |-- tsconfig.json +``` + +Navigate into your project folder and run this command to install the required dependencies: + +```bash +npm install +``` + +The SDK is now installed. To learn how to configure the SDK, refer to the [Configure section](#configure). \ No newline at end of file diff --git a/src/components/jsonpath/ImplementationDropdown/index.tsx b/src/components/jsonpath/ImplementationDropdown/index.tsx index 7636b54fe..6dc837c8f 100644 --- a/src/components/jsonpath/ImplementationDropdown/index.tsx +++ b/src/components/jsonpath/ImplementationDropdown/index.tsx @@ -103,7 +103,7 @@ const ImplementationDropdown: React.FC = ({ }} > Workflow - Event Trigger + Event Trigger & Web Service Connector From 2ae8c3a8ee89b464c1efc79e701574c0ac60d3e2 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Tue, 29 Apr 2025 11:21:15 -0400 Subject: [PATCH 73/82] updating doc file for cli sdk --- docs/tools/cli/sdk.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/tools/cli/sdk.md b/docs/tools/cli/sdk.md index c1d5e7b25..ea1a9569f 100644 --- a/docs/tools/cli/sdk.md +++ b/docs/tools/cli/sdk.md @@ -22,8 +22,6 @@ Learn how to use the SailPoint CLI to setup an SDK project. This command helps y ## Golang -Setting Up Golang SDK project - The SailPoint CLI offers a few commands that will allow you to quickly get started with the Go SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli). Once the CLI is installed and configured, run this command to create a new Go project with the Go SDK: @@ -54,8 +52,6 @@ The SDK is now installed. To learn how to configure the SDK, refer to the [Confi ## Python -Setting Up Python SDK project - The SailPoint CLI offers a few commands that will allow you to quickly get started with the Python SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli). Once the CLI is installed and configured, run this command to create a new Python project with the Python SDK: @@ -84,8 +80,6 @@ The SDK is now installed. To learn how to configure the SDK, refer to the [Confi ## PowerShell -Setting Up PowerShell SDK project - The SailPoint CLI offers a few commands that will allow you to quickly get started with the PowerShell SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli). Once the CLI is installed and configured, run this command to create a new PowerShell project with the PowerShell SDK: @@ -133,8 +127,6 @@ The SDK is now installed. To learn how to configure the SDK, refer to the [Confi ## TypeScript -Setting Up TypeScript SDK project - The SailPoint CLI offers a few commands that will allow you to quickly get started with the Typescript SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli). Once the CLI is installed and configured, run this command to create a new Typescript project with the Typescript SDK: From 11a9f72f998e181d000f4766624dc1c4e3948a5a Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Tue, 29 Apr 2025 15:21:59 +0000 Subject: [PATCH 74/82] Update to powershell SDK docs: 14735017218 --- .../Beta/Methods/BetaAccessProfilesApi.md | 1 + .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../V2024/Methods/V2024AccessProfilesApi.md | 1 + .../Reference/V2024/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../V2025/Methods/V2025AccessProfilesApi.md | 1 + .../Reference/V2025/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2025/Models/SourceUsage.md | 2 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V3/Models/SourceUsage.md | 2 +- .../powershell_code_examples_overlay.yaml | 14750 ------------ .../powershell_code_examples_overlay.yaml | 18621 --------------- .../powershell_code_examples_overlay.yaml | 18632 ---------------- .../v3/powershell_code_examples_overlay.yaml | 10227 --------- 19 files changed, 19 insertions(+), 62246 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md index 8be810d93..530628547 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md @@ -65,6 +65,7 @@ Method | HTTP request | Description Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-profile) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md index 9d6d48011..f6a1eaaa2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index 414c1c740..4eef80103 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md index 05cceab03..bb3b65383 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md index ced98a283..4cc2d4090 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md @@ -65,6 +65,7 @@ Method | HTTP request | Description Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-profile) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md index b901e027d..9cb9ee94f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index 6393f6ed6..54727248f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md index 3d6b4c94a..235e4ab2c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md index d6790d1d0..0f4de171a 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md @@ -65,6 +65,7 @@ Method | HTTP request | Description Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-profile) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md index 10c9e238e..f0699a5d6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V2025AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2025AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index d31582750..34280ad09 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2025NonEmployee -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md index e5a21ea4d..7c6c72949 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V2025SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2025SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md index 35c8a92f6..3b9cae031 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index 17d96a073..071f0e39a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V3NonEmployeeReq -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md index 0328c565b..92919ac01 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index 236a5c4b3..139597f9c 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -1,14752 +1,2 @@ -- path: /access-model-metadata/attributes/{key} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#get-access-model-metadata-attribute - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - - # Get Access Model Metadata Attribute - - try { - Get-BetaAccessModelMetadataAttribute -Key $Key - - # Below is a request that includes all optional parameters - # Get-BetaAccessModelMetadataAttribute -Key $Key - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" - Write-Host $_.ErrorDetails - } -- path: /access-model-metadata/attributes/{key}/values/{value} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#get-access-model-metadata-attribute-value - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $Value = "public" # String | Technical name of the Attribute value. - - # Get Access Model Metadata Value - - try { - Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value - - # Below is a request that includes all optional parameters - # Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" - Write-Host $_.ErrorDetails - } -- path: /access-model-metadata/attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#list-access-model-metadata-attribute - source: | - $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) - - # List Access Model Metadata Attributes - - try { - Get-BetaAccessModelMetadataAttribute - - # Below is a request that includes all optional parameters - # Get-BetaAccessModelMetadataAttribute -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" - Write-Host $_.ErrorDetails - } -- path: /access-model-metadata/attributes/{key}/values - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#list-access-model-metadata-attribute-value - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - - # List Access Model Metadata Values - - try { - Get-BetaAccessModelMetadataAttributeValue -Key $Key - - # Below is a request that includes all optional parameters - # Get-BetaAccessModelMetadataAttributeValue -Key $Key - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" - Write-Host $_.ErrorDetails - } -- path: /access-profiles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-profiles#create-access-profile - source: | - $AccessProfile = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "description" : "Collection of entitlements to read/write the employee database", - "source" : { - "name" : "ODS-AD-SOURCE", - "id" : "2c91809773dee3610173fdb0b6061ef4", - "type" : "SOURCE" - }, - "enabled" : true, - "revocationRequestConfig" : { - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ] - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "accessRequestConfig" : { - "commentsRequired" : true, - "reauthorizationRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "name" : "Employee-database-read-write", - "provisioningCriteria" : { - "children" : [ { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, - "modified" : "2021-03-02T20:22:28.104Z", - "id" : "2c91808a7190d06e01719938fcd20792", - "requestable" : true - } - "@ - - # Create Access Profile - - try { - $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile - New-BetaAccessProfile -AccessProfile $Result - - # Below is a request that includes all optional parameters - # New-BetaAccessProfile -AccessProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-profiles#delete-access-profile - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete - - # Delete the specified Access Profile - - try { - Remove-BetaAccessProfile -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaAccessProfile -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-profiles#delete-access-profiles-in-bulk - source: | - $AccessProfileBulkDeleteRequest = @" - { - "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], - "bestEffortOnly" : true - } - "@ - - # Delete Access Profile(s) - - try { - $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest - Remove-BetaAccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-BetaAccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesInBulk" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-profiles#get-access-profile - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile - - # Get an Access Profile - - try { - Get-BetaAccessProfile -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccessProfile -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-profiles#get-access-profile-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Access Profile's Entitlements - - try { - Get-BetaAccessProfileEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfileEntitlements" - Write-Host $_.ErrorDetails - } -- path: /access-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-profiles#list-access-profiles - source: | - $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) - - # List Access Profiles - - try { - Get-BetaAccessProfiles - - # Below is a request that includes all optional parameters - # Get-BetaAccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfiles" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-profiles#patch-access-profile - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Access Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaAccessProfile -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaAccessProfile -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/bulk-update-requestable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-profiles#update-access-profiles-in-bulk - source: | - $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ - - - # Update Access Profile(s) requestable field. - - try { - $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner - Update-BetaAccessProfilesInBulk -AccessProfileBulkUpdateRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-BetaAccessProfilesInBulk -AccessProfileBulkUpdateRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfilesInBulk" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{approvalId}/approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#approve-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $CommentDto = @" - { - "author" : { - "name" : "Adam Kennedy", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2017-07-11T18:45:37.098Z", - "comment" : "This is a comment." - } - "@ - - # Approve Access Request Approval - - try { - $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Approve-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result - - # Below is a request that includes all optional parameters - # Approve-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaAccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{approvalId}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#forward-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $ForwardApprovalDto = @" - { - "newOwnerId" : "newOwnerId", - "comment" : "comment" - } - "@ - - # Forward Access Request Approval - - try { - $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto - Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result - - # Below is a request that includes all optional parameters - # Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardAccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/approval-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#get-access-request-approval-summary - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) - - # Get Access Requests Approvals Number - - try { - Get-BetaAccessRequestApprovalSummary - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestApprovalSummary" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#list-completed-approvals - source: | - $OwnerId = "MyOwnerId" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) - $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Completed Access Request Approvals List - - try { - Get-BetaCompletedApprovals - - # Below is a request that includes all optional parameters - # Get-BetaCompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedApprovals" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/pending - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#list-pending-approvals - source: | - $OwnerId = "MyOwnerId" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) - $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Pending Access Request Approvals List - - try { - Get-BetaPendingApprovals - - # Below is a request that includes all optional parameters - # Get-BetaPendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingApprovals" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{approvalId}/reject - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#reject-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $CommentDto = @" - { - "author" : { - "name" : "Adam Kennedy", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2017-07-11T18:45:37.098Z", - "comment" : "This is a comment." - } - "@ - - # Reject Access Request Approval - - try { - $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Deny-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result - - # Below is a request that includes all optional parameters - # Deny-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaAccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-request-identity-metrics#get-access-request-identity-metrics - source: | - $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. - $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. - $Type = "ENTITLEMENT" # String | Requested access item's type. - - # Return access request identity metrics - - try { - Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestIdentityMetrics" - Write-Host $_.ErrorDetails - } -- path: /access-requests/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-requests#cancel-access-request - source: | - $CancelAccessRequest = @" - { - "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I requested this role by mistake." - } - "@ - - # Cancel Access Request - - try { - $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest - Suspend-BetaAccessRequest -CancelAccessRequest $Result - - # Below is a request that includes all optional parameters - # Suspend-BetaAccessRequest -CancelAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaAccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-requests/close - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-requests#close-access-request - source: | - $CloseAccessRequest = @" - { - "executionStatus" : "Terminated", - "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "completionStatus" : "Failure", - "message" : "The IdentityNow Administrator manually closed this request." - } - "@ - - # Close Access Request - - try { - $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest - Close-BetaAccessRequest -CloseAccessRequest $Result - - # Below is a request that includes all optional parameters - # Close-BetaAccessRequest -CloseAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-BetaAccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-requests#create-access-request - source: | - $AccessRequest = @" - { - "requestedFor" : "2c918084660f45d6016617daa9210584", - "clientMetadata" : { - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", - "requestedAppName" : "test-app" - }, - "requestType" : "GRANT_ACCESS", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ], - "requestedForWithRequestedItems" : [ { - "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ] - }, { - "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ] - } ] - } - "@ - - # Submit Access Request - - try { - $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest - New-BetaAccessRequest -AccessRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaAccessRequest -AccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-requests#get-access-request-config - source: | - - # Get Access Request Configuration - - try { - Get-BetaAccessRequestConfig - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /access-request-status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-requests#list-access-request-status - source: | - $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) - $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - - # Access Request Status - - try { - Get-BetaAccessRequestStatus - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestStatus" - Write-Host $_.ErrorDetails - } -- path: /access-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/access-requests#set-access-request-config - source: | - $AccessRequestConfig = @" - { - "requestOnBehalfOfConfig" : { - "allowRequestOnBehalfOfEmployeeByManager" : true, - "allowRequestOnBehalfOfAnyoneByAnyone" : true - }, - "approvalReminderAndEscalationConfig" : { - "fallbackApproverRef" : { - "name" : "Alison Ferguso", - "id" : "5168015d32f890ca15812c9180835d2e", - "type" : "IDENTITY", - "email" : "alison.ferguso@identitysoon.com" - }, - "maxReminders" : 1, - "daysUntilEscalation" : 0, - "daysBetweenReminders" : 0 - }, - "autoApprovalEnabled" : true, - "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - }, - "reauthorizationEnabled" : true, - "approvalsMustBeExternal" : true - } - "@ - - # Update Access Request Configuration - - try { - $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig - Set-BetaAccessRequestConfig -AccessRequestConfig $Result - - # Below is a request that includes all optional parameters - # Set-BetaAccessRequestConfig -AccessRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaAccessRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /account-activities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/account-activities#get-account-activity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id - - # Get Account Activity - - try { - Get-BetaAccountActivity -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccountActivity -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivity" - Write-Host $_.ErrorDetails - } -- path: /account-activities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/account-activities#list-account-activities - source: | - $RequestedFor = "MyRequestedFor" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "MyRequestedBy" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "MyRegardingIdentity" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $Type = "MyType" # String | The type of account activity. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) - $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) - - # List Account Activities - - try { - Get-BetaAccountActivities - - # Below is a request that includes all optional parameters - # Get-BetaAccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivities" - Write-Host $_.ErrorDetails - } -- path: /account-aggregations/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/account-aggregations#get-account-aggregation-status - source: | - $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id - - # In-progress Account Aggregation status - - try { - Get-BetaAccountAggregationStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccountAggregationStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" - Write-Host $_.ErrorDetails - } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-BetaUsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" - Write-Host $_.ErrorDetails - } -- path: /accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#create-account - source: | - $AccountAttributesCreate = @" - { - "attributes" : { - "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - } - "@ - - # Create Account - - try { - $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate - New-BetaAccount -AccountAttributesCreate $Result - - # Below is a request that includes all optional parameters - # New-BetaAccount -AccountAttributesCreate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#delete-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - - # Delete Account - - try { - Remove-BetaAccount -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaAccount -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccount" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#delete-account-async - source: | - $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id - - # Remove Account - - try { - Remove-BetaAccountAsync -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaAccountAsync -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountAsync" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#disable-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $AccountToggleRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } - "@ - - # Disable Account - - try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Disable-BetaAccount -Id $Id -AccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Disable-BetaAccount -Id $Id -AccountToggleRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccount" - Write-Host $_.ErrorDetails - } -- path: /identities-accounts/{id}/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#disable-account-for-identity - source: | - $Id = "2c91808384203c2d018437e631158309" # String | The identity id. - - # Disable IDN Account for Identity - - try { - Disable-BetaAccountForIdentity -Id $Id - - # Below is a request that includes all optional parameters - # Disable-BetaAccountForIdentity -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountForIdentity" - Write-Host $_.ErrorDetails - } -- path: /identities-accounts/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#disable-accounts-for-identities - source: | - $IdentitiesAccountsBulkRequest = @" - { - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - } - "@ - - # Disable IDN Accounts for Identities - - try { - $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Disable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result - - # Below is a request that includes all optional parameters - # Disable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountsForIdentities" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#enable-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $AccountToggleRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } - "@ - - # Enable Account - - try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Enable-BetaAccount -Id $Id -AccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Enable-BetaAccount -Id $Id -AccountToggleRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccount" - Write-Host $_.ErrorDetails - } -- path: /identities-accounts/{id}/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#enable-account-for-identity - source: | - $Id = "2c91808384203c2d018437e631158309" # String | The identity id. - - # Enable IDN Account for Identity - - try { - Enable-BetaAccountForIdentity -Id $Id - - # Below is a request that includes all optional parameters - # Enable-BetaAccountForIdentity -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountForIdentity" - Write-Host $_.ErrorDetails - } -- path: /identities-accounts/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#enable-accounts-for-identities - source: | - $IdentitiesAccountsBulkRequest = @" - { - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - } - "@ - - # Enable IDN Accounts for Identities - - try { - $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Enable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result - - # Below is a request that includes all optional parameters - # Enable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountsForIdentities" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#get-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - - # Account Details - - try { - Get-BetaAccount -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccount -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccount" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#get-account-entitlements - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Account Entitlements - - try { - Get-BetaAccountEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccountEntitlements -Id $Id -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountEntitlements" - Write-Host $_.ErrorDetails - } -- path: /accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#list-accounts - source: | - $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) - - # Accounts List - - try { - Get-BetaAccounts - - # Below is a request that includes all optional parameters - # Get-BetaAccounts -DetailLevel $DetailLevel -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccounts" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#put-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - $AccountAttributes = @" - { - "attributes" : { - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - } - "@ - - # Update Account - - try { - $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes - Send-BetaAccount -Id $Id -AccountAttributes $Result - - # Below is a request that includes all optional parameters - # Send-BetaAccount -Id $Id -AccountAttributes $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaAccount" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/reload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#submit-reload-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - - # Reload Account - - try { - Submit-BetaReloadAccount -Id $Id - - # Below is a request that includes all optional parameters - # Submit-BetaReloadAccount -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReloadAccount" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/unlock - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#unlock-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. - $AccountUnlockRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", - "unlockIDNAccount" : false - } - "@ - - # Unlock Account - - try { - $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest - Unlock-BetaAccount -Id $Id -AccountUnlockRequest $Result - - # Below is a request that includes all optional parameters - # Unlock-BetaAccount -Id $Id -AccountUnlockRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-BetaAccount" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/accounts#update-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@ - - - # Update Account - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaAccount -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaAccount -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" - Write-Host $_.ErrorDetails - } -- path: /discovered-applications/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/application-discovery#get-discovered-application-by-id - source: | - $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. - - # Get Discovered Application by ID - - try { - Get-BetaDiscoveredApplicationByID -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaDiscoveredApplicationByID -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplicationByID" - Write-Host $_.ErrorDetails - } -- path: /discovered-applications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/application-discovery#get-discovered-applications - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) - $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) - - # Retrieve discovered applications for tenant - - try { - Get-BetaDiscoveredApplications - - # Below is a request that includes all optional parameters - # Get-BetaDiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplications" - Write-Host $_.ErrorDetails - } -- path: /manual-discover-applications-template - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/application-discovery#get-manual-discover-applications-csv-template - source: | - - # Download CSV Template for Discovery - - try { - Get-BetaManualDiscoverApplicationsCsvTemplate - - # Below is a request that includes all optional parameters - # Get-BetaManualDiscoverApplicationsCsvTemplate - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails - } -- path: /discovered-applications/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/application-discovery#patch-discovered-application-by-id - source: | - $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. - $JsonPatchOperations = @"{ - "op" : "replace", - "path" : "/dismissed", - "value" : true - }"@ - - - # Patch Discovered Application by ID - - try { - Update-BetaDiscoveredApplicationByID -Id $Id - - # Below is a request that includes all optional parameters - # Update-BetaDiscoveredApplicationByID -Id $Id -JsonPatchOperations $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaDiscoveredApplicationByID" - Write-Host $_.ErrorDetails - } -- path: /manual-discover-applications - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/application-discovery#send-manual-discover-applications-csv-template - source: | - $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - - # Upload CSV to Discover Applications - - try { - Send-BetaManualDiscoverApplicationsCsvTemplate -File $File - - # Below is a request that includes all optional parameters - # Send-BetaManualDiscoverApplicationsCsvTemplate -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails - } -- path: /generic-approvals/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/approvals#get-approval - source: | - $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned. - - # Get Approval - - try { - Get-BetaApproval -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaApproval -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApproval" - Write-Host $_.ErrorDetails - } -- path: /generic-approvals - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/approvals#get-approvals - source: | - $Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional) - $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. (optional) - $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) - - # Get Approvals - - try { - Get-BetaApprovals - - # Below is a request that includes all optional parameters - # Get-BetaApprovals -Mine $Mine -RequesterId $RequesterId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApprovals" - Write-Host $_.ErrorDetails - } -- path: /source-apps - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#create-source-app - source: | - $SourceAppCreateDto = @" - { - "name" : "my app", - "description" : "the source app for engineers", - "accountSource" : { - "name" : "ODS-AD-Source", - "id" : "2c9180827ca885d7017ca8ce28a000eb", - "type" : "SOURCE" - }, - "matchAllAccounts" : true - } - "@ - - # Create source app - - try { - $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto - New-BetaSourceApp -SourceAppCreateDto $Result - - # Below is a request that includes all optional parameters - # New-BetaSourceApp -SourceAppCreateDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id}/access-profiles/bulk-remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#delete-access-profiles-from-source-app-by-bulk - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # Bulk remove access profiles from the specified source app - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-BetaAccessProfilesFromSourceAppByBulk -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-BetaAccessProfilesFromSourceAppByBulk -Id $Id -RequestBody $Result -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesFromSourceAppByBulk" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#delete-source-app - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. - - # Delete source app by ID - - try { - Remove-BetaSourceApp -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSourceApp -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#get-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - - # Get source app by ID - - try { - Get-BetaSourceApp -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSourceApp -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id}/access-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#list-access-profiles-for-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "name eq "developer access profile"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List access profiles for the specified source app - - try { - Get-BetaAccessProfilesForSourceApp -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccessProfilesForSourceApp -Id $Id -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfilesForSourceApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/all - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#list-all-source-app - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - $Filters = "enabled eq true" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) - - # List all source apps - - try { - Get-BetaAllSourceApp - - # Below is a request that includes all optional parameters - # Get-BetaAllSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp" - Write-Host $_.ErrorDetails - } -- path: /user-apps/all - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#list-all-user-apps - source: | - $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List all user apps - - try { - Get-BetaAllUserApps -Filters $Filters - - # Below is a request that includes all optional parameters - # Get-BetaAllUserApps -Filters $Filters -Limit $Limit -Count $Count -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllUserApps" - Write-Host $_.ErrorDetails - } -- path: /source-apps/assigned - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#list-assigned-source-app - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) - $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - - # List assigned source apps - - try { - Get-BetaAssignedSourceApp - - # Below is a request that includes all optional parameters - # Get-BetaAssignedSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAssignedSourceApp" - Write-Host $_.ErrorDetails - } -- path: /user-apps/{id}/available-accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#list-available-accounts-for-user-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List available accounts for user app - - try { - Get-BetaAvailableAccountsForUserApp -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaAvailableAccountsForUserApp -Id $Id -Limit $Limit -Count $Count -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableAccountsForUserApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#list-available-source-apps - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - - # List available source apps - - try { - Get-BetaAvailableSourceApps - - # Below is a request that includes all optional parameters - # Get-BetaAvailableSourceApps -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableSourceApps" - Write-Host $_.ErrorDetails - } -- path: /user-apps - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#list-owned-user-apps - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) - - # List owned user apps - - try { - Get-BetaOwnedUserApps - - # Below is a request that includes all optional parameters - # Get-BetaOwnedUserApps -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOwnedUserApps" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#patch-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch source app by ID - - try { - Update-BetaSourceApp -Id $Id - - # Below is a request that includes all optional parameters - # Update-BetaSourceApp -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp" - Write-Host $_.ErrorDetails - } -- path: /user-apps/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#patch-user-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch user app by ID - - try { - Update-BetaUserApp -Id $Id - - # Below is a request that includes all optional parameters - # Update-BetaUserApp -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/apps#update-source-apps-in-bulk - source: | - $SourceAppBulkUpdateRequest = @" - { - "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : false - }, { - "op" : "replace", - "path" : "/matchAllAccounts", - "value" : false - } ] - } - "@ - - # Bulk update source apps - - try { - Update-BetaSourceAppsInBulk - - # Below is a request that includes all optional parameters - # Update-BetaSourceAppsInBulk -SourceAppBulkUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceAppsInBulk" - Write-Host $_.ErrorDetails - } -- path: /auth-profiles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/auth-profile#get-profile-config - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to get. - - # Get Auth Profile. - - try { - Get-BetaProfileConfig -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaProfileConfig -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/auth-profile#get-profile-config-list - source: | - - # Get list of Auth Profiles. - - try { - Get-BetaProfileConfigList - - # Below is a request that includes all optional parameters - # Get-BetaProfileConfigList - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfigList" - Write-Host $_.ErrorDetails - } -- path: /auth-profiles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/auth-profile#patch-profile-config - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Auth Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaProfileConfig -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaProfileConfig -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProfileConfig" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/complete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#complete-campaign - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. - $CompleteCampaignOptions = @" - { - "autoCompleteAction" : "REVOKE" - } - "@ - - # Complete a Campaign - - try { - Complete-BetaCampaign -Id $Id - - # Below is a request that includes all optional parameters - # Complete-BetaCampaign -Id $Id -CompleteCampaignOptions $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaCampaign" - Write-Host $_.ErrorDetails - } -- path: /campaigns - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#create-campaign - source: | - $Campaign = @" - { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - } - "@ - - # Create Campaign - - try { - $Result = ConvertFrom-JsonToCampaign -Json $Campaign - New-BetaCampaign -Campaign $Result - - # Below is a request that includes all optional parameters - # New-BetaCampaign -Campaign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaign" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#create-campaign-template - source: | - $CampaignTemplate = @" - { - "ownerRef" : { - "name" : "Mister Manager", - "id" : "2c918086676d3e0601677611dbde220f", - "type" : "IDENTITY", - "email" : "mr.manager@example.com" - }, - "deadlineDuration" : "P2W", - "created" : "2020-03-05T22:44:00.364Z", - "scheduled" : false, - "name" : "Manager Campaign Template", - "description" : "Template for the annual manager campaign.", - "modified" : "2020-03-05T22:52:09.969Z", - "campaign" : { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - }, - "id" : "2c9079b270a266a60170a277bb960008" - } - "@ - - # Create a Campaign Template - - try { - $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate - New-BetaCampaignTemplate -CampaignTemplate $Result - - # Below is a request that includes all optional parameters - # New-BetaCampaignTemplate -CampaignTemplate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#delete-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. - - # Delete a Campaign Template - - try { - Remove-BetaCampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaCampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#delete-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. - - # Delete Campaign Template Schedule - - try { - Remove-BetaCampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaCampaignTemplateSchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } -- path: /campaigns/delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#delete-campaigns - source: | - $DeleteCampaignsRequest = @" - { - "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] - } - "@ - - # Delete Campaigns - - try { - $Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest - Remove-BetaCampaigns -DeleteCampaignsRequest $Result - - # Below is a request that includes all optional parameters - # Remove-BetaCampaigns -DeleteCampaignsRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaigns" - Write-Host $_.ErrorDetails - } -- path: /campaigns - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-active-campaigns - source: | - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) - - # List Campaigns - - try { - Get-BetaActiveCampaigns - - # Below is a request that includes all optional parameters - # Get-BetaActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaActiveCampaigns" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. - - # Get Campaign - - try { - Get-BetaCampaign -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaCampaign -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaign" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/reports - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-reports - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. - - # Get Campaign Reports - - try { - Get-BetaCampaignReports -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaCampaignReports -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReports" - Write-Host $_.ErrorDetails - } -- path: /campaigns/reports-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-reports-config - source: | - - # Get Campaign Reports Configuration - - try { - Get-BetaCampaignReportsConfig - - # Below is a request that includes all optional parameters - # Get-BetaCampaignReportsConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReportsConfig" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. - - # Get a Campaign Template - - try { - Get-BetaCampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaCampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. - - # Get Campaign Template Schedule - - try { - Get-BetaCampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaCampaignTemplateSchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-templates - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) - - # List Campaign Templates - - try { - Get-BetaCampaignTemplates - - # Below is a request that includes all optional parameters - # Get-BetaCampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplates" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/reassign - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#move - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID - $AdminReviewReassign = @" - { - "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], - "reason" : "reassigned for some reason", - "reassignTo" : { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "IDENTITY" - } - } - "@ - - # Reassign Certifications - - try { - $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign - Move-Beta -Id $Id -AdminReviewReassign $Result - - # Below is a request that includes all optional parameters - # Move-Beta -Id $Id -AdminReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-Beta" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#patch-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update a Campaign Template - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaCampaignTemplate -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaCampaignTemplate -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaigns/reports-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#set-campaign-reports-config - source: | - $CampaignReportsConfig = @" - { - "identityAttributeColumns" : [ "firstname", "lastname" ] - } - "@ - - # Set Campaign Reports Configuration - - try { - $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig - Set-BetaCampaignReportsConfig -CampaignReportsConfig $Result - - # Below is a request that includes all optional parameters - # Set-BetaCampaignReportsConfig -CampaignReportsConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignReportsConfig" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#set-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. - $Schedule = @" - { - "hours" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "months" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "timeZoneId" : "CST", - "days" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "expiration" : "2000-01-23T04:56:07.000+00:00", - "type" : "WEEKLY" - } - "@ - - # Set Campaign Template Schedule - - try { - Set-BetaCampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Set-BetaCampaignTemplateSchedule -Id $Id -Schedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/activate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-campaign - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. - $ActivateCampaignOptions = @" - { - "timeZone" : "-05:00" - } - "@ - - # Activate a Campaign - - try { - Start-BetaCampaign -Id $Id - - # Below is a request that includes all optional parameters - # Start-BetaCampaign -Id $Id -ActivateCampaignOptions $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaign" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/run-remediation-scan - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-campaign-remediation-scan - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. - - # Run Campaign Remediation Scan - - try { - Start-BetaCampaignRemediationScan -Id $Id - - # Below is a request that includes all optional parameters - # Start-BetaCampaignRemediationScan -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignRemediationScan" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/run-report/{type} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-campaign-report - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. - $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of report to run. - - # Run Campaign Report - - try { - Start-BetaCampaignReport -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Start-BetaCampaignReport -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignReport" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/generate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-generate-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. - - # Generate a Campaign from Template - - try { - Start-BetaGenerateCampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Start-BetaGenerateCampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaGenerateCampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#update-campaign - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign being modified. - $RequestBody = # SystemCollectionsHashtable[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - $RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ - - - # Update a Campaign - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaCampaign -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaCampaign -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaign" - Write-Host $_.ErrorDetails - } -- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certifications#get-identity-certification-item-permissions - source: | - $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID - $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Permissions for Entitlement Certification Item - - try { - Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId - - # Below is a request that includes all optional parameters - # Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationItemPermissions" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/tasks-pending - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certifications#get-identity-certification-pending-tasks - source: | - $Id = "MyId" # String | The identity campaign certification ID - - # Pending Certification Tasks - - try { - Get-BetaIdentityCertificationPendingTasks -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentityCertificationPendingTasks -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationPendingTasks" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/tasks/{taskId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certifications#get-identity-certification-task-status - source: | - $Id = "MyId" # String | The identity campaign certification ID - $TaskId = "MyTaskId" # String | The certification task ID - - # Certification Task Status - - try { - Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId - - # Below is a request that includes all optional parameters - # Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationTaskStatus" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/reviewers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certifications#list-certification-reviewers - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) - - # List of Reviewers for certification - - try { - Get-BetaCertificationReviewers -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaCertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertificationReviewers" - Write-Host $_.ErrorDetails - } -- path: /certifications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certifications#list-certifications - source: | - $ReviewerIdentitiy = "MyReviewerIdentitiy" # String | The ID of reviewer identity. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) - $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) - - # Certifications by IDs - - try { - Get-BetaCertifications - - # Below is a request that includes all optional parameters - # Get-BetaCertifications -ReviewerIdentitiy $ReviewerIdentitiy -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertifications" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/reassign-async - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/certifications#submit-reassign-certs-async - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $ReviewReassign = @" - { - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - } - "@ - - # Reassign Certifications Asynchronously - - try { - $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Submit-BetaReassignCertsAsync -Id $Id -ReviewReassign $Result - - # Below is a request that includes all optional parameters - # Submit-BetaReassignCertsAsync -Id $Id -ReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReassignCertsAsync" - Write-Host $_.ErrorDetails - } -- path: /connector-rules - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#create-connector-rule - source: | - $ConnectorRuleCreateRequest = @" - { - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "type" : "BuildMap" - } - "@ - - # Create Connector Rule - - try { - $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest - New-BetaConnectorRule -ConnectorRuleCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaConnectorRule -ConnectorRuleCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connector-rules/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#delete-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete - - # Delete a Connector-Rule - - try { - Remove-BetaConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaConnectorRule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connector-rules/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#get-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve - - # Connector-Rule by ID - - try { - Get-BetaConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaConnectorRule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connector-rules - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#get-connector-rule-list - source: | - - # List Connector Rules - - try { - Get-BetaConnectorRuleList - - # Below is a request that includes all optional parameters - # Get-BetaConnectorRuleList - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRuleList" - Write-Host $_.ErrorDetails - } -- path: /connector-rules/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#update-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update - $ConnectorRuleUpdateRequest = @" - { - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", - "type" : "BuildMap" - } - "@ - - # Update a Connector Rule - - try { - Update-BetaConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Update-BetaConnectorRule -Id $Id -ConnectorRuleUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connector-rules/validate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#validate-connector-rule - source: | - $SourceCode = @" - { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - } - "@ - - # Validate Connector Rule - - try { - $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode - Confirm-BetaConnectorRule -SourceCode $Result - - # Below is a request that includes all optional parameters - # Confirm-BetaConnectorRule -SourceCode $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Confirm-BetaConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connectors - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/connectors#get-connector-list - source: | - $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector List - - try { - Get-BetaConnectorList - - # Below is a request that includes all optional parameters - # Get-BetaConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorList" - Write-Host $_.ErrorDetails - } -- path: /form-definitions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition - source: | - $CreateFormDefinitionRequest = @" - { - "owner" : { - "name" : "Grant Smith", - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "formConditions" : [ { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - }, { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - } ], - "formInput" : [ { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - }, { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - } ], - "name" : "My form", - "description" : "My form description", - "usedBy" : [ { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - }, { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - } ], - "formElements" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - } ] - } - "@ - - # Creates a form definition. - - try { - New-BetaFormDefinition - - # Below is a request that includes all optional parameters - # New-BetaFormDefinition -CreateFormDefinitionRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinition" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/template - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition-by-template - source: | - $CreateFormDefinitionRequest = @" - { - "owner" : { - "name" : "Grant Smith", - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "formConditions" : [ { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - }, { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - } ], - "formInput" : [ { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - }, { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - } ], - "name" : "My form", - "description" : "My form description", - "usedBy" : [ { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - }, { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - } ], - "formElements" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - } ] - } - "@ - - # Create a form definition by template. - - try { - New-BetaFormDefinitionByTemplate - - # Below is a request that includes all optional parameters - # New-BetaFormDefinitionByTemplate -CreateFormDefinitionRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionByTemplate" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/forms-action-dynamic-schema - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition-dynamic-schema - source: | - $Body = @" - { - "description" : "A description", - "attributes" : { - "formDefinitionId" : "00000000-0000-0000-0000-000000000000" - }, - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "action", - "versionNumber" : 1 - } - "@ - - # Generate JSON Schema dynamically. - - try { - New-BetaFormDefinitionDynamicSchema - - # Below is a request that includes all optional parameters - # New-BetaFormDefinitionDynamicSchema -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionDynamicSchema" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID}/upload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition-file-request - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID - $File = # System.IO.FileInfo | File specifying the multipart - - # Upload new form definition file. - - try { - New-BetaFormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File - - # Below is a request that includes all optional parameters - # New-BetaFormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionFileRequest" - Write-Host $_.ErrorDetails - } -- path: /form-instances - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-instance - source: | - $Body = @" - { - "formInput" : { - "input1" : "Sales" - }, - "standAloneForm" : false, - "createdBy" : { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "WORKFLOW_EXECUTION" - }, - "recipients" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - } ], - "expire" : "2023-08-12T20:14:57.74486Z", - "formDefinitionId" : "00000000-0000-0000-0000-000000000000", - "state" : "ASSIGNED", - "ttl" : 1571827560 - } - "@ - - # Creates a form instance. - - try { - New-BetaFormInstance - - # Below is a request that includes all optional parameters - # New-BetaFormInstance -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormInstance" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#delete-form-definition - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - - # Deletes a form definition. - - try { - Remove-BetaFormDefinition -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Remove-BetaFormDefinition -FormDefinitionID $FormDefinitionID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaFormDefinition" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#export-form-definitions-by-tenant - source: | - $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") - - # List form definitions by tenant. - - try { - Export-BetaFormDefinitionsByTenant - - # Below is a request that includes all optional parameters - # Export-BetaFormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaFormDefinitionsByTenant" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID}/file/{fileID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-file-from-s3 - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID - $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. - - # Download definition file by fileId. - - try { - Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID - - # Below is a request that includes all optional parameters - # Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFileFromS3" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-form-definition-by-key - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - - # Return a form definition. - - try { - Get-BetaFormDefinitionByKey -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Get-BetaFormDefinitionByKey -FormDefinitionID $FormDefinitionID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormDefinitionByKey" - Write-Host $_.ErrorDetails - } -- path: /form-instances/{formInstanceID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-form-instance-by-key - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - - # Returns a form instance. - - try { - Get-BetaFormInstanceByKey -FormInstanceID $FormInstanceID - - # Below is a request that includes all optional parameters - # Get-BetaFormInstanceByKey -FormInstanceID $FormInstanceID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceByKey" - Write-Host $_.ErrorDetails - } -- path: /form-instances/{formInstanceID}/file/{fileID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-form-instance-file - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID - $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. - - # Download instance file by fileId. - - try { - Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID - - # Below is a request that includes all optional parameters - # Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceFile" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#import-form-definitions - source: | - - - - - $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ - - - # Import form definitions from export. - - try { - Import-BetaFormDefinitions - - # Below is a request that includes all optional parameters - # Import-BetaFormDefinitions -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaFormDefinitions" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#patch-form-definition - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) - $Body = @"[{op=replace, path=/description, value=test-description}]"@ - - - # Patch a form definition. - - try { - Update-BetaFormDefinition -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Update-BetaFormDefinition -FormDefinitionID $FormDefinitionID -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormDefinition" - Write-Host $_.ErrorDetails - } -- path: /form-instances/{formInstanceID} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#patch-form-instance - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) - $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ - - - # Patch a form instance. - - try { - Update-BetaFormInstance -FormInstanceID $FormInstanceID - - # Below is a request that includes all optional parameters - # Update-BetaFormInstance -FormInstanceID $FormInstanceID -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormInstance" - Write-Host $_.ErrorDetails - } -- path: /form-definitions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-form-definitions-by-tenant - source: | - $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") - - # Export form definitions by tenant. - - try { - Search-BetaFormDefinitionsByTenant - - # Below is a request that includes all optional parameters - # Search-BetaFormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormDefinitionsByTenant" - Write-Host $_.ErrorDetails - } -- path: /form-instances/{formInstanceID}/data-source/{formElementID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-form-element-data-by-element-id - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - $FormElementID = "1" # String | Form element ID - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) - $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) - - # Retrieves dynamic data by element. - - try { - Search-BetaFormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID - - # Below is a request that includes all optional parameters - # Search-BetaFormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormElementDataByElementID" - Write-Host $_.ErrorDetails - } -- path: /form-instances - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-form-instances-by-tenant - source: | - - # List form instances by tenant. - - try { - Search-BetaFormInstancesByTenant - - # Below is a request that includes all optional parameters - # Search-BetaFormInstancesByTenant - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormInstancesByTenant" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/predefined-select-options - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-pre-defined-select-options - source: | - - # List predefined select options. - - try { - Search-BetaPreDefinedSelectOptions - - # Below is a request that includes all optional parameters - # Search-BetaPreDefinedSelectOptions - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPreDefinedSelectOptions" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID}/data-source - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-forms#show-preview-data-source - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) - $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) - $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) - $FormElementPreviewRequest = @" - { - "dataSource" : { - "config" : { - "indices" : [ "identities" ], - "query" : "*", - "aggregationBucketField" : "attributes.cloudStatus.exact", - "objectType" : "IDENTITY" - }, - "dataSourceType" : "STATIC" - } - } - "@ - - # Preview form definition data source. - - try { - Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaPreviewDataSource" - Write-Host $_.ErrorDetails - } -- path: /custom-password-instructions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-password-instructions#create-custom-password-instructions - source: | - $CustomPasswordInstruction = @" - { - "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", - "pageId" : "change-password:enter-password", - "locale" : "en" - } - "@ - - # Create Custom Password Instructions - - try { - $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction - New-BetaCustomPasswordInstructions -CustomPasswordInstruction $Result - - # Below is a request that includes all optional parameters - # New-BetaCustomPasswordInstructions -CustomPasswordInstruction $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCustomPasswordInstructions" - Write-Host $_.ErrorDetails - } -- path: /custom-password-instructions/{pageId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-password-instructions#delete-custom-password-instructions - source: | - $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. - $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - - # Delete Custom Password Instructions by page ID - - try { - Remove-BetaCustomPasswordInstructions -PageId $PageId - - # Below is a request that includes all optional parameters - # Remove-BetaCustomPasswordInstructions -PageId $PageId -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCustomPasswordInstructions" - Write-Host $_.ErrorDetails - } -- path: /custom-password-instructions/{pageId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/custom-password-instructions#get-custom-password-instructions - source: | - $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. - $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - - # Get Custom Password Instructions by Page ID - - try { - Get-BetaCustomPasswordInstructions -PageId $PageId - - # Below is a request that includes all optional parameters - # Get-BetaCustomPasswordInstructions -PageId $PageId -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomPasswordInstructions" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/entitlements#create-access-model-metadata-for-entitlement - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - - # Add metadata to an entitlement. - - try { - New-BetaAccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - - # Below is a request that includes all optional parameters - # New-BetaAccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessModelMetadataForEntitlement" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/entitlements#delete-access-model-metadata-from-entitlement - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - - # Remove metadata from an entitlement. - - try { - Remove-BetaAccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - - # Below is a request that includes all optional parameters - # Remove-BetaAccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessModelMetadataFromEntitlement" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/entitlements#get-entitlement - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID - - # Get an entitlement - - try { - Get-BetaEntitlement -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaEntitlement -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlement" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/entitlement-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/entitlements#get-entitlement-request-config - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id - - # Get Entitlement Request Config - - try { - Get-BetaEntitlementRequestConfig -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementRequestConfig -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /entitlements/aggregate/sources/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/entitlements#import-entitlements-by-source - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id - $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) - - # Aggregate Entitlements - - try { - Import-BetaEntitlementsBySource -Id $Id - - # Below is a request that includes all optional parameters - # Import-BetaEntitlementsBySource -Id $Id -CsvFile $CsvFile - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlementsBySource" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/children - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/entitlements#list-entitlement-children - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List of entitlements children - - try { - Get-BetaEntitlementChildren -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementChildren -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChildren" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/parents - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/entitlements#list-entitlement-parents - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List of entitlements parents - - try { - Get-BetaEntitlementParents -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementParents -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementParents" - Write-Host $_.ErrorDetails - } -- path: /entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/entitlements#list-entitlements - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) - $SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) - $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) - $IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - - # Gets a list of entitlements. - - try { - Get-BetaEntitlements - - # Below is a request that includes all optional parameters - # Get-BetaEntitlements -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlements" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/entitlements#patch-entitlement - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch an entitlement - - try { - Update-BetaEntitlement -Id $Id - - # Below is a request that includes all optional parameters - # Update-BetaEntitlement -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlement" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/entitlement-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/entitlements#put-entitlement-request-config - source: | - $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID - $EntitlementRequestConfig = @" - { - "accessRequestConfig" : { - "denialCommentRequired" : false, - "approvalSchemes" : [ { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - } ], - "requestCommentRequired" : true - } - } - "@ - - # Replace Entitlement Request Config - - try { - $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig - Send-BetaEntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Send-BetaEntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /entitlements/reset/sources/{sourceId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/entitlements#reset-source-entitlements - source: | - $SourceId = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset - - # Reset Source Entitlements - - try { - Reset-BetaSourceEntitlements -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Reset-BetaSourceEntitlements -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaSourceEntitlements" - Write-Host $_.ErrorDetails - } -- path: /entitlements/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/entitlements#update-entitlements-in-bulk - source: | - $EntitlementBulkUpdateRequest = @" - { - "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/privileged", - "value" : false - }, { - "op" : "replace", - "path" : "/requestable", - "value" : false - } ] - } - "@ - - # Bulk update an entitlement list - - try { - $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest - Update-BetaEntitlementsInBulk -EntitlementBulkUpdateRequest $Result - - # Below is a request that includes all optional parameters - # Update-BetaEntitlementsInBulk -EntitlementBulkUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsInBulk" - Write-Host $_.ErrorDetails - } -- path: /workgroups - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/governance-groups#create-workgroup - source: | - $WorkgroupDto = @" - { - "owner" : { - "emailAddress" : "support@sailpoint.com", - "displayName" : "Support", - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "connectionCount" : 1641498673000, - "created" : "2022-01-06T19:51:13Z", - "memberCount" : 1641498673000, - "name" : "DB Access Governance Group", - "description" : "Description of the Governance Group", - "modified" : "2022-01-06T19:51:13Z", - "id" : "2c91808568c529c60168cca6f90c1313" - } - "@ - - # Create a new Governance Group. - - try { - $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto - New-BetaWorkgroup -WorkgroupDto $Result - - # Below is a request that includes all optional parameters - # New-BetaWorkgroup -WorkgroupDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkgroup" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/governance-groups#delete-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - - # Delete a Governance Group - - try { - Remove-BetaWorkgroup -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaWorkgroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroup" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{workgroupId}/members/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/governance-groups#delete-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $BulkWorkgroupMembersRequestInner = @""@ - - - # Remove members from Governance Group - - try { - $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner - Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result - - # Below is a request that includes all optional parameters - # Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupMembers" - Write-Host $_.ErrorDetails - } -- path: /workgroups/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/governance-groups#delete-workgroups-in-bulk - source: | - $WorkgroupBulkDeleteRequest = @" - { - "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] - } - "@ - - # Delete Governance Group(s) - - try { - $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest - Remove-BetaWorkgroupsInBulk -WorkgroupBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-BetaWorkgroupsInBulk -WorkgroupBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupsInBulk" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/governance-groups#get-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - - # Get Governance Group by Id - - try { - Get-BetaWorkgroup -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkgroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroup" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{workgroupId}/connections - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/governance-groups#list-connections - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List connections for Governance Group - - try { - Get-BetaConnections -WorkgroupId $WorkgroupId - - # Below is a request that includes all optional parameters - # Get-BetaConnections -WorkgroupId $WorkgroupId -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnections" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{workgroupId}/members - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/governance-groups#list-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Governance Group Members - - try { - Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId - - # Below is a request that includes all optional parameters - # Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroupMembers" - Write-Host $_.ErrorDetails - } -- path: /workgroups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/governance-groups#list-workgroups - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw "Test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) - - # List Governance Groups - - try { - Get-BetaWorkgroups - - # Below is a request that includes all optional parameters - # Get-BetaWorkgroups -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroups" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/governance-groups#patch-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Governance Group - - try { - Update-BetaWorkgroup -Id $Id - - # Below is a request that includes all optional parameters - # Update-BetaWorkgroup -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroup" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{workgroupId}/members/bulk-add - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/governance-groups#update-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $BulkWorkgroupMembersRequestInner = @""@ - - - # Add members to Governance Group - - try { - $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner - Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroupMembers" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/ignored-items - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item - source: | - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Ignore Access Request Recommendation - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsIgnoredItem -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsIgnoredItem -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsIgnoredItem" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/requested-items - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item - source: | - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Accept Access Request Recommendation - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsRequestedItem -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsRequestedItem -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsRequestedItem" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/viewed-items - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item - source: | - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Mark Viewed Access Request Recommendations - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsViewedItem -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsViewedItem -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItem" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/viewed-items/bulk-create - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items - source: | - $AccessRequestRecommendationActionItemDto = @"{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - }"@ - - - # Bulk Mark Viewed Access Request Recommendations - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsViewedItems -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsViewedItems -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItems" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations - source: | - $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") - $Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) - $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) - - # Identity Access Request Recommendations - - try { - Get-BetaAccessRequestRecommendations - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestRecommendations -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendations" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/ignored-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Ignored Access Request Recommendations - - try { - Get-BetaAccessRequestRecommendationsIgnoredItems - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestRecommendationsIgnoredItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsIgnoredItems" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/requested-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Accepted Access Request Recommendations - - try { - Get-BetaAccessRequestRecommendationsRequestedItems - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestRecommendationsRequestedItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsRequestedItems" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/viewed-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Viewed Access Request Recommendations - - try { - Get-BetaAccessRequestRecommendationsViewedItems - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestRecommendationsViewedItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsViewedItems" - Write-Host $_.ErrorDetails - } -- path: /common-access - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-common-access#create-common-access - source: | - $CommonAccessItemRequest = @" - { - "access" : { - "ownerName" : "ownerName", - "name" : "name", - "description" : "description", - "id" : "id", - "type" : "ACCESS_PROFILE", - "ownerId" : "ownerId" - }, - "status" : "CONFIRMED" - } - "@ - - # Create common access items - - try { - $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest - New-BetaCommonAccess -CommonAccessItemRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaCommonAccess -CommonAccessItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess" - Write-Host $_.ErrorDetails - } -- path: /common-access - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-common-access#get-common-access - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.type eq "ROLE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) - - # Get a paginated list of common access - - try { - Get-BetaCommonAccess - - # Below is a request that includes all optional parameters - # Get-BetaCommonAccess -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCommonAccess" - Write-Host $_.ErrorDetails - } -- path: /common-access/update-status - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-common-access#update-common-access-status-in-bulk - source: | - $CommonAccessIDStatus = @"{ - "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], - "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] - }"@ - - - # Bulk update common access status - - try { - $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus - Update-BetaCommonAccessStatusInBulk -CommonAccessIDStatus $Result - - # Below is a request that includes all optional parameters - # Update-BetaCommonAccessStatusInBulk -CommonAccessIDStatus $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCommonAccessStatusInBulk" - Write-Host $_.ErrorDetails - } -- path: /translation-catalogs/{catalog-id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-message-catalogs#get-message-catalogs - source: | - $CatalogId = "recommender" # String | The ID of the message catalog. - - # Get Message catalogs - - try { - Get-BetaMessageCatalogs -CatalogId $CatalogId - - # Below is a request that includes all optional parameters - # Get-BetaMessageCatalogs -CatalogId $CatalogId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMessageCatalogs" - Write-Host $_.ErrorDetails - } -- path: /outliers/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#export-outliers-zip - source: | - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - - # IAI Identity Outliers Export - - try { - Export-BetaOutliersZip - - # Below is a request that includes all optional parameters - # Export-BetaOutliersZip -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaOutliersZip" - Write-Host $_.ErrorDetails - } -- path: /outlier-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-identity-outlier-snapshots - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) - $Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) - - # IAI Identity Outliers Summary - - try { - Get-BetaIdentityOutlierSnapshots - - # Below is a request that includes all optional parameters - # Get-BetaIdentityOutlierSnapshots -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutlierSnapshots" - Write-Host $_.ErrorDetails - } -- path: /outliers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-identity-outliers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) - $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) - - # IAI Get Identity Outliers - - try { - Get-BetaIdentityOutliers - - # Below is a request that includes all optional parameters - # Get-BetaIdentityOutliers -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutliers" - Write-Host $_.ErrorDetails - } -- path: /outlier-summaries/latest - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-latest-identity-outlier-snapshots - source: | - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - - # IAI Identity Outliers Latest Summary - - try { - Get-BetaLatestIdentityOutlierSnapshots - - # Below is a request that includes all optional parameters - # Get-BetaLatestIdentityOutlierSnapshots -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLatestIdentityOutlierSnapshots" - Write-Host $_.ErrorDetails - } -- path: /outlier-feature-summaries/{outlierFeatureId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-outlier-contributing-feature-summary - source: | - $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id - - # Get identity outlier contibuting feature summary - - try { - Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId - - # Below is a request that includes all optional parameters - # Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutlierContributingFeatureSummary" - Write-Host $_.ErrorDetails - } -- path: /outliers/{outlierId}/contributing-features - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-peer-group-outliers-contributing-features - source: | - $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) - $Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) - - # Get identity outlier's contibuting features - - try { - Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId - - # Below is a request that includes all optional parameters - # Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliersContributingFeatures" - Write-Host $_.ErrorDetails - } -- path: /outliers/ignore - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#ignore-identity-outliers - source: | - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - - - # IAI Identity Outliers Ignore - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result - - # Below is a request that includes all optional parameters - # Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaIgnoreIdentityOutliers" - Write-Host $_.ErrorDetails - } -- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#list-outliers-contributing-feature-access-items - source: | - $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id - $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) - $Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) - - # Gets a list of access items associated with each identity outlier contributing feature - - try { - Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName - - # Below is a request that includes all optional parameters - # Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutliersContributingFeatureAccessItems" - Write-Host $_.ErrorDetails - } -- path: /outliers/unignore - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#un-ignore-identity-outliers - source: | - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - - - # IAI Identity Outliers Unignore - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result - - # Below is a request that includes all optional parameters - # Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaUnIgnoreIdentityOutliers" - Write-Host $_.ErrorDetails - } -- path: /peer-group-strategies/{strategy}/identity-outliers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-peer-group-strategies#get-peer-group-outliers - source: | - $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Identity Outliers List - - try { - Get-BetaPeerGroupOutliers -Strategy $Strategy - - # Below is a request that includes all optional parameters - # Get-BetaPeerGroupOutliers -Strategy $Strategy -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliers" - Write-Host $_.ErrorDetails - } -- path: /recommendations/request - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#get-recommendations - source: | - $RecommendationRequestDto = @" - { - "prescribeMode" : false, - "excludeInterpretations" : false, - "requests" : [ { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - }, { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - } ], - "includeTranslationMessages" : false, - "includeDebugInformation" : true - } - "@ - - # Returns Recommendation Based on Object - - try { - $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto - Get-BetaRecommendations -RecommendationRequestDto $Result - - # Below is a request that includes all optional parameters - # Get-BetaRecommendations -RecommendationRequestDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations" - Write-Host $_.ErrorDetails - } -- path: /recommendations/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#get-recommendations-config - source: | - - # Get certification recommendation config values - - try { - Get-BetaRecommendationsConfig - - # Below is a request that includes all optional parameters - # Get-BetaRecommendationsConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendationsConfig" - Write-Host $_.ErrorDetails - } -- path: /recommendations/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#update-recommendations-config - source: | - $RecommendationConfigDto = @" - { - "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], - "peerGroupPercentageThreshold" : 0.5, - "runAutoSelectOnce" : false, - "onlyTuneThreshold" : false - } - "@ - - # Update certification recommendation config values - - try { - $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto - Update-BetaRecommendationsConfig -RecommendationConfigDto $Result - - # Below is a request that includes all optional parameters - # Update-BetaRecommendationsConfig -RecommendationConfigDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRecommendationsConfig" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#create-potential-role-provision-request - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) - $RoleMiningPotentialRoleProvisionRequest = @" - { - "includeIdentities" : true, - "roleName" : "Finance - Accounting", - "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", - "roleDescription" : "General access for accounting department", - "directlyAssignedEntitlements" : false - } - "@ - - # Create request to provision a potential role into an actual role. - - try { - New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPotentialRoleProvisionRequest" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#create-role-mining-sessions - source: | - $RoleMiningSessionDto = @" - { - "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", - "prescribedPruneThreshold" : 10, - "pruneThreshold" : 50, - "saved" : true, - "potentialRolesReadyCount" : 0, - "scope" : { - "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], - "attributeFilterCriteria" : { - "displayName" : { - "untranslated" : "Location: Miami" - }, - "ariaLabel" : { - "untranslated" : "Location: Miami" - }, - "data" : { - "displayName" : { - "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" - }, - "name" : "location", - "operator" : "EQUALS", - "values" : [ "Miami" ] - } - }, - "criteria" : "source.name:DataScienceDataset" - }, - "potentialRoleCount" : 0, - "name" : "Saved RM Session - 07/10", - "minNumIdentitiesInPotentialRole" : 20, - "identityCount" : 0, - "type" : "SPECIALIZED" - } - "@ - - # Create a role mining session - - try { - $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto - New-BetaRoleMiningSessions -RoleMiningSessionDto $Result - - # Below is a request that includes all optional parameters - # New-BetaRoleMiningSessions -RoleMiningSessionDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleMiningSessions" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#download-role-mining-potential-role-zip - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role - - # Export (download) details for a potential role in a role mining session - - try { - Invoke-BetaDownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId - - # Below is a request that includes all optional parameters - # Invoke-BetaDownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleMiningPotentialRoleZip" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#export-role-mining-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - - # Export (download) details for a potential role in a role mining session - - try { - Export-BetaRoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Export-BetaRoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#export-role-mining-potential-role-async - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $RoleMiningPotentialRoleExportRequest = @" - { - "minEntitlementPopularity" : 0, - "includeCommonAccess" : true - } - "@ - - # Asynchronously export details for a potential role in a role mining session and upload to S3 - - try { - Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleExportRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleAsync" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#export-role-mining-potential-role-status - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role - - # Retrieve status of a potential role export job - - try { - Export-BetaRoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId - - # Below is a request that includes all optional parameters - # Export-BetaRoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleStatus" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-all-potential-role-summaries - source: | - $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) - $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all potential role summaries - - try { - Get-BetaAllPotentialRoleSummaries - - # Below is a request that includes all optional parameters - # Get-BetaAllPotentialRoleSummaries -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllPotentialRoleSummaries" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-entitlement-distribution-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) - - # Retrieves entitlement popularity distribution for a potential role in a role mining session - - try { - Get-BetaEntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -IncludeCommonAccess $IncludeCommonAccess - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementDistributionPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) - $Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) - $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves entitlements for a potential role in a role mining session - - try { - Get-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-excluded-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) - $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves excluded entitlements for a potential role in a role mining session - - try { - Get-BetaExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaExcludedEntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-identities-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves identities for a potential role in a role mining session - - try { - Get-BetaIdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaIdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitiesPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - - # Retrieve potential role in session - - try { - Get-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-applications - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session - $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves the applications of a potential role for a role mining session - - try { - Get-BetaPotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaPotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleApplications" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-entitlements - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session - $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves the entitlements of a potential role for a role mining session - - try { - Get-BetaPotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaPotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleEntitlements" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-source-identity-usage - source: | - $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id - $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id - $Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves potential role source usage - - try { - Get-BetaPotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaPotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSourceIdentityUsage" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-summaries - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) - $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieve session's potential role summaries - - try { - Get-BetaPotentialRoleSummaries -SessionId $SessionId - - # Below is a request that includes all optional parameters - # Get-BetaPotentialRoleSummaries -SessionId $SessionId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSummaries" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles/{potentialRoleId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-potential-role - source: | - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id - - # Retrieves a specific potential role - - try { - Get-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-session - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. - - # Get a role mining session - - try { - Get-BetaRoleMiningSession -SessionId $SessionId - - # Below is a request that includes all optional parameters - # Get-BetaRoleMiningSession -SessionId $SessionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSession" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-session-status - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - - # Get role mining session status state - - try { - Get-BetaRoleMiningSessionStatus -SessionId $SessionId - - # Below is a request that includes all optional parameters - # Get-BetaRoleMiningSessionStatus -SessionId $SessionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessionStatus" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-sessions - source: | - $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) - $Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all role mining sessions - - try { - Get-BetaRoleMiningSessions - - # Below is a request that includes all optional parameters - # Get-BetaRoleMiningSessions -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessions" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles/saved - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-saved-potential-roles - source: | - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all saved potential roles - - try { - Get-BetaSavedPotentialRoles - - # Below is a request that includes all optional parameters - # Get-BetaSavedPotentialRoles -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSavedPotentialRoles" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#patch-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id - $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ - - - # Update a potential role in session - - try { - $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles/{potentialRoleId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#patch-role-mining-potential-role - source: | - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id - $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ - - - # Update a potential role - - try { - $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#patch-role-mining-session - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a role mining session - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaRoleMiningSession -SessionId $SessionId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaRoleMiningSession -SessionId $SessionId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningSession" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#update-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $RoleMiningPotentialRoleEditEntitlements = @" - { - "ids" : [ "entId1", "entId2" ], - "exclude" : true - } - "@ - - # Edit entitlements for a potential role to exclude some entitlements - - try { - $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements - Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleEditEntitlements $Result - - # Below is a request that includes all optional parameters - # Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleEditEntitlements $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /icons/{objectType}/{objectId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/icons#delete-icon - source: | - $ObjectType = "application" # String | Object type - $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. - - # Delete an icon - - try { - Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId - - # Below is a request that includes all optional parameters - # Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIcon" - Write-Host $_.ErrorDetails - } -- path: /icons/{objectType}/{objectId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/icons#set-icon - source: | - $ObjectType = "application" # String | Object type - $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. - $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] - - # Update an icon - - try { - Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image - - # Below is a request that includes all optional parameters - # Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIcon" - Write-Host $_.ErrorDetails - } -- path: /identities/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identities#delete-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - - # Delete identity - - try { - Remove-BetaIdentity -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaIdentity -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentity" - Write-Host $_.ErrorDetails - } -- path: /identities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identities#get-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - - # Identity Details - - try { - Get-BetaIdentity -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentity -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentity" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/ownership - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identities#get-identity-ownership-details - source: | - $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. - - # Get ownership details - - try { - Get-BetaIdentityOwnershipDetails -IdentityId $IdentityId - - # Below is a request that includes all optional parameters - # Get-BetaIdentityOwnershipDetails -IdentityId $IdentityId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOwnershipDetails" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/role-assignments/{assignmentId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identities#get-role-assignment - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id - - # Role assignment details - - try { - Get-BetaRoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId - - # Below is a request that includes all optional parameters - # Get-BetaRoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignment" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/role-assignments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identities#get-role-assignments - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for - $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) - $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) - - # List role assignments - - try { - Get-BetaRoleAssignments -IdentityId $IdentityId - - # Below is a request that includes all optional parameters - # Get-BetaRoleAssignments -IdentityId $IdentityId -RoleId $RoleId -RoleName $RoleName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignments" - Write-Host $_.ErrorDetails - } -- path: /identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identities#list-identities - source: | - $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) - $Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) - $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Identities - - try { - Get-BetaIdentities - - # Below is a request that includes all optional parameters - # Get-BetaIdentities -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentities" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/reset - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identities#reset-identity - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - - # Reset an identity - - try { - Reset-BetaIdentity -IdentityId $IdentityId - - # Below is a request that includes all optional parameters - # Reset-BetaIdentity -IdentityId $IdentityId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaIdentity" - Write-Host $_.ErrorDetails - } -- path: /identities/{id}/verification/account/send - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identities#send-identity-verification-account-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - $SendAccountVerificationRequest = @" - { - "sourceName" : "Active Directory Source", - "via" : "EMAIL_WORK" - } - "@ - - # Send password reset email - - try { - $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest - Send-BetaIdentityVerificationAccountToken -Id $Id -SendAccountVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaIdentityVerificationAccountToken -Id $Id -SendAccountVerificationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityVerificationAccountToken" - Write-Host $_.ErrorDetails - } -- path: /identities/invite - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identities#start-identities-invite - source: | - $InviteIdentitiesRequest = @" - { - "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], - "uninvited" : false - } - "@ - - # Invite identities to register - - try { - $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest - Start-BetaIdentitiesInvite -InviteIdentitiesRequest $Result - - # Below is a request that includes all optional parameters - # Start-BetaIdentitiesInvite -InviteIdentitiesRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentitiesInvite" - Write-Host $_.ErrorDetails - } -- path: /identities/process - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identities#start-identity-processing - source: | - $ProcessIdentitiesRequest = @" - { - "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] - } - "@ - - # Process a list of identityIds - - try { - $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest - Start-BetaIdentityProcessing -ProcessIdentitiesRequest $Result - - # Below is a request that includes all optional parameters - # Start-BetaIdentityProcessing -ProcessIdentitiesRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentityProcessing" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/synchronize-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identities#synchronize-attributes-for-identity - source: | - $IdentityId = "MyIdentityId" # String | The Identity id - - # Attribute synchronization for single identity. - - try { - Sync-BetahronizeAttributesForIdentity -IdentityId $IdentityId - - # Below is a request that includes all optional parameters - # Sync-BetahronizeAttributesForIdentity -IdentityId $IdentityId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetahronizeAttributesForIdentity" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#create-identity-attribute - source: | - $IdentityAttribute = @" - { - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - } - "@ - - # Create Identity Attribute - - try { - $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - New-BetaIdentityAttribute -IdentityAttribute $Result - - # Below is a request that includes all optional parameters - # New-BetaIdentityAttribute -IdentityAttribute $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#delete-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - - # Delete Identity Attribute - - try { - Remove-BetaIdentityAttribute -Name $Name - - # Below is a request that includes all optional parameters - # Remove-BetaIdentityAttribute -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttribute" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes/bulk-delete - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#delete-identity-attributes-in-bulk - source: | - $IdentityAttributeNames = @" - { - "ids" : [ "name", "displayName" ] - } - "@ - - # Bulk delete Identity Attributes - - try { - $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames - Remove-BetaIdentityAttributesInBulk -IdentityAttributeNames $Result - - # Below is a request that includes all optional parameters - # Remove-BetaIdentityAttributesInBulk -IdentityAttributeNames $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#get-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - - # Get Identity Attribute - - try { - Get-BetaIdentityAttribute -Name $Name - - # Below is a request that includes all optional parameters - # Get-BetaIdentityAttribute -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttribute" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#list-identity-attributes - source: | - $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) - $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) - $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Identity Attributes - - try { - Get-BetaIdentityAttributes - - # Below is a request that includes all optional parameters - # Get-BetaIdentityAttributes -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttributes" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes/{name} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#put-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $IdentityAttribute = @" - { - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - } - "@ - - # Update Identity Attribute - - try { - $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - Send-BetaIdentityAttribute -Name $Name -IdentityAttribute $Result - - # Below is a request that includes all optional parameters - # Send-BetaIdentityAttribute -Name $Name -IdentityAttribute $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityAttribute" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/compare - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-history#compare-identity-snapshots - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) - $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) - $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets a difference of count for each access item types for the given identity between 2 snapshots - - try { - Compare-BetaIdentitySnapshots -Id $Id - - # Below is a request that includes all optional parameters - # Compare-BetaIdentitySnapshots -Id $Id -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshots" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/compare/{accessType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-history#compare-identity-snapshots-access-type - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $AccessType = "accessProfile" # String | The specific type which needs to be compared - $AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) - $Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) - $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets a list of differences of specific accessType for the given identity between 2 snapshots - - try { - Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType - - # Below is a request that includes all optional parameters - # Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshotsAccessType" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-historical-identity - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - - # Get latest snapshot of identity - - try { - Get-BetaHistoricalIdentity -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaHistoricalIdentity -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentity" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/events - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-historical-identity-events - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) - $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) - - $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ - $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - $AccessItemTypes = @"[entitlement, account]"@ - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Lists all events for the given identity - - try { - Get-BetaHistoricalIdentityEvents -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaHistoricalIdentityEvents -Id $Id -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentityEvents" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/snapshots/{date} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-identity-snapshot - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Date = "2007-03-01T13:00:00Z" # String | The specified date - - # Gets an identity snapshot at a given date - - try { - Get-BetaIdentitySnapshot -Id $Id -Date $Date - - # Below is a request that includes all optional parameters - # Get-BetaIdentitySnapshot -Id $Id -Date $Date - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshot" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/snapshot-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-identity-snapshot-summary - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) - $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) - $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets the summary for the event count for a specific identity - - try { - Get-BetaIdentitySnapshotSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentitySnapshotSummary -Id $Id -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotSummary" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/start-date - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-identity-start-date - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - - # Gets the start date of the identity - - try { - Get-BetaIdentityStartDate -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentityStartDate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityStartDate" - Write-Host $_.ErrorDetails - } -- path: /historical-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-historical-identities - source: | - $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) - $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) - $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # Lists all the identities - - try { - Get-BetaHistoricalIdentities - - # Below is a request that includes all optional parameters - # Get-BetaHistoricalIdentities -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentities" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/access-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-identity-access-items - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) - $Filters = "source eq "DataScienceDataset"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) - $Query = "Dr. Arden" # String | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Access Items by Identity - - try { - Get-BetaIdentityAccessItems -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentityAccessItems -Id $Id -Type $Type -Filters $Filters -Sorters $Sorters -Query $Query -Limit $Limit -Count $Count -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAccessItems" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/snapshots/{date}/access-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-identity-snapshot-access-items - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Identity ID. - $Date = "2007-03-01T13:00:00Z" # String | Specified date. - $Type = "role" # String | Access item type. (optional) - - # Get Identity Access Items Snapshot - - try { - Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date - - # Below is a request that includes all optional parameters - # Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotAccessItems" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/snapshots - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-identity-snapshots - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) - $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Lists all the snapshots for the identity - - try { - Get-BetaIdentitySnapshots -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentitySnapshots -Id $Id -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshots" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#create-identity-profile - source: | - $IdentityProfile = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2023-01-03T21:16:22.432Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2023-01-03T21:16:22.432Z", - "id" : "id12345" - } - "@ - - # Create Identity Profile - - try { - $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-BetaIdentityProfile -IdentityProfile $Result - - # Below is a request that includes all optional parameters - # New-BetaIdentityProfile -IdentityProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#delete-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - - # Delete Identity Profile - - try { - Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#delete-identity-profiles - source: | - $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. - $RequestBody = @""@ - - - # Delete Identity Profiles - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-BetaIdentityProfiles -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-BetaIdentityProfiles -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#export-identity-profiles - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) - $Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) - - # Export Identity Profiles - - try { - Export-BetaIdentityProfiles - - # Below is a request that includes all optional parameters - # Export-BetaIdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaIdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#get-default-identity-attribute-config - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID - - # Default identity attribute config - - try { - Get-BetaDefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-BetaDefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultIdentityAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#get-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - - # Get Identity Profile - - try { - Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#import-identity-profiles - source: | - - - - - - $IdentityProfileExportedObject = @"{ - "self" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "version" : 1, - "object" : { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - }"@ - - - # Import Identity Profiles - - try { - $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-BetaIdentityProfiles -IdentityProfileExportedObject $Result - - # Below is a request that includes all optional parameters - # Import-BetaIdentityProfiles -IdentityProfileExportedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaIdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#list-identity-profiles - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) - $Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - - # List Identity Profiles - - try { - Get-BetaIdentityProfiles - - # Below is a request that includes all optional parameters - # Get-BetaIdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/identity-preview - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#show-generate-identity-preview - source: | - $IdentityPreviewRequest = @" - { - "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - } - } - "@ - - # Generate Identity Profile Preview - - try { - $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - Show-BetaGenerateIdentityPreview -IdentityPreviewRequest $Result - - # Below is a request that includes all optional parameters - # Show-BetaGenerateIdentityPreview -IdentityPreviewRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaGenerateIdentityPreview" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/process-identities - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#sync-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed - - # Process identities under profile - - try { - Sync-BetaIdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Sync-BetaIdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaIdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#update-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Identity Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaIdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /launchers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/launchers#create-launcher - source: | - $LauncherRequest = @" - { - "reference" : { - "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", - "type" : "WORKFLOW" - }, - "name" : "Group Create", - "description" : "Create a new Active Directory Group", - "disabled" : false, - "type" : "INTERACTIVE_PROCESS", - "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" - } - "@ - - # Create launcher - - try { - $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest - New-BetaLauncher -LauncherRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaLauncher -LauncherRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher" - Write-Host $_.ErrorDetails - } -- path: /launchers/{launcherID} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/launchers#delete-launcher - source: | - $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted - - # Delete Launcher - - try { - Remove-BetaLauncher -LauncherID $LauncherID - - # Below is a request that includes all optional parameters - # Remove-BetaLauncher -LauncherID $LauncherID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaLauncher" - Write-Host $_.ErrorDetails - } -- path: /launchers/{launcherID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/launchers#get-launcher - source: | - $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved - - # Get Launcher by ID - - try { - Get-BetaLauncher -LauncherID $LauncherID - - # Below is a request that includes all optional parameters - # Get-BetaLauncher -LauncherID $LauncherID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLauncher" - Write-Host $_.ErrorDetails - } -- path: /launchers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/launchers#get-launchers - source: | - $Filters = "disabled eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) - $Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional) - $Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10) - - # List all Launchers for tenant - - try { - Get-BetaLaunchers - - # Below is a request that includes all optional parameters - # Get-BetaLaunchers -Filters $Filters -Next $Next -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLaunchers" - Write-Host $_.ErrorDetails - } -- path: /launchers/{launcherID} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/launchers#put-launcher - source: | - $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced - $LauncherRequest = @" - { - "reference" : { - "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", - "type" : "WORKFLOW" - }, - "name" : "Group Create", - "description" : "Create a new Active Directory Group", - "disabled" : false, - "type" : "INTERACTIVE_PROCESS", - "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" - } - "@ - - # Replace Launcher - - try { - $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest - Send-BetaLauncher -LauncherID $LauncherID -LauncherRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaLauncher -LauncherID $LauncherID -LauncherRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaLauncher" - Write-Host $_.ErrorDetails - } -- path: /beta/launchers/{launcherID}/launch - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/launchers#start-launcher - source: | - $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched - - # Launch a Launcher - - try { - Start-BetaLauncher -LauncherID $LauncherID - - # Below is a request that includes all optional parameters - # Start-BetaLauncher -LauncherID $LauncherID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/lifecycle-states#get-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. - - # Get Lifecycle State - - try { - Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLifecycleStates" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/lifecycle-states#update-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Lifecycle State - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/delete - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#delete-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # Delete MFA method configuration - - try { - Remove-BetaMFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Remove-BetaMFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMFAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-BetaMFADuoConfig - - # Below is a request that includes all optional parameters - # Get-BetaMFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-BetaMFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-BetaMFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAKbaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-BetaMFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-BetaMFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-BetaMFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-BetaMFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-BetaMFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-BetaMFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAKBAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-BetaMFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-BetaMFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-BetaMFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-BetaMFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaMFAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/token/send - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#create-send-token - source: | - $SendTokenRequest = @" - { - "userAlias" : "will.albin", - "deliveryType" : "EMAIL_WORK" - } - "@ - - # Create and send user token - - try { - $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest - New-BetaSendToken -SendTokenRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaSendToken -SendTokenRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSendToken" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/poll - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#ping-verification-status - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' - $VerificationPollRequest = @" - { - "requestId" : "089899f13a8f4da7824996191587bab9" - } - "@ - - # Polling MFA method by VerificationPollRequest - - try { - $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest - Ping-BetaVerificationStatus -Method $Method -VerificationPollRequest $Result - - # Below is a request that includes all optional parameters - # Ping-BetaVerificationStatus -Method $Method -VerificationPollRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaVerificationStatus" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/verify - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#send-duo-verify-request - source: | - $DuoVerificationRequest = @" - { - "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", - "userId" : "2c9180947f0ef465017f215cbcfd004b" - } - "@ - - # Verifying authentication via Duo method - - try { - $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest - Send-BetaDuoVerifyRequest -DuoVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaDuoVerifyRequest -DuoVerificationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaDuoVerifyRequest" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/authenticate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#send-kba-answers - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Authenticate KBA provided MFA method - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Send-BetaKbaAnswers -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Send-BetaKbaAnswers -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaKbaAnswers" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/verify - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#send-okta-verify-request - source: | - $OktaVerificationRequest = @" - { - "userId" : "example@mail.com" - } - "@ - - # Verifying authentication via Okta method - - try { - $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest - Send-BetaOktaVerifyRequest -OktaVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaOktaVerifyRequest -OktaVerificationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaOktaVerifyRequest" - Write-Host $_.ErrorDetails - } -- path: /mfa/token/authenticate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#send-token-auth-request - source: | - $TokenAuthRequest = @" - { - "userAlias" : "will.albin", - "deliveryType" : "EMAIL_WORK", - "token" : "12345" - } - "@ - - # Authenticate Token provided MFA method - - try { - $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest - Send-BetaTokenAuthRequest -TokenAuthRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaTokenAuthRequest -TokenAuthRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to get - $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get - - # Specified Managed Client Status. - - try { - Get-BetaManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-BetaManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to update - $ManagedClientStatus = @" - { - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - } - "@ - - # Handle status request from client - - try { - $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus - Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result - - # Below is a request that includes all optional parameters - # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for - - # Get managed cluster's log configuration - - try { - Get-BetaClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster - source: | - $Id = "aClusterId" # String | ID of the ManagedCluster to get - - # Get a specified ManagedCluster. - - try { - Get-BetaManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq operation" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Retrieve all Managed Clusters. - - try { - Get-BetaManagedClusters - - # Below is a request that includes all optional parameters - # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for - $ClientLogConfiguration = @" - { - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" - } - "@ - - # Update managed cluster's log configuration - - try { - Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result - - # Below is a request that includes all optional parameters - # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /multihosts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-multi-host-integration - source: | - $MultiHostIntegrationsCreate = @" - { - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "connector" : "multihost-microsoft-sql-server", - "connectorAttributes" : { - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "created" : "2022-02-08T14:50:03.827Z", - "name" : "My Multi-Host Integration", - "description" : "This is the Multi-Host Integration.", - "modified" : "2024-01-23T18:08:50.897Z" - } - "@ - - # Create Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate - New-BetaMultiHostIntegration -MultiHostIntegrationsCreate $Result - - # Below is a request that includes all optional parameters - # New-BetaMultiHostIntegration -MultiHostIntegrationsCreate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-sources-within-multi-host - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - $MultiHostIntegrationsCreateSources = @"{ - "connectorAttributes" : { - "authType" : "SQLAuthentication", - "url" : "jdbc:sqlserver://178.18.41.118:1433", - "user" : "username", - "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "name" : "My Source", - "description" : "This is the corporate directory." - }"@ - - - # Create Sources Within Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources - New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result - - # Below is a request that includes all optional parameters - # New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourcesWithinMultiHost" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#delete-multi-host - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. - - # Delete Multi-Host Integration - - try { - Remove-BetaMultiHost -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Remove-BetaMultiHost -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMultiHost" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId}/acctAggregationGroups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-acct-aggregation-groups - source: | - $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - - # Get Account Aggregation Groups Within Multi-Host Integration ID - - try { - Get-BetaAcctAggregationGroups -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-BetaAcctAggregationGroups -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAcctAggregationGroups" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multiHostId}/entitlementAggregationGroups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-entitlement-aggregation-groups - source: | - $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - - # Get Entitlement Aggregation Groups Within Multi-Host Integration ID - - try { - Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementAggregationGroups" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multi-host-integrations - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - - # Get Multi-Host Integration By ID - - try { - Get-BetaMultiHostIntegrations -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-BetaMultiHostIntegrations -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrations" - Write-Host $_.ErrorDetails - } -- path: /multihosts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multi-host-integrations-list - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - - # List All Existing Multi-Host Integrations - - try { - Get-BetaMultiHostIntegrationsList - - # Below is a request that includes all optional parameters - # Get-BetaMultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrationsList" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multiHostId}/sources/errors - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multi-host-source-creation-errors - source: | - $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration - - # List Multi-Host Source Creation Errors - - try { - Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostSourceCreationErrors" - Write-Host $_.ErrorDetails - } -- path: /multihosts/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multihost-integration-types - source: | - - # List Multi-Host Integration Types - - try { - Get-BetaMultihostIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-BetaMultihostIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultihostIntegrationTypes" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId}/sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-sources-within-multi-host - source: | - $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Sources Within Multi-Host Integration - - try { - Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourcesWithinMultiHost" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId}/sources/testConnection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#test-connection-multi-host-sources - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration - - # Test Configuration For Multi-Host Integration - - try { - Test-BetaConnectionMultiHostSources -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Test-BetaConnectionMultiHostSources -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaConnectionMultiHostSources" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#test-source-connection-multihost - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration - $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration - - # Test Configuration For Multi-Host Integration's Single Source - - try { - Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnectionMultihost" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#update-multi-host-sources - source: | - $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. - $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ - - - # Update Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner - Update-BetaMultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-BetaMultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaMultiHostSources" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id}/approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#approve-non-employee-request - source: | - $Id = "MyId" # String | Non-Employee approval item id (UUID) - $NonEmployeeApprovalDecision = @" - { - "comment" : "comment" - } - "@ - - # Approve a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-BetaNonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Approve-BetaNonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaNonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-record - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-BetaNonEmployeeRecord -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-BetaNonEmployeeRecord -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-request - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-BetaNonEmployeeRequest -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-BetaNonEmployeeRequest -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-source - source: | - $NonEmployeeSourceRequestBody = @" - { - "owner" : { - "id" : "2c91808570313110017040b06f344ec9" - }, - "managementWorkgroup" : "123299", - "accountManagers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ], - "name" : "Retail", - "description" : "Source description", - "approvers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ] - } - "@ - - # Create Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-BetaNonEmployeeSource -NonEmployeeSourceRequestBody $Result - - # Below is a request that includes all optional parameters - # New-BetaNonEmployeeSource -NonEmployeeSourceRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes - source: | - $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id - $NonEmployeeSchemaAttributeBody = @" - { - "helpText" : "The unique identifier for the account", - "label" : "Account Name", - "placeholder" : "Enter a unique user name for this account.", - "type" : "TEXT", - "technicalName" : "account.name", - "required" : true - } - "@ - - # Create Non-Employee Source Schema Attribute - - try { - $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - - # Below is a request that includes all optional parameters - # New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-record - source: | - $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) - - # Delete Non-Employee Record - - try { - Remove-BetaNonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-record-in-bulk - source: | - $DeleteNonEmployeeRecordInBulkRequest = @" - - "@ - - # Delete Multiple Non-Employee Records - - try { - $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest - Remove-BetaNonEmployeeRecordInBulk -DeleteNonEmployeeRecordInBulkRequest $Result - - # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeRecordInBulk -DeleteNonEmployeeRecordInBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-request - source: | - $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in the UUID format - - # Delete Non-Employee Request - - try { - Remove-BetaNonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute - source: | - $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) - $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id - - # Delete Non-Employee Source's Schema Attribute - - try { - Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-source - source: | - $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id - - # Delete Non-Employee Source - - try { - Remove-BetaNonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes - source: | - $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id - - # Delete all custom schema attributes - - try { - Remove-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/non-employees/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#export-non-employee-records - source: | - $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) - - # Exports Non-Employee Records to CSV - - try { - Export-BetaNonEmployeeRecords -Id $Id - - # Below is a request that includes all optional parameters - # Export-BetaNonEmployeeRecords -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeRecords" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/schema-attributes-template/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template - source: | - $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) - - # Exports Source Schema Template - - try { - Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeSourceSchemaTemplate" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-approval - source: | - $Id = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | Non-Employee approval item id (UUID) - $IncludeDetail = "include-detail=false" # String | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) - - # Get a non-employee approval item detail - - try { - Get-BetaNonEmployeeApproval -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/summary/{requested-for} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-approval-summary - source: | - $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Approval Requests - - try { - Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApprovalSummary" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/non-employee-bulk-upload/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status - source: | - $Id = "2c918085842e69ae018432d22ccb212f" # String | Source ID (UUID) - - # Bulk upload status on source - - try { - Get-BetaNonEmployeeBulkUploadStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeBulkUploadStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeBulkUploadStatus" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-record - source: | - $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) - - # Get a Non-Employee Record - - try { - Get-BetaNonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-request - source: | - $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUID) - - # Get a Non-Employee Request - - try { - Get-BetaNonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests/summary/{requested-for} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-request-summary - source: | - $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Requests - - try { - Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequestSummary" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute - source: | - $AttributeId = "2c918085842e69ae018432d22ccb212f" # String | The Schema Attribute Id (UUID) - $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id - - # Get Schema Attribute Non-Employee Source - - try { - Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-source - source: | - $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id - - # Get a Non-Employee Source - - try { - Get-BetaNonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes - source: | - $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id - - # List Schema Attributes Non-Employee Source - - try { - Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/non-employee-bulk-upload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - $Data = # System.IO.FileInfo | - - # Imports, or Updates, Non-Employee Records - - try { - Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data - - # Below is a request that includes all optional parameters - # Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaNonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-approval - source: | - $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity for whom the request was made. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "approvalStatus eq "PENDING"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Get List of Non-Employee Approval Requests - - try { - Get-BetaNonEmployeeApproval - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeApproval -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-records - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - - # List Non-Employee Records - - try { - Get-BetaNonEmployeeRecords - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecords" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-requests - source: | - $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "approvalStatus,firstName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - - # List Non-Employee Requests - - try { - Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequests" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-sources - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) - $NonEmployeeCount = $false # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) - $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - - # List Non-Employee Sources - - try { - Get-BetaNonEmployeeSources - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#patch-non-employee-record - source: | - $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Non-Employee Record - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaNonEmployeeRecord -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeRecord -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute - source: | - $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) - $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Non-Employee Source's Schema Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#patch-non-employee-source - source: | - $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaNonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id}/reject - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#reject-non-employee-request - source: | - $Id = "MyId" # String | Non-Employee approval item id (UUID) - $NonEmployeeRejectApprovalDecision = @" - { - "comment" : "comment" - } - "@ - - # Reject a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-BetaNonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Deny-BetaNonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaNonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#update-non-employee-record - source: | - $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Update Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-BetaNonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /verified-domains - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#create-domain-dkim - source: | - $DomainAddress = @" - { - "domain" : "sailpoint.com" - } - "@ - - # Verify domain address via DKIM - - try { - $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress - New-BetaDomainDkim -DomainAddress $Result - - # Below is a request that includes all optional parameters - # New-BetaDomainDkim -DomainAddress $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim" - Write-Host $_.ErrorDetails - } -- path: /notification-templates - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#create-notification-template - source: | - $TemplateDto = @" - { - "slackTemplate" : "slackTemplate", - "footer" : "footer", - "teamsTemplate" : "teamsTemplate", - "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", - "created" : "2020-01-01T00:00:00Z", - "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", - "medium" : "EMAIL", - "locale" : "en", - "body" : "Please go to the task manager", - "name" : "Task Manager Subscription", - "replyTo" : "$__global.emailFromAddress", - "header" : "header", - "modified" : "2020-01-01T00:00:00Z", - "from" : "$__global.emailFromAddress", - "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", - "key" : "cloud_manual_work_item_summary" - } - "@ - - # Create Notification Template - - try { - $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto - New-BetaNotificationTemplate -TemplateDto $Result - - # Below is a request that includes all optional parameters - # New-BetaNotificationTemplate -TemplateDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate" - Write-Host $_.ErrorDetails - } -- path: /verified-from-addresses - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#create-verified-from-address - source: | - $EmailStatusDto = @" - { - "isVerifiedByDomain" : false, - "verificationStatus" : "PENDING", - "id" : "id", - "email" : "sender@example.com" - } - "@ - - # Create Verified From Address - - try { - $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto - New-BetaVerifiedFromAddress -EmailStatusDto $Result - - # Below is a request that includes all optional parameters - # New-BetaVerifiedFromAddress -EmailStatusDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress" - Write-Host $_.ErrorDetails - } -- path: /notification-templates/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#delete-notification-templates-in-bulk - source: | - $TemplateBulkDeleteDto = @"{ - "medium" : "EMAIL", - "locale" : "en", - "key" : "cloud_manual_work_item_summary" - }"@ - - - # Bulk Delete Notification Templates - - try { - $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto - Remove-BetaNotificationTemplatesInBulk -TemplateBulkDeleteDto $Result - - # Below is a request that includes all optional parameters - # Remove-BetaNotificationTemplatesInBulk -TemplateBulkDeleteDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk" - Write-Host $_.ErrorDetails - } -- path: /verified-from-addresses/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#delete-verified-from-address - source: | - $Id = "MyId" # String | - - # Delete Verified From Address - - try { - Remove-BetaVerifiedFromAddress -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaVerifiedFromAddress -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVerifiedFromAddress" - Write-Host $_.ErrorDetails - } -- path: /verified-domains - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#get-dkim-attributes - source: | - - # Get DKIM Attributes - - try { - Get-BetaDkimAttributes - - # Below is a request that includes all optional parameters - # Get-BetaDkimAttributes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDkimAttributes" - Write-Host $_.ErrorDetails - } -- path: /mail-from-attributes/{identityId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#get-mail-from-attributes - source: | - $IdentityId = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - - # Get MAIL FROM Attributes - - try { - Get-BetaMailFromAttributes -IdentityId $IdentityId - - # Below is a request that includes all optional parameters - # Get-BetaMailFromAttributes -IdentityId $IdentityId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMailFromAttributes" - Write-Host $_.ErrorDetails - } -- path: /notification-templates/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#get-notification-template - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template - - # Get Notification Template By Id - - try { - Get-BetaNotificationTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaNotificationTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplate" - Write-Host $_.ErrorDetails - } -- path: /notification-template-context - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#get-notifications-template-context - source: | - - # Get Notification Template Context - - try { - Get-BetaNotificationsTemplateContext - - # Below is a request that includes all optional parameters - # Get-BetaNotificationsTemplateContext - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationsTemplateContext" - Write-Host $_.ErrorDetails - } -- path: /verified-from-addresses - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#list-from-addresses - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "email eq "john.doe@company.com"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) - $Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) - - # List From Addresses - - try { - Get-BetaFromAddresses - - # Below is a request that includes all optional parameters - # Get-BetaFromAddresses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFromAddresses" - Write-Host $_.ErrorDetails - } -- path: /notification-preferences/{key} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#list-notification-preferences - source: | - $Key = "cloud_manual_work_item_summary" # String | The notification key. - - # List Notification Preferences for tenant. - - try { - Get-BetaNotificationPreferences -Key $Key - - # Below is a request that includes all optional parameters - # Get-BetaNotificationPreferences -Key $Key - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationPreferences" - Write-Host $_.ErrorDetails - } -- path: /notification-template-defaults - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#list-notification-template-defaults - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "key eq "cloud_manual_work_item_summary"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - - # List Notification Template Defaults - - try { - Get-BetaNotificationTemplateDefaults - - # Below is a request that includes all optional parameters - # Get-BetaNotificationTemplateDefaults -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplateDefaults" - Write-Host $_.ErrorDetails - } -- path: /notification-templates - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#list-notification-templates - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "medium eq "EMAIL"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - - # List Notification Templates - - try { - Get-BetaNotificationTemplates - - # Below is a request that includes all optional parameters - # Get-BetaNotificationTemplates -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplates" - Write-Host $_.ErrorDetails - } -- path: /mail-from-attributes - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#put-mail-from-attributes - source: | - $MailFromAttributesDto = @" - { - "identity" : "BobSmith@sailpoint.com", - "mailFromDomain" : "example.sailpoint.com" - } - "@ - - # Change MAIL FROM domain - - try { - $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto - Send-BetaMailFromAttributes -MailFromAttributesDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaMailFromAttributes -MailFromAttributesDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes" - Write-Host $_.ErrorDetails - } -- path: /send-test-notification - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/notifications#send-test-notification - source: | - $SendTestNotificationRequestDto = @" - { - "context" : "{}", - "medium" : "EMAIL", - "key" : "cloud_manual_work_item_summary" - } - "@ - - # Send Test Notification - - try { - $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto - Send-BetaTestNotification -SendTestNotificationRequestDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaTestNotification -SendTestNotificationRequestDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTestNotification" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#create-oauth-client - source: | - $CreateOAuthClientRequest = @" - { - "internal" : false, - "businessName" : "Acme-Solar", - "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", - "refreshTokenValiditySeconds" : 86400, - "type" : "CONFIDENTIAL", - "redirectUris" : [ "http://localhost:12345", "http://localhost:67890" ], - "enabled" : true, - "accessType" : "OFFLINE", - "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], - "strongAuthSupported" : false, - "homepageUrl" : "http://localhost:12345", - "accessTokenValiditySeconds" : 750, - "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], - "name" : "Demo API Client", - "claimsSupported" : false - } - "@ - - # Create OAuth Client - - try { - $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-BetaOauthClient -CreateOAuthClientRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaOauthClient -CreateOAuthClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaOauthClient" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#delete-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Delete OAuth Client - - try { - Remove-BetaOauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaOauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaOauthClient" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#get-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Get OAuth Client - - try { - Get-BetaOauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaOauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClient" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#list-oauth-clients - source: | - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - - # List OAuth Clients - - try { - Get-BetaOauthClients - - # Below is a request that includes all optional parameters - # Get-BetaOauthClients -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClients" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#patch-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch OAuth Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaOauthClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaOauthClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOauthClient" - Write-Host $_.ErrorDetails - } -- path: /org-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/org-config#get-org-config - source: | - - # Get Org configuration settings - - try { - Get-BetaOrgConfig - - # Below is a request that includes all optional parameters - # Get-BetaOrgConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /org-config/valid-time-zones - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/org-config#get-valid-time-zones - source: | - - # Get list of time zones - - try { - Get-BetaValidTimeZones - - # Below is a request that includes all optional parameters - # Get-BetaValidTimeZones - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaValidTimeZones" - Write-Host $_.ErrorDetails - } -- path: /org-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/org-config#patch-org-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch an Org configuration property - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaOrgConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaOrgConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-org-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-configuration#create-password-org-config - source: | - $PasswordOrgConfig = @" - { - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - } - "@ - - # Create Password Org Config - - try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - New-BetaPasswordOrgConfig -PasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # New-BetaPasswordOrgConfig -PasswordOrgConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-org-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-configuration#get-password-org-config - source: | - - # Get Password Org Config - - try { - Get-BetaPasswordOrgConfig - - # Below is a request that includes all optional parameters - # Get-BetaPasswordOrgConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-org-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-configuration#put-password-org-config - source: | - $PasswordOrgConfig = @" - { - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - } - "@ - - # Update Password Org Config - - try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - Send-BetaPasswordOrgConfig -PasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # Send-BetaPasswordOrgConfig -PasswordOrgConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-dictionary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-dictionary#get-password-dictionary - source: | - - # Get Password Dictionary - - try { - Get-BetaPasswordDictionary - - # Below is a request that includes all optional parameters - # Get-BetaPasswordDictionary - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordDictionary" - Write-Host $_.ErrorDetails - } -- path: /password-dictionary - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-dictionary#put-password-dictionary - source: | - $File = # System.IO.FileInfo | (optional) - - # Update Password Dictionary - - try { - Send-BetaPasswordDictionary - - # Below is a request that includes all optional parameters - # Send-BetaPasswordDictionary -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordDictionary" - Write-Host $_.ErrorDetails - } -- path: /generate-password-reset-token/digit - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-management#create-digit-token - source: | - $PasswordDigitTokenReset = @" - { - "durationMinutes" : 5, - "length" : 8, - "userId" : "Abby.Smith" - } - "@ - - # Generate a digit token - - try { - $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset - New-BetaDigitToken -PasswordDigitTokenReset $Result - - # Below is a request that includes all optional parameters - # New-BetaDigitToken -PasswordDigitTokenReset $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken" - Write-Host $_.ErrorDetails - } -- path: /password-change-status/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-management#get-identity-password-change-status - source: | - $Id = "MyId" # String | - - # Get Password Change Request Status - - try { - Get-BetaIdentityPasswordChangeStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentityPasswordChangeStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityPasswordChangeStatus" - Write-Host $_.ErrorDetails - } -- path: /query-password-info - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-management#query-password-info - source: | - $PasswordInfoQueryDTO = @" - { - "sourceName" : "My-AD", - "userName" : "Abby.Smith" - } - "@ - - # Query Password Info - - try { - $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO - Search-BetaPasswordInfo -PasswordInfoQueryDTO $Result - - # Below is a request that includes all optional parameters - # Search-BetaPasswordInfo -PasswordInfoQueryDTO $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo" - Write-Host $_.ErrorDetails - } -- path: /set-password - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-management#set-identity-password - source: | - $PasswordChangeRequest = @" - { - "sourceId" : "8a807d4c73c545510173c545d4b60246", - "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", - "identityId" : "8a807d4c73c545510173c545f0a002ff", - "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", - "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" - } - "@ - - # Set Identity's Password - - try { - $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest - Set-BetaIdentityPassword -PasswordChangeRequest $Result - - # Below is a request that includes all optional parameters - # Set-BetaIdentityPassword -PasswordChangeRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIdentityPassword" - Write-Host $_.ErrorDetails - } -- path: /password-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-policies#create-password-policy - source: | - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : "2000-01-23T04:56:07.000+00:00", - "validateAgainstAccountId" : false, - "dateCreated" : "2000-01-23T04:56:07.000+00:00", - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Create Password Policy - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-BetaPasswordPolicy -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # New-BetaPasswordPolicy -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy" - Write-Host $_.ErrorDetails - } -- path: /password-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-policies#delete-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. - - # Delete Password Policy by ID - - try { - Remove-BetaPasswordPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaPasswordPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordPolicy" - Write-Host $_.ErrorDetails - } -- path: /password-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-policies#get-password-policy-by-id - source: | - $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. - - # Get Password Policy by ID - - try { - Get-BetaPasswordPolicyById -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaPasswordPolicyById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicyById" - Write-Host $_.ErrorDetails - } -- path: /password-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-policies#list-password-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Password Policies - - try { - Get-BetaPasswordPolicies - - # Below is a request that includes all optional parameters - # Get-BetaPasswordPolicies -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicies" - Write-Host $_.ErrorDetails - } -- path: /password-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-policies#set-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : "2000-01-23T04:56:07.000+00:00", - "validateAgainstAccountId" : false, - "dateCreated" : "2000-01-23T04:56:07.000+00:00", - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Update Password Policy by ID - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-BetaPasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # Set-BetaPasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaPasswordPolicy" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#create-password-sync-group - source: | - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Create Password Sync Group - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-BetaPasswordSyncGroup -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # New-BetaPasswordSyncGroup -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#delete-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. - - # Delete Password Sync Group by ID - - try { - Remove-BetaPasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaPasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#get-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. - - # Get Password Sync Group by ID - - try { - Get-BetaPasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaPasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#get-password-sync-groups - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Get Password Sync Group List - - try { - Get-BetaPasswordSyncGroups - - # Below is a request that includes all optional parameters - # Get-BetaPasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#update-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Update Password Sync Group by ID - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-BetaPasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # Update-BetaPasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#create-personal-access-token - source: | - $CreatePersonalAccessTokenRequest = @" - { - "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], - "accessTokenValiditySeconds" : 36900, - "name" : "NodeJS Integration" - } - "@ - - # Create Personal Access Token - - try { - $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-BetaPersonalAccessToken -CreatePersonalAccessTokenRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaPersonalAccessToken -CreatePersonalAccessTokenRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPersonalAccessToken" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#delete-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id - - # Delete Personal Access Token - - try { - Remove-BetaPersonalAccessToken -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaPersonalAccessToken -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPersonalAccessToken" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#list-personal-access-tokens - source: | - $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - - # List Personal Access Tokens - - try { - Get-BetaPersonalAccessTokens - - # Below is a request that includes all optional parameters - # Get-BetaPersonalAccessTokens -OwnerId $OwnerId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPersonalAccessTokens" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#patch-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Personal Access Token - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaPersonalAccessToken -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaPersonalAccessToken -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPersonalAccessToken" - Write-Host $_.ErrorDetails - } -- path: /public-identities-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/public-identities-config#get-public-identity-config - source: | - - # Get Public Identity Config - - try { - Get-BetaPublicIdentityConfig - - # Below is a request that includes all optional parameters - # Get-BetaPublicIdentityConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPublicIdentityConfig" - Write-Host $_.ErrorDetails - } -- path: /public-identities-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/public-identities-config#update-public-identity-config - source: | - $PublicIdentityConfig = @" - { - "modified" : "2018-06-25T20:22:28.104Z", - "attributes" : [ { - "name" : "Country", - "key" : "country" - }, { - "name" : "Country", - "key" : "country" - } ], - "modifiedBy" : { - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - } - "@ - - # Update Public Identity Config - - try { - $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-BetaPublicIdentityConfig -PublicIdentityConfig $Result - - # Below is a request that includes all optional parameters - # Update-BetaPublicIdentityConfig -PublicIdentityConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPublicIdentityConfig" - Write-Host $_.ErrorDetails - } -- path: /requestable-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/requestable-objects#list-requestable-objects - source: | - $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) - $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) - - $Types = @"ROLE,ACCESS_PROFILE"@ - $Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) - $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) - - $Statuses = @"[ASSIGNED, PENDING]"@ - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Requestable Objects List - - try { - Get-BetaRequestableObjects - - # Below is a request that includes all optional parameters - # Get-BetaRequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRequestableObjects" - Write-Host $_.ErrorDetails - } -- path: /role-insights/requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/role-insights#create-role-insight-requests - source: | - - # Generate insights for roles - - try { - New-BetaRoleInsightRequests - - # Below is a request that includes all optional parameters - # New-BetaRoleInsightRequests - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleInsightRequests" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId}/entitlement-changes/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/role-insights#download-role-insights-entitlements-changes - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) - $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Download entitlement insights for a role - - try { - Invoke-BetaDownloadRoleInsightsEntitlementsChanges -InsightId $InsightId - - # Below is a request that includes all optional parameters - # Invoke-BetaDownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleInsightsEntitlementsChanges" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-entitlement-changes-identities - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id - $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "name sw "Jan"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - - # Get identities for a suggested entitlement (for a role) - - try { - Get-BetaEntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChangesIdentities" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insight - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - - # Get a single role insight - - try { - Get-BetaRoleInsight -InsightId $InsightId - - # Below is a request that includes all optional parameters - # Get-BetaRoleInsight -InsightId $InsightId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsight" - Write-Host $_.ErrorDetails - } -- path: /role-insights - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) - $Filters = "name sw "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) - - # Get role insights - - try { - Get-BetaRoleInsights - - # Below is a request that includes all optional parameters - # Get-BetaRoleInsights -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsights" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId}/current-entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-current-entitlements - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Get current entitlement for a role - - try { - Get-BetaRoleInsightsCurrentEntitlements -InsightId $InsightId - - # Below is a request that includes all optional parameters - # Get-BetaRoleInsightsCurrentEntitlements -InsightId $InsightId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsCurrentEntitlements" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId}/entitlement-changes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-entitlements-changes - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) - $Filters = "name sw "Admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Get entitlement insights for a role - - try { - Get-BetaRoleInsightsEntitlementsChanges -InsightId $InsightId - - # Below is a request that includes all optional parameters - # Get-BetaRoleInsightsEntitlementsChanges -InsightId $InsightId -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsEntitlementsChanges" - Write-Host $_.ErrorDetails - } -- path: /role-insights/requests/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-requests - source: | - $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id - - # Returns metadata from prior request. - - try { - Get-BetaRoleInsightsRequests -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaRoleInsightsRequests -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsRequests" - Write-Host $_.ErrorDetails - } -- path: /role-insights/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-summary - source: | - - # Get role insights summary information - - try { - Get-BetaRoleInsightsSummary - - # Below is a request that includes all optional parameters - # Get-BetaRoleInsightsSummary - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsSummary" - Write-Host $_.ErrorDetails - } -- path: /roles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/roles#create-role - source: | - $Role = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "dimensional" : false, - "created" : "2021-03-01T22:32:58.104Z", - "dimensionRefs" : [ { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - }, { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - } ], - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "membership" : { - "identities" : [ { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } ], - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, - "type" : "IDENTITY_LIST" - }, - "enabled" : true, - "revocationRequestConfig" : { - "commentsRequired" : false, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : false - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "legacyMembershipInfo" : { - "type" : "IDENTITY_LIST" - }, - "accessRequestConfig" : { - "commentsRequired" : true, - "reauthorizationRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "name" : "Role 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "accessModelMetadata" : { - "attributes" : [ { - "key" : "iscPrivacy", - "name" : "Privacy", - "multiselect" : false, - "status" : "active", - "type" : "governance", - "objectTypes" : [ "all" ], - "description" : "Specifies the level of privacy associated with an access item.", - "values" : [ { - "value" : "public", - "name" : "Public", - "status" : "active" - } ] - } ] - }, - "id" : "2c918086749d78830174a1a40e121518", - "requestable" : true - } - "@ - - # Create a Role - - try { - $Result = ConvertFrom-JsonToRole -Json $Role - New-BetaRole -Role $Result - - # Below is a request that includes all optional parameters - # New-BetaRole -Role $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRole" - Write-Host $_.ErrorDetails - } -- path: /roles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/roles#delete-bulk-roles - source: | - $RoleBulkDeleteRequest = @" - { - "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - } - "@ - - # Delete Role(s) - - try { - $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-BetaBulkRoles -RoleBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-BetaBulkRoles -RoleBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaBulkRoles" - Write-Host $_.ErrorDetails - } -- path: /roles/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/roles#delete-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - - # Delete a Role - - try { - Remove-BetaRole -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaRole -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaRole" - Write-Host $_.ErrorDetails - } -- path: /roles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/roles#get-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - - # Get a Role - - try { - Get-BetaRole -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaRole -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRole" - Write-Host $_.ErrorDetails - } -- path: /roles/{id}/assigned-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/roles#get-role-assigned-identities - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) - $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) - - # Identities assigned a Role - - try { - Get-BetaRoleAssignedIdentities -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaRoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignedIdentities" - Write-Host $_.ErrorDetails - } -- path: /roles/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/roles#get-role-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | Containing role's ID. - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Role's Entitlements - - try { - Get-BetaRoleEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaRoleEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleEntitlements" - Write-Host $_.ErrorDetails - } -- path: /roles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/roles#list-roles - source: | - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) - - # List Roles - - try { - Get-BetaRoles - - # Below is a request that includes all optional parameters - # Get-BetaRoles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoles" - Write-Host $_.ErrorDetails - } -- path: /roles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/roles#patch-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Role - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaRole -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaRole -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#create-sim-integration - source: | - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2023-01-03T21:16:22.432Z", - "name" : "aName", - "modified" : "2023-01-03T21:16:22.432Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-BetaSIMIntegration -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-BetaSIMIntegration -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#delete-sim-integration - source: | - $Id = "12345" # String | The id of the integration to delete. - - # Delete a SIM integration - - try { - Remove-BetaSIMIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSIMIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - - # Get a SIM integration details. - - try { - Get-BetaSIMIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSIMIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integrations - source: | - - # List the existing SIM integrations. - - try { - Get-BetaSIMIntegrations - - # Below is a request that includes all optional parameters - # Get-BetaSIMIntegrations - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $JsonPatch = @" - "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-BetaBeforeProvisioningRule -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-BetaBeforeProvisioningRule -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $JsonPatch = @" - "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-BetaSIMAttributes -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-BetaSIMAttributes -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2023-01-03T21:16:22.432Z", - "name" : "aName", - "modified" : "2023-01-03T21:16:22.432Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-BetaSIMIntegration -Id $Id -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-BetaSIMIntegration -Id $Id -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-BetaSodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-BetaSodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-BetaSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-BetaSodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-BetaDefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-BetaDefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-BetaSodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-BetaSodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - - # Get SOD policy by ID - - try { - Get-BetaSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - - # Get SOD policy schedule - - try { - Get-BetaSodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - - # Get SOD violation report status - - try { - Get-BetaSodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#list-sod-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-BetaSodPolicies - - # Below is a request that includes all optional parameters - # Get-BetaSodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified. - $RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - $RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ - - - # Patch a SOD policy - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSodPolicy -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaSodPolicy -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-BetaPolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-BetaPolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-BetaSodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-BetaSodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] - } - "@ - - # Runs all policies for org - - try { - Start-BetaSodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-BetaSodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-BetaSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-BetaSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-BetaPredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-BetaPredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-BetaSpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-BetaSpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-BetaSpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-BetaSpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-BetaSpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-BetaSpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-BetaSpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-BetaSpConfigObjects - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config - source: | - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ - - # Create Extended Search Attributes - - try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-BetaSearchAttributeConfig -SearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - - # Delete Extended Search Attribute - - try { - Remove-BetaSearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Remove-BetaSearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Extended Search Attributes - - try { - Get-BetaSearchAttributeConfig - - # Below is a request that includes all optional parameters - # Get-BetaSearchAttributeConfig -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - - # Get Extended Search Attribute - - try { - Get-BetaSingleSearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Get-BetaSingleSearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config - source: | - $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Extended Search Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment - source: | - $Segment = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-BetaSegment -Segment $Result - - # Below is a request that includes all optional parameters - # New-BetaSegment -Segment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-BetaSegment -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSegment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-BetaSegment -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSegment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Segments - - try { - Get-BetaSegments - - # Below is a request that includes all optional parameters - # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSegment -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaSegment -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration - source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - } - "@ - - # Create new Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration - source: | - $Id = "anId" # String | ID of Service Desk integration to delete - - # Delete a Service Desk integration - - try { - Remove-BetaServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to get - - # Get a Service Desk integration - - try { - Get-BetaServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List existing Service Desk integrations - - try { - Get-BetaServiceDeskIntegrationList - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - - # Service Desk integration template by scriptName - - try { - Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types - source: | - - # List Service Desk integration types - - try { - Get-BetaServiceDeskIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details - source: | - - # Get the time check configuration - - try { - Get-BetaStatusCheckDetails - - # Below is a request that includes all optional parameters - # Get-BetaStatusCheckDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - - "@ - - # Patch a Service Desk Integration - - try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - - # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - } - "@ - - # Update a Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details - source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ - - # Update the time check configuration - - try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result - - # Below is a request that includes all optional parameters - # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-BetaStatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaStatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-BetaUsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#create-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - $ProvisioningPolicyDto = @" - { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } - "@ - - # Create Provisioning Policy - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-BetaProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # New-BetaProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#create-source - source: | - $Source = @" - { - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - } - "@ - $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) - - # Creates a source in IdentityNow. - - try { - $Result = ConvertFrom-JsonToSource -Json $Source - New-BetaSource -Source $Result - - # Below is a request that includes all optional parameters - # New-BetaSource -Source $Result -ProvisionAsCsv $ProvisionAsCsv - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSource" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#create-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Schema = @" - { - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" - } - "@ - - # Create Schema on Source - - try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - New-BetaSourceSchema -SourceId $SourceId -Schema $Result - - # Below is a request that includes all optional parameters - # New-BetaSourceSchema -SourceId $SourceId -Schema $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#delete - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Delete Source by ID - - try { - Remove-Beta -Id $Id - - # Below is a request that includes all optional parameters - # Remove-Beta -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Beta" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/remove-accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#delete-accounts-async - source: | - $SourceId = "ebbf35756e1140699ce52b233121384a" # String | The source id - - # Remove All Accounts in a Source - - try { - Remove-BetaAccountsAsync -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-BetaAccountsAsync -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountsAsync" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/native-change-detection-config - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#delete-native-change-detection-config - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id - - # Delete Native Change Detection Configuration - - try { - Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#delete-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - - # Delete Provisioning Policy by UsageType - - try { - Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - - # Below is a request that includes all optional parameters - # Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#delete-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. - - # Delete Source Schema by ID - - try { - Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/correlation-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#get-correlation-config - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id - - # Get Source Correlation Configuration - - try { - Get-BetaCorrelationConfig -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaCorrelationConfig -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCorrelationConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/native-change-detection-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#get-native-change-detection-config - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id - - # Native Change Detection Configuration - - try { - Get-BetaNativeChangeDetectionConfig -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaNativeChangeDetectionConfig -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#get-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - - # Get Provisioning Policy by UsageType - - try { - Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - - # Below is a request that includes all optional parameters - # Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#get-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Get Source by ID - - try { - Get-BetaSource -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSource -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSource" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-accounts-schema - source: | - $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - - # Downloads source accounts schema template - - try { - Get-BetaSourceAccountsSchema -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaSourceAccountsSchema -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAccountsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/attribute-sync-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-attr-sync-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - - # Attribute Sync Config - - try { - Get-BetaSourceAttrSyncConfig -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSourceAttrSyncConfig -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAttrSyncConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/connectors/source-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-config - source: | - $Id = "MyId" # String | The Source id - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Gets source config with language translations - - try { - Get-BetaSourceConfig -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSourceConfig -Id $Id -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/entitlement-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-entitlement-request-config - source: | - $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - - # Get Source Entitlement Request Configuration - - try { - Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-entitlements-schema - source: | - $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) - - # Downloads source entitlements schema template - - try { - Get-BetaSourceEntitlementsSchema -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaSourceEntitlementsSchema -SourceId $SourceId -SchemaName $SchemaName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. - - # Get Source Schema by ID - - try { - Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-schemas - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) - $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) - - # List Schemas on Source - - try { - Get-BetaSourceSchemas -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaSourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchemas" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/load-accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#import-accounts - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id - $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) - $DisableOptimization = "true" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) - - # Account Aggregation - - try { - Import-BetaAccounts -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Import-BetaAccounts -SourceId $SourceId -File $File -DisableOptimization $DisableOptimization - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaAccounts" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/load-entitlements - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#import-entitlements - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id - $File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) - - # Entitlement Aggregation - - try { - Import-BetaEntitlements -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Import-BetaEntitlements -SourceId $SourceId -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlements" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#import-source-accounts-schema - source: | - $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $File = # System.IO.FileInfo | (optional) - - # Uploads source accounts schema template - - try { - Import-BetaSourceAccountsSchema -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Import-BetaSourceAccountsSchema -SourceId $SourceId -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceAccountsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/upload-connector-file - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#import-source-connector-file - source: | - $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $File = # System.IO.FileInfo | (optional) - - # Upload connector file to source - - try { - Import-BetaSourceConnectorFile -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Import-BetaSourceConnectorFile -SourceId $SourceId -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceConnectorFile" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/entitlements - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#import-source-entitlements-schema - source: | - $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) - $File = # System.IO.FileInfo | (optional) - - # Uploads source entitlements schema template - - try { - Import-BetaSourceEntitlementsSchema -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Import-BetaSourceEntitlementsSchema -SourceId $SourceId -SchemaName $SchemaName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceEntitlementsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/load-uncorrelated-accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#import-uncorrelated-accounts - source: | - $SourceId = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id - $File = # System.IO.FileInfo | (optional) - - # Process Uncorrelated Accounts - - try { - Import-BetaUncorrelatedAccounts -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Import-BetaUncorrelatedAccounts -SourceId $SourceId -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaUncorrelatedAccounts" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#list-provisioning-policies - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - - # Lists ProvisioningPolicies - - try { - Get-BetaProvisioningPolicies -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaProvisioningPolicies -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicies" - Write-Host $_.ErrorDetails - } -- path: /sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#list-sources - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) - $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) - $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) - - # Lists all sources in IdentityNow. - - try { - Get-BetaSources - - # Below is a request that includes all optional parameters - # Get-BetaSources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSources" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connector/peek-resource-objects - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#peek-resource-objects - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - $ResourceObjectsRequest = @" - { - "maxCount" : 100, - "objectType" : "group" - } - "@ - - # Peek source connector's resource objects - - try { - $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest - Receive-BetaResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result - - # Below is a request that includes all optional parameters - # Receive-BetaResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-BetaResourceObjects" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connector/ping-cluster - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#ping-cluster - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - - # Ping cluster for source connector - - try { - Ping-BetaCluster -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Ping-BetaCluster -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaCluster" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/correlation-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#put-correlation-config - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id - $CorrelationConfig = @" - { - "attributeAssignments" : [ { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - }, { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - } ], - "name" : "Source [source] Account Correlation", - "id" : "2c9180835d191a86015d28455b4a2329" - } - "@ - - # Update Source Correlation Configuration - - try { - $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig - Send-BetaCorrelationConfig -SourceId $SourceId -CorrelationConfig $Result - - # Below is a request that includes all optional parameters - # Send-BetaCorrelationConfig -SourceId $SourceId -CorrelationConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaCorrelationConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/native-change-detection-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#put-native-change-detection-config - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id - $NativeChangeDetectionConfig = @" - { - "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], - "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], - "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], - "allNonEntitlementAttributes" : false, - "allEntitlements" : false, - "enabled" : true - } - "@ - - # Update Native Change Detection Configuration - - try { - $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig - Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -NativeChangeDetectionConfig $Result - - # Below is a request that includes all optional parameters - # Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -NativeChangeDetectionConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaNativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#put-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $ProvisioningPolicyDto = @" - { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } - "@ - - # Update Provisioning Policy by UsageType - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#put-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Source = @" - { - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - } - "@ - - # Update Source (Full) - - try { - $Result = ConvertFrom-JsonToSource -Json $Source - Send-BetaSource -Id $Id -Source $Result - - # Below is a request that includes all optional parameters - # Send-BetaSource -Id $Id -Source $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSource" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/attribute-sync-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#put-source-attr-sync-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $AttrSyncSourceConfig = @" - { - "attributes" : [ { - "name" : "email", - "displayName" : "Email", - "enabled" : true, - "target" : "mail" - }, { - "name" : "firstname", - "displayName" : "First Name", - "enabled" : false, - "target" : "givenName" - } ], - "source" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - } - } - "@ - - # Update Attribute Sync Config - - try { - $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig - Send-BetaSourceAttrSyncConfig -Id $Id -AttrSyncSourceConfig $Result - - # Below is a request that includes all optional parameters - # Send-BetaSourceAttrSyncConfig -Id $Id -AttrSyncSourceConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceAttrSyncConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#put-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. - $Schema = @" - { - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" - } - "@ - - # Update Source Schema (Full) - - try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result - - # Below is a request that includes all optional parameters - # Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/synchronize-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#sync-attributes-for-source - source: | - $SourceId = "MySourceId" # String | The Source id - - # Synchronize single source attributes. - - try { - Sync-BetaAttributesForSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Sync-BetaAttributesForSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaAttributesForSource" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connector/test-configuration - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#test-source-configuration - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - - # Test configuration for source connector - - try { - Test-BetaSourceConfiguration -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-BetaSourceConfiguration -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConfiguration" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connector/check-connection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#test-source-connection - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. - - # Check connection for source connector. - - try { - Test-BetaSourceConnection -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-BetaSourceConnection -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnection" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#update-provisioning-policies-in-bulk - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ProvisioningPolicyDto = @"{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - }"@ - - - # Bulk Update Provisioning Policies - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPoliciesInBulk" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#update-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Partial update of Provisioning Policy - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#update-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSource -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaSource -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSource" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/entitlement-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#update-source-entitlement-request-config - source: | - $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SourceEntitlementRequestConfig = @" - { - "accessRequestConfig" : { - "denialCommentRequired" : false, - "approvalSchemes" : [ { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - } ], - "requestCommentRequired" : true - } - } - "@ - - # Update Source Entitlement Request Configuration - - try { - $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -SourceEntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -SourceEntitlementRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sources#update-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source Schema (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-batches/{batchId}/stats - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#get-sed-batch-stats - source: | - $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id - - # Submit Sed Batch Stats Request - - try { - Get-BetaSedBatchStats -BatchId $BatchId - - # Below is a request that includes all optional parameters - # Get-BetaSedBatchStats -BatchId $BatchId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatchStats" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-batches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#get-sed-batches - source: | - - # List Sed Batch Request - - try { - Get-BetaSedBatches - - # Below is a request that includes all optional parameters - # Get-BetaSedBatches - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatches" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-descriptions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#list-seds - source: | - $Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) - $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) - $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) - $Count = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) - $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) - $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) - $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) - - # List Suggested Entitlement Descriptions - - try { - Get-BetaSeds - - # Below is a request that includes all optional parameters - # Get-BetaSeds -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSeds" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-descriptions - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#patch-sed - source: | - $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id - $SedPatch = @"{ - "op" : "replace", - "path" : "status", - "value" : "approved" - }"@ - - - # Patch Suggested Entitlement Description - - try { - $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-BetaSed -Id $Id -SedPatch $Result - - # Below is a request that includes all optional parameters - # Update-BetaSed -Id $Id -SedPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-approvals - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#submit-sed-approval - source: | - $SedApproval = @"{ - "items" : "016629d1-1d25-463f-97f3-c6686846650" - }"@ - - - # Submit Bulk Approval Request - - try { - $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-BetaSedApproval -SedApproval $Result - - # Below is a request that includes all optional parameters - # Submit-BetaSedApproval -SedApproval $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-assignments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#submit-sed-assignment - source: | - $SedAssignment = @" - { - "assignee" : { - "type" : "SOURCE_OWNER", - "value" : "016629d1-1d25-463f-97f3-c6686846650" - }, - "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] - } - "@ - - # Submit Sed Assignment Request - - try { - $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-BetaSedAssignment -SedAssignment $Result - - # Below is a request that includes all optional parameters - # Submit-BetaSedAssignment -SedAssignment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-batches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#submit-sed-batch-request - source: | - $SedBatchRequest = @" - { - "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] - } - "@ - - # Submit Sed Batch Request - - try { - Submit-BetaSedBatchRequest - - # Below is a request that includes all optional parameters - # Submit-BetaSedBatchRequest -SedBatchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedBatchRequest" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type}/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#delete-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. - - # Delete Object Tags - - try { - Remove-BetaTaggedObject -Type $Type -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaTaggedObject -Type $Type -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTaggedObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/bulk-remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#delete-tags-to-many-object - source: | - $BulkTaggedObject = @" - { - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "operation" : "MERGE", - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Remove Tags from Multiple Objects - - try { - $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject - Remove-BetaTagsToManyObject -BulkTaggedObject $Result - - # Below is a request that includes all optional parameters - # Remove-BetaTagsToManyObject -BulkTaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagsToManyObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type}/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#get-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - - # Get Tagged Object - - try { - Get-BetaTaggedObject -Type $Type -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaTaggedObject -Type $Type -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#list-tagged-objects - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) - - # List Tagged Objects - - try { - Get-BetaTaggedObjects - - # Below is a request that includes all optional parameters - # Get-BetaTaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjects" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#list-tagged-objects-by-type - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) - - # List Tagged Objects by Type - - try { - Get-BetaTaggedObjectsByType -Type $Type - - # Below is a request that includes all optional parameters - # Get-BetaTaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjectsByType" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type}/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#put-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. - $TaggedObject = @" - { - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Update Tagged Object - - try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-BetaTaggedObject -Type $Type -Id $Id -TaggedObject $Result - - # Below is a request that includes all optional parameters - # Send-BetaTaggedObject -Type $Type -Id $Id -TaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTaggedObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#set-tag-to-object - source: | - $TaggedObject = @" - { - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Add Tag to Object - - try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-BetaTagToObject -TaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-BetaTagToObject -TaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagToObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/bulk-add - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#set-tags-to-many-objects - source: | - $BulkTaggedObject = @" - { - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "operation" : "MERGE", - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Tag Multiple Objects - - try { - $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject - Set-BetaTagsToManyObjects -BulkTaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-BetaTagsToManyObjects -BulkTaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagsToManyObjects" - Write-Host $_.ErrorDetails - } -- path: /tags - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tags#create-tag - source: | - $Tag = @" - { - "created" : "2022-05-04T14:48:49Z", - "tagCategoryRefs" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "name" : "PCI", - "modified" : "2022-07-14T16:31:11Z", - "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" - } - "@ - - # Create Tag - - try { - $Result = ConvertFrom-JsonToTag -Json $Tag - New-BetaTag -Tag $Result - - # Below is a request that includes all optional parameters - # New-BetaTag -Tag $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag" - Write-Host $_.ErrorDetails - } -- path: /tags/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tags#delete-tag-by-id - source: | - $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete. - - # Delete Tag - - try { - Remove-BetaTagById -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaTagById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagById" - Write-Host $_.ErrorDetails - } -- path: /tags/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tags#get-tag-by-id - source: | - $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve. - - # Get Tag By Id - - try { - Get-BetaTagById -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaTagById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTagById" - Write-Host $_.ErrorDetails - } -- path: /tags - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tags#list-tags - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) - - # List Tags - - try { - Get-BetaTags - - # Below is a request that includes all optional parameters - # Get-BetaTags -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTags" - Write-Host $_.ErrorDetails - } -- path: /task-status/pending-tasks - method: HEAD - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/task-management#get-pending-task-headers - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieve Pending Task List Headers - - try { - Get-BetaPendingTaskHeaders - - # Below is a request that includes all optional parameters - # Get-BetaPendingTaskHeaders -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTaskHeaders" - Write-Host $_.ErrorDetails - } -- path: /task-status/pending-tasks - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/task-management#get-pending-tasks - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieve Pending Task Status List - - try { - Get-BetaPendingTasks - - # Below is a request that includes all optional parameters - # Get-BetaPendingTasks -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTasks" - Write-Host $_.ErrorDetails - } -- path: /task-status/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/task-management#get-task-status - source: | - $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - - # Get Task Status by ID - - try { - Get-BetaTaskStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaTaskStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatus" - Write-Host $_.ErrorDetails - } -- path: /task-status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/task-management#get-task-status-list - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "completionStatus eq "Success"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) - $Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) - - # Retrieve Task Status List - - try { - Get-BetaTaskStatusList - - # Below is a request that includes all optional parameters - # Get-BetaTaskStatusList -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatusList" - Write-Host $_.ErrorDetails - } -- path: /task-status/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/task-management#update-task-status - source: | - $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Task Status by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaTaskStatus -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaTaskStatus -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTaskStatus" - Write-Host $_.ErrorDetails - } -- path: /tenant - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/tenant#get-tenant - source: | - - # Get Tenant Information. - - try { - Get-BetaTenant - - # Below is a request that includes all optional parameters - # Get-BetaTenant - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenant" - Write-Host $_.ErrorDetails - } -- path: /transforms - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/transforms#create-transform - source: | - $Transform = @" - { - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" - } - "@ - - # Create transform - - try { - $Result = ConvertFrom-JsonToTransform -Json $Transform - New-BetaTransform -Transform $Result - - # Below is a request that includes all optional parameters - # New-BetaTransform -Transform $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTransform" - Write-Host $_.ErrorDetails - } -- path: /transforms/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/transforms#delete-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete - - # Delete a transform - - try { - Remove-BetaTransform -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaTransform -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTransform" - Write-Host $_.ErrorDetails - } -- path: /transforms/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/transforms#get-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve - - # Transform by ID - - try { - Get-BetaTransform -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaTransform -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransform" - Write-Host $_.ErrorDetails - } -- path: /transforms - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/transforms#list-transforms - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) - $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) - - # List transforms - - try { - Get-BetaTransforms - - # Below is a request that includes all optional parameters - # Get-BetaTransforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransforms" - Write-Host $_.ErrorDetails - } -- path: /transforms/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/transforms#update-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update - $Transform = @" - { - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" - } - "@ - - # Update a transform - - try { - Update-BetaTransform -Id $Id - - # Below is a request that includes all optional parameters - # Update-BetaTransform -Id $Id -Transform $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTransform" - Write-Host $_.ErrorDetails - } -- path: /trigger-invocations/{id}/complete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/triggers#complete-trigger-invocation - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. - $CompleteInvocation = @" - { - "output" : { - "approved" : false - }, - "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "error" : "Access request is denied." - } - "@ - - # Complete Trigger Invocation - - try { - $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation - Complete-BetaTriggerInvocation -Id $Id -CompleteInvocation $Result - - # Below is a request that includes all optional parameters - # Complete-BetaTriggerInvocation -Id $Id -CompleteInvocation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaTriggerInvocation" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/triggers#create-subscription - source: | - $SubscriptionPostRequest = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "triggerId" : "idn:access-requested", - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - } - "@ - - # Create a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest - New-BetaSubscription -SubscriptionPostRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaSubscription -SubscriptionPostRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSubscription" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/triggers#delete-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID - - # Delete a Subscription - - try { - Remove-BetaSubscription -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSubscription -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSubscription" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/triggers#list-subscriptions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) - $Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) - - # List Subscriptions - - try { - Get-BetaSubscriptions - - # Below is a request that includes all optional parameters - # Get-BetaSubscriptions -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSubscriptions" - Write-Host $_.ErrorDetails - } -- path: /trigger-invocations/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/triggers#list-trigger-invocation-status - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "triggerId eq "idn:access-request-dynamic-approver"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) - - # List Latest Invocation Statuses - - try { - Get-BetaTriggerInvocationStatus - - # Below is a request that includes all optional parameters - # Get-BetaTriggerInvocationStatus -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggerInvocationStatus" - Write-Host $_.ErrorDetails - } -- path: /triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/triggers#list-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "idn:access-request-post-approval"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) - - # List Triggers - - try { - Get-BetaTriggers - - # Below is a request that includes all optional parameters - # Get-BetaTriggers -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggers" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/triggers#patch-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch - $SubscriptionPatchRequestInner = @""@ - - - # Patch a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner - Update-BetaSubscription -Id $Id -SubscriptionPatchRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-BetaSubscription -Id $Id -SubscriptionPatchRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" - Write-Host $_.ErrorDetails - } -- path: /trigger-invocations/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/triggers#start-test-trigger-invocation - source: | - $TestInvocation = @" - { - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - }, - "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], - "triggerId" : "idn:access-request-post-approval", - "contentJson" : { - "workflowId" : 1234 - } - } - "@ - - # Start a Test Invocation - - try { - $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation - Start-BetaTestTriggerInvocation -TestInvocation $Result - - # Below is a request that includes all optional parameters - # Start-BetaTestTriggerInvocation -TestInvocation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaTestTriggerInvocation" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions/validate-filter - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/triggers#test-subscription-filter - source: | - $ValidateFilterInputDto = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - } - } - "@ - - # Validate a Subscription Filter - - try { - $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto - Test-BetaSubscriptionFilter -ValidateFilterInputDto $Result - - # Below is a request that includes all optional parameters - # Test-BetaSubscriptionFilter -ValidateFilterInputDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSubscriptionFilter" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/triggers#update-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID - $SubscriptionPutRequest = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - } - "@ - - # Update a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest - Update-BetaSubscription -Id $Id -SubscriptionPutRequest $Result - - # Below is a request that includes all optional parameters - # Update-BetaSubscription -Id $Id -SubscriptionPutRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" - Write-Host $_.ErrorDetails - } -- path: /ui-metadata/tenant - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/ui-metadata#get-tenant-ui-metadata - source: | - - # Get a tenant UI metadata - - try { - Get-BetaTenantUiMetadata - - # Below is a request that includes all optional parameters - # Get-BetaTenantUiMetadata - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantUiMetadata" - Write-Host $_.ErrorDetails - } -- path: /ui-metadata/tenant - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/ui-metadata#set-tenant-ui-metadata - source: | - $TenantUiMetadataItemUpdateRequest = @" - { - "usernameEmptyText" : "Please provide your work email address...", - "usernameLabel" : "Email", - "iframeWhiteList" : "http://example.com http://example2.com" - } - "@ - - # Update tenant UI metadata - - try { - $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest - Set-BetaTenantUiMetadata -TenantUiMetadataItemUpdateRequest $Result - - # Below is a request that includes all optional parameters - # Set-BetaTenantUiMetadata -TenantUiMetadataItemUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTenantUiMetadata" - Write-Host $_.ErrorDetails - } -- path: /vendor-connector-mappings - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#create-vendor-connector-mapping - source: | - $VendorConnectorMapping = @" - { - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - } - "@ - - # Create Vendor Connector Mapping - - try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-BetaVendorConnectorMapping -VendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # New-BetaVendorConnectorMapping -VendorConnectorMapping $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVendorConnectorMapping" - Write-Host $_.ErrorDetails - } -- path: /vendor-connector-mappings - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#delete-vendor-connector-mapping - source: | - $VendorConnectorMapping = @" - { - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - } - "@ - - # Delete Vendor Connector Mapping - - try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-BetaVendorConnectorMapping -VendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # Remove-BetaVendorConnectorMapping -VendorConnectorMapping $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVendorConnectorMapping" - Write-Host $_.ErrorDetails - } -- path: /vendor-connector-mappings - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#get-vendor-connector-mappings - source: | - - # List Vendor Connector Mappings - - try { - Get-BetaVendorConnectorMappings - - # Below is a request that includes all optional parameters - # Get-BetaVendorConnectorMappings - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Approve an Approval Item - - try { - Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk approve Approval Items - - try { - Approve-BetaApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Approve-BetaApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) - - # Complete a Work Item - - try { - Complete-BetaWorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Complete-BetaWorkItem -Id $Id -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#forward-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ - - # Forward a Work Item - - try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result - - # Below is a request that includes all optional parameters - # Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-completed-work-items - source: | - $OwnerId = "MyOwnerId" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Completed Work Items - - try { - Get-BetaCompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-BetaCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-completed-work-items - source: | - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - - # Count Completed Work Items - - try { - Get-BetaCountCompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-work-items - source: | - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - - # Count Work Items - - try { - Get-BetaCountWorkItems - - # Below is a request that includes all optional parameters - # Get-BetaCountWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - $OwnerId = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item owner. (optional) - - # Get a Work Item - - try { - Get-BetaWorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkItem -Id $Id -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-items-summary - source: | - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - - # Work Items Summary - - try { - Get-BetaWorkItemsSummary - - # Below is a request that includes all optional parameters - # Get-BetaWorkItemsSummary -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" - Write-Host $_.ErrorDetails - } -- path: /work-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#list-work-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - - # List Work Items - - try { - Get-BetaWorkItems - - # Below is a request that includes all optional parameters - # Get-BetaWorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Reject an Approval Item - - try { - Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk reject Approval Items - - try { - Deny-BetaApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Deny-BetaApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#submit-account-selection - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - - # Submit Account Selections - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-BetaAccountSelection -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Submit-BetaAccountSelection -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#create-reassignment-configuration - source: | - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - - # Create a Reassignment Configuration - - try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId}/{configType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#delete-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | - - # Delete Reassignment Configuration - - try { - Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType - - # Below is a request that includes all optional parameters - # Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId}/evaluate/{configType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-evaluate-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type - $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - - $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ - - # Evaluate Reassignment Configuration - - try { - Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType - - # Below is a request that includes all optional parameters - # Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -ExclusionFilters $ExclusionFilters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-config-types - source: | - - # List Reassignment Config Types - - try { - Get-BetaReassignmentConfigTypes - - # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfigTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id - - # Get Reassignment Configuration - - try { - Get-BetaReassignmentConfiguration -IdentityId $IdentityId - - # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfiguration -IdentityId $IdentityId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/tenant-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-tenant-config-configuration - source: | - - # Get Tenant-wide Reassignment Configuration settings - - try { - Get-BetaTenantConfigConfiguration - - # Below is a request that includes all optional parameters - # Get-BetaTenantConfigConfiguration - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#list-reassignment-configurations - source: | - $Limit = 20 # Int32 | Max number of results to return. (optional) (default to 20) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - - # List Reassignment Configurations - - try { - Get-BetaReassignmentConfigurations - - # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfigurations -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-reassignment-config - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - - # Update Reassignment Configuration - - try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/tenant-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-tenant-configuration - source: | - $TenantConfigurationRequest = @" - { - "configDetails" : { - "disabled" : true - } - } - "@ - - # Update Tenant-wide Reassignment Configuration settings - - try { - $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-BetaTenantConfiguration -TenantConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaTenantConfiguration -TenantConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-BetaWorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-BetaWorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-BetaWorkflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaWorkflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-BetaWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaWorkflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) - - # Get Workflow By Id - - try { - Get-BetaWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflow -Id $Id -WorkflowMetrics $WorkflowMetrics - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-BetaWorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-BetaWorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-BetaWorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-BetaCompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-BetaWorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-BetaWorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-BetaWorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $TriggerId = "idn:identity-created" # String | Trigger ID (optional) - $ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) - - # List Workflows - - try { - Get-BetaWorkflows - - # Below is a request that includes all optional parameters - # Get-BetaWorkflows -Limit $Limit -Offset $Offset -TriggerId $TriggerId -ConnectorInstanceId $ConnectorInstanceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $PostExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - Submit-BetaExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - Submit-BetaWorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # Submit-BetaWorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-BetaWorkflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-BetaWorkflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-BetaExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" - Write-Host $_.ErrorDetails - } diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index 0e2bc76b1..139597f9c 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -1,18623 +1,2 @@ -- path: /access-model-metadata/attributes/{key} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#get-access-model-metadata-attribute - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Model Metadata Attribute - - try { - Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" - Write-Host $_.ErrorDetails - } -- path: /access-model-metadata/attributes/{key}/values/{value} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#get-access-model-metadata-attribute-value - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $Value = "public" # String | Technical name of the Attribute value. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Model Metadata Value - - try { - Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" - Write-Host $_.ErrorDetails - } -- path: /access-model-metadata/attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#list-access-model-metadata-attribute - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) - - # List Access Model Metadata Attributes - - try { - Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" - Write-Host $_.ErrorDetails - } -- path: /access-model-metadata/attributes/{key}/values - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#list-access-model-metadata-attribute-value - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Access Model Metadata Values - - try { - Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" - Write-Host $_.ErrorDetails - } -- path: /access-profiles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#create-access-profile - source: | - $AccessProfile = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "description" : "Collection of entitlements to read/write the employee database", - "source" : { - "name" : "ODS-AD-SOURCE", - "id" : "2c91809773dee3610173fdb0b6061ef4", - "type" : "SOURCE" - }, - "enabled" : true, - "revocationRequestConfig" : { - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ] - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "accessRequestConfig" : { - "commentsRequired" : true, - "reauthorizationRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "name" : "Employee-database-read-write", - "provisioningCriteria" : { - "children" : [ { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, - "modified" : "2021-03-02T20:22:28.104Z", - "id" : "2c91808a7190d06e01719938fcd20792", - "requestable" : true - } - "@ - - # Create Access Profile - - try { - $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile - New-V2024AccessProfile -AccessProfile $Result - - # Below is a request that includes all optional parameters - # New-V2024AccessProfile -AccessProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#delete-access-profile - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete - - # Delete the specified Access Profile - - try { - Remove-V2024AccessProfile -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024AccessProfile -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#delete-access-profiles-in-bulk - source: | - $AccessProfileBulkDeleteRequest = @" - { - "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], - "bestEffortOnly" : true - } - "@ - - # Delete Access Profile(s) - - try { - $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest - Remove-V2024AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2024AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesInBulk" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#get-access-profile - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile - - # Get an Access Profile - - try { - Get-V2024AccessProfile -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024AccessProfile -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#get-access-profile-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Access Profile's Entitlements - - try { - Get-V2024AccessProfileEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfileEntitlements" - Write-Host $_.ErrorDetails - } -- path: /access-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#list-access-profiles - source: | - $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) - - # List Access Profiles - - try { - Get-V2024AccessProfiles - - # Below is a request that includes all optional parameters - # Get-V2024AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfiles" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#patch-access-profile - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Access Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024AccessProfile -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024AccessProfile -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/bulk-update-requestable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#update-access-profiles-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ - - - # Update Access Profile(s) requestable field. - - try { - $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner - Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfilesInBulk" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{approvalId}/approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#approve-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $CommentDto = @" - { - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - } - "@ - - # Approve Access Request Approval - - try { - Approve-V2024AccessRequest -ApprovalId $ApprovalId - - # Below is a request that includes all optional parameters - # Approve-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{approvalId}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#forward-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $ForwardApprovalDto = @" - { - "newOwnerId" : "2c91808568c529c60168cca6f90c1314", - "comment" : "2c91808568c529c60168cca6f90c1313" - } - "@ - - # Forward Access Request Approval - - try { - $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto - Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result - - # Below is a request that includes all optional parameters - # Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardAccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/approval-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#get-access-request-approval-summary - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) - - # Get Access Requests Approvals Number - - try { - Get-V2024AccessRequestApprovalSummary - - # Below is a request that includes all optional parameters - # Get-V2024AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovalSummary" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{accessRequestId}/approvers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#list-access-request-approvers - source: | - $AccessRequestId = "2c91808568c529c60168cca6f90c1313" # String | Access Request ID. - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - - # Access Request Approvers - - try { - Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId - - # Below is a request that includes all optional parameters - # Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovers" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#list-completed-approvals - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Completed Access Request Approvals List - - try { - Get-V2024CompletedApprovals - - # Below is a request that includes all optional parameters - # Get-V2024CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedApprovals" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/pending - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#list-pending-approvals - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Pending Access Request Approvals List - - try { - Get-V2024PendingApprovals - - # Below is a request that includes all optional parameters - # Get-V2024PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingApprovals" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{approvalId}/reject - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#reject-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $CommentDto = @" - { - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - } - "@ - - # Reject Access Request Approval - - try { - $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Deny-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - - # Below is a request that includes all optional parameters - # Deny-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-request-identity-metrics#get-access-request-identity-metrics - source: | - $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. - $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. - $Type = "ENTITLEMENT" # String | Requested access item's type. - - # Return access request identity metrics - - try { - Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/bulk-approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-requests#approve-bulk-access-request - source: | - $BulkApproveAccessRequest = @" - { - "comment" : "I approve these request items", - "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] - } - "@ - - # Bulk Approve Access Request - - try { - $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest - Approve-V2024BulkAccessRequest -BulkApproveAccessRequest $Result - - # Below is a request that includes all optional parameters - # Approve-V2024BulkAccessRequest -BulkApproveAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024BulkAccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-requests/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-requests#cancel-access-request - source: | - $CancelAccessRequest = @" - { - "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I requested this role by mistake." - } - "@ - - # Cancel Access Request - - try { - $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest - Suspend-V2024AccessRequest -CancelAccessRequest $Result - - # Below is a request that includes all optional parameters - # Suspend-V2024AccessRequest -CancelAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-requests/bulk-cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-requests#cancel-access-request-in-bulk - source: | - $BulkCancelAccessRequest = @" - { - "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], - "comment" : "I requested this role by mistake." - } - "@ - - # Bulk Cancel Access Request - - try { - $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest - Suspend-V2024AccessRequestInBulk -BulkCancelAccessRequest $Result - - # Below is a request that includes all optional parameters - # Suspend-V2024AccessRequestInBulk -BulkCancelAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequestInBulk" - Write-Host $_.ErrorDetails - } -- path: /access-requests/close - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-requests#close-access-request - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CloseAccessRequest = @" - { - "executionStatus" : "Terminated", - "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "completionStatus" : "Failure", - "message" : "The IdentityNow Administrator manually closed this request." - } - "@ - - # Close Access Request - - try { - $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest - Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result - - # Below is a request that includes all optional parameters - # Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-requests#create-access-request - source: | - $AccessRequest = @" - { - "requestedFor" : "2c918084660f45d6016617daa9210584", - "clientMetadata" : { - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", - "requestedAppName" : "test-app" - }, - "requestType" : "GRANT_ACCESS", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ], - "requestedForWithRequestedItems" : [ { - "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ] - }, { - "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ] - } ] - } - "@ - - # Submit Access Request - - try { - $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest - New-V2024AccessRequest -AccessRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024AccessRequest -AccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-requests#get-access-request-config - source: | - - # Get Access Request Configuration - - try { - Get-V2024AccessRequestConfig - - # Below is a request that includes all optional parameters - # Get-V2024AccessRequestConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /access-request-status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-requests#list-access-request-status - source: | - $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) - $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - - # Access Request Status - - try { - Get-V2024AccessRequestStatus - - # Below is a request that includes all optional parameters - # Get-V2024AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestStatus" - Write-Host $_.ErrorDetails - } -- path: /access-request-administration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-requests#list-administrators-access-request-status - source: | - $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) - $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - - # Access Request Status for Administrators - - try { - Get-V2024AdministratorsAccessRequestStatus - - # Below is a request that includes all optional parameters - # Get-V2024AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus" - Write-Host $_.ErrorDetails - } -- path: /access-requests/accounts-selection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-requests#load-account-selections - source: | - $AccountsSelectionRequest = @" - { - "requestedFor" : "2c918084660f45d6016617daa9210584", - "clientMetadata" : { - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", - "requestedAppName" : "test-app" - }, - "requestType" : "GRANT_ACCESS", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ] - } - "@ - - # Get accounts selections for identity - - try { - $Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest - Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result - - # Below is a request that includes all optional parameters - # Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024LoadAccountSelections" - Write-Host $_.ErrorDetails - } -- path: /access-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-requests#set-access-request-config - source: | - $AccessRequestConfig = @" - { - "requestOnBehalfOfConfig" : { - "allowRequestOnBehalfOfEmployeeByManager" : true, - "allowRequestOnBehalfOfAnyoneByAnyone" : true - }, - "approvalReminderAndEscalationConfig" : { - "fallbackApproverRef" : { - "name" : "Alison Ferguso", - "id" : "5168015d32f890ca15812c9180835d2e", - "type" : "IDENTITY", - "email" : "alison.ferguso@identitysoon.com" - }, - "maxReminders" : 1, - "daysUntilEscalation" : 0, - "daysBetweenReminders" : 0 - }, - "autoApprovalEnabled" : true, - "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - }, - "reauthorizationEnabled" : true, - "approvalsMustBeExternal" : true - } - "@ - - # Update Access Request Configuration - - try { - $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig - Set-V2024AccessRequestConfig -AccessRequestConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2024AccessRequestConfig -AccessRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /account-activities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/account-activities#get-account-activity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id - - # Get an Account Activity - - try { - Get-V2024AccountActivity -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024AccountActivity -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivity" - Write-Host $_.ErrorDetails - } -- path: /account-activities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/account-activities#list-account-activities - source: | - $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) - - # List Account Activities - - try { - Get-V2024AccountActivities - - # Below is a request that includes all optional parameters - # Get-V2024AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivities" - Write-Host $_.ErrorDetails - } -- path: /account-aggregations/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/account-aggregations#get-account-aggregation-status - source: | - $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # In-progress Account Aggregation status - - try { - Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" - Write-Host $_.ErrorDetails - } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2024UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" - Write-Host $_.ErrorDetails - } -- path: /accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#create-account - source: | - $AccountAttributesCreate = @" - { - "attributes" : { - "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - } - "@ - - # Create Account - - try { - $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate - New-V2024Account -AccountAttributesCreate $Result - - # Below is a request that includes all optional parameters - # New-V2024Account -AccountAttributesCreate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#delete-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - - # Delete Account - - try { - Remove-V2024Account -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Account -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#delete-account-async - source: | - $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Remove Account - - try { - Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#disable-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $AccountToggleRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } - "@ - - # Disable Account - - try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Disable-V2024Account -Id $Id -AccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Disable-V2024Account -Id $Id -AccountToggleRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account" - Write-Host $_.ErrorDetails - } -- path: /identities-accounts/{id}/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#disable-account-for-identity - source: | - $Id = "2c91808384203c2d018437e631158309" # String | The identity id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Disable IDN Account for Identity - - try { - Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity" - Write-Host $_.ErrorDetails - } -- path: /identities-accounts/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#disable-accounts-for-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentitiesAccountsBulkRequest = @" - { - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - } - "@ - - # Disable IDN Accounts for Identities - - try { - $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - - # Below is a request that includes all optional parameters - # Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#enable-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $AccountToggleRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } - "@ - - # Enable Account - - try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Enable-V2024Account -Id $Id -AccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Enable-V2024Account -Id $Id -AccountToggleRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account" - Write-Host $_.ErrorDetails - } -- path: /identities-accounts/{id}/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#enable-account-for-identity - source: | - $Id = "2c91808384203c2d018437e631158309" # String | The identity id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Enable IDN Account for Identity - - try { - Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity" - Write-Host $_.ErrorDetails - } -- path: /identities-accounts/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#enable-accounts-for-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentitiesAccountsBulkRequest = @" - { - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - } - "@ - - # Enable IDN Accounts for Identities - - try { - $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - - # Below is a request that includes all optional parameters - # Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#get-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - - # Account Details - - try { - Get-V2024Account -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Account -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#get-account-entitlements - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Account Entitlements - - try { - Get-V2024AccountEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountEntitlements" - Write-Host $_.ErrorDetails - } -- path: /accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#list-accounts - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) - - # Accounts List - - try { - Get-V2024Accounts - - # Below is a request that includes all optional parameters - # Get-V2024Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Accounts" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#put-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - $AccountAttributes = @" - { - "attributes" : { - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - } - "@ - - # Update Account - - try { - $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes - Send-V2024Account -Id $Id -AccountAttributes $Result - - # Below is a request that includes all optional parameters - # Send-V2024Account -Id $Id -AccountAttributes $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/reload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#submit-reload-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - - # Reload Account - - try { - Submit-V2024ReloadAccount -Id $Id - - # Below is a request that includes all optional parameters - # Submit-V2024ReloadAccount -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReloadAccount" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/unlock - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#unlock-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. - $AccountUnlockRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", - "unlockIDNAccount" : false - } - "@ - - # Unlock Account - - try { - $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest - Unlock-V2024Account -Id $Id -AccountUnlockRequest $Result - - # Below is a request that includes all optional parameters - # Unlock-V2024Account -Id $Id -AccountUnlockRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#update-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"[{op=remove, path=/identityId}]"@ - - - # Update Account - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024Account -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2024Account -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" - Write-Host $_.ErrorDetails - } -- path: /discovered-applications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/application-discovery#get-discovered-applications - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) - $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) - - # Get Discovered Applications for Tenant - - try { - Get-V2024DiscoveredApplications - - # Below is a request that includes all optional parameters - # Get-V2024DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DiscoveredApplications" - Write-Host $_.ErrorDetails - } -- path: /manual-discover-applications-template - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/application-discovery#get-manual-discover-applications-csv-template - source: | - - # Download CSV Template for Discovery - - try { - Get-V2024ManualDiscoverApplicationsCsvTemplate - - # Below is a request that includes all optional parameters - # Get-V2024ManualDiscoverApplicationsCsvTemplate - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails - } -- path: /manual-discover-applications - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/application-discovery#send-manual-discover-applications-csv-template - source: | - $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - - # Upload CSV to Discover Applications - - try { - Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File - - # Below is a request that includes all optional parameters - # Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails - } -- path: /generic-approvals/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/approvals#get-approval - source: | - $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that is to be returned - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get an approval - - try { - Get-V2024Approval -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024Approval -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approval" - Write-Host $_.ErrorDetails - } -- path: /generic-approvals - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/approvals#get-approvals - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Mine = $true # Boolean | Returns the list of approvals for the current caller (optional) - $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID (optional) - $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) - - # Get Approvals - - try { - Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approvals" - Write-Host $_.ErrorDetails - } -- path: /source-apps - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#create-source-app - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceAppCreateDto = @" - { - "name" : "my app", - "description" : "the source app for engineers", - "accountSource" : { - "name" : "ODS-AD-Source", - "id" : "2c9180827ca885d7017ca8ce28a000eb", - "type" : "SOURCE" - }, - "matchAllAccounts" : true - } - "@ - - # Create source app - - try { - $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto - New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result - - # Below is a request that includes all optional parameters - # New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id}/access-profiles/bulk-remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#delete-access-profiles-from-source-app-by-bulk - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @"[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]"@ - - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # Bulk remove access profiles from the specified source app - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2024AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-V2024AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesFromSourceAppByBulk" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#delete-source-app - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete source app by ID - - try { - Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#get-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get source app by ID - - try { - Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id}/access-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-access-profiles-for-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "name eq "developer access profile"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List access profiles for the specified source app - - try { - Get-V2024AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfilesForSourceApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/all - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-all-source-app - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - $Filters = "enabled eq true" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) - - # List all source apps - - try { - Get-V2024AllSourceApp -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AllSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllSourceApp" - Write-Host $_.ErrorDetails - } -- path: /user-apps/all - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-all-user-apps - source: | - $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List all user apps - - try { - Get-V2024AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllUserApps" - Write-Host $_.ErrorDetails - } -- path: /source-apps/assigned - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-assigned-source-app - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) - $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - - # List assigned source apps - - try { - Get-V2024AssignedSourceApp -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AssignedSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AssignedSourceApp" - Write-Host $_.ErrorDetails - } -- path: /user-apps/{id}/available-accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-available-accounts-for-user-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List available accounts for user app - - try { - Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableAccountsForUserApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-available-source-apps - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - - # List available source apps - - try { - Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableSourceApps" - Write-Host $_.ErrorDetails - } -- path: /user-apps - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-owned-user-apps - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) - - # List owned user apps - - try { - Get-V2024OwnedUserApps -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024OwnedUserApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OwnedUserApps" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#patch-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch source app by ID - - try { - Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceApp" - Write-Host $_.ErrorDetails - } -- path: /user-apps/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#patch-user-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch user app by ID - - try { - Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024UserApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#update-source-apps-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceAppBulkUpdateRequest = @" - { - "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : false - }, { - "op" : "replace", - "path" : "/matchAllAccounts", - "value" : false - } ] - } - "@ - - # Bulk update source apps - - try { - Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -SourceAppBulkUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceAppsInBulk" - Write-Host $_.ErrorDetails - } -- path: /auth-profiles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/auth-profile#get-profile-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - - # Get Auth Profile - - try { - Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/auth-profile#get-profile-config-list - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get list of Auth Profiles - - try { - Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfigList" - Write-Host $_.ErrorDetails - } -- path: /auth-profiles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/auth-profile#patch-profile-config - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Auth Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProfileConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-users/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/auth-users#get-auth-user - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - - # Auth User Details - - try { - Get-V2024AuthUser -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024AuthUser -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthUser" - Write-Host $_.ErrorDetails - } -- path: /auth-users/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/auth-users#patch-auth-user - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Auth User Update - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024AuthUser -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024AuthUser -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthUser" - Write-Host $_.ErrorDetails - } -- path: /brandings - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/branding#create-branding-item - source: | - $Name = "MyName" # String | name of branding item - $ProductName = "MyProductName" # String | product name - $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) - $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) - $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) - $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) - $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) - $FileStandard = # System.IO.FileInfo | png file with logo (optional) - - # Create a branding item - - try { - New-V2024BrandingItem -Name $Name -ProductName $ProductName - - # Below is a request that includes all optional parameters - # New-V2024BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024BrandingItem" - Write-Host $_.ErrorDetails - } -- path: /brandings/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/branding#delete-branding - source: | - $Name = "default" # String | The name of the branding item to be deleted - - # Delete a branding item - - try { - Remove-V2024Branding -Name $Name - - # Below is a request that includes all optional parameters - # Remove-V2024Branding -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Branding" - Write-Host $_.ErrorDetails - } -- path: /brandings/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/branding#get-branding - source: | - $Name = "default" # String | The name of the branding item to be retrieved - - # Get a branding item - - try { - Get-V2024Branding -Name $Name - - # Below is a request that includes all optional parameters - # Get-V2024Branding -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Branding" - Write-Host $_.ErrorDetails - } -- path: /brandings - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/branding#get-branding-list - source: | - - # List of branding items - - try { - Get-V2024BrandingList - - # Below is a request that includes all optional parameters - # Get-V2024BrandingList - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BrandingList" - Write-Host $_.ErrorDetails - } -- path: /brandings/{name} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/branding#set-branding-item - source: | - $Name = "default" # String | The name of the branding item to be retrieved - $Name2 = "Name_example" # String | name of branding item - $ProductName = "MyProductName" # String | product name - $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) - $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) - $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) - $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) - $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) - $FileStandard = # System.IO.FileInfo | png file with logo (optional) - - # Update a branding item - - try { - Set-V2024BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName - - # Below is a request that includes all optional parameters - # Set-V2024BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024BrandingItem" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#create-campaign-filter - source: | - $CampaignFilterDetails = @" - { - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - } - "@ - - # Create Campaign Filter - - try { - $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - New-V2024CampaignFilter -CampaignFilterDetails $Result - - # Below is a request that includes all optional parameters - # New-V2024CampaignFilter -CampaignFilterDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignFilter" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters/delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#delete-campaign-filters - source: | - $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. - $RequestBody = @""@ - - - # Deletes Campaign Filters - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2024CampaignFilters -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-V2024CampaignFilters -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignFilters" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#get-campaign-filter-by-id - source: | - $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. - - # Get Campaign Filter by ID - - try { - Get-V2024CampaignFilterById -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024CampaignFilterById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilterById" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#list-campaign-filters - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) - - # List Campaign Filters - - try { - Get-V2024CampaignFilters - - # Below is a request that includes all optional parameters - # Get-V2024CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilters" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#update-campaign-filter - source: | - $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. - $CampaignFilterDetails = @" - { - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - } - "@ - - # Updates a Campaign Filter - - try { - $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - Update-V2024CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result - - # Below is a request that includes all optional parameters - # Update-V2024CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignFilter" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/complete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#complete-campaign - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. - $CampaignCompleteOptions = @" - { - "autoCompleteAction" : "REVOKE" - } - "@ - - # Complete a Campaign - - try { - Complete-V2024Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Complete-V2024Campaign -Id $Id -CampaignCompleteOptions $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024Campaign" - Write-Host $_.ErrorDetails - } -- path: /campaigns - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#create-campaign - source: | - $Campaign = @" - { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "reviewerId" : "2c91808568c529c60168cca6f90c1313", - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - } - "@ - - # Create a campaign - - try { - $Result = ConvertFrom-JsonToCampaign -Json $Campaign - New-V2024Campaign -Campaign $Result - - # Below is a request that includes all optional parameters - # New-V2024Campaign -Campaign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Campaign" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#create-campaign-template - source: | - $CampaignTemplate = @" - { - "ownerRef" : { - "name" : "Mister Manager", - "id" : "2c918086676d3e0601677611dbde220f", - "type" : "IDENTITY", - "email" : "mr.manager@example.com" - }, - "deadlineDuration" : "P2W", - "created" : "2020-03-05T22:44:00.364Z", - "scheduled" : false, - "name" : "Manager Campaign Template", - "description" : "Template for the annual manager campaign.", - "modified" : "2020-03-05T22:52:09.969Z", - "campaign" : { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "reviewerId" : "2c91808568c529c60168cca6f90c1313", - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - }, - "id" : "2c9079b270a266a60170a277bb960008" - } - "@ - - # Create a Campaign Template - - try { - $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate - New-V2024CampaignTemplate -CampaignTemplate $Result - - # Below is a request that includes all optional parameters - # New-V2024CampaignTemplate -CampaignTemplate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#delete-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. - - # Delete a Campaign Template - - try { - Remove-V2024CampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024CampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#delete-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. - - # Delete Campaign Template Schedule - - try { - Remove-V2024CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024CampaignTemplateSchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } -- path: /campaigns/delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#delete-campaigns - source: | - $CampaignsDeleteRequest = @" - { - "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] - } - "@ - - # Delete Campaigns - - try { - $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest - Remove-V2024Campaigns -CampaignsDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2024Campaigns -CampaignsDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Campaigns" - Write-Host $_.ErrorDetails - } -- path: /campaigns - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-active-campaigns - source: | - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) - - # List Campaigns - - try { - Get-V2024ActiveCampaigns - - # Below is a request that includes all optional parameters - # Get-V2024ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ActiveCampaigns" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - - # Get Campaign - - try { - Get-V2024Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Campaign -Id $Id -Detail $Detail - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Campaign" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/reports - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-reports - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. - - # Get Campaign Reports - - try { - Get-V2024CampaignReports -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024CampaignReports -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReports" - Write-Host $_.ErrorDetails - } -- path: /campaigns/reports-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-reports-config - source: | - - # Get Campaign Reports Configuration - - try { - Get-V2024CampaignReportsConfig - - # Below is a request that includes all optional parameters - # Get-V2024CampaignReportsConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReportsConfig" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. - - # Get a Campaign Template - - try { - Get-V2024CampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024CampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. - - # Get Campaign Template Schedule - - try { - Get-V2024CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024CampaignTemplateSchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-templates - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) - - # List Campaign Templates - - try { - Get-V2024CampaignTemplates - - # Below is a request that includes all optional parameters - # Get-V2024CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplates" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/reassign - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#move - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID - $AdminReviewReassign = @" - { - "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], - "reason" : "reassigned for some reason", - "reassignTo" : { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "IDENTITY" - } - } - "@ - - # Reassign Certifications - - try { - $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign - Move-V2024 -Id $Id -AdminReviewReassign $Result - - # Below is a request that includes all optional parameters - # Move-V2024 -Id $Id -AdminReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2024" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#patch-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update a Campaign Template - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024CampaignTemplate -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024CampaignTemplate -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaigns/reports-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#set-campaign-reports-config - source: | - $CampaignReportsConfig = @" - { - "identityAttributeColumns" : [ "firstname", "lastname" ] - } - "@ - - # Set Campaign Reports Configuration - - try { - $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig - Set-V2024CampaignReportsConfig -CampaignReportsConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2024CampaignReportsConfig -CampaignReportsConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignReportsConfig" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#set-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. - $Schedule = @" - { - "hours" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "months" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "timeZoneId" : "CST", - "days" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "expiration" : "2000-01-23T04:56:07.000+00:00", - "type" : "WEEKLY" - } - "@ - - # Set Campaign Template Schedule - - try { - Set-V2024CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Set-V2024CampaignTemplateSchedule -Id $Id -Schedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/activate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#start-campaign - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. - $ActivateCampaignOptions = @" - { - "timeZone" : "-05:00" - } - "@ - - # Activate a Campaign - - try { - Start-V2024Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024Campaign -Id $Id -ActivateCampaignOptions $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Campaign" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/run-remediation-scan - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#start-campaign-remediation-scan - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. - - # Run Campaign Remediation Scan - - try { - Start-V2024CampaignRemediationScan -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024CampaignRemediationScan -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignRemediationScan" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/run-report/{type} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#start-campaign-report - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. - $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. - - # Run Campaign Report - - try { - Start-V2024CampaignReport -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Start-V2024CampaignReport -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignReport" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/generate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#start-generate-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. - - # Generate a Campaign from Template - - try { - Start-V2024GenerateCampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024GenerateCampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024GenerateCampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#update-campaign - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update a Campaign - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Campaign -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024Campaign -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2024IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2024IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2024IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" - Write-Host $_.ErrorDetails - } -- path: /certification-tasks/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-certification-task - source: | - $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID - - # Certification Task by ID - - try { - Get-V2024CertificationTask -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024CertificationTask -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationTask" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-identity-certification - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id - - # Identity Certification by ID - - try { - Get-V2024IdentityCertification -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentityCertification -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertification" - Write-Host $_.ErrorDetails - } -- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-identity-certification-item-permissions - source: | - $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID - $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Permissions for Entitlement Certification Item - - try { - Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId - - # Below is a request that includes all optional parameters - # Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertificationItemPermissions" - Write-Host $_.ErrorDetails - } -- path: /certification-tasks - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-pending-certification-tasks - source: | - $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) - - # List of Pending Certification Tasks - - try { - Get-V2024PendingCertificationTasks - - # Below is a request that includes all optional parameters - # Get-V2024PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingCertificationTasks" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/reviewers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certifications#list-certification-reviewers - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) - - # List of Reviewers for certification - - try { - Get-V2024CertificationReviewers -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationReviewers" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/access-review-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certifications#list-identity-access-review-items - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) - $Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) - $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) - $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) - - # List of Access Review Items - - try { - Get-V2024IdentityAccessReviewItems -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessReviewItems" - Write-Host $_.ErrorDetails - } -- path: /certifications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certifications#list-identity-certifications - source: | - $ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) - $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) - - # List Identity Campaign Certifications - - try { - Get-V2024IdentityCertifications - - # Below is a request that includes all optional parameters - # Get-V2024IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertifications" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decide - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certifications#make-identity-decision - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions - $ReviewDecision = @"{ - "comments" : "This user no longer needs access to this source", - "decision" : "APPROVE", - "proposedEndDate" : "2017-07-11T18:45:37.098Z", - "recommendation" : { - "reasons" : [ "Reason 1", "Reason 2" ], - "recommendation" : "recommendation", - "timestamp" : "2020-06-01T13:49:37.385Z" - }, - "id" : "ef38f94347e94562b5bb8424a56397d8", - "bulk" : true - }"@ - - - # Decide on a Certification Item - - try { - $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision - Select-V2024IdentityDecision -Id $Id -ReviewDecision $Result - - # Below is a request that includes all optional parameters - # Select-V2024IdentityDecision -Id $Id -ReviewDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2024IdentityDecision" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/reassign - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certifications#reassign-identity-certifications - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $ReviewReassign = @" - { - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - } - "@ - - # Reassign Identities or Items - - try { - $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Invoke-V2024ReassignIdentityCertifications -Id $Id -ReviewReassign $Result - - # Below is a request that includes all optional parameters - # Invoke-V2024ReassignIdentityCertifications -Id $Id -ReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ReassignIdentityCertifications" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/sign-off - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certifications#sign-off-identity-certification - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - - # Finalize Identity Certification Decisions - - try { - Invoke-V2024SignOffIdentityCertification -Id $Id - - # Below is a request that includes all optional parameters - # Invoke-V2024SignOffIdentityCertification -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024SignOffIdentityCertification" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/reassign-async - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certifications#submit-reassign-certs-async - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $ReviewReassign = @" - { - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - } - "@ - - # Reassign Certifications Asynchronously - - try { - $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Submit-V2024ReassignCertsAsync -Id $Id -ReviewReassign $Result - - # Below is a request that includes all optional parameters - # Submit-V2024ReassignCertsAsync -Id $Id -ReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/deploys - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-deploy - source: | - $DeployRequest = @" - { - "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" - } - "@ - - # Create a Deploy - - try { - $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest - New-V2024Deploy -DeployRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024Deploy -DeployRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-object-mapping - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingRequest = @" - { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - } - "@ - - # Creates an object mapping - - try { - $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest - New-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingBulkCreateRequest = @" - { - "newObjectsMappings" : [ { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - }, { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - } ] - } - "@ - - # Bulk creates object mappings - - try { - $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest - New-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/scheduled-actions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-scheduled-action - source: | - $ScheduledActionPayload = @" - { - "cronString" : "0 0 12 * * * *", - "timeZoneId" : "America/Chicago", - "startTime" : "2024-08-16T14:16:58.389Z", - "jobType" : "BACKUP", - "content" : { - "sourceTenant" : "tenant-name", - "draftId" : "9012b87d-48ca-439a-868f-2160001da8c3", - "name" : "Daily Backup", - "backupOptions" : { - "includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ], - "objectOptions" : { - "SOURCE" : { - "includedNames" : [ "Source1", "Source2" ] - }, - "ROLE" : { - "includedNames" : [ "Admin Role", "User Role" ] - } - } - }, - "sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2" - } - } - "@ - - # Create Scheduled Action - - try { - $Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload - New-V2024ScheduledAction -ScheduledActionPayload $Result - - # Below is a request that includes all optional parameters - # New-V2024ScheduledAction -ScheduledActionPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledAction" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/uploads - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-uploaded-configuration - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. - - # Upload a Configuration - - try { - New-V2024UploadedConfiguration -Data $Data -Name $Name - - # Below is a request that includes all optional parameters - # New-V2024UploadedConfiguration -Data $Data -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024UploadedConfiguration" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-backup - source: | - $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. - - # Delete a Backup - - try { - Remove-V2024Backup -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Backup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Backup" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/drafts/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-draft - source: | - $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to delete. - - # Delete a draft - - try { - Remove-V2024Draft -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Draft -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Draft" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-object-mapping - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. - - # Deletes an object mapping - - try { - Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId - - # Below is a request that includes all optional parameters - # Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/scheduled-actions/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-scheduled-action - source: | - $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. - - # Delete Scheduled Action - - try { - Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId - - # Below is a request that includes all optional parameters - # Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledAction" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/uploads/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-uploaded-configuration - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - - # Delete an Uploaded Configuration - - try { - Remove-V2024UploadedConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024UploadedConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024UploadedConfiguration" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/deploys/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#get-deploy - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. - - # Get a Deploy - - try { - Get-V2024Deploy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Deploy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploy" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#get-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - - # Gets list of object mappings - - try { - Get-V2024ObjectMappings -SourceOrg $SourceOrg - - # Below is a request that includes all optional parameters - # Get-V2024ObjectMappings -SourceOrg $SourceOrg - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ObjectMappings" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/uploads/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#get-uploaded-configuration - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - - # Get an Uploaded Configuration - - try { - Get-V2024UploadedConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024UploadedConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfiguration" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-backups - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - - # List Backups - - try { - Get-V2024Backups - - # Below is a request that includes all optional parameters - # Get-V2024Backups -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Backups" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/deploys - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-deploys - source: | - - # List Deploys - - try { - Get-V2024Deploys - - # Below is a request that includes all optional parameters - # Get-V2024Deploys - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploys" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/drafts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-drafts - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) - - # List Drafts - - try { - Get-V2024Drafts - - # Below is a request that includes all optional parameters - # Get-V2024Drafts -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/scheduled-actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-scheduled-actions - source: | - - # List Scheduled Actions - - try { - Get-V2024ScheduledActions - - # Below is a request that includes all optional parameters - # Get-V2024ScheduledActions - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledActions" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/uploads - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-uploaded-configurations - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - - # List Uploaded Configurations - - try { - Get-V2024UploadedConfigurations - - # Below is a request that includes all optional parameters - # Get-V2024UploadedConfigurations -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfigurations" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#update-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingBulkPatchRequest = @" - { - "patches" : { - "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : true - } ], - "00bece34-f50d-4227-8878-76f620b5a971" : [ { - "op" : "replace", - "path" : "/targetValue", - "value" : "New Target Value" - } ] - } - } - "@ - - # Bulk updates object mappings - - try { - $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest - Update-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/scheduled-actions/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#update-scheduled-action - source: | - $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update Scheduled Action - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledAction" - Write-Host $_.ErrorDetails - } -- path: /connector-customizers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#create-connector-customizer - source: | - $ConnectorCustomizerCreateRequest = @" - { - "name" : "My Custom Connector" - } - "@ - - # Create Connector Customizer - - try { - $Result = ConvertFrom-JsonToConnectorCustomizerCreateRequest -Json $ConnectorCustomizerCreateRequest - New-V2024ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorCustomizer" - Write-Host $_.ErrorDetails - } -- path: /connector-customizers/{id}/versions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#create-connector-customizer-version - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | The id of the connector customizer. - - # Creates a connector customizer version - - try { - New-V2024ConnectorCustomizerVersion -Id $Id - - # Below is a request that includes all optional parameters - # New-V2024ConnectorCustomizerVersion -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorCustomizerVersion" - Write-Host $_.ErrorDetails - } -- path: /connector-customizers/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#delete-connector-customizer - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete. - - # Delete Connector Customizer - - try { - Remove-V2024ConnectorCustomizer -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ConnectorCustomizer -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ConnectorCustomizer" - Write-Host $_.ErrorDetails - } -- path: /connector-customizers/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#get-connector-customizer - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to get. - - # Get connector customizer - - try { - Get-V2024ConnectorCustomizer -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ConnectorCustomizer -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCustomizer" - Write-Host $_.ErrorDetails - } -- path: /connector-customizers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#list-connector-customizers - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List All Connector Customizers - - try { - Get-V2024ConnectorCustomizers - - # Below is a request that includes all optional parameters - # Get-V2024ConnectorCustomizers -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCustomizers" - Write-Host $_.ErrorDetails - } -- path: /connector-customizers/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#put-connector-customizer - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to update. - $ConnectorCustomizerUpdateRequest = @" - { - "name" : "My Custom Connector" - } - "@ - - # Update Connector Customizer - - try { - Send-V2024ConnectorCustomizer -Id $Id - - # Below is a request that includes all optional parameters - # Send-V2024ConnectorCustomizer -Id $Id -ConnectorCustomizerUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCustomizer" - Write-Host $_.ErrorDetails - } -- path: /connector-rules - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#create-connector-rule - source: | - $ConnectorRuleCreateRequest = @" - { - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "type" : "BuildMap" - } - "@ - - # Create Connector Rule - - try { - $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest - New-V2024ConnectorRule -ConnectorRuleCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ConnectorRule -ConnectorRuleCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connector-rules/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#delete-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. - - # Delete Connector Rule - - try { - Remove-V2024ConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ConnectorRule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connector-rules/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#get-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. - - # Get Connector Rule - - try { - Get-V2024ConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ConnectorRule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connector-rules - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#get-connector-rule-list - source: | - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Connector Rules - - try { - Get-V2024ConnectorRuleList - - # Below is a request that includes all optional parameters - # Get-V2024ConnectorRuleList -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRuleList" - Write-Host $_.ErrorDetails - } -- path: /connector-rules/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#put-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update. - $ConnectorRuleUpdateRequest = @" - { - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", - "type" : "BuildMap" - } - "@ - - # Update Connector Rule - - try { - Send-V2024ConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Send-V2024ConnectorRule -Id $Id -ConnectorRuleUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connector-rules/validate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#test-connector-rule - source: | - $SourceCode = @" - { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - } - "@ - - # Validate Connector Rule - - try { - $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode - Test-V2024ConnectorRule -SourceCode $Result - - # Below is a request that includes all optional parameters - # Test-V2024ConnectorRule -SourceCode $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connectors - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#create-custom-connector - source: | - $V3CreateConnectorDto = @" - { - "name" : "custom connector", - "directConnect" : true, - "className" : "sailpoint.connector.OpenConnectorAdapter", - "type" : "custom connector type", - "status" : "RELEASED" - } - "@ - - # Create Custom Connector - - try { - $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto - New-V2024CustomConnector -V3CreateConnectorDto $Result - - # Below is a request that includes all optional parameters - # New-V2024CustomConnector -V3CreateConnectorDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomConnector" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#delete-custom-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Delete Connector by Script Name - - try { - Remove-V2024CustomConnector -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Remove-V2024CustomConnector -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomConnector" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector by Script Name - - try { - Get-V2024Connector -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2024Connector -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connector" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/correlation-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector-correlation-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - - # Get Connector Correlation Configuration - - try { - Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCorrelationConfig" - Write-Host $_.ErrorDetails - } -- path: /connectors - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector-list - source: | - $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector List - - try { - Get-V2024ConnectorList - - # Below is a request that includes all optional parameters - # Get-V2024ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorList" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/source-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector-source-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Get Connector Source Configuration - - try { - Get-V2024ConnectorSourceConfig -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2024ConnectorSourceConfig -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceConfig" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/source-template - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector-source-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Get Connector Source Template - - try { - Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceTemplate" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/translations/{locale} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector-translations - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - - # Get Connector Translations - - try { - Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - - # Below is a request that includes all optional parameters - # Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorTranslations" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/correlation-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#put-connector-correlation-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector correlation config xml file - - # Update Connector Correlation Configuration - - try { - Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCorrelationConfig" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/source-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#put-connector-source-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector source config xml file - - # Update Connector Source Configuration - - try { - Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceConfig" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/source-template - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#put-connector-source-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector source template xml file - - # Update Connector Source Template - - try { - Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceTemplate" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/translations/{locale} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#put-connector-translations - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - - # Update Connector Translations - - try { - Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - - # Below is a request that includes all optional parameters - # Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorTranslations" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connectors#update-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Connector by Script Name - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Connector -ScriptName $ScriptName -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024Connector -ScriptName $ScriptName -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Connector" - Write-Host $_.ErrorDetails - } -- path: /form-definitions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition - source: | - $Body = @" - { - "owner" : { - "name" : "Grant Smith", - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "formConditions" : [ { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - }, { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - } ], - "formInput" : [ { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - }, { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - } ], - "name" : "My form", - "description" : "My form description", - "usedBy" : [ { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - }, { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - } ], - "formElements" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - } ] - } - "@ - - # Creates a form definition. - - try { - New-V2024FormDefinition - - # Below is a request that includes all optional parameters - # New-V2024FormDefinition -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/forms-action-dynamic-schema - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-dynamic-schema - source: | - $Body = @" - { - "description" : "A description", - "attributes" : { - "formDefinitionId" : "00000000-0000-0000-0000-000000000000" - }, - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "action", - "versionNumber" : 1 - } - "@ - - # Generate JSON Schema dynamically. - - try { - New-V2024FormDefinitionDynamicSchema - - # Below is a request that includes all optional parameters - # New-V2024FormDefinitionDynamicSchema -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID}/upload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-file-request - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID - $File = # System.IO.FileInfo | File specifying the multipart - - # Upload new form definition file. - - try { - New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File - - # Below is a request that includes all optional parameters - # New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest" - Write-Host $_.ErrorDetails - } -- path: /form-instances - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-instance - source: | - $Body = @" - { - "formInput" : { - "input1" : "Sales" - }, - "standAloneForm" : false, - "createdBy" : { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "WORKFLOW_EXECUTION" - }, - "recipients" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - } ], - "expire" : "2023-08-12T20:14:57.74486Z", - "formDefinitionId" : "00000000-0000-0000-0000-000000000000", - "state" : "ASSIGNED", - "ttl" : 1571827560 - } - "@ - - # Creates a form instance. - - try { - New-V2024FormInstance - - # Below is a request that includes all optional parameters - # New-V2024FormInstance -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#delete-form-definition - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - - # Deletes a form definition. - - try { - Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#export-form-definitions-by-tenant - source: | - $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") - - # List form definitions by tenant. - - try { - Export-V2024FormDefinitionsByTenant - - # Below is a request that includes all optional parameters - # Export-V2024FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID}/file/{fileID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-file-from-s3 - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID - $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. - - # Download definition file by fileId. - - try { - Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID - - # Below is a request that includes all optional parameters - # Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-definition-by-key - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - - # Return a form definition. - - try { - Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey" - Write-Host $_.ErrorDetails - } -- path: /form-instances/{formInstanceID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-instance-by-key - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - - # Returns a form instance. - - try { - Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID - - # Below is a request that includes all optional parameters - # Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey" - Write-Host $_.ErrorDetails - } -- path: /form-instances/{formInstanceID}/file/{fileID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-instance-file - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID - $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. - - # Download instance file by fileId. - - try { - Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID - - # Below is a request that includes all optional parameters - # Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#import-form-definitions - source: | - - - - - $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ - - - # Import form definitions from export. - - try { - Import-V2024FormDefinitions - - # Below is a request that includes all optional parameters - # Import-V2024FormDefinitions -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-definition - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) - $Body = @"[{op=replace, path=/description, value=test-description}]"@ - - - # Patch a form definition. - - try { - Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition" - Write-Host $_.ErrorDetails - } -- path: /form-instances/{formInstanceID} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-instance - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) - $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ - - - # Patch a form instance. - - try { - Update-V2024FormInstance -FormInstanceID $FormInstanceID - - # Below is a request that includes all optional parameters - # Update-V2024FormInstance -FormInstanceID $FormInstanceID -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance" - Write-Host $_.ErrorDetails - } -- path: /form-definitions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-definitions-by-tenant - source: | - $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") - - # Export form definitions by tenant. - - try { - Search-V2024FormDefinitionsByTenant - - # Below is a request that includes all optional parameters - # Search-V2024FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant" - Write-Host $_.ErrorDetails - } -- path: /form-instances/{formInstanceID}/data-source/{formElementID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-element-data-by-element-id - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - $FormElementID = "1" # String | Form element ID - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) - $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) - - # Retrieves dynamic data by element. - - try { - Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID - - # Below is a request that includes all optional parameters - # Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID" - Write-Host $_.ErrorDetails - } -- path: /form-instances - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-instances-by-tenant - source: | - - # List form instances by tenant. - - try { - Search-V2024FormInstancesByTenant - - # Below is a request that includes all optional parameters - # Search-V2024FormInstancesByTenant - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/predefined-select-options - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-pre-defined-select-options - source: | - - # List predefined select options. - - try { - Search-V2024PreDefinedSelectOptions - - # Below is a request that includes all optional parameters - # Search-V2024PreDefinedSelectOptions - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID}/data-source - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#show-preview-data-source - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) - $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) - $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) - $FormElementPreviewRequest = @" - { - "dataSource" : { - "config" : { - "indices" : [ "identities" ], - "query" : "*", - "aggregationBucketField" : "attributes.cloudStatus.exact", - "objectType" : "IDENTITY" - }, - "dataSourceType" : "STATIC" - } - } - "@ - - # Preview form definition data source. - - try { - Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource" - Write-Host $_.ErrorDetails - } -- path: /custom-password-instructions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-password-instructions#create-custom-password-instructions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CustomPasswordInstruction = @" - { - "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", - "pageId" : "change-password:enter-password", - "locale" : "en" - } - "@ - - # Create Custom Password Instructions - - try { - $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction - New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result - - # Below is a request that includes all optional parameters - # New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomPasswordInstructions" - Write-Host $_.ErrorDetails - } -- path: /custom-password-instructions/{pageId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-password-instructions#delete-custom-password-instructions - source: | - $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - - # Delete Custom Password Instructions by page ID - - try { - Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomPasswordInstructions" - Write-Host $_.ErrorDetails - } -- path: /custom-password-instructions/{pageId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-password-instructions#get-custom-password-instructions - source: | - $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - - # Get Custom Password Instructions by Page ID - - try { - Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions" - Write-Host $_.ErrorDetails - } -- path: /data-segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#create-data-segment - source: | - $DataSegment = @" - - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment - New-V2024DataSegment -DataSegment $Result - - # Below is a request that includes all optional parameters - # New-V2024DataSegment -DataSegment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DataSegment" - Write-Host $_.ErrorDetails - } -- path: /data-segments/{segmentId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#delete-data-segment - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false) - - # Delete Segment by ID - - try { - Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -Published $Published - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024DataSegment" - Write-Host $_.ErrorDetails - } -- path: /data-segments/{segmentId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segment - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Segment by ID - - try { - Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegment" - Write-Host $_.ErrorDetails - } -- path: /data-segments/membership/{identityId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segment-identity-membership - source: | - $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get SegmentMembership by Identity ID - - try { - Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentIdentityMembership" - Write-Host $_.ErrorDetails - } -- path: /data-segments/user-enabled/{identityId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segmentation-enabled-for-user - source: | - $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Is Segmentation enabled by Identity - - try { - Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentationEnabledForUser" - Write-Host $_.ErrorDetails - } -- path: /data-segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#list-data-segments - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Enabled = $true # Boolean | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to $true) - $Unique = $false # Boolean | This returns only one record if set to true and that would be the published record if exists. (optional) (default to $false) - $Published = $true # Boolean | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to $true) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq """ # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) - - # Get Segments - - try { - Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental -Enabled $Enabled -Unique $Unique -Published $Published -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegments" - Write-Host $_.ErrorDetails - } -- path: /data-segments/{segmentId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#patch-data-segment - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to modify. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - $RequestBody = @"[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024DataSegment" - Write-Host $_.ErrorDetails - } -- path: /data-segments/{segmentId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#publish-data-segment - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish to publish - $RequestBody = @""@ - - $PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true) - - # Publish segment by ID - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Publish-V2024DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Publish-V2024DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -PublishAll $PublishAll - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2024DataSegment" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/dimensions#create-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $Dimension = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "name" : "Dimension 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "id" : "2c918086749d78830174a1a40e121518", - "membership" : { - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, - "type" : "STANDARD" - }, - "parentId" : "2c918086749d78830174a1a40e121518" - } - "@ - - # Create a Dimension - - try { - $Result = ConvertFrom-JsonToDimension -Json $Dimension - New-V2024Dimension -RoleId $RoleId -Dimension $Result - - # Below is a request that includes all optional parameters - # New-V2024Dimension -RoleId $RoleId -Dimension $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Dimension" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/dimensions#delete-bulk-dimensions - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimensions. - $DimensionBulkDeleteRequest = @" - { - "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - } - "@ - - # Delete Dimension(s) - - try { - $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest - Remove-V2024BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2024BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkDimensions" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions/{dimensionId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/dimensions#delete-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - - # Delete a Dimension - - try { - Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Dimension" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions/{dimensionId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/dimensions#get-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - - # Get a Dimension under Role. - - try { - Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimension" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions/{dimensionId}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/dimensions#get-dimension-entitlements - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Dimension's Entitlements - - try { - Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionEntitlements" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/dimensions#list-dimension-access-profiles - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "source.id eq "2c91808982f979270182f99e386d00fa"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Dimension's Access Profiles - - try { - Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionAccessProfiles" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/dimensions#list-dimensions - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq '2c918086749d78830174a1a40e121518'" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Dimensions - - try { - Get-V2024Dimensions -RoleId $RoleId - - # Below is a request that includes all optional parameters - # Get-V2024Dimensions -RoleId $RoleId -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimensions" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions/{dimensionId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/dimensions#patch-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Dimension - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Dimension" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#create-access-model-metadata-for-entitlement - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Add metadata to an entitlement. - - try { - New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#delete-access-model-metadata-from-entitlement - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Remove metadata from an entitlement. - - try { - Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#get-entitlement - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get an entitlement - - try { - Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/entitlement-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#get-entitlement-request-config - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Entitlement Request Config - - try { - Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /entitlements/aggregate/sources/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#import-entitlements-by-source - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) - - # Aggregate Entitlements - - try { - Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/children - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlement-children - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List of entitlements children - - try { - Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/parents - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlement-parents - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List of entitlements parents - - try { - Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents" - Write-Host $_.ErrorDetails - } -- path: /entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlements - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) - $SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) - $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) - $IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - - # Gets a list of entitlements. - - try { - Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#patch-entitlement - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch an entitlement - - try { - Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/entitlement-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#put-entitlement-request-config - source: | - $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $EntitlementRequestConfig = @" - { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - } - "@ - - # Replace Entitlement Request Config - - try { - $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig - Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /entitlements/reset/sources/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#reset-source-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Reset Source Entitlements - - try { - Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements" - Write-Host $_.ErrorDetails - } -- path: /entitlements/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#update-entitlements-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $EntitlementBulkUpdateRequest = @" - { - "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/privileged", - "value" : false - }, { - "op" : "replace", - "path" : "/requestable", - "value" : false - } ] - } - "@ - - # Bulk update an entitlement list - - try { - $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest - Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk" - Write-Host $_.ErrorDetails - } -- path: /auth-org/network-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#create-auth-org-network-config - source: | - $NetworkConfiguration = @" - { - "range" : [ "1.3.7.2", "255.255.255.252/30" ], - "whitelisted" : true, - "geolocation" : [ "CA", "FR", "HT" ] - } - "@ - - # Create security network configuration. - - try { - $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration - New-V2024AuthOrgNetworkConfig -NetworkConfiguration $Result - - # Below is a request that includes all optional parameters - # New-V2024AuthOrgNetworkConfig -NetworkConfiguration $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/lockout-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-lockout-config - source: | - - # Get Auth Org Lockout Configuration. - - try { - Get-V2024AuthOrgLockoutConfig - - # Below is a request that includes all optional parameters - # Get-V2024AuthOrgLockoutConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgLockoutConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/network-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-network-config - source: | - - # Get security network configuration. - - try { - Get-V2024AuthOrgNetworkConfig - - # Below is a request that includes all optional parameters - # Get-V2024AuthOrgNetworkConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/service-provider-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-service-provider-config - source: | - - # Get Service Provider Configuration. - - try { - Get-V2024AuthOrgServiceProviderConfig - - # Below is a request that includes all optional parameters - # Get-V2024AuthOrgServiceProviderConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgServiceProviderConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/session-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-session-config - source: | - - # Get Auth Org Session Configuration. - - try { - Get-V2024AuthOrgSessionConfig - - # Below is a request that includes all optional parameters - # Get-V2024AuthOrgSessionConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgSessionConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/lockout-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-lockout-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Auth Org Lockout Configuration - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgLockoutConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/network-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-network-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update security network configuration. - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024AuthOrgNetworkConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024AuthOrgNetworkConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/service-provider-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-service-provider-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Service Provider Configuration - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgServiceProviderConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/session-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-session-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Auth Org Session Configuration - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgSessionConfig" - Write-Host $_.ErrorDetails - } -- path: /workgroups - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#create-workgroup - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $WorkgroupDto = @" - { - "owner" : { - "emailAddress" : "support@sailpoint.com", - "displayName" : "Support", - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "connectionCount" : 1641498673000, - "created" : "2022-01-06T19:51:13Z", - "memberCount" : 1641498673000, - "name" : "DB Access Governance Group", - "description" : "Description of the Governance Group", - "modified" : "2022-01-06T19:51:13Z", - "id" : "2c91808568c529c60168cca6f90c1313" - } - "@ - - # Create a new Governance Group. - - try { - $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto - New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result - - # Below is a request that includes all optional parameters - # New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a Governance Group - - try { - Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workgroup" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{workgroupId}/members/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityPreviewResponseIdentity = @""@ - - - # Remove members from Governance Group - - try { - $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - - # Below is a request that includes all optional parameters - # Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers" - Write-Host $_.ErrorDetails - } -- path: /workgroups/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroups-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $WorkgroupBulkDeleteRequest = @" - { - "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] - } - "@ - - # Delete Governance Group(s) - - try { - $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest - Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#get-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Governance Group by Id - - try { - Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroup" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{workgroupId}/connections - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#list-connections - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List connections for Governance Group - - try { - Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connections" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{workgroupId}/members - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#list-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Governance Group Members - - try { - Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkgroupMembers" - Write-Host $_.ErrorDetails - } -- path: /workgroups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#list-workgroups - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw "Test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) - - # List Governance Groups - - try { - Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroups" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#patch-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Governance Group - - try { - Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{workgroupId}/members/bulk-add - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#update-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityPreviewResponseIdentity = @""@ - - - # Add members to Governance Group - - try { - $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - - # Below is a request that includes all optional parameters - # Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024WorkgroupMembers" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/ignored-items - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Ignore Access Request Recommendation - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsIgnoredItem" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/requested-items - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Accept Access Request Recommendation - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsRequestedItem" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/viewed-items - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Mark Viewed Access Request Recommendations - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItem" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/viewed-items/bulk-create - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @"{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - }"@ - - - # Bulk Mark Viewed Access Request Recommendations - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItems" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") - $Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) - $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) - - # Identity Access Request Recommendations - - try { - Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Request Recommendations config - - try { - Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/ignored-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Ignored Access Request Recommendations - - try { - Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsIgnoredItems" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/requested-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Accepted Access Request Recommendations - - try { - Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsRequestedItems" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/viewed-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Viewed Access Request Recommendations - - try { - Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationConfigDto = @" - { - "scoreThreshold" : 0.5, - "startDateAttribute" : "startDate", - "restrictionAttribute" : "location", - "moverAttribute" : "isMover", - "joinerAttribute" : "isJoiner", - "useRestrictionAttribute" : true - } - "@ - - # Update Access Request Recommendations config - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto - Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result - - # Below is a request that includes all optional parameters - # Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig" - Write-Host $_.ErrorDetails - } -- path: /common-access - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-common-access#create-common-access - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CommonAccessItemRequest = @" - { - "access" : { - "ownerName" : "ownerName", - "name" : "name", - "description" : "description", - "id" : "id", - "type" : "ACCESS_PROFILE", - "ownerId" : "ownerId" - }, - "status" : "CONFIRMED" - } - "@ - - # Create common access items - - try { - $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest - New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CommonAccess" - Write-Host $_.ErrorDetails - } -- path: /common-access - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-common-access#get-common-access - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.type eq "ROLE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) - - # Get a paginated list of common access - - try { - Get-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CommonAccess" - Write-Host $_.ErrorDetails - } -- path: /common-access/update-status - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-common-access#update-common-access-status-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CommonAccessIDStatus = @"{ - "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], - "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] - }"@ - - - # Bulk update common access status - - try { - $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus - Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result - - # Below is a request that includes all optional parameters - # Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CommonAccessStatusInBulk" - Write-Host $_.ErrorDetails - } -- path: /outliers/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#export-outliers-zip - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - - # IAI Identity Outliers Export - - try { - Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024OutliersZip" - Write-Host $_.ErrorDetails - } -- path: /outlier-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-identity-outlier-snapshots - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) - $Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) - - # IAI Identity Outliers Summary - - try { - Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutlierSnapshots" - Write-Host $_.ErrorDetails - } -- path: /outliers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-identity-outliers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) - $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) - - # IAI Get Identity Outliers - - try { - Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutliers" - Write-Host $_.ErrorDetails - } -- path: /outlier-summaries/latest - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-latest-identity-outlier-snapshots - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - - # IAI Identity Outliers Latest Summary - - try { - Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LatestIdentityOutlierSnapshots" - Write-Host $_.ErrorDetails - } -- path: /outlier-feature-summaries/{outlierFeatureId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-outlier-contributing-feature-summary - source: | - $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get identity outlier contibuting feature summary - - try { - Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutlierContributingFeatureSummary" - Write-Host $_.ErrorDetails - } -- path: /outliers/{outlierId}/contributing-features - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-peer-group-outliers-contributing-features - source: | - $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) - $Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) - - # Get identity outlier's contibuting features - - try { - Get-V2024PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliersContributingFeatures" - Write-Host $_.ErrorDetails - } -- path: /outliers/ignore - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#ignore-identity-outliers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - - - # IAI Identity Outliers Ignore - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024IgnoreIdentityOutliers" - Write-Host $_.ErrorDetails - } -- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#list-outliers-contributing-feature-access-items - source: | - $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id - $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) - $Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) - - # Gets a list of access items associated with each identity outlier contributing feature - - try { - Get-V2024OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutliersContributingFeatureAccessItems" - Write-Host $_.ErrorDetails - } -- path: /outliers/unignore - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#un-ignore-identity-outliers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - - - # IAI Identity Outliers Unignore - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnIgnoreIdentityOutliers" - Write-Host $_.ErrorDetails - } -- path: /peer-group-strategies/{strategy}/identity-outliers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-peer-group-strategies#get-peer-group-outliers - source: | - $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Identity Outliers List - - try { - Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliers" - Write-Host $_.ErrorDetails - } -- path: /recommendations/request - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-recommendations#get-recommendations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RecommendationRequestDto = @" - { - "prescribeMode" : false, - "excludeInterpretations" : false, - "requests" : [ { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - }, { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - } ], - "includeTranslationMessages" : false, - "includeDebugInformation" : true - } - "@ - - # Returns Recommendation Based on Object - - try { - $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto - Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result - - # Below is a request that includes all optional parameters - # Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Recommendations" - Write-Host $_.ErrorDetails - } -- path: /recommendations/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-recommendations#get-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get certification recommendation config values - - try { - Get-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RecommendationsConfig" - Write-Host $_.ErrorDetails - } -- path: /recommendations/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-recommendations#update-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RecommendationConfigDto = @" - { - "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], - "peerGroupPercentageThreshold" : 0.5, - "runAutoSelectOnce" : false, - "onlyTuneThreshold" : false - } - "@ - - # Update certification recommendation config values - - try { - $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto - Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result - - # Below is a request that includes all optional parameters - # Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RecommendationsConfig" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#create-potential-role-provision-request - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) - $RoleMiningPotentialRoleProvisionRequest = @" - { - "includeIdentities" : true, - "roleName" : "Finance - Accounting", - "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", - "roleDescription" : "General access for accounting department", - "directlyAssignedEntitlements" : false - } - "@ - - # Create request to provision a potential role into an actual role. - - try { - New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PotentialRoleProvisionRequest" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#create-role-mining-sessions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleMiningSessionDto = @" - { - "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", - "prescribedPruneThreshold" : 10, - "pruneThreshold" : 50, - "saved" : true, - "potentialRolesReadyCount" : 0, - "scope" : { - "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], - "attributeFilterCriteria" : { - "displayName" : { - "untranslated" : "Location: Miami" - }, - "ariaLabel" : { - "untranslated" : "Location: Miami" - }, - "data" : { - "displayName" : { - "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" - }, - "name" : "location", - "operator" : "EQUALS", - "values" : [ "Miami" ] - } - }, - "criteria" : "source.name:DataScienceDataset" - }, - "potentialRoleCount" : 0, - "name" : "Saved RM Session - 07/10", - "minNumIdentitiesInPotentialRole" : 20, - "identityCount" : 0, - "type" : "SPECIALIZED" - } - "@ - - # Create a role mining session - - try { - $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto - New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result - - # Below is a request that includes all optional parameters - # New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleMiningSessions" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#download-role-mining-potential-role-zip - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Export (download) details for a potential role in a role mining session - - try { - Invoke-V2024DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Invoke-V2024DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleMiningPotentialRoleZip" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#export-role-mining-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Export (download) details for a potential role in a role mining session - - try { - Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#export-role-mining-potential-role-async - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleMiningPotentialRoleExportRequest = @" - { - "minEntitlementPopularity" : 0, - "includeCommonAccess" : true - } - "@ - - # Asynchronously export details for a potential role in a role mining session and upload to S3 - - try { - Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleExportRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleAsync" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#export-role-mining-potential-role-status - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieve status of a potential role export job - - try { - Export-V2024RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2024RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleStatus" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-all-potential-role-summaries - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) - $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all potential role summaries - - try { - Get-V2024AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllPotentialRoleSummaries" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-entitlement-distribution-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) - - # Retrieves entitlement popularity distribution for a potential role in a role mining session - - try { - Get-V2024EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementDistributionPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) - $Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) - $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves entitlements for a potential role in a role mining session - - try { - Get-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-excluded-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) - $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves excluded entitlements for a potential role in a role mining session - - try { - Get-V2024ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ExcludedEntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-identities-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves identities for a potential role in a role mining session - - try { - Get-V2024IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitiesPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieves a specific potential role - - try { - Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-applications - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves the applications of a potential role for a role mining session - - try { - Get-V2024PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleApplications" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-entitlements - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves the entitlements of a potential role for a role mining session - - try { - Get-V2024PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleEntitlements" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-source-identity-usage - source: | - $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id - $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves potential role source usage - - try { - Get-V2024PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSourceIdentityUsage" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-summaries - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) - $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all potential role summaries - - try { - Get-V2024PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSummaries" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles/{potentialRoleId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-potential-role - source: | - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieves a specific potential role - - try { - Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-session - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a role mining session - - try { - Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSession" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-session-status - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get role mining session status state - - try { - Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessionStatus" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-sessions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) - $Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all role mining sessions - - try { - Get-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessions" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles/saved - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-saved-potential-roles - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all saved potential roles - - try { - Get-V2024SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedPotentialRoles" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#patch-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ - - - # Update a potential role - - try { - $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles/{potentialRoleId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#patch-potential-role-0 - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ - - - # Update a potential role - - try { - $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole0" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#patch-role-mining-session - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a role mining session - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RoleMiningSession" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#update-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleMiningPotentialRoleEditEntitlements = @" - { - "ids" : [ "entId1", "entId2" ], - "exclude" : true - } - "@ - - # Edit entitlements for a potential role to exclude some entitlements - - try { - $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements - Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result - - # Below is a request that includes all optional parameters - # Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /icons/{objectType}/{objectId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/icons#delete-icon - source: | - $ObjectType = "application" # String | Object type. Available options ['application'] - $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete an icon - - try { - Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Icon" - Write-Host $_.ErrorDetails - } -- path: /icons/{objectType}/{objectId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/icons#set-icon - source: | - $ObjectType = "application" # String | Object type. Available options ['application'] - $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] - - # Update an icon - - try { - Set-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image - - # Below is a request that includes all optional parameters - # Set-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Icon" - Write-Host $_.ErrorDetails - } -- path: /identities/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#delete-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete identity - - try { - Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Identity" - Write-Host $_.ErrorDetails - } -- path: /identities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#get-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Identity Details - - try { - Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identity" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/ownership - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#get-identity-ownership-details - source: | - $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get ownership details - - try { - Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOwnershipDetails" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/role-assignments/{assignmentId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#get-role-assignment - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Role assignment details - - try { - Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignment" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/role-assignments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#get-role-assignments - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) - $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) - - # List role assignments - - try { - Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -RoleId $RoleId -RoleName $RoleName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignments" - Write-Host $_.ErrorDetails - } -- path: /identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#list-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) - $Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) - $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Identities - - try { - Get-V2024Identities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024Identities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identities" - Write-Host $_.ErrorDetails - } -- path: /identities/{id}/reset - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#reset-identity - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Reset an identity - - try { - Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024Identity" - Write-Host $_.ErrorDetails - } -- path: /identities/{id}/verification/account/send - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#send-identity-verification-account-token - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - $SendAccountVerificationRequest = @" - { - "sourceName" : "Active Directory Source", - "via" : "EMAIL_WORK" - } - "@ - - # Send password reset email - - try { - $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest - Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityVerificationAccountToken" - Write-Host $_.ErrorDetails - } -- path: /identities/invite - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#start-identities-invite - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $InviteIdentitiesRequest = @" - { - "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], - "uninvited" : false - } - "@ - - # Invite identities to register - - try { - $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest - Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result - - # Below is a request that includes all optional parameters - # Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite" - Write-Host $_.ErrorDetails - } -- path: /identities/process - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#start-identity-processing - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ProcessIdentitiesRequest = @" - { - "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] - } - "@ - - # Process a list of identityIds - - try { - $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest - Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result - - # Below is a request that includes all optional parameters - # Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentityProcessing" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/synchronize-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#synchronize-attributes-for-identity - source: | - $IdentityId = "MyIdentityId" # String | The Identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Attribute synchronization for single identity. - - try { - Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024hronizeAttributesForIdentity" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#create-identity-attribute - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityAttribute = @" - { - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - } - "@ - - # Create Identity Attribute - - try { - $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - - # Below is a request that includes all optional parameters - # New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#delete-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Identity Attribute - - try { - Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttribute" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes/bulk-delete - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#delete-identity-attributes-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityAttributeNames = @" - { - "ids" : [ "name", "displayName" ] - } - "@ - - # Bulk delete Identity Attributes - - try { - $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames - Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result - - # Below is a request that includes all optional parameters - # Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#get-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Identity Attribute - - try { - Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttribute" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#list-identity-attributes - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) - $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) - $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Identity Attributes - - try { - Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttributes" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes/{name} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#put-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityAttribute = @" - { - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - } - "@ - - # Update Identity Attribute - - try { - $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - - # Below is a request that includes all optional parameters - # Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/compare - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#compare-identity-snapshots - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) - $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) - $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets a difference of count for each access item types for the given identity between 2 snapshots - - try { - Compare-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Compare-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshots" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/compare/{access-type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#compare-identity-snapshots-access-type - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $AccessType = "accessProfile" # String | The specific type which needs to be compared - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) - $Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) - $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets a list of differences of specific accessType for the given identity between 2 snapshots - - try { - Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshotsAccessType" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-historical-identity - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get latest snapshot of identity - - try { - Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentity" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/events - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-historical-identity-events - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) - $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) - - $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ - $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - $AccessItemTypes = @"[entitlement, account]"@ - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Lists all events for the given identity - - try { - Get-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentityEvents" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/snapshots/{date} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-identity-snapshot - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Date = "2007-03-01T13:00:00Z" # String | The specified date - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Gets an identity snapshot at a given date - - try { - Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshot" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/snapshot-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-identity-snapshot-summary - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) - $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) - $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets the summary for the event count for a specific identity - - try { - Get-V2024IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotSummary" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/start-date - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-identity-start-date - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Gets the start date of the identity - - try { - Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityStartDate" - Write-Host $_.ErrorDetails - } -- path: /historical-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#list-historical-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) - $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) - $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # Lists all the identities - - try { - Get-V2024HistoricalIdentities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024HistoricalIdentities -XSailPointExperimental $XSailPointExperimental -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentities" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/access-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#list-identity-access-items - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Access Items by Identity - - try { - Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental -Type $Type -Limit $Limit -Count $Count -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessItems" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/snapshots/{date}/access-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#list-identity-snapshot-access-items - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Date = "2007-03-01T13:00:00Z" # String | The specified date - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "account" # String | The access item type (optional) - - # Gets the list of identity access items at a given date filterd by item type - - try { - Get-V2024IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotAccessItems" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/snapshots - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#list-identity-snapshots - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) - $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Lists all the snapshots for the identity - - try { - Get-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshots" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#create-identity-profile - source: | - $IdentityProfile = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - "@ - - # Create Identity Profile - - try { - $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-V2024IdentityProfile -IdentityProfile $Result - - # Below is a request that includes all optional parameters - # New-V2024IdentityProfile -IdentityProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#delete-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - - # Delete Identity Profile - - try { - Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#delete-identity-profiles - source: | - $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. - $RequestBody = @""@ - - - # Delete Identity Profiles - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2024IdentityProfiles -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-V2024IdentityProfiles -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#export-identity-profiles - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) - - # Export Identity Profiles - - try { - Export-V2024IdentityProfiles - - # Below is a request that includes all optional parameters - # Export-V2024IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024IdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/identity-preview - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#generate-identity-preview - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityPreviewRequest = @" - { - "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - } - } - "@ - - # Generate Identity Profile Preview - - try { - $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityPreview" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#get-default-identity-attribute-config - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. - - # Get default Identity Attribute Config - - try { - Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultIdentityAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#get-identity-profile - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - - # Get Identity Profile - - try { - Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#import-identity-profiles - source: | - - - - - - $IdentityProfileExportedObject = @"{ - "self" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "version" : 1, - "object" : { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - }"@ - - - # Import Identity Profiles - - try { - $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-V2024IdentityProfiles -IdentityProfileExportedObject $Result - - # Below is a request that includes all optional parameters - # Import-V2024IdentityProfiles -IdentityProfileExportedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024IdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#list-identity-profiles - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - - # List Identity Profiles - - try { - Get-V2024IdentityProfiles - - # Below is a request that includes all optional parameters - # Get-V2024IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/process-identities - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#sync-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed - - # Process identities under profile - - try { - Sync-V2024IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Sync-V2024IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#update-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Identity Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/lifecycle-states#create-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleState = @" - { - "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], - "emailNotificationOption" : { - "notifyManagers" : true, - "notifySpecificUsers" : true, - "emailAddressList" : [ "test@test.com", "test2@test.com" ], - "notifyAllAdmins" : true - }, - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Lifecycle description", - "accountActions" : [ { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - }, { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } ], - "id" : "id12345", - "identityCount" : 42, - "technicalName" : "Technical Name", - "identityState" : "identityState", - "enabled" : true - } - "@ - - # Create Lifecycle State - - try { - $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState - New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result - - # Below is a request that includes all optional parameters - # New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024LifecycleState" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/lifecycle-states#delete-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - - # Delete Lifecycle State - - try { - Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024LifecycleState" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/lifecycle-states#get-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - - # Get Lifecycle State - - try { - Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleState" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/lifecycle-states#get-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Lists LifecycleStates - - try { - Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleStates" - Write-Host $_.ErrorDetails - } -- path: /identities/{identity-id}/set-lifecycle-state - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/lifecycle-states#set-lifecycle-state - source: | - $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. - $SetLifecycleStateRequest = @" - - "@ - - # Set Lifecycle State - - try { - $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest - Set-V2024LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result - - # Below is a request that includes all optional parameters - # Set-V2024LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024LifecycleState" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/lifecycle-states#update-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Lifecycle State - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-V2024MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-V2024MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-V2024MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2024MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2024MFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-V2024MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-V2024MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" - Write-Host $_.ErrorDetails - } -- path: /machine-accounts/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#get-machine-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Machine Account Details - - try { - Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount" - Write-Host $_.ErrorDetails - } -- path: /machine-accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#list-machine-accounts - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) - - # Machine Accounts List - - try { - Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccounts" - Write-Host $_.ErrorDetails - } -- path: /machine-accounts/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#update-machine-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - $RequestBody = @"[{op=add, path=/environment, value=test}]"@ - - - # Update a Machine Account - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount" - Write-Host $_.ErrorDetails - } -- path: /machine-identities - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#create-machine-identity - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MachineIdentity = @" - { - "created" : "2015-05-28T14:07:17Z", - "businessApplication" : "ADService", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "", - "attributes" : "{\"Region\":\"EU\"}", - "id" : "id12345", - "manuallyEdited" : true - } - "@ - - # Create Machine Identities - - try { - $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity - New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result - - # Below is a request that includes all optional parameters - # New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity" - Write-Host $_.ErrorDetails - } -- path: /machine-identities/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#delete-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete machine identity - - try { - Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity" - Write-Host $_.ErrorDetails - } -- path: /machine-identities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#get-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Machine Identity Details - - try { - Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity" - Write-Host $_.ErrorDetails - } -- path: /machine-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#list-machine-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) - $Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Machine Identities - - try { - Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities" - Write-Host $_.ErrorDetails - } -- path: /machine-identities/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#update-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ - - - # Update a Machine Identity - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#create-managed-client - source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ - - # Create Managed Client - - try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-V2024ManagedClient -ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ManagedClient -ManagedClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#delete-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Delete Managed Client - - try { - Remove-V2024ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Get Managed Client - - try { - Get-V2024ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. - - # Get Managed Client Status - - try { - Get-V2024ManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-clients - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - - # Get Managed Clients - - try { - Get-V2024ManagedClients - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#update-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#create-managed-cluster-type - source: | - $ManagedClusterType = @" - { - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - } - "@ - - # Create new Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType - New-V2024ManagedClusterType -ManagedClusterType $Result - - # Below is a request that includes all optional parameters - # New-V2024ManagedClusterType -ManagedClusterType $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#delete-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Delete a Managed Cluster Type - - try { - Remove-V2024ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Get a Managed Cluster Type - - try { - Get-V2024ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-types - source: | - $Type = "IDN" # String | Type descriptor (optional) - $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) - $Org = "denali-xyz" # String | Pinned org (or default) (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # Get Managed Cluster Types - - try { - Get-V2024ManagedClusterTypes - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterTypes" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#update-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update a Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-V2024ManagedCluster -ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ManagedCluster -ManagedClusterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-V2024ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-V2024ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-V2024ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-V2024ManagedClusters - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/manualUpgrade - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. - - # Trigger Manual Upgrade for Managed Cluster - - try { - Update-V2024 -Id $Id - - # Below is a request that includes all optional parameters - # Update-V2024 -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /multihosts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#create-multi-host-integration - source: | - $MultiHostIntegrationsCreate = @" - { - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "connector" : "multihost-microsoft-sql-server", - "connectorAttributes" : { - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "created" : "2022-02-08T14:50:03.827Z", - "name" : "My Multi-Host Integration", - "description" : "This is the Multi-Host Integration.", - "modified" : "2024-01-23T18:08:50.897Z" - } - "@ - - # Create Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate - New-V2024MultiHostIntegration -MultiHostIntegrationsCreate $Result - - # Below is a request that includes all optional parameters - # New-V2024MultiHostIntegration -MultiHostIntegrationsCreate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MultiHostIntegration" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#create-sources-within-multi-host - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - $MultiHostIntegrationsCreateSources = @"{ - "connectorAttributes" : { - "authType" : "SQLAuthentication", - "url" : "jdbc:sqlserver://178.18.41.118:1433", - "user" : "username", - "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "name" : "My Source", - "description" : "This is the corporate directory." - }"@ - - - # Create Sources Within Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources - New-V2024SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result - - # Below is a request that includes all optional parameters - # New-V2024SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourcesWithinMultiHost" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#delete-multi-host - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. - - # Delete Multi-Host Integration - - try { - Remove-V2024MultiHost -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Remove-V2024MultiHost -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MultiHost" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId}/acctAggregationGroups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-acct-aggregation-groups - source: | - $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Account-Aggregation-Groups by Multi-Host ID - - try { - Get-V2024AcctAggregationGroups -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-V2024AcctAggregationGroups -MultihostId $MultihostId -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AcctAggregationGroups" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multiHostId}/entitlementAggregationGroups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-entitlement-aggregation-groups - source: | - $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Entitlement-Aggregation-Groups by Integration ID - - try { - Get-V2024EntitlementAggregationGroups -MultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-V2024EntitlementAggregationGroups -MultiHostId $MultiHostId -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementAggregationGroups" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multi-host-integrations - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - - # Get Multi-Host Integration By ID - - try { - Get-V2024MultiHostIntegrations -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-V2024MultiHostIntegrations -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MultiHostIntegrations" - Write-Host $_.ErrorDetails - } -- path: /multihosts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multi-host-integrations-list - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - - # List All Existing Multi-Host Integrations - - try { - Get-V2024MultiHostIntegrationsList - - # Below is a request that includes all optional parameters - # Get-V2024MultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MultiHostIntegrationsList" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multiHostId}/sources/errors - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multi-host-source-creation-errors - source: | - $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration - - # List Multi-Host Source Creation Errors - - try { - Get-V2024MultiHostSourceCreationErrors -MultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-V2024MultiHostSourceCreationErrors -MultiHostId $MultiHostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MultiHostSourceCreationErrors" - Write-Host $_.ErrorDetails - } -- path: /multihosts/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multihost-integration-types - source: | - - # List Multi-Host Integration Types - - try { - Get-V2024MultihostIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-V2024MultihostIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MultihostIntegrationTypes" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId}/sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-sources-within-multi-host - source: | - $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Sources Within Multi-Host Integration - - try { - Get-V2024SourcesWithinMultiHost -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-V2024SourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourcesWithinMultiHost" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId}/sources/testConnection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#test-connection-multi-host-sources - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration - - # Test Configuration For Multi-Host Integration - - try { - Test-V2024ConnectionMultiHostSources -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Test-V2024ConnectionMultiHostSources -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectionMultiHostSources" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#test-source-connection-multihost - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration - $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration - - # Test Configuration For Multi-Host Integration's Single Source - - try { - Test-V2024SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-V2024SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConnectionMultihost" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#update-multi-host-sources - source: | - $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. - $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ - - - # Update Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner - Update-V2024MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2024MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MultiHostSources" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id}/approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeApprovalDecision = @" - { - "comment" : "Approved by manager" - } - "@ - - # Approve a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-V2024NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Approve-V2024NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-record - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2024NonEmployeeRecord -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2024NonEmployeeRecord -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-request - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2024NonEmployeeRequest -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2024NonEmployeeRequest -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source - source: | - $NonEmployeeSourceRequestBody = @" - { - "owner" : { - "id" : "2c91808570313110017040b06f344ec9" - }, - "managementWorkgroup" : "123299", - "accountManagers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ], - "name" : "Retail", - "description" : "Source description", - "approvers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ] - } - "@ - - # Create Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-V2024NonEmployeeSource -NonEmployeeSourceRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2024NonEmployeeSource -NonEmployeeSourceRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - $NonEmployeeSchemaAttributeBody = @" - { - "helpText" : "The unique identifier for the account", - "label" : "Account Name", - "placeholder" : "Enter a unique user name for this account.", - "type" : "TEXT", - "technicalName" : "account.name", - "required" : true - } - "@ - - # Create a new Schema Attribute for Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - - # Below is a request that includes all optional parameters - # New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - - # Delete Non-Employee Record - - try { - Remove-V2024NonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk - source: | - $DeleteNonEmployeeRecordsInBulkRequest = @" - - "@ - - # Delete Multiple Non-Employee Records - - try { - $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest - Remove-V2024NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-request - source: | - $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format - - # Delete Non-Employee Request - - try { - Remove-V2024NonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Delete a Schema Attribute for Non-Employee Source - - try { - Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source - source: | - $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - - # Delete Non-Employee Source - - try { - Remove-V2024NonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Delete all custom schema attributes for Non-Employee Source - - try { - Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/non-employees/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#export-non-employee-records - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - - # Exports Non-Employee Records to CSV - - try { - Export-V2024NonEmployeeRecords -Id $Id - - # Below is a request that includes all optional parameters - # Export-V2024NonEmployeeRecords -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeRecords" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/schema-attributes-template/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) - - # Exports Source Schema Template - - try { - Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeSourceSchemaTemplate" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) - - # Get a non-employee approval item detail - - try { - Get-V2024NonEmployeeApproval -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApproval" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/summary/{requested-for} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval-summary - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Approval Requests - - try { - Get-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovalSummary" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/non-employee-bulk-upload/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) - - # Obtain the status of bulk upload on the source - - try { - Get-V2024NonEmployeeBulkUploadStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeBulkUploadStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeBulkUploadStatus" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - - # Get a Non-Employee Record - - try { - Get-V2024NonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-request - source: | - $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) - - # Get a Non-Employee Request - - try { - Get-V2024NonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests/summary/{requested-for} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-request-summary - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Requests - - try { - Get-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequestSummary" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Get Schema Attribute Non-Employee Source - - try { - Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-source - source: | - $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id - - # Get a Non-Employee Source - - try { - Get-V2024NonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # List Schema Attributes Non-Employee Source - - try { - Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/non-employee-bulk-upload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - $Data = # System.IO.FileInfo | - - # Imports, or Updates, Non-Employee Records - - try { - Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024NonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-approvals - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Get List of Non-Employee Approval Requests - - try { - Get-V2024NonEmployeeApprovals - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovals" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-records - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - - # List Non-Employee Records - - try { - Get-V2024NonEmployeeRecords - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecords" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-requests - source: | - $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - - # List Non-Employee Requests - - try { - Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequests" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-sources - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) - $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) - $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - - # List Non-Employee Sources - - try { - Get-V2024NonEmployeeSources - - # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#patch-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Non-Employee Record - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024NonEmployeeRecord -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024NonEmployeeRecord -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Schema Attribute for Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#patch-non-employee-source - source: | - $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id}/reject - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#reject-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeRejectApprovalDecision = @" - { - "comment" : "approved" - } - "@ - - # Reject a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-V2024NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Deny-V2024NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#update-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Update Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-V2024NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2024NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /verified-domains - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#create-domain-dkim - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $DomainAddress = @" - { - "domain" : "sailpoint.com" - } - "@ - - # Verify domain address via DKIM - - try { - $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress - New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result - - # Below is a request that includes all optional parameters - # New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim" - Write-Host $_.ErrorDetails - } -- path: /notification-templates - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#create-notification-template - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TemplateDto = @" - { - "slackTemplate" : "slackTemplate", - "footer" : "footer", - "teamsTemplate" : "teamsTemplate", - "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", - "created" : "2020-01-01T00:00:00Z", - "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", - "medium" : "EMAIL", - "locale" : "en", - "body" : "Please go to the task manager", - "name" : "Task Manager Subscription", - "replyTo" : "$__global.emailFromAddress", - "header" : "header", - "modified" : "2020-01-01T00:00:00Z", - "from" : "$__global.emailFromAddress", - "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", - "key" : "cloud_manual_work_item_summary" - } - "@ - - # Create Notification Template - - try { - $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto - New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result - - # Below is a request that includes all optional parameters - # New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate" - Write-Host $_.ErrorDetails - } -- path: /verified-from-addresses - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#create-verified-from-address - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $EmailStatusDto = @" - { - "isVerifiedByDomain" : false, - "verificationStatus" : "PENDING", - "id" : "id", - "email" : "sender@example.com" - } - "@ - - # Create Verified From Address - - try { - $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto - New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result - - # Below is a request that includes all optional parameters - # New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress" - Write-Host $_.ErrorDetails - } -- path: /notification-templates/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#delete-notification-templates-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TemplateBulkDeleteDto = @"{ - "medium" : "EMAIL", - "locale" : "en", - "key" : "cloud_manual_work_item_summary" - }"@ - - - # Bulk Delete Notification Templates - - try { - $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto - Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result - - # Below is a request that includes all optional parameters - # Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk" - Write-Host $_.ErrorDetails - } -- path: /verified-from-addresses/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#delete-verified-from-address - source: | - $Id = "MyId" # String | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Verified From Address - - try { - Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VerifiedFromAddress" - Write-Host $_.ErrorDetails - } -- path: /verified-domains - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#get-dkim-attributes - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get DKIM Attributes - - try { - Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DkimAttributes" - Write-Host $_.ErrorDetails - } -- path: /mail-from-attributes/{identity} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#get-mail-from-attributes - source: | - $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get MAIL FROM Attributes - - try { - Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MailFromAttributes" - Write-Host $_.ErrorDetails - } -- path: /notification-templates/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#get-notification-template - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Notification Template By Id - - try { - Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplate" - Write-Host $_.ErrorDetails - } -- path: /notification-template-context - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#get-notifications-template-context - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Notification Template Context - - try { - Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationsTemplateContext" - Write-Host $_.ErrorDetails - } -- path: /verified-from-addresses - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#list-from-addresses - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "email eq "john.doe@company.com"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) - $Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) - - # List From Addresses - - try { - Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FromAddresses" - Write-Host $_.ErrorDetails - } -- path: /notification-preferences/{key} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#list-notification-preferences - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Notification Preferences for tenant. - - try { - Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationPreferences" - Write-Host $_.ErrorDetails - } -- path: /notification-template-defaults - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#list-notification-template-defaults - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "key eq "cloud_manual_work_item_summary"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - - # List Notification Template Defaults - - try { - Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplateDefaults" - Write-Host $_.ErrorDetails - } -- path: /notification-templates - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#list-notification-templates - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "medium eq "EMAIL"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - - # List Notification Templates - - try { - Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplates" - Write-Host $_.ErrorDetails - } -- path: /mail-from-attributes - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#put-mail-from-attributes - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MailFromAttributesDto = @" - { - "identity" : "BobSmith@sailpoint.com", - "mailFromDomain" : "example.sailpoint.com" - } - "@ - - # Change MAIL FROM domain - - try { - $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto - Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result - - # Below is a request that includes all optional parameters - # Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes" - Write-Host $_.ErrorDetails - } -- path: /send-test-notification - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#send-test-notification - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SendTestNotificationRequestDto = @" - { - "context" : "{}", - "medium" : "EMAIL", - "key" : "cloud_manual_work_item_summary" - } - "@ - - # Send Test Notification - - try { - $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto - Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result - - # Below is a request that includes all optional parameters - # Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TestNotification" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/o-auth-clients#create-oauth-client - source: | - $CreateOAuthClientRequest = @" - { - "internal" : false, - "businessName" : "Acme-Solar", - "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", - "refreshTokenValiditySeconds" : 86400, - "type" : "CONFIDENTIAL", - "redirectUris" : [ "http://localhost:12345" ], - "enabled" : true, - "accessType" : "OFFLINE", - "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], - "strongAuthSupported" : false, - "homepageUrl" : "http://localhost:12345", - "accessTokenValiditySeconds" : 750, - "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], - "name" : "Demo API Client", - "claimsSupported" : false - } - "@ - - # Create OAuth Client - - try { - $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-V2024OauthClient -CreateOAuthClientRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024OauthClient -CreateOAuthClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024OauthClient" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/o-auth-clients#delete-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Delete OAuth Client - - try { - Remove-V2024OauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024OauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024OauthClient" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/o-auth-clients#get-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Get OAuth Client - - try { - Get-V2024OauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024OauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClient" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/o-auth-clients#list-oauth-clients - source: | - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - - # List OAuth Clients - - try { - Get-V2024OauthClients - - # Below is a request that includes all optional parameters - # Get-V2024OauthClients -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClients" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/o-auth-clients#patch-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch OAuth Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024OauthClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024OauthClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OauthClient" - Write-Host $_.ErrorDetails - } -- path: /org-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/org-config#get-org-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Org Config Settings - - try { - Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OrgConfig" - Write-Host $_.ErrorDetails - } -- path: /org-config/valid-time-zones - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/org-config#get-valid-time-zones - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Get Valid Time Zones - - try { - Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ValidTimeZones" - Write-Host $_.ErrorDetails - } -- path: /org-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/org-config#patch-org-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Org Config - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-org-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-configuration#create-password-org-config - source: | - $PasswordOrgConfig = @" - { - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - } - "@ - - # Create Password Org Config - - try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - New-V2024PasswordOrgConfig -PasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # New-V2024PasswordOrgConfig -PasswordOrgConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-org-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-configuration#get-password-org-config - source: | - - # Get Password Org Config - - try { - Get-V2024PasswordOrgConfig - - # Below is a request that includes all optional parameters - # Get-V2024PasswordOrgConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-org-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-configuration#put-password-org-config - source: | - $PasswordOrgConfig = @" - { - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - } - "@ - - # Update Password Org Config - - try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - Send-V2024PasswordOrgConfig -PasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2024PasswordOrgConfig -PasswordOrgConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-dictionary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-dictionary#get-password-dictionary - source: | - - # Get Password Dictionary - - try { - Get-V2024PasswordDictionary - - # Below is a request that includes all optional parameters - # Get-V2024PasswordDictionary - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordDictionary" - Write-Host $_.ErrorDetails - } -- path: /password-dictionary - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-dictionary#put-password-dictionary - source: | - $File = # System.IO.FileInfo | (optional) - - # Update Password Dictionary - - try { - Send-V2024PasswordDictionary - - # Below is a request that includes all optional parameters - # Send-V2024PasswordDictionary -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordDictionary" - Write-Host $_.ErrorDetails - } -- path: /generate-password-reset-token/digit - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-management#create-digit-token - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $PasswordDigitTokenReset = @" - { - "durationMinutes" : 5, - "length" : 8, - "userId" : "Abby.Smith" - } - "@ - - # Generate a digit token - - try { - $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset - New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result - - # Below is a request that includes all optional parameters - # New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DigitToken" - Write-Host $_.ErrorDetails - } -- path: /password-change-status/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-management#get-password-change-status - source: | - $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID - - # Get Password Change Request Status - - try { - Get-V2024PasswordChangeStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024PasswordChangeStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordChangeStatus" - Write-Host $_.ErrorDetails - } -- path: /query-password-info - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-management#query-password-info - source: | - $PasswordInfoQueryDTO = @" - { - "sourceName" : "My-AD", - "userName" : "Abby.Smith" - } - "@ - - # Query Password Info - - try { - $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO - Search-V2024PasswordInfo -PasswordInfoQueryDTO $Result - - # Below is a request that includes all optional parameters - # Search-V2024PasswordInfo -PasswordInfoQueryDTO $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PasswordInfo" - Write-Host $_.ErrorDetails - } -- path: /set-password - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-management#set-password - source: | - $PasswordChangeRequest = @" - { - "sourceId" : "8a807d4c73c545510173c545d4b60246", - "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", - "identityId" : "8a807d4c73c545510173c545f0a002ff", - "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", - "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" - } - "@ - - # Set Identity's Password - - try { - $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest - Set-V2024Password -PasswordChangeRequest $Result - - # Below is a request that includes all optional parameters - # Set-V2024Password -PasswordChangeRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Password" - Write-Host $_.ErrorDetails - } -- path: /password-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-policies#create-password-policy - source: | - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : 1939056206564, - "validateAgainstAccountId" : false, - "dateCreated" : 1639056206564, - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Create Password Policy - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-V2024PasswordPolicy -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # New-V2024PasswordPolicy -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordPolicy" - Write-Host $_.ErrorDetails - } -- path: /password-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-policies#delete-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. - - # Delete Password Policy by ID - - try { - Remove-V2024PasswordPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024PasswordPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordPolicy" - Write-Host $_.ErrorDetails - } -- path: /password-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-policies#get-password-policy-by-id - source: | - $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. - - # Get Password Policy by ID - - try { - Get-V2024PasswordPolicyById -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024PasswordPolicyById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicyById" - Write-Host $_.ErrorDetails - } -- path: /password-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-policies#list-password-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Password Policies - - try { - Get-V2024PasswordPolicies - - # Below is a request that includes all optional parameters - # Get-V2024PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicies" - Write-Host $_.ErrorDetails - } -- path: /password-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-policies#set-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : 1939056206564, - "validateAgainstAccountId" : false, - "dateCreated" : 1639056206564, - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Update Password Policy by ID - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-V2024PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # Set-V2024PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024PasswordPolicy" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-sync-groups#create-password-sync-group - source: | - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Create Password Sync Group - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-V2024PasswordSyncGroup -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # New-V2024PasswordSyncGroup -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-sync-groups#delete-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. - - # Delete Password Sync Group by ID - - try { - Remove-V2024PasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024PasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-sync-groups#get-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. - - # Get Password Sync Group by ID - - try { - Get-V2024PasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024PasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-sync-groups#get-password-sync-groups - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Get Password Sync Group List - - try { - Get-V2024PasswordSyncGroups - - # Below is a request that includes all optional parameters - # Get-V2024PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroups" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-sync-groups#update-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Update Password Sync Group by ID - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-V2024PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # Update-V2024PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/personal-access-tokens#create-personal-access-token - source: | - $CreatePersonalAccessTokenRequest = @" - { - "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], - "accessTokenValiditySeconds" : 36900, - "name" : "NodeJS Integration" - } - "@ - - # Create Personal Access Token - - try { - $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-V2024PersonalAccessToken -CreatePersonalAccessTokenRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024PersonalAccessToken -CreatePersonalAccessTokenRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PersonalAccessToken" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/personal-access-tokens#delete-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id - - # Delete Personal Access Token - - try { - Remove-V2024PersonalAccessToken -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024PersonalAccessToken -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PersonalAccessToken" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/personal-access-tokens#list-personal-access-tokens - source: | - $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - - # List Personal Access Tokens - - try { - Get-V2024PersonalAccessTokens - - # Below is a request that includes all optional parameters - # Get-V2024PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PersonalAccessTokens" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/personal-access-tokens#patch-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Personal Access Token - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024PersonalAccessToken -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024PersonalAccessToken -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PersonalAccessToken" - Write-Host $_.ErrorDetails - } -- path: /public-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/public-identities#get-public-identities - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) - $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Get list of public identities - - try { - Get-V2024PublicIdentities - - # Below is a request that includes all optional parameters - # Get-V2024PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentities" - Write-Host $_.ErrorDetails - } -- path: /public-identities-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/public-identities-config#get-public-identity-config - source: | - - # Get the Public Identities Configuration - - try { - Get-V2024PublicIdentityConfig - - # Below is a request that includes all optional parameters - # Get-V2024PublicIdentityConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentityConfig" - Write-Host $_.ErrorDetails - } -- path: /public-identities-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/public-identities-config#update-public-identity-config - source: | - $PublicIdentityConfig = @" - { - "modified" : "2018-06-25T20:22:28.104Z", - "attributes" : [ { - "name" : "Country", - "key" : "country" - }, { - "name" : "Country", - "key" : "country" - } ], - "modifiedBy" : { - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - } - "@ - - # Update the Public Identities Configuration - - try { - $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-V2024PublicIdentityConfig -PublicIdentityConfig $Result - - # Below is a request that includes all optional parameters - # Update-V2024PublicIdentityConfig -PublicIdentityConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PublicIdentityConfig" - Write-Host $_.ErrorDetails - } -- path: /reports/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/reports-data-extraction#cancel-report - source: | - $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel - - # Cancel Report - - try { - Suspend-V2024Report -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2024Report -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024Report" - Write-Host $_.ErrorDetails - } -- path: /reports/{taskResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/reports-data-extraction#get-report - source: | - $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report - $FileFormat = "csv" # String | Output format of the requested report file - $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) - $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) - - # Get Report File - - try { - Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat - - # Below is a request that includes all optional parameters - # Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Report" - Write-Host $_.ErrorDetails - } -- path: /reports/{taskResultId}/result - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/reports-data-extraction#get-report-result - source: | - $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report - $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) - - # Get Report Result - - try { - Get-V2024ReportResult -TaskResultId $TaskResultId - - # Below is a request that includes all optional parameters - # Get-V2024ReportResult -TaskResultId $TaskResultId -Completed $Completed - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReportResult" - Write-Host $_.ErrorDetails - } -- path: /reports/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/reports-data-extraction#start-report - source: | - $ReportDetails = @" - { - "reportType" : "ACCOUNTS", - "arguments" : { - "application" : "2c9180897e7742b2017e781782f705b9", - "sourceName" : "Active Directory" - } - } - "@ - - # Run Report - - try { - $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails - Start-V2024Report -ReportDetails $Result - - # Below is a request that includes all optional parameters - # Start-V2024Report -ReportDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Report" - Write-Host $_.ErrorDetails - } -- path: /requestable-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/requestable-objects#list-requestable-objects - source: | - $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) - $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) - - $Types = @"ROLE,ACCESS_PROFILE"@ - $Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) - $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) - - $Statuses = @"[ASSIGNED, PENDING]"@ - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Requestable Objects List - - try { - Get-V2024RequestableObjects - - # Below is a request that includes all optional parameters - # Get-V2024RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RequestableObjects" - Write-Host $_.ErrorDetails - } -- path: /role-insights/requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#create-role-insight-requests - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Generate insights for roles - - try { - New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleInsightRequests" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId}/entitlement-changes/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#download-role-insights-entitlements-changes - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) - $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Download entitlement insights for a role - - try { - Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleInsightsEntitlementsChanges" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-entitlement-changes-identities - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "name sw "Jan"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - - # Get identities for a suggested entitlement (for a role) - - try { - Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChangesIdentities" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insight - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a single role insight - - try { - Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsight" - Write-Host $_.ErrorDetails - } -- path: /role-insights - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) - $Filters = "name sw "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) - - # Get role insights - - try { - Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsights" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId}/current-entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-current-entitlements - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Get current entitlement for a role - - try { - Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsCurrentEntitlements" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId}/entitlement-changes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-entitlements-changes - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) - $Filters = "name sw "Admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Get entitlement insights for a role - - try { - Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsEntitlementsChanges" - Write-Host $_.ErrorDetails - } -- path: /role-insights/requests/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-requests - source: | - $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Returns metadata from prior request. - - try { - Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsRequests" - Write-Host $_.ErrorDetails - } -- path: /role-insights/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-summary - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get role insights summary information - - try { - Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsSummary" - Write-Host $_.ErrorDetails - } -- path: /roles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#create-role - source: | - $Role = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "dimensional" : false, - "created" : "2021-03-01T22:32:58.104Z", - "dimensionRefs" : [ { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - }, { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - } ], - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "membership" : { - "identities" : [ { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } ], - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, - "type" : "IDENTITY_LIST" - }, - "enabled" : true, - "revocationRequestConfig" : { - "commentsRequired" : false, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : false - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "legacyMembershipInfo" : { - "type" : "IDENTITY_LIST" - }, - "accessRequestConfig" : { - "commentsRequired" : true, - "reauthorizationRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "name" : "Role 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "accessModelMetadata" : { - "attributes" : [ { - "key" : "iscPrivacy", - "name" : "Privacy", - "multiselect" : false, - "status" : "active", - "type" : "governance", - "objectTypes" : [ "all" ], - "description" : "Specifies the level of privacy associated with an access item.", - "values" : [ { - "value" : "public", - "name" : "Public", - "status" : "active" - } ] - } ] - }, - "id" : "2c918086749d78830174a1a40e121518", - "requestable" : true - } - "@ - - # Create a Role - - try { - $Result = ConvertFrom-JsonToRole -Json $Role - New-V2024Role -Role $Result - - # Below is a request that includes all optional parameters - # New-V2024Role -Role $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Role" - Write-Host $_.ErrorDetails - } -- path: /roles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#delete-bulk-roles - source: | - $RoleBulkDeleteRequest = @" - { - "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - } - "@ - - # Delete Role(s) - - try { - $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-V2024BulkRoles -RoleBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2024BulkRoles -RoleBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkRoles" - Write-Host $_.ErrorDetails - } -- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#delete-metadata-from-role-by-key-and-value - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - - # Remove a Metadata From Role. - - try { - Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - - # Below is a request that includes all optional parameters - # Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MetadataFromRoleByKeyAndValue" - Write-Host $_.ErrorDetails - } -- path: /roles/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#delete-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - - # Delete a Role - - try { - Remove-V2024Role -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Role -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Role" - Write-Host $_.ErrorDetails - } -- path: /roles/access-model-metadata/bulk-update - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#get-bulk-update-status - source: | - - # Get Bulk-Update Statuses - - try { - Get-V2024BulkUpdateStatus - - # Below is a request that includes all optional parameters - # Get-V2024BulkUpdateStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatus" - Write-Host $_.ErrorDetails - } -- path: /roles/access-model-metadata/bulk-update/id - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#get-bulk-update-status-by-id - source: | - $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. - - # Get Bulk-Update Status by ID - - try { - Get-V2024BulkUpdateStatusById -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024BulkUpdateStatusById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatusById" - Write-Host $_.ErrorDetails - } -- path: /roles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#get-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - - # Get a Role - - try { - Get-V2024Role -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Role -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Role" - Write-Host $_.ErrorDetails - } -- path: /roles/{id}/assigned-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#get-role-assigned-identities - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) - $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) - - # List Identities assigned a Role - - try { - Get-V2024RoleAssignedIdentities -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignedIdentities" - Write-Host $_.ErrorDetails - } -- path: /roles/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#get-role-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | Containing role's ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Role's Entitlements - - try { - Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleEntitlements" - Write-Host $_.ErrorDetails - } -- path: /roles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#list-roles - source: | - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) - - # List Roles - - try { - Get-V2024Roles - - # Below is a request that includes all optional parameters - # Get-V2024Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Roles" - Write-Host $_.ErrorDetails - } -- path: /roles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#patch-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Role - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Role -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024Role -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Role" - Write-Host $_.ErrorDetails - } -- path: /roles/filter - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#search-roles-by-filter - source: | - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) - $RoleListFilterDTO = @" - { - "ammKeyValues" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "secret" ] - } ], - "filters" : "dimensional eq false" - } - "@ - - # Filter Roles by Metadata - - try { - Search-V2024RolesByFilter - - # Below is a request that includes all optional parameters - # Search-V2024RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -RoleListFilterDTO $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024RolesByFilter" - Write-Host $_.ErrorDetails - } -- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#update-attribute-key-and-value-to-role - source: | - $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - - # Add a Metadata to Role. - - try { - Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - - # Below is a request that includes all optional parameters - # Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AttributeKeyAndValueToRole" - Write-Host $_.ErrorDetails - } -- path: /roles/access-model-metadata/bulk-update/filter - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-filter - source: | - $RoleMetadataBulkUpdateByFilterRequest = @" - { - "values" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "topSecret" ] - } ], - "filters" : " requestable eq false", - "replaceScope" : "ALL", - "operation" : "REPLACE" - } - "@ - - # Bulk-Update Roles' Metadata by Filters - - try { - $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest - Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByFilter" - Write-Host $_.ErrorDetails - } -- path: /roles/access-model-metadata/bulk-update/ids - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-ids - source: | - $RoleMetadataBulkUpdateByIdRequest = @" - { - "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], - "values" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "topSecret" ] - } ], - "replaceScope" : "ALL", - "operation" : "REPLACE" - } - "@ - - # Bulk-Update Roles' Metadata by ID - - try { - $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest - Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByIds" - Write-Host $_.ErrorDetails - } -- path: /roles/access-model-metadata/bulk-update/query - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-query - source: | - $RoleMetadataBulkUpdateByQueryRequest = @" - { - "query" : { - "query\"" : { - "indices" : [ "roles" ], - "queryType" : "TEXT", - "textQuery" : { - "terms" : [ "test123" ], - "fields" : [ "id" ], - "matchAny" : false, - "contains" : true - }, - "includeNested" : false - } - }, - "values" : [ { - "attributeValue" : [ "topSecret" ], - "attributeKey" : "iscFederalClassifications" - }, { - "attributeValue" : [ "topSecret" ], - "attributeKey" : "iscFederalClassifications" - } ], - "replaceScope" : "ALL", - "operation" : "REPLACE" - } - "@ - - # Bulk-Update Roles' Metadata by Query - - try { - $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest - Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration - source: | - $Id = "12345" # String | The id of the integration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a SIM integration - - try { - Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a SIM integration details. - - try { - Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2024SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2024SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2024SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2024DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2024SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2024SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2024SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2024SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-V2024SodPolicies - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2024SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2024SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2024EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2024SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2024PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2024SpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2024SpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-V2024SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-V2024SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-V2024SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-V2024SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2024SpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-V2024SpConfigObjects - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" - Write-Host $_.ErrorDetails - } -- path: /saved-searches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#create-saved-search - source: | - $CreateSavedSearchRequest = @" - - "@ - - # Create a saved search - - try { - $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-V2024SavedSearch -CreateSavedSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024SavedSearch -CreateSavedSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#delete-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete document by ID - - try { - Remove-V2024SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id}/execute - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#execute-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SearchArguments = @" - { - "owner" : "", - "recipients" : [ { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - } - "@ - - # Execute a saved search by ID - - try { - $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-V2024ExecuteSavedSearch -Id $Id -SearchArguments $Result - - # Below is a request that includes all optional parameters - # Invoke-V2024ExecuteSavedSearch -Id $Id -SearchArguments $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#get-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Return saved search by ID - - try { - Get-V2024SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#list-saved-searches - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) - - # A list of Saved Searches - - try { - Get-V2024SavedSearches - - # Below is a request that includes all optional parameters - # Get-V2024SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#put-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SavedSearch = @" - { - "owner" : { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2018-06-25T20:22:28.104Z", - "columns" : { - "identity" : [ { - "field" : "displayName", - "header" : "Display Name" - }, { - "field" : "e-mail", - "header" : "Work Email" - } ] - }, - "query" : "@accounts(disabled:true)", - "description" : "Disabled accounts", - "orderBy" : { - "identity" : [ "lastName", "firstName" ], - "role" : [ "name" ] - }, - "sort" : [ "displayName" ], - "filters" : { - "terms" : [ "account_count", "account_count" ], - "range" : { - "lower" : { - "inclusive" : false, - "value" : "1" - }, - "upper" : { - "inclusive" : false, - "value" : "1" - } - }, - "exclude" : false, - "type" : "RANGE" - }, - "ownerId" : "2c91808568c529c60168cca6f90c1313", - "indices" : [ "identities" ], - "public" : false, - "name" : "Disabled accounts", - "modified" : "2018-06-25T20:22:28.104Z", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "fields" : [ "disabled" ] - } - "@ - - # Updates an existing saved search - - try { - $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-V2024SavedSearch -Id $Id -SavedSearch $Result - - # Below is a request that includes all optional parameters - # Send-V2024SavedSearch -Id $Id -SavedSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#create-scheduled-search - source: | - $CreateScheduledSearchRequest = @" - {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} - "@ - - # Create a new scheduled search - - try { - $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-V2024ScheduledSearch -CreateScheduledSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ScheduledSearch -CreateScheduledSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#delete-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete a Scheduled Search - - try { - Remove-V2024ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#get-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Scheduled Search - - try { - Get-V2024ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#list-scheduled-search - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - - # List scheduled searches - - try { - Get-V2024ScheduledSearch - - # Below is a request that includes all optional parameters - # Get-V2024ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id}/unsubscribe - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#unsubscribe-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $TypedReference = @" - { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - "@ - - # Unsubscribe a recipient from Scheduled Search - - try { - $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-V2024UnsubscribeScheduledSearch -Id $Id -TypedReference $Result - - # Below is a request that includes all optional parameters - # Invoke-V2024UnsubscribeScheduledSearch -Id $Id -TypedReference $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#update-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $ScheduledSearch = @" - { - "owner" : { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "displayQueryDetails" : false, - "created" : "", - "description" : "Daily disabled accounts", - "ownerId" : "2c9180867624cbd7017642d8c8c81f67", - "enabled" : false, - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "recipients" : [ { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - } ], - "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", - "name" : "Daily disabled accounts", - "modified" : "", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "emailEmptyResults" : false - } - "@ - - # Update an existing Scheduled Search - - try { - $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-V2024ScheduledSearch -Id $Id -ScheduledSearch $Result - - # Below is a request that includes all optional parameters - # Update-V2024ScheduledSearch -Id $Id -ScheduledSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /search/aggregate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search#search-aggregate - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Perform a Search Query Aggregation - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Aggregate -Search $Result - - # Below is a request that includes all optional parameters - # Search-V2024Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" - Write-Host $_.ErrorDetails - } -- path: /search/count - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search#search-count - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - - # Count Documents Satisfying a Query - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Count -Search $Result - - # Below is a request that includes all optional parameters - # Search-V2024Count -Search $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" - Write-Host $_.ErrorDetails - } -- path: /search/{index}/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search#search-get - source: | - $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Document by ID - - try { - Search-V2024Get -Index $Index -Id $Id - - # Below is a request that includes all optional parameters - # Search-V2024Get -Index $Index -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get" - Write-Host $_.ErrorDetails - } -- path: /search - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search#search-post - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Perform Search - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Post -Search $Result - - # Below is a request that includes all optional parameters - # Search-V2024Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#create-search-attribute-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ - - # Create Extended Search Attributes - - try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#delete-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Extended Search Attribute - - try { - Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-search-attribute-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Extended Search Attributes - - try { - Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Extended Search Attribute - - try { - Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#patch-search-attribute-config - source: | - $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Extended Search Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#create-segment - source: | - $Segment = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-V2024Segment -Segment $Result - - # Below is a request that includes all optional parameters - # New-V2024Segment -Segment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-V2024Segment -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-V2024Segment -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment" - Write-Host $_.ErrorDetails - } -- path: /segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#list-segments - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Segments - - try { - Get-V2024Segments - - # Below is a request that includes all optional parameters - # Get-V2024Segments -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#patch-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024Segment -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2024Segment -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#create-service-desk-integration - source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ - - # Create new Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-V2024ServiceDeskIntegration -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-V2024ServiceDeskIntegration -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#delete-service-desk-integration - source: | - $Id = "anId" # String | ID of Service Desk integration to delete - - # Delete a Service Desk integration - - try { - Remove-V2024ServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to get - - # Get a Service Desk integration - - try { - Get-V2024ServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - - # Service Desk integration template by scriptName - - try { - Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-types - source: | - - # List Service Desk integration types - - try { - Get-V2024ServiceDeskIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTypes" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integrations - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List existing Service Desk integrations - - try { - Get-V2024ServiceDeskIntegrations - - # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrations" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-status-check-details - source: | - - # Get the time check configuration - - try { - Get-V2024StatusCheckDetails - - # Below is a request that includes all optional parameters - # Get-V2024StatusCheckDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#patch-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - - "@ - - # Patch a Service Desk Integration - - try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#put-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ - - # Update a Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-V2024ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # Send-V2024ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#update-status-check-details - source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ - - # Update the time check configuration - - try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-V2024StatusCheckDetails -QueuedCheckConfigDetails $Result - - # Below is a request that includes all optional parameters - # Update-V2024StatusCheckDetails -QueuedCheckConfigDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-V2024StatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024StatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-V2024UsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#create-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - $ProvisioningPolicyDto = @" - { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } - "@ - - # Create Provisioning Policy - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#create-source - source: | - $Source = @" - { - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - } - "@ - $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) - - # Creates a source in IdentityNow. - - try { - $Result = ConvertFrom-JsonToSource -Json $Source - New-V2024Source -Source $Result - - # Below is a request that includes all optional parameters - # New-V2024Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schedules - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#create-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Schedule1 = @" - - "@ - - # Create Schedule on Source - - try { - $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 - New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result - - # Below is a request that includes all optional parameters - # New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchedule" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#create-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Schema = @" - { - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" - } - "@ - - # Create Schema on Source - - try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - New-V2024SourceSchema -SourceId $SourceId -Schema $Result - - # Below is a request that includes all optional parameters - # New-V2024SourceSchema -SourceId $SourceId -Schema $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/remove-accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-accounts-async - source: | - $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Remove All Accounts in a Source - - try { - Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountsAsync" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/native-change-detection-config - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-native-change-detection-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Native Change Detection Configuration - - try { - Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - - # Delete Provisioning Policy by UsageType - - try { - Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - - # Below is a request that includes all optional parameters - # Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Delete Source by ID - - try { - Remove-V2024Source -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Source -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schedules/{scheduleType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - - # Delete Source Schedule by type. - - try { - Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - - # Below is a request that includes all optional parameters - # Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchedule" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - - # Delete Source Schema by ID - - try { - Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/schemas/accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-accounts-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - - # Downloads source accounts schema template - - try { - Get-V2024AccountsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024AccountsSchema -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/correlation-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-correlation-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - - # Get Source Correlation Configuration - - try { - Get-V2024CorrelationConfig -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024CorrelationConfig -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CorrelationConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/schemas/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-entitlements-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) - - # Downloads source entitlements schema template - - try { - Get-V2024EntitlementsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024EntitlementsSchema -Id $Id -SchemaName $SchemaName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/native-change-detection-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-native-change-detection-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Native Change Detection Configuration - - try { - Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - - # Get Provisioning Policy by UsageType - - try { - Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - - # Below is a request that includes all optional parameters - # Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Get Source by ID - - try { - Get-V2024Source -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Source -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/attribute-sync-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-attr-sync-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Attribute Sync Config - - try { - Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceAttrSyncConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/connectors/source-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-config - source: | - $Id = "cef3ee201db947c5912551015ba0c679" # String | The Source id - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Gets source config with language-translations - - try { - Get-V2024SourceConfig -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SourceConfig -Id $Id -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connections - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-connections - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Get Source Connections by ID - - try { - Get-V2024SourceConnections -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024SourceConnections -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConnections" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/entitlement-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-entitlement-request-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Source Entitlement Request Configuration - - try { - Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/source-health - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-health - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - - # Fetches source health by id - - try { - Get-V2024SourceHealth -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024SourceHealth -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceHealth" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schedules/{scheduleType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - - # Get Source Schedule by Type - - try { - Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - - # Below is a request that includes all optional parameters - # Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedule" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schedules - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schedules - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # List Schedules on Source - - try { - Get-V2024SourceSchedules -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024SourceSchedules -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedules" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - - # Get Source Schema by ID - - try { - Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schemas - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) - $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) - - # List Schemas on Source - - try { - Get-V2024SourceSchemas -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchemas" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/load-accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#import-accounts - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) - $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) - - # Account Aggregation - - try { - Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Accounts" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/schemas/accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#import-accounts-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $File = # System.IO.FileInfo | (optional) - - # Uploads source accounts schema template - - try { - Import-V2024AccountsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Import-V2024AccountsSchema -Id $Id -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024AccountsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/upload-connector-file - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#import-connector-file - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $File = # System.IO.FileInfo | (optional) - - # Upload connector file to source - - try { - Import-V2024ConnectorFile -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Import-V2024ConnectorFile -SourceId $SourceId -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024ConnectorFile" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/schemas/entitlements - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#import-entitlements-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) - $File = # System.IO.FileInfo | (optional) - - # Uploads source entitlements schema template - - try { - Import-V2024EntitlementsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Import-V2024EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/load-uncorrelated-accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#import-uncorrelated-accounts - source: | - $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $File = # System.IO.FileInfo | (optional) - - # Process Uncorrelated Accounts - - try { - Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024UncorrelatedAccounts" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#list-provisioning-policies - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - - # Lists ProvisioningPolicies - - try { - Get-V2024ProvisioningPolicies -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024ProvisioningPolicies -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicies" - Write-Host $_.ErrorDetails - } -- path: /sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#list-sources - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) - $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) - $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) - - # Lists all sources in IdentityNow. - - try { - Get-V2024Sources - - # Below is a request that includes all optional parameters - # Get-V2024Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Sources" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connector/ping-cluster - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#ping-cluster - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - - # Ping cluster for source connector - - try { - Ping-V2024Cluster -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Ping-V2024Cluster -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2024Cluster" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/correlation-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#put-correlation-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $CorrelationConfig = @" - { - "attributeAssignments" : [ { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - }, { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - } ], - "name" : "Source [source] Account Correlation", - "id" : "2c9180835d191a86015d28455b4a2329" - } - "@ - - # Update Source Correlation Configuration - - try { - $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig - Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024CorrelationConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/native-change-detection-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#put-native-change-detection-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $NativeChangeDetectionConfig = @" - { - "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], - "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], - "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], - "allNonEntitlementAttributes" : false, - "allEntitlements" : false, - "enabled" : true - } - "@ - - # Update Native Change Detection Configuration - - try { - $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig - Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024NativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#put-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $ProvisioningPolicyDto = @" - { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } - "@ - - # Update Provisioning Policy by UsageType - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#put-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Source = @" - { - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - } - "@ - - # Update Source (Full) - - try { - $Result = ConvertFrom-JsonToSource -Json $Source - Send-V2024Source -Id $Id -Source $Result - - # Below is a request that includes all optional parameters - # Send-V2024Source -Id $Id -Source $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/attribute-sync-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#put-source-attr-sync-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AttrSyncSourceConfig = @" - { - "attributes" : [ { - "name" : "email", - "displayName" : "Email", - "enabled" : true, - "target" : "mail" - }, { - "name" : "firstname", - "displayName" : "First Name", - "enabled" : false, - "target" : "givenName" - } ], - "source" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - } - } - "@ - - # Update Attribute Sync Config - - try { - $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig - Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceAttrSyncConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#put-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $Schema = @" - { - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" - } - "@ - - # Update Source Schema (Full) - - try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result - - # Below is a request that includes all optional parameters - # Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connector/peek-resource-objects - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#search-resource-objects - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - $ResourceObjectsRequest = @" - { - "maxCount" : 100, - "objectType" : "group" - } - "@ - - # Peek source connector's resource objects - - try { - $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest - Search-V2024ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result - - # Below is a request that includes all optional parameters - # Search-V2024ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024ResourceObjects" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/synchronize-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#sync-attributes-for-source - source: | - $Id = "MyId" # String | The Source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Synchronize single source attributes. - - try { - Sync-V2024AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Sync-V2024AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024AttributesForSource" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connector/test-configuration - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#test-source-configuration - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - - # Test configuration for source connector - - try { - Test-V2024SourceConfiguration -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-V2024SourceConfiguration -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConfiguration" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connector/check-connection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#test-source-connection - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. - - # Check connection for source connector. - - try { - Test-V2024SourceConnection -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-V2024SourceConnection -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConnection" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/password-policies - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-password-policy-holders - source: | - $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $PasswordPolicyHoldersDtoInner = @""@ - - - # Update Password Policy - - try { - $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner - Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result - - # Below is a request that includes all optional parameters - # Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordPolicyHolders" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policies-in-bulk - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ProvisioningPolicyDto = @"{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - }"@ - - - # Bulk Update Provisioning Policies - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Partial update of Provisioning Policy - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Source -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024Source -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/entitlement-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-entitlement-request-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceEntitlementRequestConfig = @" - { - "accessRequestConfig" : { - "denialCommentRequired" : false, - "approvalSchemes" : [ { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - } ], - "requestCommentRequired" : true - } - } - "@ - - # Update Source Entitlement Request Configuration - - try { - $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schedules/{scheduleType} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source Schedule (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source Schema (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-batches/{batchId}/stats - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batch-stats - source: | - $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id - - # Submit Sed Batch Stats Request - - try { - Get-V2024SedBatchStats -BatchId $BatchId - - # Below is a request that includes all optional parameters - # Get-V2024SedBatchStats -BatchId $BatchId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-batches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batches - source: | - - # List Sed Batch Request - - try { - Get-V2024SedBatches - - # Below is a request that includes all optional parameters - # Get-V2024SedBatches - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-descriptions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#list-seds - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) - $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) - $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) - $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) - $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) - - # List Suggested Entitlement Descriptions - - try { - Get-V2024Seds - - # Below is a request that includes all optional parameters - # Get-V2024Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-descriptions - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#patch-sed - source: | - $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id - $SedPatch = @"{ - "op" : "replace", - "path" : "status", - "value" : "approved" - }"@ - - - # Patch Suggested Entitlement Description - - try { - $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-V2024Sed -Id $Id -SedPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024Sed -Id $Id -SedPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-approvals - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-approval - source: | - $SedApproval = @"{ - "items" : "016629d1-1d25-463f-97f3-c6686846650" - }"@ - - - # Submit Bulk Approval Request - - try { - $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-V2024SedApproval -SedApproval $Result - - # Below is a request that includes all optional parameters - # Submit-V2024SedApproval -SedApproval $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-assignments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-assignment - source: | - $SedAssignment = @" - { - "assignee" : { - "type" : "SOURCE_OWNER", - "value" : "016629d1-1d25-463f-97f3-c6686846650" - }, - "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] - } - "@ - - # Submit Sed Assignment Request - - try { - $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-V2024SedAssignment -SedAssignment $Result - - # Below is a request that includes all optional parameters - # Submit-V2024SedAssignment -SedAssignment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-batches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-batch-request - source: | - $SedBatchRequest = @" - { - "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] - } - "@ - - # Submit Sed Batch Request - - try { - Submit-V2024SedBatchRequest - - # Below is a request that includes all optional parameters - # Submit-V2024SedBatchRequest -SedBatchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type}/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#delete-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. - - # Delete Object Tags - - try { - Remove-V2024TaggedObject -Type $Type -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024TaggedObject -Type $Type -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TaggedObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/bulk-remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#delete-tags-to-many-object - source: | - $BulkRemoveTaggedObject = @" - { - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Remove Tags from Multiple Objects - - try { - $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject - Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result - - # Below is a request that includes all optional parameters - # Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type}/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#get-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - - # Get Tagged Object - - try { - Get-V2024TaggedObject -Type $Type -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024TaggedObject -Type $Type -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#list-tagged-objects - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) - - # List Tagged Objects - - try { - Get-V2024TaggedObjects - - # Below is a request that includes all optional parameters - # Get-V2024TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjects" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#list-tagged-objects-by-type - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) - - # List Tagged Objects by Type - - try { - Get-V2024TaggedObjectsByType -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2024TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjectsByType" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type}/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#put-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. - $TaggedObject = @" - { - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Update Tagged Object - - try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result - - # Below is a request that includes all optional parameters - # Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#set-tag-to-object - source: | - $TaggedObject = @" - { - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Add Tag to Object - - try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-V2024TagToObject -TaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-V2024TagToObject -TaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/bulk-add - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#set-tags-to-many-objects - source: | - $BulkAddTaggedObject = @" - { - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "operation" : "MERGE", - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Tag Multiple Objects - - try { - $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject - Set-V2024TagsToManyObjects -BulkAddTaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-V2024TagsToManyObjects -BulkAddTaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects" - Write-Host $_.ErrorDetails - } -- path: /task-status/pending-tasks - method: HEAD - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-pending-task-headers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieve Pending Task List Headers - - try { - Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTaskHeaders" - Write-Host $_.ErrorDetails - } -- path: /task-status/pending-tasks - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-pending-tasks - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieve Pending Task Status List - - try { - Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTasks" - Write-Host $_.ErrorDetails - } -- path: /task-status/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-task-status - source: | - $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Task Status by ID - - try { - Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatus" - Write-Host $_.ErrorDetails - } -- path: /task-status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-task-status-list - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "completionStatus eq "Success"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) - $Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) - - # Retrieve Task Status List - - try { - Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatusList" - Write-Host $_.ErrorDetails - } -- path: /task-status/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/task-management#update-task-status - source: | - $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Task Status by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus" - Write-Host $_.ErrorDetails - } -- path: /tenant - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tenant#get-tenant - source: | - - # Get Tenant Information. - - try { - Get-V2024Tenant - - # Below is a request that includes all optional parameters - # Get-V2024Tenant - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant" - Write-Host $_.ErrorDetails - } -- path: /tenant-context - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tenant-context#get-tenant-context - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieve tenant context - - try { - Get-V2024TenantContext -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024TenantContext -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantContext" - Write-Host $_.ErrorDetails - } -- path: /tenant-context - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tenant-context#patch-tenant-context - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @" - { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } - "@ - - # Update tenant context - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TenantContext" - Write-Host $_.ErrorDetails - } -- path: /transforms - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/transforms#create-transform - source: | - $Transform = @" - { - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" - } - "@ - - # Create transform - - try { - $Result = ConvertFrom-JsonToTransform -Json $Transform - New-V2024Transform -Transform $Result - - # Below is a request that includes all optional parameters - # New-V2024Transform -Transform $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Transform" - Write-Host $_.ErrorDetails - } -- path: /transforms/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/transforms#delete-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete - - # Delete a transform - - try { - Remove-V2024Transform -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Transform -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Transform" - Write-Host $_.ErrorDetails - } -- path: /transforms/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/transforms#get-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve - - # Transform by ID - - try { - Get-V2024Transform -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Transform -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transform" - Write-Host $_.ErrorDetails - } -- path: /transforms - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/transforms#list-transforms - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) - $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) - - # List transforms - - try { - Get-V2024Transforms - - # Below is a request that includes all optional parameters - # Get-V2024Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transforms" - Write-Host $_.ErrorDetails - } -- path: /transforms/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/transforms#update-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update - $Transform = @" - { - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" - } - "@ - - # Update a transform - - try { - Update-V2024Transform -Id $Id - - # Below is a request that includes all optional parameters - # Update-V2024Transform -Id $Id -Transform $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Transform" - Write-Host $_.ErrorDetails - } -- path: /trigger-invocations/{id}/complete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#complete-trigger-invocation - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CompleteInvocation = @" - { - "output" : { - "approved" : false - }, - "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "error" : "Access request is denied." - } - "@ - - # Complete Trigger Invocation - - try { - $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation - Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result - - # Below is a request that includes all optional parameters - # Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#create-subscription - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SubscriptionPostRequest = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "triggerId" : "idn:access-requested", - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - } - "@ - - # Create a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest - New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#delete-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a Subscription - - try { - Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Subscription" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#list-subscriptions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) - $Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) - - # List Subscriptions - - try { - Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Subscriptions" - Write-Host $_.ErrorDetails - } -- path: /trigger-invocations/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#list-trigger-invocation-status - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "triggerId eq "idn:access-request-dynamic-approver"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) - - # List Latest Invocation Statuses - - try { - Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TriggerInvocationStatus" - Write-Host $_.ErrorDetails - } -- path: /triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#list-triggers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "idn:access-request-post-approval"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) - - # List Triggers - - try { - Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Triggers" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#patch-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SubscriptionPatchRequestInner = @""@ - - - # Patch a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner - Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" - Write-Host $_.ErrorDetails - } -- path: /trigger-invocations/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#start-test-trigger-invocation - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TestInvocation = @" - { - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - }, - "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], - "triggerId" : "idn:access-request-post-approval", - "contentJson" : { - "workflowId" : 1234 - } - } - "@ - - # Start a Test Invocation - - try { - $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation - Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result - - # Below is a request that includes all optional parameters - # Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions/validate-filter - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#test-subscription-filter - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ValidateFilterInputDto = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - } - } - "@ - - # Validate a Subscription Filter - - try { - $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto - Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result - - # Below is a request that includes all optional parameters - # Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#update-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SubscriptionPutRequest = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - } - "@ - - # Update a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest - Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" - Write-Host $_.ErrorDetails - } -- path: /ui-metadata/tenant - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/ui-metadata#get-tenant-ui-metadata - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a tenant UI metadata - - try { - Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantUiMetadata" - Write-Host $_.ErrorDetails - } -- path: /ui-metadata/tenant - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/ui-metadata#set-tenant-ui-metadata - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TenantUiMetadataItemUpdateRequest = @" - { - "usernameEmptyText" : "Please provide your work email address...", - "usernameLabel" : "Email", - "iframeWhiteList" : "http://example.com http://example2.com" - } - "@ - - # Update tenant UI metadata - - try { - $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest - Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result - - # Below is a request that includes all optional parameters - # Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TenantUiMetadata" - Write-Host $_.ErrorDetails - } -- path: /vendor-connector-mappings - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#create-vendor-connector-mapping - source: | - $VendorConnectorMapping = @" - { - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - } - "@ - - # Create Vendor Connector Mapping - - try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-V2024VendorConnectorMapping -VendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # New-V2024VendorConnectorMapping -VendorConnectorMapping $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VendorConnectorMapping" - Write-Host $_.ErrorDetails - } -- path: /vendor-connector-mappings - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#delete-vendor-connector-mapping - source: | - $VendorConnectorMapping = @" - { - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - } - "@ - - # Delete Vendor Connector Mapping - - try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VendorConnectorMapping" - Write-Host $_.ErrorDetails - } -- path: /vendor-connector-mappings - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#get-vendor-connector-mappings - source: | - - # List Vendor Connector Mappings - - try { - Get-V2024VendorConnectorMappings - - # Below is a request that includes all optional parameters - # Get-V2024VendorConnectorMappings - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Approve an Approval Item - - try { - Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk approve Approval Items - - try { - Approve-V2024ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Approve-V2024ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#complete-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) - - # Complete a Work Item - - try { - Complete-V2024WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Complete-V2024WorkItem -Id $Id -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#forward-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ - - # Forward a Work Item - - try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-V2024ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result - - # Below is a request that includes all optional parameters - # Invoke-V2024ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardWorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Completed Work Items - - try { - Get-V2024CompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-V2024CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-completed-work-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - - # Count Completed Work Items - - try { - Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-work-items - source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - - # Count Work Items - - try { - Get-V2024CountWorkItems - - # Below is a request that includes all optional parameters - # Get-V2024CountWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-item - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - - # Get a Work Item - - try { - Get-V2024WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkItem -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-items-summary - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Work Items Summary - - try { - Get-V2024WorkItemsSummary - - # Below is a request that includes all optional parameters - # Get-V2024WorkItemsSummary -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" - Write-Host $_.ErrorDetails - } -- path: /work-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#list-work-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # List Work Items - - try { - Get-V2024WorkItems - - # Below is a request that includes all optional parameters - # Get-V2024WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Reject an Approval Item - - try { - Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk reject Approval Items - - try { - Deny-V2024ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Deny-V2024ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#submit-account-selection - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - - # Submit Account Selections - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-V2024AccountSelection -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Submit-V2024AccountSelection -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#create-reassignment-configuration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - - # Create a Reassignment Configuration - - try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId}/{configType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#delete-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Reassignment Configuration - - try { - Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId}/evaluate/{configType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - - $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ - - # Evaluate Reassignment Configuration - - try { - Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-config-types - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Reassignment Config Types - - try { - Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Reassignment Configuration - - try { - Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/tenant-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-tenant-config-configuration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Tenant-wide Reassignment Configuration settings - - try { - Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#list-reassignment-configurations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Reassignment Configurations - - try { - Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-reassignment-config - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - - # Update Reassignment Configuration - - try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/tenant-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-tenant-configuration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TenantConfigurationRequest = @" - { - "configDetails" : { - "disabled" : true - } - } - "@ - - # Update Tenant-wide Reassignment Configuration settings - - try { - $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2024WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2024WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2024ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2024Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2024WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-V2024WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2024Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2024Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2024WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2024WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2024WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-V2024CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-V2024WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2024WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-V2024WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2024Workflows - - # Below is a request that includes all optional parameters - # Get-V2024Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2024Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2024Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2024ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" - Write-Host $_.ErrorDetails - } diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index 720362c97..139597f9c 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -1,18634 +1,2 @@ -- path: /access-model-metadata/attributes/{key} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#get-access-model-metadata-attribute - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Model Metadata Attribute - - try { - Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" - Write-Host $_.ErrorDetails - } -- path: /access-model-metadata/attributes/{key}/values/{value} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#get-access-model-metadata-attribute-value - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $Value = "public" # String | Technical name of the Attribute value. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Model Metadata Value - - try { - Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" - Write-Host $_.ErrorDetails - } -- path: /access-model-metadata/attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) - - # List Access Model Metadata Attributes - - try { - Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" - Write-Host $_.ErrorDetails - } -- path: /access-model-metadata/attributes/{key}/values - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute-value - source: | - $Key = "iscPrivacy" # String | Technical name of the Attribute. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Access Model Metadata Values - - try { - Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" - Write-Host $_.ErrorDetails - } -- path: /access-profiles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#create-access-profile - source: | - $AccessProfile = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "description" : "Collection of entitlements to read/write the employee database", - "source" : { - "name" : "ODS-AD-SOURCE", - "id" : "2c91809773dee3610173fdb0b6061ef4", - "type" : "SOURCE" - }, - "enabled" : true, - "revocationRequestConfig" : { - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ] - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "accessRequestConfig" : { - "commentsRequired" : true, - "reauthorizationRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "name" : "Employee-database-read-write", - "provisioningCriteria" : { - "children" : [ { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, - "modified" : "2021-03-02T20:22:28.104Z", - "id" : "2c91808a7190d06e01719938fcd20792", - "requestable" : true - } - "@ - - # Create Access Profile - - try { - $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile - New-V2025AccessProfile -AccessProfile $Result - - # Below is a request that includes all optional parameters - # New-V2025AccessProfile -AccessProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#delete-access-profile - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete - - # Delete the specified Access Profile - - try { - Remove-V2025AccessProfile -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025AccessProfile -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#delete-access-profiles-in-bulk - source: | - $AccessProfileBulkDeleteRequest = @" - { - "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], - "bestEffortOnly" : true - } - "@ - - # Delete Access Profile(s) - - try { - $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest - Remove-V2025AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfilesInBulk" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#get-access-profile - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile - - # Get an Access Profile - - try { - Get-V2025AccessProfile -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccessProfile -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#get-access-profile-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Access Profile's Entitlements - - try { - Get-V2025AccessProfileEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfileEntitlements" - Write-Host $_.ErrorDetails - } -- path: /access-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#list-access-profiles - source: | - $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) - - # List Access Profiles - - try { - Get-V2025AccessProfiles - - # Below is a request that includes all optional parameters - # Get-V2025AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfiles" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#patch-access-profile - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Access Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025AccessProfile -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025AccessProfile -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/bulk-update-requestable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#update-access-profiles-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ - - - # Update Access Profile(s) requestable field. - - try { - $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner - Update-V2025AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AccessProfilesInBulk" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{approvalId}/approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#approve-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $CommentDto = @" - { - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - } - "@ - - # Approve Access Request Approval - - try { - Approve-V2025AccessRequest -ApprovalId $ApprovalId - - # Below is a request that includes all optional parameters - # Approve-V2025AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{approvalId}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#forward-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $ForwardApprovalDto = @" - { - "newOwnerId" : "2c91808568c529c60168cca6f90c1314", - "comment" : "2c91808568c529c60168cca6f90c1313" - } - "@ - - # Forward Access Request Approval - - try { - $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto - Invoke-V2025ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ForwardAccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/approval-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#get-access-request-approval-summary - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) - - # Get Access Requests Approvals Number - - try { - Get-V2025AccessRequestApprovalSummary - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestApprovalSummary" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{accessRequestId}/approvers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#list-access-request-approvers - source: | - $AccessRequestId = "2c91808568c529c60168cca6f90c1313" # String | Access Request ID. - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - - # Access Request Approvers - - try { - Get-V2025AccessRequestApprovers -AccessRequestId $AccessRequestId - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestApprovers -AccessRequestId $AccessRequestId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestApprovers" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#list-completed-approvals - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Completed Access Request Approvals List - - try { - Get-V2025CompletedApprovals - - # Below is a request that includes all optional parameters - # Get-V2025CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompletedApprovals" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/pending - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#list-pending-approvals - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Pending Access Request Approvals List - - try { - Get-V2025PendingApprovals - - # Below is a request that includes all optional parameters - # Get-V2025PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingApprovals" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{approvalId}/reject - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#reject-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $CommentDto = @" - { - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - } - "@ - - # Reject Access Request Approval - - try { - $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Deny-V2025AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - - # Below is a request that includes all optional parameters - # Deny-V2025AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-request-identity-metrics#get-access-request-identity-metrics - source: | - $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. - $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. - $Type = "ENTITLEMENT" # String | Requested access item's type. - - # Return access request identity metrics - - try { - Get-V2025AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestIdentityMetrics" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/bulk-approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#approve-bulk-access-request - source: | - $BulkApproveAccessRequest = @" - { - "comment" : "I approve these request items", - "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] - } - "@ - - # Bulk Approve Access Request - - try { - $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest - Approve-V2025BulkAccessRequest -BulkApproveAccessRequest $Result - - # Below is a request that includes all optional parameters - # Approve-V2025BulkAccessRequest -BulkApproveAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025BulkAccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-requests/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#cancel-access-request - source: | - $CancelAccessRequest = @" - { - "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I requested this role by mistake." - } - "@ - - # Cancel Access Request - - try { - $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest - Suspend-V2025AccessRequest -CancelAccessRequest $Result - - # Below is a request that includes all optional parameters - # Suspend-V2025AccessRequest -CancelAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-requests/bulk-cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#cancel-access-request-in-bulk - source: | - $BulkCancelAccessRequest = @" - { - "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], - "comment" : "I requested this role by mistake." - } - "@ - - # Bulk Cancel Access Request - - try { - $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest - Suspend-V2025AccessRequestInBulk -BulkCancelAccessRequest $Result - - # Below is a request that includes all optional parameters - # Suspend-V2025AccessRequestInBulk -BulkCancelAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025AccessRequestInBulk" - Write-Host $_.ErrorDetails - } -- path: /access-requests/close - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#close-access-request - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CloseAccessRequest = @" - { - "executionStatus" : "Terminated", - "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "completionStatus" : "Failure", - "message" : "The IdentityNow Administrator manually closed this request." - } - "@ - - # Close Access Request - - try { - $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest - Close-V2025AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result - - # Below is a request that includes all optional parameters - # Close-V2025AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2025AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#create-access-request - source: | - $AccessRequest = @" - { - "requestedFor" : "2c918084660f45d6016617daa9210584", - "clientMetadata" : { - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", - "requestedAppName" : "test-app" - }, - "requestType" : "GRANT_ACCESS", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - } ], - "requestedForWithRequestedItems" : [ { - "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ] - }, { - "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ] - } ] - } - "@ - - # Submit Access Request - - try { - $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest - New-V2025AccessRequest -AccessRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025AccessRequest -AccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#get-access-request-config - source: | - - # Get Access Request Configuration - - try { - Get-V2025AccessRequestConfig - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /access-requests/revocable-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#get-entitlement-details-for-identity - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityId = "7025c863c2704ba6beeaedf3cb091573" # String | The identity ID. - $EntitlementId = "ef38f94347e94562b5bb8424a56397d8" # String | The entitlement ID - - # Identity Entitlement Details - - try { - Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementDetailsForIdentity" - Write-Host $_.ErrorDetails - } -- path: /access-request-status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#list-access-request-status - source: | - $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) - $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - - # Access Request Status - - try { - Get-V2025AccessRequestStatus - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestStatus" - Write-Host $_.ErrorDetails - } -- path: /access-request-administration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#list-administrators-access-request-status - source: | - $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) - $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - - # Access Request Status for Administrators - - try { - Get-V2025AdministratorsAccessRequestStatus - - # Below is a request that includes all optional parameters - # Get-V2025AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AdministratorsAccessRequestStatus" - Write-Host $_.ErrorDetails - } -- path: /access-requests/accounts-selection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#load-account-selections - source: | - $AccountsSelectionRequest = @" - { - "requestedFor" : "2c918084660f45d6016617daa9210584", - "clientMetadata" : { - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", - "requestedAppName" : "test-app" - }, - "requestType" : "GRANT_ACCESS", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ] - } - "@ - - # Get accounts selections for identity - - try { - $Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest - Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025LoadAccountSelections" - Write-Host $_.ErrorDetails - } -- path: /access-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/access-requests#set-access-request-config - source: | - $AccessRequestConfig = @" - { - "requestOnBehalfOfConfig" : { - "allowRequestOnBehalfOfEmployeeByManager" : true, - "allowRequestOnBehalfOfAnyoneByAnyone" : true - }, - "approvalReminderAndEscalationConfig" : { - "fallbackApproverRef" : { - "name" : "Alison Ferguso", - "id" : "5168015d32f890ca15812c9180835d2e", - "type" : "IDENTITY", - "email" : "alison.ferguso@identitysoon.com" - }, - "maxReminders" : 1, - "daysUntilEscalation" : 0, - "daysBetweenReminders" : 0 - }, - "autoApprovalEnabled" : true, - "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - }, - "reauthorizationEnabled" : true, - "approvalsMustBeExternal" : true - } - "@ - - # Update Access Request Configuration - - try { - $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig - Set-V2025AccessRequestConfig -AccessRequestConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025AccessRequestConfig -AccessRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025AccessRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /account-activities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-activities#get-account-activity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id - - # Get an Account Activity - - try { - Get-V2025AccountActivity -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccountActivity -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountActivity" - Write-Host $_.ErrorDetails - } -- path: /account-activities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-activities#list-account-activities - source: | - $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) - - # List Account Activities - - try { - Get-V2025AccountActivities - - # Below is a request that includes all optional parameters - # Get-V2025AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountActivities" - Write-Host $_.ErrorDetails - } -- path: /account-aggregations/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-aggregations#get-account-aggregation-status - source: | - $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # In-progress Account Aggregation status - - try { - Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountAggregationStatus" - Write-Host $_.ErrorDetails - } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2025UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" - Write-Host $_.ErrorDetails - } -- path: /accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#create-account - source: | - $AccountAttributesCreate = @" - { - "attributes" : { - "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - } - "@ - - # Create Account - - try { - $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate - New-V2025Account -AccountAttributesCreate $Result - - # Below is a request that includes all optional parameters - # New-V2025Account -AccountAttributesCreate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#delete-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - - # Delete Account - - try { - Remove-V2025Account -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Account -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#delete-account-async - source: | - $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Remove Account - - try { - Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccountAsync" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $AccountToggleRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } - "@ - - # Disable Account - - try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Disable-V2025Account -Id $Id -AccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Disable-V2025Account -Id $Id -AccountToggleRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025Account" - Write-Host $_.ErrorDetails - } -- path: /identities-accounts/{id}/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-account-for-identity - source: | - $Id = "2c91808384203c2d018437e631158309" # String | The identity id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Disable IDN Account for Identity - - try { - Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025AccountForIdentity" - Write-Host $_.ErrorDetails - } -- path: /identities-accounts/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-accounts-for-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentitiesAccountsBulkRequest = @" - { - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - } - "@ - - # Disable IDN Accounts for Identities - - try { - $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Disable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - - # Below is a request that includes all optional parameters - # Disable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025AccountsForIdentities" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $AccountToggleRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } - "@ - - # Enable Account - - try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Enable-V2025Account -Id $Id -AccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Enable-V2025Account -Id $Id -AccountToggleRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025Account" - Write-Host $_.ErrorDetails - } -- path: /identities-accounts/{id}/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-account-for-identity - source: | - $Id = "2c91808384203c2d018437e631158309" # String | The identity id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Enable IDN Account for Identity - - try { - Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025AccountForIdentity" - Write-Host $_.ErrorDetails - } -- path: /identities-accounts/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-accounts-for-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentitiesAccountsBulkRequest = @" - { - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] - } - "@ - - # Enable IDN Accounts for Identities - - try { - $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Enable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - - # Below is a request that includes all optional parameters - # Enable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025AccountsForIdentities" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#get-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - - # Account Details - - try { - Get-V2025Account -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Account -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#get-account-entitlements - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Account Entitlements - - try { - Get-V2025AccountEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountEntitlements" - Write-Host $_.ErrorDetails - } -- path: /accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#list-accounts - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) - - # Accounts List - - try { - Get-V2025Accounts - - # Below is a request that includes all optional parameters - # Get-V2025Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Accounts" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#put-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - $AccountAttributes = @" - { - "attributes" : { - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - } - "@ - - # Update Account - - try { - $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes - Send-V2025Account -Id $Id -AccountAttributes $Result - - # Below is a request that includes all optional parameters - # Send-V2025Account -Id $Id -AccountAttributes $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/reload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#submit-reload-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - - # Reload Account - - try { - Submit-V2025ReloadAccount -Id $Id - - # Below is a request that includes all optional parameters - # Submit-V2025ReloadAccount -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025ReloadAccount" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/unlock - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#unlock-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. - $AccountUnlockRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", - "unlockIDNAccount" : false - } - "@ - - # Unlock Account - - try { - $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest - Unlock-V2025Account -Id $Id -AccountUnlockRequest $Result - - # Below is a request that includes all optional parameters - # Unlock-V2025Account -Id $Id -AccountUnlockRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2025Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/accounts#update-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"[{op=remove, path=/identityId}]"@ - - - # Update Account - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025Account -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025Account -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Account" - Write-Host $_.ErrorDetails - } -- path: /discovered-applications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#get-discovered-applications - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) - $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) - - # Get Discovered Applications for Tenant - - try { - Get-V2025DiscoveredApplications - - # Below is a request that includes all optional parameters - # Get-V2025DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DiscoveredApplications" - Write-Host $_.ErrorDetails - } -- path: /manual-discover-applications-template - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#get-manual-discover-applications-csv-template - source: | - - # Download CSV Template for Discovery - - try { - Get-V2025ManualDiscoverApplicationsCsvTemplate - - # Below is a request that includes all optional parameters - # Get-V2025ManualDiscoverApplicationsCsvTemplate - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails - } -- path: /manual-discover-applications - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#send-manual-discover-applications-csv-template - source: | - $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - - # Upload CSV to Discover Applications - - try { - Send-V2025ManualDiscoverApplicationsCsvTemplate -File $File - - # Below is a request that includes all optional parameters - # Send-V2025ManualDiscoverApplicationsCsvTemplate -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails - } -- path: /generic-approvals/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/approvals#get-approval - source: | - $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that is to be returned - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get an approval - - try { - Get-V2025Approval -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Approval -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approval" - Write-Host $_.ErrorDetails - } -- path: /generic-approvals - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/approvals#get-approvals - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Mine = $true # Boolean | Returns the list of approvals for the current caller (optional) - $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID (optional) - $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) - - # Get Approvals - - try { - Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approvals" - Write-Host $_.ErrorDetails - } -- path: /source-apps - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#create-source-app - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceAppCreateDto = @" - { - "name" : "my app", - "description" : "the source app for engineers", - "accountSource" : { - "name" : "ODS-AD-Source", - "id" : "2c9180827ca885d7017ca8ce28a000eb", - "type" : "SOURCE" - }, - "matchAllAccounts" : true - } - "@ - - # Create source app - - try { - $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto - New-V2025SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result - - # Below is a request that includes all optional parameters - # New-V2025SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id}/access-profiles/bulk-remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#delete-access-profiles-from-source-app-by-bulk - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @"[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]"@ - - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # Bulk remove access profiles from the specified source app - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2025AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-V2025AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfilesFromSourceAppByBulk" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#delete-source-app - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete source app by ID - - try { - Remove-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#get-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get source app by ID - - try { - Get-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id}/access-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-access-profiles-for-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "name eq "developer access profile"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List access profiles for the specified source app - - try { - Get-V2025AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfilesForSourceApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/all - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-all-source-app - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - $Filters = "enabled eq true" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) - - # List all source apps - - try { - Get-V2025AllSourceApp -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AllSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllSourceApp" - Write-Host $_.ErrorDetails - } -- path: /user-apps/all - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-all-user-apps - source: | - $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List all user apps - - try { - Get-V2025AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllUserApps" - Write-Host $_.ErrorDetails - } -- path: /source-apps/assigned - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-assigned-source-app - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) - $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - - # List assigned source apps - - try { - Get-V2025AssignedSourceApp -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AssignedSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AssignedSourceApp" - Write-Host $_.ErrorDetails - } -- path: /user-apps/{id}/available-accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-available-accounts-for-user-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List available accounts for user app - - try { - Get-V2025AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AvailableAccountsForUserApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-available-source-apps - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) - $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) - - # List available source apps - - try { - Get-V2025AvailableSourceApps -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AvailableSourceApps" - Write-Host $_.ErrorDetails - } -- path: /user-apps - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#list-owned-user-apps - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) - - # List owned user apps - - try { - Get-V2025OwnedUserApps -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025OwnedUserApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OwnedUserApps" - Write-Host $_.ErrorDetails - } -- path: /source-apps/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#patch-source-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch source app by ID - - try { - Update-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceApp" - Write-Host $_.ErrorDetails - } -- path: /user-apps/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#patch-user-app - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch user app by ID - - try { - Update-V2025UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025UserApp" - Write-Host $_.ErrorDetails - } -- path: /source-apps/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/apps#update-source-apps-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceAppBulkUpdateRequest = @" - { - "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : false - }, { - "op" : "replace", - "path" : "/matchAllAccounts", - "value" : false - } ] - } - "@ - - # Bulk update source apps - - try { - Update-V2025SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -SourceAppBulkUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceAppsInBulk" - Write-Host $_.ErrorDetails - } -- path: /auth-profiles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#get-profile-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - - # Get Auth Profile - - try { - Get-V2025ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProfileConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#get-profile-config-list - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get list of Auth Profiles - - try { - Get-V2025ProfileConfigList -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ProfileConfigList -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProfileConfigList" - Write-Host $_.ErrorDetails - } -- path: /auth-profiles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#patch-profile-config - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Auth Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProfileConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-users/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-users#get-auth-user - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - - # Auth User Details - - try { - Get-V2025AuthUser -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AuthUser -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthUser" - Write-Host $_.ErrorDetails - } -- path: /auth-users/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/auth-users#patch-auth-user - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Auth User Update - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025AuthUser -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025AuthUser -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthUser" - Write-Host $_.ErrorDetails - } -- path: /brandings - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#create-branding-item - source: | - $Name = "MyName" # String | name of branding item - $ProductName = "MyProductName" # String | product name - $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) - $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) - $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) - $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) - $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) - $FileStandard = # System.IO.FileInfo | png file with logo (optional) - - # Create a branding item - - try { - New-V2025BrandingItem -Name $Name -ProductName $ProductName - - # Below is a request that includes all optional parameters - # New-V2025BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025BrandingItem" - Write-Host $_.ErrorDetails - } -- path: /brandings/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#delete-branding - source: | - $Name = "default" # String | The name of the branding item to be deleted - - # Delete a branding item - - try { - Remove-V2025Branding -Name $Name - - # Below is a request that includes all optional parameters - # Remove-V2025Branding -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Branding" - Write-Host $_.ErrorDetails - } -- path: /brandings/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#get-branding - source: | - $Name = "default" # String | The name of the branding item to be retrieved - - # Get a branding item - - try { - Get-V2025Branding -Name $Name - - # Below is a request that includes all optional parameters - # Get-V2025Branding -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Branding" - Write-Host $_.ErrorDetails - } -- path: /brandings - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#get-branding-list - source: | - - # List of branding items - - try { - Get-V2025BrandingList - - # Below is a request that includes all optional parameters - # Get-V2025BrandingList - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BrandingList" - Write-Host $_.ErrorDetails - } -- path: /brandings/{name} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/branding#set-branding-item - source: | - $Name = "default" # String | The name of the branding item to be retrieved - $Name2 = "Name_example" # String | name of branding item - $ProductName = "MyProductName" # String | product name - $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) - $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) - $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) - $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) - $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) - $FileStandard = # System.IO.FileInfo | png file with logo (optional) - - # Update a branding item - - try { - Set-V2025BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName - - # Below is a request that includes all optional parameters - # Set-V2025BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025BrandingItem" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#create-campaign-filter - source: | - $CampaignFilterDetails = @" - { - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - } - "@ - - # Create Campaign Filter - - try { - $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - New-V2025CampaignFilter -CampaignFilterDetails $Result - - # Below is a request that includes all optional parameters - # New-V2025CampaignFilter -CampaignFilterDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CampaignFilter" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters/delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#delete-campaign-filters - source: | - $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. - $RequestBody = @""@ - - - # Deletes Campaign Filters - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2025CampaignFilters -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-V2025CampaignFilters -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CampaignFilters" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#get-campaign-filter-by-id - source: | - $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. - - # Get Campaign Filter by ID - - try { - Get-V2025CampaignFilterById -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CampaignFilterById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignFilterById" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#list-campaign-filters - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) - - # List Campaign Filters - - try { - Get-V2025CampaignFilters - - # Below is a request that includes all optional parameters - # Get-V2025CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignFilters" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#update-campaign-filter - source: | - $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. - $CampaignFilterDetails = @" - { - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - } - "@ - - # Updates a Campaign Filter - - try { - $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - Update-V2025CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result - - # Below is a request that includes all optional parameters - # Update-V2025CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CampaignFilter" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/complete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#complete-campaign - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. - $CampaignCompleteOptions = @" - { - "autoCompleteAction" : "REVOKE" - } - "@ - - # Complete a Campaign - - try { - Complete-V2025Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Complete-V2025Campaign -Id $Id -CampaignCompleteOptions $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025Campaign" - Write-Host $_.ErrorDetails - } -- path: /campaigns - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#create-campaign - source: | - $Campaign = @" - { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "reviewerId" : "2c91808568c529c60168cca6f90c1313", - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - } - "@ - - # Create a campaign - - try { - $Result = ConvertFrom-JsonToCampaign -Json $Campaign - New-V2025Campaign -Campaign $Result - - # Below is a request that includes all optional parameters - # New-V2025Campaign -Campaign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Campaign" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#create-campaign-template - source: | - $CampaignTemplate = @" - { - "ownerRef" : { - "name" : "Mister Manager", - "id" : "2c918086676d3e0601677611dbde220f", - "type" : "IDENTITY", - "email" : "mr.manager@example.com" - }, - "deadlineDuration" : "P2W", - "created" : "2020-03-05T22:44:00.364Z", - "scheduled" : false, - "name" : "Manager Campaign Template", - "description" : "Template for the annual manager campaign.", - "modified" : "2020-03-05T22:52:09.969Z", - "campaign" : { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "reviewerId" : "2c91808568c529c60168cca6f90c1313", - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - }, - "id" : "2c9079b270a266a60170a277bb960008" - } - "@ - - # Create a Campaign Template - - try { - $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate - New-V2025CampaignTemplate -CampaignTemplate $Result - - # Below is a request that includes all optional parameters - # New-V2025CampaignTemplate -CampaignTemplate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#delete-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. - - # Delete a Campaign Template - - try { - Remove-V2025CampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025CampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#delete-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. - - # Delete Campaign Template Schedule - - try { - Remove-V2025CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025CampaignTemplateSchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } -- path: /campaigns/delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#delete-campaigns - source: | - $CampaignsDeleteRequest = @" - { - "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] - } - "@ - - # Delete Campaigns - - try { - $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest - Remove-V2025Campaigns -CampaignsDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025Campaigns -CampaignsDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Campaigns" - Write-Host $_.ErrorDetails - } -- path: /campaigns - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-active-campaigns - source: | - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) - - # List Campaigns - - try { - Get-V2025ActiveCampaigns - - # Below is a request that includes all optional parameters - # Get-V2025ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ActiveCampaigns" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - - # Get Campaign - - try { - Get-V2025Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Campaign -Id $Id -Detail $Detail - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Campaign" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/reports - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-reports - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. - - # Get Campaign Reports - - try { - Get-V2025CampaignReports -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CampaignReports -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignReports" - Write-Host $_.ErrorDetails - } -- path: /campaigns/reports-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-reports-config - source: | - - # Get Campaign Reports Configuration - - try { - Get-V2025CampaignReportsConfig - - # Below is a request that includes all optional parameters - # Get-V2025CampaignReportsConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignReportsConfig" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. - - # Get a Campaign Template - - try { - Get-V2025CampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. - - # Get Campaign Template Schedule - - try { - Get-V2025CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CampaignTemplateSchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-templates - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) - - # List Campaign Templates - - try { - Get-V2025CampaignTemplates - - # Below is a request that includes all optional parameters - # Get-V2025CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignTemplates" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/reassign - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#move - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID - $AdminReviewReassign = @" - { - "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], - "reason" : "reassigned for some reason", - "reassignTo" : { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "IDENTITY" - } - } - "@ - - # Reassign Certifications - - try { - $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign - Move-V2025 -Id $Id -AdminReviewReassign $Result - - # Below is a request that includes all optional parameters - # Move-V2025 -Id $Id -AdminReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2025" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#patch-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update a Campaign Template - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025CampaignTemplate -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025CampaignTemplate -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaigns/reports-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#set-campaign-reports-config - source: | - $CampaignReportsConfig = @" - { - "identityAttributeColumns" : [ "firstname", "lastname" ] - } - "@ - - # Set Campaign Reports Configuration - - try { - $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig - Set-V2025CampaignReportsConfig -CampaignReportsConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025CampaignReportsConfig -CampaignReportsConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025CampaignReportsConfig" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#set-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. - $Schedule = @" - { - "hours" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "months" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "timeZoneId" : "CST", - "days" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "expiration" : "2000-01-23T04:56:07.000+00:00", - "type" : "WEEKLY" - } - "@ - - # Set Campaign Template Schedule - - try { - Set-V2025CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Set-V2025CampaignTemplateSchedule -Id $Id -Schedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/activate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-campaign - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. - $ActivateCampaignOptions = @" - { - "timeZone" : "-05:00" - } - "@ - - # Activate a Campaign - - try { - Start-V2025Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025Campaign -Id $Id -ActivateCampaignOptions $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025Campaign" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/run-remediation-scan - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-campaign-remediation-scan - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. - - # Run Campaign Remediation Scan - - try { - Start-V2025CampaignRemediationScan -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025CampaignRemediationScan -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025CampaignRemediationScan" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/run-report/{type} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-campaign-report - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. - $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. - - # Run Campaign Report - - try { - Start-V2025CampaignReport -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Start-V2025CampaignReport -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025CampaignReport" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/generate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-generate-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. - - # Generate a Campaign from Template - - try { - Start-V2025GenerateCampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025GenerateCampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025GenerateCampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#update-campaign - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update a Campaign - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Campaign -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Campaign -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Campaign" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2025IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2025IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2025IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummary" - Write-Host $_.ErrorDetails - } -- path: /certification-tasks/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-certification-task - source: | - $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID - - # Certification Task by ID - - try { - Get-V2025CertificationTask -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CertificationTask -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CertificationTask" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-identity-certification - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id - - # Identity Certification by ID - - try { - Get-V2025IdentityCertification -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityCertification -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityCertification" - Write-Host $_.ErrorDetails - } -- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-identity-certification-item-permissions - source: | - $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID - $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Permissions for Entitlement Certification Item - - try { - Get-V2025IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId - - # Below is a request that includes all optional parameters - # Get-V2025IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityCertificationItemPermissions" - Write-Host $_.ErrorDetails - } -- path: /certification-tasks - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-pending-certification-tasks - source: | - $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) - - # List of Pending Certification Tasks - - try { - Get-V2025PendingCertificationTasks - - # Below is a request that includes all optional parameters - # Get-V2025PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingCertificationTasks" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/reviewers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#list-certification-reviewers - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) - - # List of Reviewers for certification - - try { - Get-V2025CertificationReviewers -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CertificationReviewers" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/access-review-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#list-identity-access-review-items - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) - $Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) - $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) - $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) - - # List of Access Review Items - - try { - Get-V2025IdentityAccessReviewItems -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessReviewItems" - Write-Host $_.ErrorDetails - } -- path: /certifications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#list-identity-certifications - source: | - $ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) - $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) - - # List Identity Campaign Certifications - - try { - Get-V2025IdentityCertifications - - # Below is a request that includes all optional parameters - # Get-V2025IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityCertifications" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decide - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#make-identity-decision - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions - $ReviewDecision = @"{ - "comments" : "This user no longer needs access to this source", - "decision" : "APPROVE", - "proposedEndDate" : "2017-07-11T18:45:37.098Z", - "recommendation" : { - "reasons" : [ "Reason 1", "Reason 2" ], - "recommendation" : "recommendation", - "timestamp" : "2020-06-01T13:49:37.385Z" - }, - "id" : "ef38f94347e94562b5bb8424a56397d8", - "bulk" : true - }"@ - - - # Decide on a Certification Item - - try { - $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision - Select-V2025IdentityDecision -Id $Id -ReviewDecision $Result - - # Below is a request that includes all optional parameters - # Select-V2025IdentityDecision -Id $Id -ReviewDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2025IdentityDecision" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/reassign - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#reassign-identity-certifications - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $ReviewReassign = @" - { - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - } - "@ - - # Reassign Identities or Items - - try { - $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Invoke-V2025ReassignIdentityCertifications -Id $Id -ReviewReassign $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025ReassignIdentityCertifications -Id $Id -ReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ReassignIdentityCertifications" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/sign-off - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#sign-off-identity-certification - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - - # Finalize Identity Certification Decisions - - try { - Invoke-V2025SignOffIdentityCertification -Id $Id - - # Below is a request that includes all optional parameters - # Invoke-V2025SignOffIdentityCertification -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025SignOffIdentityCertification" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/reassign-async - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certifications#submit-reassign-certs-async - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $ReviewReassign = @" - { - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - } - "@ - - # Reassign Certifications Asynchronously - - try { - $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Submit-V2025ReassignCertsAsync -Id $Id -ReviewReassign $Result - - # Below is a request that includes all optional parameters - # Submit-V2025ReassignCertsAsync -Id $Id -ReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025ReassignCertsAsync" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/deploys - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-deploy - source: | - $DeployRequest = @" - { - "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" - } - "@ - - # Create a Deploy - - try { - $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest - New-V2025Deploy -DeployRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Deploy -DeployRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Deploy" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-object-mapping - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingRequest = @" - { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - } - "@ - - # Creates an object mapping - - try { - $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest - New-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ObjectMapping" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingBulkCreateRequest = @" - { - "newObjectsMappings" : [ { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - }, { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - } ] - } - "@ - - # Bulk creates object mappings - - try { - $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest - New-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ObjectMappings" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/scheduled-actions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-scheduled-action - source: | - $ScheduledActionPayload = @" - { - "cronString" : "0 0 * * * *", - "timeZoneId" : "America/Chicago", - "startTime" : "2024-08-16T14:16:58.389Z", - "jobType" : "BACKUP", - "content" : { - "sourceTenant" : "tenant-name", - "draftId" : "9012b87d-48ca-439a-868f-2160001da8c3", - "name" : "Daily Backup", - "backupOptions" : { - "includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ], - "objectOptions" : { - "SOURCE" : { - "includedNames" : [ "Source1", "Source2" ] - }, - "ROLE" : { - "includedNames" : [ "Admin Role", "User Role" ] - } - } - }, - "sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2" - } - } - "@ - - # Create Scheduled Action - - try { - $Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload - New-V2025ScheduledAction -ScheduledActionPayload $Result - - # Below is a request that includes all optional parameters - # New-V2025ScheduledAction -ScheduledActionPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ScheduledAction" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/uploads - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-uploaded-configuration - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. - - # Upload a Configuration - - try { - New-V2025UploadedConfiguration -Data $Data -Name $Name - - # Below is a request that includes all optional parameters - # New-V2025UploadedConfiguration -Data $Data -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025UploadedConfiguration" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-backup - source: | - $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. - - # Delete a Backup - - try { - Remove-V2025Backup -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Backup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Backup" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/drafts/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-draft - source: | - $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to delete. - - # Delete a draft - - try { - Remove-V2025Draft -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Draft -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Draft" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-object-mapping - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. - - # Deletes an object mapping - - try { - Remove-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId - - # Below is a request that includes all optional parameters - # Remove-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ObjectMapping" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/scheduled-actions/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-scheduled-action - source: | - $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. - - # Delete Scheduled Action - - try { - Remove-V2025ScheduledAction -ScheduledActionId $ScheduledActionId - - # Below is a request that includes all optional parameters - # Remove-V2025ScheduledAction -ScheduledActionId $ScheduledActionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ScheduledAction" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/uploads/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-uploaded-configuration - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - - # Delete an Uploaded Configuration - - try { - Remove-V2025UploadedConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025UploadedConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025UploadedConfiguration" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/deploys/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#get-deploy - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. - - # Get a Deploy - - try { - Get-V2025Deploy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Deploy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Deploy" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#get-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - - # Gets list of object mappings - - try { - Get-V2025ObjectMappings -SourceOrg $SourceOrg - - # Below is a request that includes all optional parameters - # Get-V2025ObjectMappings -SourceOrg $SourceOrg - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ObjectMappings" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/uploads/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#get-uploaded-configuration - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - - # Get an Uploaded Configuration - - try { - Get-V2025UploadedConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025UploadedConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UploadedConfiguration" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-backups - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - - # List Backups - - try { - Get-V2025Backups - - # Below is a request that includes all optional parameters - # Get-V2025Backups -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Backups" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/deploys - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-deploys - source: | - - # List Deploys - - try { - Get-V2025Deploys - - # Below is a request that includes all optional parameters - # Get-V2025Deploys - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Deploys" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/drafts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-drafts - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) - - # List Drafts - - try { - Get-V2025Drafts - - # Below is a request that includes all optional parameters - # Get-V2025Drafts -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Drafts" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/scheduled-actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-scheduled-actions - source: | - - # List Scheduled Actions - - try { - Get-V2025ScheduledActions - - # Below is a request that includes all optional parameters - # Get-V2025ScheduledActions - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ScheduledActions" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/uploads - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-uploaded-configurations - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - - # List Uploaded Configurations - - try { - Get-V2025UploadedConfigurations - - # Below is a request that includes all optional parameters - # Get-V2025UploadedConfigurations -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UploadedConfigurations" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#update-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingBulkPatchRequest = @" - { - "patches" : { - "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : true - } ], - "00bece34-f50d-4227-8878-76f620b5a971" : [ { - "op" : "replace", - "path" : "/targetValue", - "value" : "New Target Value" - } ] - } - } - "@ - - # Bulk updates object mappings - - try { - $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest - Update-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ObjectMappings" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/scheduled-actions/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#update-scheduled-action - source: | - $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update Scheduled Action - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ScheduledAction" - Write-Host $_.ErrorDetails - } -- path: /connector-customizers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#create-connector-customizer - source: | - $ConnectorCustomizerCreateRequest = @" - { - "name" : "My Custom Connector" - } - "@ - - # Create Connector Customizer - - try { - $Result = ConvertFrom-JsonToConnectorCustomizerCreateRequest -Json $ConnectorCustomizerCreateRequest - New-V2025ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ConnectorCustomizer" - Write-Host $_.ErrorDetails - } -- path: /connector-customizers/{id}/versions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#create-connector-customizer-version - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | The id of the connector customizer. - - # Creates a connector customizer version - - try { - New-V2025ConnectorCustomizerVersion -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025ConnectorCustomizerVersion -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ConnectorCustomizerVersion" - Write-Host $_.ErrorDetails - } -- path: /connector-customizers/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#delete-connector-customizer - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete. - - # Delete Connector Customizer - - try { - Remove-V2025ConnectorCustomizer -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ConnectorCustomizer -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ConnectorCustomizer" - Write-Host $_.ErrorDetails - } -- path: /connector-customizers/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#get-connector-customizer - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to get. - - # Get connector customizer - - try { - Get-V2025ConnectorCustomizer -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorCustomizer -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorCustomizer" - Write-Host $_.ErrorDetails - } -- path: /connector-customizers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#list-connector-customizers - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List All Connector Customizers - - try { - Get-V2025ConnectorCustomizers - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorCustomizers -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorCustomizers" - Write-Host $_.ErrorDetails - } -- path: /connector-customizers/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#put-connector-customizer - source: | - $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to update. - $ConnectorCustomizerUpdateRequest = @" - { - "name" : "My Custom Connector" - } - "@ - - # Update Connector Customizer - - try { - Send-V2025ConnectorCustomizer -Id $Id - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorCustomizer -Id $Id -ConnectorCustomizerUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorCustomizer" - Write-Host $_.ErrorDetails - } -- path: /connector-rules - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#create-connector-rule - source: | - $ConnectorRuleCreateRequest = @" - { - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "type" : "BuildMap" - } - "@ - - # Create Connector Rule - - try { - $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest - New-V2025ConnectorRule -ConnectorRuleCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ConnectorRule -ConnectorRuleCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connector-rules/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#delete-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. - - # Delete Connector Rule - - try { - Remove-V2025ConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ConnectorRule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connector-rules/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#get-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. - - # Get Connector Rule - - try { - Get-V2025ConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorRule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connector-rules - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#get-connector-rule-list - source: | - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Connector Rules - - try { - Get-V2025ConnectorRuleList - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorRuleList -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorRuleList" - Write-Host $_.ErrorDetails - } -- path: /connector-rules/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#put-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update. - $ConnectorRuleUpdateRequest = @" - { - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", - "type" : "BuildMap" - } - "@ - - # Update Connector Rule - - try { - Send-V2025ConnectorRule -Id $Id - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorRule -Id $Id -ConnectorRuleUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connector-rules/validate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#test-connector-rule - source: | - $SourceCode = @" - { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - } - "@ - - # Validate Connector Rule - - try { - $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode - Test-V2025ConnectorRule -SourceCode $Result - - # Below is a request that includes all optional parameters - # Test-V2025ConnectorRule -SourceCode $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ConnectorRule" - Write-Host $_.ErrorDetails - } -- path: /connectors - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#create-custom-connector - source: | - $V3CreateConnectorDto = @" - { - "name" : "custom connector", - "directConnect" : true, - "className" : "sailpoint.connector.OpenConnectorAdapter", - "type" : "custom connector type", - "status" : "RELEASED" - } - "@ - - # Create Custom Connector - - try { - $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto - New-V2025CustomConnector -V3CreateConnectorDto $Result - - # Below is a request that includes all optional parameters - # New-V2025CustomConnector -V3CreateConnectorDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CustomConnector" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#delete-custom-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Delete Connector by Script Name - - try { - Remove-V2025CustomConnector -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Remove-V2025CustomConnector -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CustomConnector" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector by Script Name - - try { - Get-V2025Connector -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025Connector -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Connector" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/correlation-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-correlation-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - - # Get Connector Correlation Configuration - - try { - Get-V2025ConnectorCorrelationConfig -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorCorrelationConfig -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorCorrelationConfig" - Write-Host $_.ErrorDetails - } -- path: /connectors - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-list - source: | - $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector List - - try { - Get-V2025ConnectorList - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorList" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/source-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-source-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Get Connector Source Configuration - - try { - Get-V2025ConnectorSourceConfig -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorSourceConfig -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorSourceConfig" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/source-template - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-source-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Get Connector Source Template - - try { - Get-V2025ConnectorSourceTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorSourceTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorSourceTemplate" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/translations/{locale} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-translations - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - - # Get Connector Translations - - try { - Get-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - - # Below is a request that includes all optional parameters - # Get-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorTranslations" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/correlation-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-correlation-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector correlation config xml file - - # Update Connector Correlation Configuration - - try { - Send-V2025ConnectorCorrelationConfig -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorCorrelationConfig -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorCorrelationConfig" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/source-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-source-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector source config xml file - - # Update Connector Source Configuration - - try { - Send-V2025ConnectorSourceConfig -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorSourceConfig -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorSourceConfig" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/source-template - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-source-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector source template xml file - - # Update Connector Source Template - - try { - Send-V2025ConnectorSourceTemplate -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorSourceTemplate -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorSourceTemplate" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/translations/{locale} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-translations - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - - # Update Connector Translations - - try { - Send-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - - # Below is a request that includes all optional parameters - # Send-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorTranslations" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/connectors#update-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Connector by Script Name - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Connector -ScriptName $ScriptName -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Connector -ScriptName $ScriptName -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Connector" - Write-Host $_.ErrorDetails - } -- path: /form-definitions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition - source: | - $Body = @" - { - "owner" : { - "name" : "Grant Smith", - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "formConditions" : [ { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - }, { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - } ], - "formInput" : [ { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - }, { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - } ], - "name" : "My form", - "description" : "My form description", - "usedBy" : [ { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - }, { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - } ], - "formElements" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - } ] - } - "@ - - # Creates a form definition. - - try { - New-V2025FormDefinition - - # Below is a request that includes all optional parameters - # New-V2025FormDefinition -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinition" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/forms-action-dynamic-schema - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition-dynamic-schema - source: | - $Body = @" - { - "description" : "A description", - "attributes" : { - "formDefinitionId" : "00000000-0000-0000-0000-000000000000" - }, - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "action", - "versionNumber" : 1 - } - "@ - - # Generate JSON Schema dynamically. - - try { - New-V2025FormDefinitionDynamicSchema - - # Below is a request that includes all optional parameters - # New-V2025FormDefinitionDynamicSchema -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinitionDynamicSchema" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID}/upload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition-file-request - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID - $File = # System.IO.FileInfo | File specifying the multipart - - # Upload new form definition file. - - try { - New-V2025FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File - - # Below is a request that includes all optional parameters - # New-V2025FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinitionFileRequest" - Write-Host $_.ErrorDetails - } -- path: /form-instances - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-instance - source: | - $Body = @" - { - "formInput" : { - "input1" : "Sales" - }, - "standAloneForm" : false, - "createdBy" : { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "WORKFLOW_EXECUTION" - }, - "recipients" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - } ], - "expire" : "2023-08-12T20:14:57.74486Z", - "formDefinitionId" : "00000000-0000-0000-0000-000000000000", - "state" : "ASSIGNED", - "ttl" : 1571827560 - } - "@ - - # Creates a form instance. - - try { - New-V2025FormInstance - - # Below is a request that includes all optional parameters - # New-V2025FormInstance -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormInstance" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#delete-form-definition - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - - # Deletes a form definition. - - try { - Remove-V2025FormDefinition -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Remove-V2025FormDefinition -FormDefinitionID $FormDefinitionID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025FormDefinition" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#export-form-definitions-by-tenant - source: | - $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") - - # List form definitions by tenant. - - try { - Export-V2025FormDefinitionsByTenant - - # Below is a request that includes all optional parameters - # Export-V2025FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025FormDefinitionsByTenant" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID}/file/{fileID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-file-from-s3 - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID - $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. - - # Download definition file by fileId. - - try { - Get-V2025FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID - - # Below is a request that includes all optional parameters - # Get-V2025FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FileFromS3" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-definition-by-key - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - - # Return a form definition. - - try { - Get-V2025FormDefinitionByKey -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Get-V2025FormDefinitionByKey -FormDefinitionID $FormDefinitionID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormDefinitionByKey" - Write-Host $_.ErrorDetails - } -- path: /form-instances/{formInstanceID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-instance-by-key - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - - # Returns a form instance. - - try { - Get-V2025FormInstanceByKey -FormInstanceID $FormInstanceID - - # Below is a request that includes all optional parameters - # Get-V2025FormInstanceByKey -FormInstanceID $FormInstanceID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormInstanceByKey" - Write-Host $_.ErrorDetails - } -- path: /form-instances/{formInstanceID}/file/{fileID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-instance-file - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID - $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. - - # Download instance file by fileId. - - try { - Get-V2025FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID - - # Below is a request that includes all optional parameters - # Get-V2025FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormInstanceFile" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#import-form-definitions - source: | - - - - - $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ - - - # Import form definitions from export. - - try { - Import-V2025FormDefinitions - - # Below is a request that includes all optional parameters - # Import-V2025FormDefinitions -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025FormDefinitions" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#patch-form-definition - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) - $Body = @"[{op=replace, path=/description, value=test-description}]"@ - - - # Patch a form definition. - - try { - Update-V2025FormDefinition -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Update-V2025FormDefinition -FormDefinitionID $FormDefinitionID -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025FormDefinition" - Write-Host $_.ErrorDetails - } -- path: /form-instances/{formInstanceID} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#patch-form-instance - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) - $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ - - - # Patch a form instance. - - try { - Update-V2025FormInstance -FormInstanceID $FormInstanceID - - # Below is a request that includes all optional parameters - # Update-V2025FormInstance -FormInstanceID $FormInstanceID -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025FormInstance" - Write-Host $_.ErrorDetails - } -- path: /form-definitions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-definitions-by-tenant - source: | - $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") - - # Export form definitions by tenant. - - try { - Search-V2025FormDefinitionsByTenant - - # Below is a request that includes all optional parameters - # Search-V2025FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormDefinitionsByTenant" - Write-Host $_.ErrorDetails - } -- path: /form-instances/{formInstanceID}/data-source/{formElementID} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-element-data-by-element-id - source: | - $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - $FormElementID = "1" # String | Form element ID - $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) - $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) - $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) - - # Retrieves dynamic data by element. - - try { - Search-V2025FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID - - # Below is a request that includes all optional parameters - # Search-V2025FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormElementDataByElementID" - Write-Host $_.ErrorDetails - } -- path: /form-instances - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-instances-by-tenant - source: | - - # List form instances by tenant. - - try { - Search-V2025FormInstancesByTenant - - # Below is a request that includes all optional parameters - # Search-V2025FormInstancesByTenant - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormInstancesByTenant" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/predefined-select-options - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-pre-defined-select-options - source: | - - # List predefined select options. - - try { - Search-V2025PreDefinedSelectOptions - - # Below is a request that includes all optional parameters - # Search-V2025PreDefinedSelectOptions - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025PreDefinedSelectOptions" - Write-Host $_.ErrorDetails - } -- path: /form-definitions/{formDefinitionID}/data-source - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#show-preview-data-source - source: | - $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) - $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) - $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) - $FormElementPreviewRequest = @" - { - "dataSource" : { - "config" : { - "indices" : [ "identities" ], - "query" : "*", - "aggregationBucketField" : "attributes.cloudStatus.exact", - "objectType" : "IDENTITY" - }, - "dataSourceType" : "STATIC" - } - } - "@ - - # Preview form definition data source. - - try { - Show-V2025PreviewDataSource -FormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Show-V2025PreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2025PreviewDataSource" - Write-Host $_.ErrorDetails - } -- path: /custom-password-instructions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#create-custom-password-instructions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CustomPasswordInstruction = @" - { - "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", - "pageId" : "change-password:enter-password", - "locale" : "en" - } - "@ - - # Create Custom Password Instructions - - try { - $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction - New-V2025CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result - - # Below is a request that includes all optional parameters - # New-V2025CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CustomPasswordInstructions" - Write-Host $_.ErrorDetails - } -- path: /custom-password-instructions/{pageId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#delete-custom-password-instructions - source: | - $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - - # Delete Custom Password Instructions by page ID - - try { - Remove-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CustomPasswordInstructions" - Write-Host $_.ErrorDetails - } -- path: /custom-password-instructions/{pageId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#get-custom-password-instructions - source: | - $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - - # Get Custom Password Instructions by Page ID - - try { - Get-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomPasswordInstructions" - Write-Host $_.ErrorDetails - } -- path: /data-segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#create-data-segment - source: | - $DataSegment = @" - - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment - New-V2025DataSegment -DataSegment $Result - - # Below is a request that includes all optional parameters - # New-V2025DataSegment -DataSegment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DataSegment" - Write-Host $_.ErrorDetails - } -- path: /data-segments/{segmentId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#delete-data-segment - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false) - - # Delete Segment by ID - - try { - Remove-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -Published $Published - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025DataSegment" - Write-Host $_.ErrorDetails - } -- path: /data-segments/{segmentId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#get-data-segment - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Segment by ID - - try { - Get-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegment" - Write-Host $_.ErrorDetails - } -- path: /data-segments/membership/{identityId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#get-data-segment-identity-membership - source: | - $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get SegmentMembership by Identity ID - - try { - Get-V2025DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegmentIdentityMembership" - Write-Host $_.ErrorDetails - } -- path: /data-segments/user-enabled/{identityId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#get-data-segmentation-enabled-for-user - source: | - $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Is Segmentation enabled by Identity - - try { - Get-V2025DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegmentationEnabledForUser" - Write-Host $_.ErrorDetails - } -- path: /data-segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#list-data-segments - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Enabled = $true # Boolean | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to $true) - $Unique = $false # Boolean | This returns only one record if set to true and that would be the published record if exists. (optional) (default to $false) - $Published = $true # Boolean | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to $true) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq """ # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) - - # Get Segments - - try { - Get-V2025DataSegments -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DataSegments -XSailPointExperimental $XSailPointExperimental -Enabled $Enabled -Unique $Unique -Published $Published -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegments" - Write-Host $_.ErrorDetails - } -- path: /data-segments/{segmentId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#patch-data-segment - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to modify. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - $RequestBody = @"[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025DataSegment" - Write-Host $_.ErrorDetails - } -- path: /data-segments/{segmentId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#publish-data-segment - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish to publish - $RequestBody = @""@ - - $PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true) - - # Publish segment by ID - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Publish-V2025DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Publish-V2025DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -PublishAll $PublishAll - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2025DataSegment" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#create-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $Dimension = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "name" : "Dimension 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "id" : "2c918086749d78830174a1a40e121518", - "membership" : { - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - } ], - "operation" : "EQUALS", - "key" : { - "property" : "attribute.email", - "type" : "IDENTITY" - } - }, - "type" : "STANDARD" - }, - "parentId" : "2c918086749d78830174a1a40e121518" - } - "@ - - # Create a Dimension - - try { - $Result = ConvertFrom-JsonToDimension -Json $Dimension - New-V2025Dimension -RoleId $RoleId -Dimension $Result - - # Below is a request that includes all optional parameters - # New-V2025Dimension -RoleId $RoleId -Dimension $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Dimension" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#delete-bulk-dimensions - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimensions. - $DimensionBulkDeleteRequest = @" - { - "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - } - "@ - - # Delete Dimension(s) - - try { - $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest - Remove-V2025BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025BulkDimensions" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions/{dimensionId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#delete-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - - # Delete a Dimension - - try { - Remove-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Remove-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Dimension" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions/{dimensionId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#get-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - - # Get a Dimension under Role. - - try { - Get-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Get-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Dimension" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions/{dimensionId}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#get-dimension-entitlements - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Dimension's Entitlements - - try { - Get-V2025DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Get-V2025DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DimensionEntitlements" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#list-dimension-access-profiles - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "source.id eq "2c91808982f979270182f99e386d00fa"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Dimension's Access Profiles - - try { - Get-V2025DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId - - # Below is a request that includes all optional parameters - # Get-V2025DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DimensionAccessProfiles" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#list-dimensions - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq '2c918086749d78830174a1a40e121518'" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Dimensions - - try { - Get-V2025Dimensions -RoleId $RoleId - - # Below is a request that includes all optional parameters - # Get-V2025Dimensions -RoleId $RoleId -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Dimensions" - Write-Host $_.ErrorDetails - } -- path: /roles/{roleId}/dimensions/{dimensionId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/dimensions#patch-dimension - source: | - $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. - $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Dimension - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Dimension" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#create-access-model-metadata-for-entitlement - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Add metadata to an entitlement. - - try { - New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessModelMetadataForEntitlement" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#delete-access-model-metadata-from-entitlement - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Remove metadata from an entitlement. - - try { - Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessModelMetadataFromEntitlement" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get an entitlement - - try { - Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlement" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/entitlement-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement-request-config - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Entitlement Request Config - - try { - Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /entitlements/aggregate/sources/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#import-entitlements-by-source - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) - - # Aggregate Entitlements - - try { - Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsBySource" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/children - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-children - source: | - $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List of entitlements children - - try { - Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChildren" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/parents - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-parents - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) - - # List of entitlements parents - - try { - Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementParents" - Write-Host $_.ErrorDetails - } -- path: /entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlements - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) - $SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) - $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) - $IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) - - # Gets a list of entitlements. - - try { - Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlements" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#patch-entitlement - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch an entitlement - - try { - Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Entitlement" - Write-Host $_.ErrorDetails - } -- path: /entitlements/{id}/entitlement-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#put-entitlement-request-config - source: | - $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $EntitlementRequestConfig = @" - { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - } - "@ - - # Replace Entitlement Request Config - - try { - $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig - Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025EntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /entitlements/reset/sources/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#reset-source-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Reset Source Entitlements - - try { - Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025SourceEntitlements" - Write-Host $_.ErrorDetails - } -- path: /entitlements/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/entitlements#update-entitlements-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $EntitlementBulkUpdateRequest = @" - { - "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/privileged", - "value" : false - }, { - "op" : "replace", - "path" : "/requestable", - "value" : false - } ] - } - "@ - - # Bulk update an entitlement list - - try { - $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest - Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsInBulk" - Write-Host $_.ErrorDetails - } -- path: /auth-org/network-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#create-auth-org-network-config - source: | - $NetworkConfiguration = @" - { - "range" : [ "1.3.7.2", "255.255.255.252/30" ], - "whitelisted" : true, - "geolocation" : [ "CA", "FR", "HT" ] - } - "@ - - # Create security network configuration. - - try { - $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration - New-V2025AuthOrgNetworkConfig -NetworkConfiguration $Result - - # Below is a request that includes all optional parameters - # New-V2025AuthOrgNetworkConfig -NetworkConfiguration $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/lockout-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-lockout-config - source: | - - # Get Auth Org Lockout Configuration. - - try { - Get-V2025AuthOrgLockoutConfig - - # Below is a request that includes all optional parameters - # Get-V2025AuthOrgLockoutConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgLockoutConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/network-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-network-config - source: | - - # Get security network configuration. - - try { - Get-V2025AuthOrgNetworkConfig - - # Below is a request that includes all optional parameters - # Get-V2025AuthOrgNetworkConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/service-provider-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-service-provider-config - source: | - - # Get Service Provider Configuration. - - try { - Get-V2025AuthOrgServiceProviderConfig - - # Below is a request that includes all optional parameters - # Get-V2025AuthOrgServiceProviderConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgServiceProviderConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/session-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-session-config - source: | - - # Get Auth Org Session Configuration. - - try { - Get-V2025AuthOrgSessionConfig - - # Below is a request that includes all optional parameters - # Get-V2025AuthOrgSessionConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgSessionConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/lockout-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-lockout-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Auth Org Lockout Configuration - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025AuthOrgLockoutConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025AuthOrgLockoutConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgLockoutConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/network-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-network-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update security network configuration. - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025AuthOrgNetworkConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025AuthOrgNetworkConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/service-provider-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-service-provider-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Service Provider Configuration - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025AuthOrgServiceProviderConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025AuthOrgServiceProviderConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgServiceProviderConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/session-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-session-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Auth Org Session Configuration - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025AuthOrgSessionConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025AuthOrgSessionConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgSessionConfig" - Write-Host $_.ErrorDetails - } -- path: /workgroups - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#create-workgroup - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $WorkgroupDto = @" - { - "owner" : { - "emailAddress" : "support@sailpoint.com", - "displayName" : "Support", - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "connectionCount" : 1641498673000, - "created" : "2022-01-06T19:51:13Z", - "memberCount" : 1641498673000, - "name" : "DB Access Governance Group", - "description" : "Description of the Governance Group", - "modified" : "2022-01-06T19:51:13Z", - "id" : "2c91808568c529c60168cca6f90c1313" - } - "@ - - # Create a new Governance Group. - - try { - $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto - New-V2025Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result - - # Below is a request that includes all optional parameters - # New-V2025Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workgroup" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a Governance Group - - try { - Remove-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workgroup" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{workgroupId}/members/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityPreviewResponseIdentity = @""@ - - - # Remove members from Governance Group - - try { - $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Remove-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - - # Below is a request that includes all optional parameters - # Remove-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025WorkgroupMembers" - Write-Host $_.ErrorDetails - } -- path: /workgroups/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroups-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $WorkgroupBulkDeleteRequest = @" - { - "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] - } - "@ - - # Delete Governance Group(s) - - try { - $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest - Remove-V2025WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025WorkgroupsInBulk" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#get-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Governance Group by Id - - try { - Get-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workgroup" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{workgroupId}/connections - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-connections - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List connections for Governance Group - - try { - Get-V2025Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Connections" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{workgroupId}/members - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - - # List Governance Group Members - - try { - Get-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkgroupMembers" - Write-Host $_.ErrorDetails - } -- path: /workgroups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-workgroups - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw "Test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) - - # List Governance Groups - - try { - Get-V2025Workgroups -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Workgroups -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workgroups" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#patch-workgroup - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Governance Group - - try { - Update-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Update-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workgroup" - Write-Host $_.ErrorDetails - } -- path: /workgroups/{workgroupId}/members/bulk-add - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#update-workgroup-members - source: | - $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityPreviewResponseIdentity = @""@ - - - # Add members to Governance Group - - try { - $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Update-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - - # Below is a request that includes all optional parameters - # Update-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025WorkgroupMembers" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/ignored-items - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Ignore Access Request Recommendation - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2025AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2025AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsIgnoredItem" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/requested-items - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Accept Access Request Recommendation - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2025AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2025AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsRequestedItem" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/viewed-items - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @" - { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } - "@ - - # Mark Viewed Access Request Recommendations - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2025AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2025AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsViewedItem" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/viewed-items/bulk-create - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationActionItemDto = @"{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - }"@ - - - # Bulk Mark Viewed Access Request Recommendations - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsViewedItems" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") - $Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) - $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) - - # Identity Access Request Recommendations - - try { - Get-V2025AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendations" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Request Recommendations config - - try { - Get-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsConfig" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/ignored-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Ignored Access Request Recommendations - - try { - Get-V2025AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsIgnoredItems" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/requested-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Accepted Access Request Recommendations - - try { - Get-V2025AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsRequestedItems" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/viewed-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - - # List Viewed Access Request Recommendations - - try { - Get-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsViewedItems" - Write-Host $_.ErrorDetails - } -- path: /ai-access-request-recommendations/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#set-access-request-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationConfigDto = @" - { - "scoreThreshold" : 0.5, - "startDateAttribute" : "startDate", - "restrictionAttribute" : "location", - "moverAttribute" : "isMover", - "joinerAttribute" : "isJoiner", - "useRestrictionAttribute" : true - } - "@ - - # Update Access Request Recommendations config - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto - Set-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result - - # Below is a request that includes all optional parameters - # Set-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025AccessRequestRecommendationsConfig" - Write-Host $_.ErrorDetails - } -- path: /common-access - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#create-common-access - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CommonAccessItemRequest = @" - { - "access" : { - "ownerName" : "ownerName", - "name" : "name", - "description" : "description", - "id" : "id", - "type" : "ACCESS_PROFILE", - "ownerId" : "ownerId" - }, - "status" : "CONFIRMED" - } - "@ - - # Create common access items - - try { - $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest - New-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CommonAccess" - Write-Host $_.ErrorDetails - } -- path: /common-access - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#get-common-access - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.type eq "ROLE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) - - # Get a paginated list of common access - - try { - Get-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CommonAccess" - Write-Host $_.ErrorDetails - } -- path: /common-access/update-status - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#update-common-access-status-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CommonAccessIDStatus = @"{ - "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], - "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] - }"@ - - - # Bulk update common access status - - try { - $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus - Update-V2025CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result - - # Below is a request that includes all optional parameters - # Update-V2025CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CommonAccessStatusInBulk" - Write-Host $_.ErrorDetails - } -- path: /outliers/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#export-outliers-zip - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - - # IAI Identity Outliers Export - - try { - Export-V2025OutliersZip -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2025OutliersZip -XSailPointExperimental $XSailPointExperimental -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025OutliersZip" - Write-Host $_.ErrorDetails - } -- path: /outlier-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-identity-outlier-snapshots - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) - $Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) - - # IAI Identity Outliers Summary - - try { - Get-V2025IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOutlierSnapshots" - Write-Host $_.ErrorDetails - } -- path: /outliers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-identity-outliers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) - $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) - - # IAI Get Identity Outliers - - try { - Get-V2025IdentityOutliers -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityOutliers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOutliers" - Write-Host $_.ErrorDetails - } -- path: /outlier-summaries/latest - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-latest-identity-outlier-snapshots - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - - # IAI Identity Outliers Latest Summary - - try { - Get-V2025LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LatestIdentityOutlierSnapshots" - Write-Host $_.ErrorDetails - } -- path: /outlier-feature-summaries/{outlierFeatureId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-outlier-contributing-feature-summary - source: | - $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get identity outlier contibuting feature summary - - try { - Get-V2025OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OutlierContributingFeatureSummary" - Write-Host $_.ErrorDetails - } -- path: /outliers/{outlierId}/contributing-features - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-peer-group-outliers-contributing-features - source: | - $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) - $Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) - - # Get identity outlier's contibuting features - - try { - Get-V2025PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PeerGroupOutliersContributingFeatures" - Write-Host $_.ErrorDetails - } -- path: /outliers/ignore - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#ignore-identity-outliers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - - - # IAI Identity Outliers Ignore - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-V2025IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025IgnoreIdentityOutliers" - Write-Host $_.ErrorDetails - } -- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#list-outliers-contributing-feature-access-items - source: | - $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id - $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) - $Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) - - # Gets a list of access items associated with each identity outlier contributing feature - - try { - Get-V2025OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OutliersContributingFeatureAccessItems" - Write-Host $_.ErrorDetails - } -- path: /outliers/unignore - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#un-ignore-identity-outliers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - - - # IAI Identity Outliers Unignore - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-V2025UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025UnIgnoreIdentityOutliers" - Write-Host $_.ErrorDetails - } -- path: /peer-group-strategies/{strategy}/identity-outliers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-peer-group-strategies#get-peer-group-outliers - source: | - $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Identity Outliers List - - try { - Get-V2025PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PeerGroupOutliers" - Write-Host $_.ErrorDetails - } -- path: /recommendations/request - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#get-recommendations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RecommendationRequestDto = @" - { - "prescribeMode" : false, - "excludeInterpretations" : false, - "requests" : [ { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - }, { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - } ], - "includeTranslationMessages" : false, - "includeDebugInformation" : true - } - "@ - - # Returns Recommendation Based on Object - - try { - $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto - Get-V2025Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result - - # Below is a request that includes all optional parameters - # Get-V2025Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Recommendations" - Write-Host $_.ErrorDetails - } -- path: /recommendations/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#get-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get certification recommendation config values - - try { - Get-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RecommendationsConfig" - Write-Host $_.ErrorDetails - } -- path: /recommendations/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#update-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RecommendationConfigDto = @" - { - "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], - "peerGroupPercentageThreshold" : 0.5, - "runAutoSelectOnce" : false, - "onlyTuneThreshold" : false - } - "@ - - # Update certification recommendation config values - - try { - $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto - Update-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result - - # Below is a request that includes all optional parameters - # Update-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RecommendationsConfig" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#create-potential-role-provision-request - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) - $RoleMiningPotentialRoleProvisionRequest = @" - { - "includeIdentities" : true, - "roleName" : "Finance - Accounting", - "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", - "roleDescription" : "General access for accounting department", - "directlyAssignedEntitlements" : false - } - "@ - - # Create request to provision a potential role into an actual role. - - try { - New-V2025PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # New-V2025PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PotentialRoleProvisionRequest" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#create-role-mining-sessions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleMiningSessionDto = @" - { - "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", - "prescribedPruneThreshold" : 10, - "pruneThreshold" : 50, - "saved" : true, - "potentialRolesReadyCount" : 0, - "scope" : { - "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], - "attributeFilterCriteria" : { - "displayName" : { - "untranslated" : "Location: Miami" - }, - "ariaLabel" : { - "untranslated" : "Location: Miami" - }, - "data" : { - "displayName" : { - "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" - }, - "name" : "location", - "operator" : "EQUALS", - "values" : [ "Miami" ] - } - }, - "criteria" : "source.name:DataScienceDataset" - }, - "potentialRoleCount" : 0, - "name" : "Saved RM Session - 07/10", - "minNumIdentitiesInPotentialRole" : 20, - "identityCount" : 0, - "type" : "SPECIALIZED" - } - "@ - - # Create a role mining session - - try { - $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto - New-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result - - # Below is a request that includes all optional parameters - # New-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025RoleMiningSessions" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#download-role-mining-potential-role-zip - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Export (download) details for a potential role in a role mining session - - try { - Invoke-V2025DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Invoke-V2025DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025DownloadRoleMiningPotentialRoleZip" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Export (download) details for a potential role in a role mining session - - try { - Export-V2025RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2025RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role-async - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleMiningPotentialRoleExportRequest = @" - { - "minEntitlementPopularity" : 0, - "includeCommonAccess" : true - } - "@ - - # Asynchronously export details for a potential role in a role mining session and upload to S3 - - try { - Export-V2025RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2025RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleExportRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRoleAsync" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role-status - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session - $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieve status of a potential role export job - - try { - Export-V2025RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Export-V2025RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRoleStatus" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-all-potential-role-summaries - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) - $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all potential role summaries - - try { - Get-V2025AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllPotentialRoleSummaries" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-entitlement-distribution-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) - - # Retrieves entitlement popularity distribution for a potential role in a role mining session - - try { - Get-V2025EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementDistributionPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) - $Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) - $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves entitlements for a potential role in a role mining session - - try { - Get-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-excluded-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) - $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves excluded entitlements for a potential role in a role mining session - - try { - Get-V2025ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ExcludedEntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-identities-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves identities for a potential role in a role mining session - - try { - Get-V2025IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitiesPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieves a specific potential role - - try { - Get-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-applications - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves the applications of a potential role for a role mining session - - try { - Get-V2025PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleApplications" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-entitlements - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves the entitlements of a potential role for a role mining session - - try { - Get-V2025PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleEntitlements" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-source-identity-usage - source: | - $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id - $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves potential role source usage - - try { - Get-V2025PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleSourceIdentityUsage" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-summaries - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) - $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all potential role summaries - - try { - Get-V2025PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleSummaries" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles/{potentialRoleId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-potential-role - source: | - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieves a specific potential role - - try { - Get-V2025RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-session - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a role mining session - - try { - Get-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSession" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-session-status - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get role mining session status state - - try { - Get-V2025RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSessionStatus" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-sessions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) - $Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all role mining sessions - - try { - Get-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSessions" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles/saved - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-saved-potential-roles - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieves all saved potential roles - - try { - Get-V2025SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedPotentialRoles" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ - - - # Update a potential role - - try { - $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PotentialRole" - Write-Host $_.ErrorDetails - } -- path: /role-mining-potential-roles/{potentialRoleId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-potential-role-0 - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ - - - # Update a potential role - - try { - $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2025PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PotentialRole0" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-role-mining-session - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a role mining session - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RoleMiningSession" - Write-Host $_.ErrorDetails - } -- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#update-entitlements-potential-role - source: | - $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id - $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleMiningPotentialRoleEditEntitlements = @" - { - "ids" : [ "entId1", "entId2" ], - "exclude" : true - } - "@ - - # Edit entitlements for a potential role to exclude some entitlements - - try { - $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements - Update-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result - - # Below is a request that includes all optional parameters - # Update-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsPotentialRole" - Write-Host $_.ErrorDetails - } -- path: /icons/{objectType}/{objectId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/icons#delete-icon - source: | - $ObjectType = "application" # String | Object type. Available options ['application'] - $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete an icon - - try { - Remove-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Icon" - Write-Host $_.ErrorDetails - } -- path: /icons/{objectType}/{objectId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/icons#set-icon - source: | - $ObjectType = "application" # String | Object type. Available options ['application'] - $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] - - # Update an icon - - try { - Set-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image - - # Below is a request that includes all optional parameters - # Set-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025Icon" - Write-Host $_.ErrorDetails - } -- path: /identities/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#delete-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete identity - - try { - Remove-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Identity" - Write-Host $_.ErrorDetails - } -- path: /identities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#get-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Identity Details - - try { - Get-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Identity" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/ownership - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#get-identity-ownership-details - source: | - $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get ownership details - - try { - Get-V2025IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOwnershipDetails" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/role-assignments/{assignmentId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#get-role-assignment - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Role assignment details - - try { - Get-V2025RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignment" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/role-assignments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#get-role-assignments - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) - $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) - - # List role assignments - - try { - Get-V2025RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -RoleId $RoleId -RoleName $RoleName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignments" - Write-Host $_.ErrorDetails - } -- path: /identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#list-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) - $Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) - $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Identities - - try { - Get-V2025Identities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Identities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Identities" - Write-Host $_.ErrorDetails - } -- path: /identities/{id}/reset - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#reset-identity - source: | - $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Reset an identity - - try { - Reset-V2025Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Reset-V2025Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025Identity" - Write-Host $_.ErrorDetails - } -- path: /identities/{id}/verification/account/send - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#send-identity-verification-account-token - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - $SendAccountVerificationRequest = @" - { - "sourceName" : "Active Directory Source", - "via" : "EMAIL_WORK" - } - "@ - - # Send password reset email - - try { - $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest - Send-V2025IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2025IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025IdentityVerificationAccountToken" - Write-Host $_.ErrorDetails - } -- path: /identities/invite - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#start-identities-invite - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $InviteIdentitiesRequest = @" - { - "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], - "uninvited" : false - } - "@ - - # Invite identities to register - - try { - $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest - Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result - - # Below is a request that includes all optional parameters - # Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentitiesInvite" - Write-Host $_.ErrorDetails - } -- path: /identities/process - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#start-identity-processing - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ProcessIdentitiesRequest = @" - { - "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] - } - "@ - - # Process a list of identityIds - - try { - $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest - Start-V2025IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result - - # Below is a request that includes all optional parameters - # Start-V2025IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentityProcessing" - Write-Host $_.ErrorDetails - } -- path: /identities/{identityId}/synchronize-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identities#synchronize-attributes-for-identity - source: | - $IdentityId = "MyIdentityId" # String | The Identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Attribute synchronization for single identity. - - try { - Sync-V2025hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Sync-V2025hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025hronizeAttributesForIdentity" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#create-identity-attribute - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityAttribute = @" - { - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - } - "@ - - # Create Identity Attribute - - try { - $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - New-V2025IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - - # Below is a request that includes all optional parameters - # New-V2025IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityAttribute" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#delete-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Identity Attribute - - try { - Remove-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityAttribute" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes/bulk-delete - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#delete-identity-attributes-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityAttributeNames = @" - { - "ids" : [ "name", "displayName" ] - } - "@ - - # Bulk delete Identity Attributes - - try { - $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames - Remove-V2025IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result - - # Below is a request that includes all optional parameters - # Remove-V2025IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityAttributesInBulk" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#get-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Identity Attribute - - try { - Get-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAttribute" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#list-identity-attributes - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) - $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) - $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Identity Attributes - - try { - Get-V2025IdentityAttributes -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAttributes -XSailPointExperimental $XSailPointExperimental -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAttributes" - Write-Host $_.ErrorDetails - } -- path: /identity-attributes/{name} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#put-identity-attribute - source: | - $Name = "displayName" # String | The attribute's technical name. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityAttribute = @" - { - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false - } - "@ - - # Update Identity Attribute - - try { - $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - Send-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - - # Below is a request that includes all optional parameters - # Send-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025IdentityAttribute" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/compare - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#compare-identity-snapshots - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) - $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) - $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets a difference of count for each access item types for the given identity between 2 snapshots - - try { - Compare-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Compare-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2025IdentitySnapshots" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/compare/{access-type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#compare-identity-snapshots-access-type - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $AccessType = "accessProfile" # String | The specific type which needs to be compared - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) - $Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) - $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets a list of differences of specific accessType for the given identity between 2 snapshots - - try { - Compare-V2025IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Compare-V2025IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2025IdentitySnapshotsAccessType" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-historical-identity - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get latest snapshot of identity - - try { - Get-V2025HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentity" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/events - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-historical-identity-events - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) - $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) - - $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ - $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - $AccessItemTypes = @"[entitlement, account]"@ - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Lists all events for the given identity - - try { - Get-V2025HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentityEvents" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/snapshots/{date} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-snapshot - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Date = "2007-03-01T13:00:00Z" # String | The specified date - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Gets an identity snapshot at a given date - - try { - Get-V2025IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshot" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/snapshot-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-snapshot-summary - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) - $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) - $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Gets the summary for the event count for a specific identity - - try { - Get-V2025IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshotSummary" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/start-date - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-start-date - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Gets the start date of the identity - - try { - Get-V2025IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityStartDate" - Write-Host $_.ErrorDetails - } -- path: /historical-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-historical-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) - $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) - $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # Lists all the identities - - try { - Get-V2025HistoricalIdentities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025HistoricalIdentities -XSailPointExperimental $XSailPointExperimental -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentities" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/access-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-access-items - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Access Items by Identity - - try { - Get-V2025IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental -Type $Type -Limit $Limit -Count $Count -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessItems" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/snapshots/{date}/access-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-snapshot-access-items - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $Date = "2007-03-01T13:00:00Z" # String | The specified date - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Type = "account" # String | The access item type (optional) - - # Gets the list of identity access items at a given date filterd by item type - - try { - Get-V2025IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshotAccessItems" - Write-Host $_.ErrorDetails - } -- path: /historical-identities/{id}/snapshots - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-snapshots - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) - $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Lists all the snapshots for the identity - - try { - Get-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshots" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#create-identity-profile - source: | - $IdentityProfile = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - "@ - - # Create Identity Profile - - try { - $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-V2025IdentityProfile -IdentityProfile $Result - - # Below is a request that includes all optional parameters - # New-V2025IdentityProfile -IdentityProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#delete-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - - # Delete Identity Profile - - try { - Remove-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Remove-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#delete-identity-profiles - source: | - $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. - $RequestBody = @""@ - - - # Delete Identity Profiles - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2025IdentityProfiles -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-V2025IdentityProfiles -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#export-identity-profiles - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) - - # Export Identity Profiles - - try { - Export-V2025IdentityProfiles - - # Below is a request that includes all optional parameters - # Export-V2025IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025IdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/identity-preview - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#generate-identity-preview - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $IdentityPreviewRequest = @" - { - "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - } - } - "@ - - # Generate Identity Profile Preview - - try { - $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityPreview" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#get-default-identity-attribute-config - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. - - # Get default Identity Attribute Config - - try { - Get-V2025DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-V2025DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultIdentityAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#get-identity-profile - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - - # Get Identity Profile - - try { - Get-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#import-identity-profiles - source: | - - - - - - $IdentityProfileExportedObject = @"{ - "self" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "version" : 1, - "object" : { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - }"@ - - - # Import Identity Profiles - - try { - $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-V2025IdentityProfiles -IdentityProfileExportedObject $Result - - # Below is a request that includes all optional parameters - # Import-V2025IdentityProfiles -IdentityProfileExportedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025IdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#list-identity-profiles - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - - # List Identity Profiles - - try { - Get-V2025IdentityProfiles - - # Below is a request that includes all optional parameters - # Get-V2025IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/process-identities - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#sync-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed - - # Process identities under profile - - try { - Sync-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Sync-V2025IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#update-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Identity Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#create-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleState = @" - { - "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], - "emailNotificationOption" : { - "notifyManagers" : true, - "notifySpecificUsers" : true, - "emailAddressList" : [ "test@test.com", "test2@test.com" ], - "notifyAllAdmins" : true - }, - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Lifecycle description", - "accountActions" : [ { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - }, { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } ], - "id" : "id12345", - "identityCount" : 42, - "technicalName" : "Technical Name", - "identityState" : "identityState", - "enabled" : true - } - "@ - - # Create Lifecycle State - - try { - $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState - New-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result - - # Below is a request that includes all optional parameters - # New-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025LifecycleState" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#delete-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - - # Delete Lifecycle State - - try { - Remove-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Remove-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025LifecycleState" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#get-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - - # Get Lifecycle State - - try { - Get-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Get-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LifecycleState" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#get-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Lists LifecycleStates - - try { - Get-V2025LifecycleStates -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-V2025LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LifecycleStates" - Write-Host $_.ErrorDetails - } -- path: /identities/{identity-id}/set-lifecycle-state - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#set-lifecycle-state - source: | - $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. - $SetLifecycleStateRequest = @" - - "@ - - # Set Lifecycle State - - try { - $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest - Set-V2025LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result - - # Below is a request that includes all optional parameters - # Set-V2025LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025LifecycleState" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#update-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Lifecycle State - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025LifecycleStates" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-V2025MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-V2025MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAKbaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-V2025MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2025MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAKBAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2025MFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-V2025MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-V2025MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025MFAConfig" - Write-Host $_.ErrorDetails - } -- path: /machine-accounts/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#get-machine-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Machine Account Details - - try { - Get-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccount" - Write-Host $_.ErrorDetails - } -- path: /machine-accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#list-machine-accounts - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) - - # Machine Accounts List - - try { - Get-V2025MachineAccounts -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccounts" - Write-Host $_.ErrorDetails - } -- path: /machine-accounts/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#update-machine-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - $RequestBody = @"[{op=add, path=/environment, value=test}]"@ - - - # Update a Machine Account - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MachineAccount" - Write-Host $_.ErrorDetails - } -- path: /machine-identities - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#create-machine-identity - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MachineIdentity = @" - { - "created" : "2015-05-28T14:07:17Z", - "businessApplication" : "ADService", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "", - "attributes" : "{\"Region\":\"EU\"}", - "id" : "id12345", - "manuallyEdited" : true - } - "@ - - # Create Machine Identities - - try { - $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity - New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result - - # Below is a request that includes all optional parameters - # New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025MachineIdentity" - Write-Host $_.ErrorDetails - } -- path: /machine-identities/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#delete-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete machine identity - - try { - Remove-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MachineIdentity" - Write-Host $_.ErrorDetails - } -- path: /machine-identities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#get-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Machine Identity Details - - try { - Get-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineIdentity" - Write-Host $_.ErrorDetails - } -- path: /machine-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#list-machine-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) - $Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Machine Identities - - try { - Get-V2025MachineIdentities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MachineIdentities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineIdentities" - Write-Host $_.ErrorDetails - } -- path: /machine-identities/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#update-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ - - - # Update a Machine Identity - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MachineIdentity" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#create-managed-client - source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ - - # Create Managed Client - - try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-V2025ManagedClient -ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedClient -ManagedClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#delete-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Delete Managed Client - - try { - Remove-V2025ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Get Managed Client - - try { - Get-V2025ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. - - # Get Managed Client Status - - try { - Get-V2025ManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-clients - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - - # Get Managed Clients - - try { - Get-V2025ManagedClients - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClients" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#update-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025ManagedClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - $ManagedClusterType = @" - { - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - } - "@ - - # Create new Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType - New-V2025ManagedClusterType -ManagedClusterType $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedClusterType -ManagedClusterType $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Delete a Managed Cluster Type - - try { - Remove-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Get a Managed Cluster Type - - try { - Get-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - $Type = "IDN" # String | Type descriptor (optional) - $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) - $Org = "denali-xyz" # String | Pinned org (or default) (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Managed Cluster Types - - try { - Get-V2025ManagedClusterTypes - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterTypes" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update a Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-V2025ManagedCluster -ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedCluster -ManagedClusterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-V2025ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-V2025ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-V2025ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-V2025ManagedClusters - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-V2025ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2025ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/manualUpgrade - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#update - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. - - # Trigger Manual Upgrade for Managed Cluster - - try { - Update-V2025 -Id $Id - - # Below is a request that includes all optional parameters - # Update-V2025 -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025ManagedCluster -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedCluster -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /multihosts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#create-multi-host-integration - source: | - $MultiHostIntegrationsCreate = @" - { - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "connector" : "multihost-microsoft-sql-server", - "connectorAttributes" : { - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "created" : "2022-02-08T14:50:03.827Z", - "name" : "My Multi-Host Integration", - "description" : "This is the Multi-Host Integration.", - "modified" : "2024-01-23T18:08:50.897Z" - } - "@ - - # Create Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate - New-V2025MultiHostIntegration -MultiHostIntegrationsCreate $Result - - # Below is a request that includes all optional parameters - # New-V2025MultiHostIntegration -MultiHostIntegrationsCreate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025MultiHostIntegration" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#create-sources-within-multi-host - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - $MultiHostIntegrationsCreateSources = @"{ - "connectorAttributes" : { - "authType" : "SQLAuthentication", - "url" : "jdbc:sqlserver://178.18.41.118:1433", - "user" : "username", - "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "name" : "My Source", - "description" : "This is the corporate directory." - }"@ - - - # Create Sources Within Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources - New-V2025SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result - - # Below is a request that includes all optional parameters - # New-V2025SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourcesWithinMultiHost" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#delete-multi-host - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. - - # Delete Multi-Host Integration - - try { - Remove-V2025MultiHost -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Remove-V2025MultiHost -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MultiHost" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId}/acctAggregationGroups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-acct-aggregation-groups - source: | - $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Account-Aggregation-Groups by Multi-Host ID - - try { - Get-V2025AcctAggregationGroups -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-V2025AcctAggregationGroups -MultihostId $MultihostId -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AcctAggregationGroups" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multiHostId}/entitlementAggregationGroups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-entitlement-aggregation-groups - source: | - $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Entitlement-Aggregation-Groups by Integration ID - - try { - Get-V2025EntitlementAggregationGroups -MultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementAggregationGroups -MultiHostId $MultiHostId -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementAggregationGroups" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multi-host-integrations - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - - # Get Multi-Host Integration By ID - - try { - Get-V2025MultiHostIntegrations -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-V2025MultiHostIntegrations -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultiHostIntegrations" - Write-Host $_.ErrorDetails - } -- path: /multihosts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multi-host-integrations-list - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - - # List All Existing Multi-Host Integrations - - try { - Get-V2025MultiHostIntegrationsList - - # Below is a request that includes all optional parameters - # Get-V2025MultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultiHostIntegrationsList" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multiHostId}/sources/errors - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multi-host-source-creation-errors - source: | - $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration - - # List Multi-Host Source Creation Errors - - try { - Get-V2025MultiHostSourceCreationErrors -MultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-V2025MultiHostSourceCreationErrors -MultiHostId $MultiHostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultiHostSourceCreationErrors" - Write-Host $_.ErrorDetails - } -- path: /multihosts/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multihost-integration-types - source: | - - # List Multi-Host Integration Types - - try { - Get-V2025MultihostIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-V2025MultihostIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultihostIntegrationTypes" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId}/sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-sources-within-multi-host - source: | - $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Sources Within Multi-Host Integration - - try { - Get-V2025SourcesWithinMultiHost -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Get-V2025SourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourcesWithinMultiHost" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId}/sources/testConnection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#test-connection-multi-host-sources - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration - - # Test Configuration For Multi-Host Integration - - try { - Test-V2025ConnectionMultiHostSources -MultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Test-V2025ConnectionMultiHostSources -MultihostId $MultihostId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ConnectionMultiHostSources" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#test-source-connection-multihost - source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration - $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration - - # Test Configuration For Multi-Host Integration's Single Source - - try { - Test-V2025SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-V2025SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConnectionMultihost" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#update-multi-host-sources - source: | - $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. - $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ - - - # Update Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner - Update-V2025MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MultiHostSources" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id}/approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#approve-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeApprovalDecision = @" - { - "comment" : "Approved by manager" - } - "@ - - # Approve a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-V2025NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Approve-V2025NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-record - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2025NonEmployeeRecord -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2025NonEmployeeRecord -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-request - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2025NonEmployeeRequest -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2025NonEmployeeRequest -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-source - source: | - $NonEmployeeSourceRequestBody = @" - { - "owner" : { - "id" : "2c91808570313110017040b06f344ec9" - }, - "managementWorkgroup" : "123299", - "accountManagers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ], - "name" : "Retail", - "description" : "Source description", - "approvers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ] - } - "@ - - # Create Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-V2025NonEmployeeSource -NonEmployeeSourceRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2025NonEmployeeSource -NonEmployeeSourceRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - $NonEmployeeSchemaAttributeBody = @" - { - "helpText" : "The unique identifier for the account", - "label" : "Account Name", - "placeholder" : "Enter a unique user name for this account.", - "type" : "TEXT", - "technicalName" : "account.name", - "required" : true - } - "@ - - # Create a new Schema Attribute for Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - - # Below is a request that includes all optional parameters - # New-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - - # Delete Non-Employee Record - - try { - Remove-V2025NonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk - source: | - $DeleteNonEmployeeRecordsInBulkRequest = @" - - "@ - - # Delete Multiple Non-Employee Records - - try { - $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest - Remove-V2025NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-request - source: | - $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format - - # Delete Non-Employee Request - - try { - Remove-V2025NonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Delete a Schema Attribute for Non-Employee Source - - try { - Remove-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source - source: | - $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - - # Delete Non-Employee Source - - try { - Remove-V2025NonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Delete all custom schema attributes for Non-Employee Source - - try { - Remove-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/non-employees/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#export-non-employee-records - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - - # Exports Non-Employee Records to CSV - - try { - Export-V2025NonEmployeeRecords -Id $Id - - # Below is a request that includes all optional parameters - # Export-V2025NonEmployeeRecords -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025NonEmployeeRecords" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/schema-attributes-template/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) - - # Exports Source Schema Template - - try { - Export-V2025NonEmployeeSourceSchemaTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Export-V2025NonEmployeeSourceSchemaTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025NonEmployeeSourceSchemaTemplate" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) - - # Get a non-employee approval item detail - - try { - Get-V2025NonEmployeeApproval -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeApproval" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/summary/{requested-for} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval-summary - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Approval Requests - - try { - Get-V2025NonEmployeeApprovalSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeApprovalSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeApprovalSummary" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/non-employee-bulk-upload/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) - - # Obtain the status of bulk upload on the source - - try { - Get-V2025NonEmployeeBulkUploadStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeBulkUploadStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeBulkUploadStatus" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - - # Get a Non-Employee Record - - try { - Get-V2025NonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-request - source: | - $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) - - # Get a Non-Employee Request - - try { - Get-V2025NonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests/summary/{requested-for} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-request-summary - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Requests - - try { - Get-V2025NonEmployeeRequestSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRequestSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRequestSummary" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Get Schema Attribute Non-Employee Source - - try { - Get-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-source - source: | - $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id - - # Get a Non-Employee Source - - try { - Get-V2025NonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # List Schema Attributes Non-Employee Source - - try { - Get-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/non-employee-bulk-upload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - $Data = # System.IO.FileInfo | - - # Imports, or Updates, Non-Employee Records - - try { - Import-V2025NonEmployeeRecordsInBulk -Id $Id -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2025NonEmployeeRecordsInBulk -Id $Id -Data $Data - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025NonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-approvals - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Get List of Non-Employee Approval Requests - - try { - Get-V2025NonEmployeeApprovals - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeApprovals" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-records - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - - # List Non-Employee Records - - try { - Get-V2025NonEmployeeRecords - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRecords" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-requests - source: | - $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - - # List Non-Employee Requests - - try { - Get-V2025NonEmployeeRequests -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRequests" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-sources - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) - $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) - $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - - # List Non-Employee Sources - - try { - Get-V2025NonEmployeeSources - - # Below is a request that includes all optional parameters - # Get-V2025NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSources" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#patch-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Non-Employee Record - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025NonEmployeeRecord -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025NonEmployeeRecord -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Schema Attribute for Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#patch-non-employee-source - source: | - $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id}/reject - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#reject-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeRejectApprovalDecision = @" - { - "comment" : "approved" - } - "@ - - # Reject a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-V2025NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Deny-V2025NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#update-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Update Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-V2025NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /verified-domains - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-domain-dkim - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $DomainAddress = @" - { - "domain" : "sailpoint.com" - } - "@ - - # Verify domain address via DKIM - - try { - $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress - New-V2025DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result - - # Below is a request that includes all optional parameters - # New-V2025DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DomainDkim" - Write-Host $_.ErrorDetails - } -- path: /notification-templates - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-notification-template - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TemplateDto = @" - { - "slackTemplate" : "slackTemplate", - "footer" : "footer", - "teamsTemplate" : "teamsTemplate", - "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", - "created" : "2020-01-01T00:00:00Z", - "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", - "medium" : "EMAIL", - "locale" : "en", - "body" : "Please go to the task manager", - "name" : "Task Manager Subscription", - "replyTo" : "$__global.emailFromAddress", - "header" : "header", - "modified" : "2020-01-01T00:00:00Z", - "from" : "$__global.emailFromAddress", - "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", - "key" : "cloud_manual_work_item_summary" - } - "@ - - # Create Notification Template - - try { - $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto - New-V2025NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result - - # Below is a request that includes all optional parameters - # New-V2025NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NotificationTemplate" - Write-Host $_.ErrorDetails - } -- path: /verified-from-addresses - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-verified-from-address - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $EmailStatusDto = @" - { - "isVerifiedByDomain" : false, - "verificationStatus" : "PENDING", - "id" : "id", - "email" : "sender@example.com" - } - "@ - - # Create Verified From Address - - try { - $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto - New-V2025VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result - - # Below is a request that includes all optional parameters - # New-V2025VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025VerifiedFromAddress" - Write-Host $_.ErrorDetails - } -- path: /notification-templates/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#delete-notification-templates-in-bulk - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TemplateBulkDeleteDto = @"{ - "medium" : "EMAIL", - "locale" : "en", - "key" : "cloud_manual_work_item_summary" - }"@ - - - # Bulk Delete Notification Templates - - try { - $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto - Remove-V2025NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result - - # Below is a request that includes all optional parameters - # Remove-V2025NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NotificationTemplatesInBulk" - Write-Host $_.ErrorDetails - } -- path: /verified-from-addresses/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#delete-verified-from-address - source: | - $Id = "MyId" # String | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Verified From Address - - try { - Remove-V2025VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025VerifiedFromAddress" - Write-Host $_.ErrorDetails - } -- path: /verified-domains - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-dkim-attributes - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get DKIM Attributes - - try { - Get-V2025DkimAttributes -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025DkimAttributes -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DkimAttributes" - Write-Host $_.ErrorDetails - } -- path: /mail-from-attributes/{identity} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-mail-from-attributes - source: | - $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get MAIL FROM Attributes - - try { - Get-V2025MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MailFromAttributes" - Write-Host $_.ErrorDetails - } -- path: /notification-templates/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-notification-template - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Notification Template By Id - - try { - Get-V2025NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplate" - Write-Host $_.ErrorDetails - } -- path: /notification-template-context - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-notifications-template-context - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Notification Template Context - - try { - Get-V2025NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationsTemplateContext" - Write-Host $_.ErrorDetails - } -- path: /verified-from-addresses - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-from-addresses - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "email eq "john.doe@company.com"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) - $Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) - - # List From Addresses - - try { - Get-V2025FromAddresses -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025FromAddresses -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FromAddresses" - Write-Host $_.ErrorDetails - } -- path: /notification-preferences/{key} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-preferences - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Notification Preferences for tenant. - - try { - Get-V2025NotificationPreferences -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationPreferences -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationPreferences" - Write-Host $_.ErrorDetails - } -- path: /notification-template-defaults - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-template-defaults - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "key eq "cloud_manual_work_item_summary"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - - # List Notification Template Defaults - - try { - Get-V2025NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplateDefaults" - Write-Host $_.ErrorDetails - } -- path: /notification-templates - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-templates - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "medium eq "EMAIL"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) - - # List Notification Templates - - try { - Get-V2025NotificationTemplates -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplates" - Write-Host $_.ErrorDetails - } -- path: /mail-from-attributes - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#put-mail-from-attributes - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MailFromAttributesDto = @" - { - "identity" : "BobSmith@sailpoint.com", - "mailFromDomain" : "example.sailpoint.com" - } - "@ - - # Change MAIL FROM domain - - try { - $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto - Send-V2025MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result - - # Below is a request that includes all optional parameters - # Send-V2025MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025MailFromAttributes" - Write-Host $_.ErrorDetails - } -- path: /send-test-notification - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/notifications#send-test-notification - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SendTestNotificationRequestDto = @" - { - "context" : "{}", - "medium" : "EMAIL", - "key" : "cloud_manual_work_item_summary" - } - "@ - - # Send Test Notification - - try { - $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto - Send-V2025TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result - - # Below is a request that includes all optional parameters - # Send-V2025TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TestNotification" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#create-oauth-client - source: | - $CreateOAuthClientRequest = @" - { - "internal" : false, - "businessName" : "Acme-Solar", - "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", - "refreshTokenValiditySeconds" : 86400, - "type" : "CONFIDENTIAL", - "redirectUris" : [ "http://localhost:12345" ], - "enabled" : true, - "accessType" : "OFFLINE", - "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], - "strongAuthSupported" : false, - "homepageUrl" : "http://localhost:12345", - "accessTokenValiditySeconds" : 750, - "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], - "name" : "Demo API Client", - "claimsSupported" : false - } - "@ - - # Create OAuth Client - - try { - $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-V2025OauthClient -CreateOAuthClientRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025OauthClient -CreateOAuthClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025OauthClient" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#delete-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Delete OAuth Client - - try { - Remove-V2025OauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025OauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025OauthClient" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#get-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Get OAuth Client - - try { - Get-V2025OauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025OauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OauthClient" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#list-oauth-clients - source: | - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - - # List OAuth Clients - - try { - Get-V2025OauthClients - - # Below is a request that includes all optional parameters - # Get-V2025OauthClients -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OauthClients" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#patch-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch OAuth Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025OauthClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025OauthClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025OauthClient" - Write-Host $_.ErrorDetails - } -- path: /org-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/org-config#get-org-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Org Config Settings - - try { - Get-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OrgConfig" - Write-Host $_.ErrorDetails - } -- path: /org-config/valid-time-zones - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/org-config#get-valid-time-zones - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Get Valid Time Zones - - try { - Get-V2025ValidTimeZones -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ValidTimeZones" - Write-Host $_.ErrorDetails - } -- path: /org-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/org-config#patch-org-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Org Config - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025OrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-org-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#create-password-org-config - source: | - $PasswordOrgConfig = @" - { - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - } - "@ - - # Create Password Org Config - - try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - New-V2025PasswordOrgConfig -PasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # New-V2025PasswordOrgConfig -PasswordOrgConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-org-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#get-password-org-config - source: | - - # Get Password Org Config - - try { - Get-V2025PasswordOrgConfig - - # Below is a request that includes all optional parameters - # Get-V2025PasswordOrgConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-org-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#put-password-org-config - source: | - $PasswordOrgConfig = @" - { - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - } - "@ - - # Update Password Org Config - - try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - Send-V2025PasswordOrgConfig -PasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025PasswordOrgConfig -PasswordOrgConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PasswordOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-dictionary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-dictionary#get-password-dictionary - source: | - - # Get Password Dictionary - - try { - Get-V2025PasswordDictionary - - # Below is a request that includes all optional parameters - # Get-V2025PasswordDictionary - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordDictionary" - Write-Host $_.ErrorDetails - } -- path: /password-dictionary - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-dictionary#put-password-dictionary - source: | - $File = # System.IO.FileInfo | (optional) - - # Update Password Dictionary - - try { - Send-V2025PasswordDictionary - - # Below is a request that includes all optional parameters - # Send-V2025PasswordDictionary -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PasswordDictionary" - Write-Host $_.ErrorDetails - } -- path: /generate-password-reset-token/digit - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-management#create-digit-token - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $PasswordDigitTokenReset = @" - { - "durationMinutes" : 5, - "length" : 8, - "userId" : "Abby.Smith" - } - "@ - - # Generate a digit token - - try { - $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset - New-V2025DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result - - # Below is a request that includes all optional parameters - # New-V2025DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DigitToken" - Write-Host $_.ErrorDetails - } -- path: /password-change-status/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-management#get-password-change-status - source: | - $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID - - # Get Password Change Request Status - - try { - Get-V2025PasswordChangeStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025PasswordChangeStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordChangeStatus" - Write-Host $_.ErrorDetails - } -- path: /query-password-info - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-management#query-password-info - source: | - $PasswordInfoQueryDTO = @" - { - "sourceName" : "My-AD", - "userName" : "Abby.Smith" - } - "@ - - # Query Password Info - - try { - $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO - Search-V2025PasswordInfo -PasswordInfoQueryDTO $Result - - # Below is a request that includes all optional parameters - # Search-V2025PasswordInfo -PasswordInfoQueryDTO $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025PasswordInfo" - Write-Host $_.ErrorDetails - } -- path: /set-password - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-management#set-password - source: | - $PasswordChangeRequest = @" - { - "sourceId" : "8a807d4c73c545510173c545d4b60246", - "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", - "identityId" : "8a807d4c73c545510173c545f0a002ff", - "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", - "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" - } - "@ - - # Set Identity's Password - - try { - $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest - Set-V2025Password -PasswordChangeRequest $Result - - # Below is a request that includes all optional parameters - # Set-V2025Password -PasswordChangeRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025Password" - Write-Host $_.ErrorDetails - } -- path: /password-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#create-password-policy - source: | - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : 1939056206564, - "validateAgainstAccountId" : false, - "dateCreated" : 1639056206564, - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Create Password Policy - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordPolicy" - Write-Host $_.ErrorDetails - } -- path: /password-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#delete-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. - - # Delete Password Policy by ID - - try { - Remove-V2025PasswordPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025PasswordPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PasswordPolicy" - Write-Host $_.ErrorDetails - } -- path: /password-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#get-password-policy-by-id - source: | - $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. - - # Get Password Policy by ID - - try { - Get-V2025PasswordPolicyById -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025PasswordPolicyById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicyById" - Write-Host $_.ErrorDetails - } -- path: /password-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#list-password-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Password Policies - - try { - Get-V2025PasswordPolicies - - # Below is a request that includes all optional parameters - # Get-V2025PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicies" - Write-Host $_.ErrorDetails - } -- path: /password-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-policies#set-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : 1939056206564, - "validateAgainstAccountId" : false, - "dateCreated" : 1639056206564, - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Update Password Policy by ID - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025PasswordPolicy" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#create-password-sync-group - source: | - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Create Password Sync Group - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-V2025PasswordSyncGroup -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # New-V2025PasswordSyncGroup -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#delete-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. - - # Delete Password Sync Group by ID - - try { - Remove-V2025PasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025PasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#get-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. - - # Get Password Sync Group by ID - - try { - Get-V2025PasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025PasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#get-password-sync-groups - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Get Password Sync Group List - - try { - Get-V2025PasswordSyncGroups - - # Below is a request that includes all optional parameters - # Get-V2025PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordSyncGroups" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#update-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Update Password Sync Group by ID - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-V2025PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # Update-V2025PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#create-personal-access-token - source: | - $CreatePersonalAccessTokenRequest = @" - { - "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], - "accessTokenValiditySeconds" : 36900, - "name" : "NodeJS Integration" - } - "@ - - # Create Personal Access Token - - try { - $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-V2025PersonalAccessToken -CreatePersonalAccessTokenRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025PersonalAccessToken -CreatePersonalAccessTokenRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PersonalAccessToken" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#delete-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id - - # Delete Personal Access Token - - try { - Remove-V2025PersonalAccessToken -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025PersonalAccessToken -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PersonalAccessToken" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#list-personal-access-tokens - source: | - $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - - # List Personal Access Tokens - - try { - Get-V2025PersonalAccessTokens - - # Below is a request that includes all optional parameters - # Get-V2025PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PersonalAccessTokens" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#patch-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Personal Access Token - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025PersonalAccessToken -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025PersonalAccessToken -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PersonalAccessToken" - Write-Host $_.ErrorDetails - } -- path: /public-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/public-identities#get-public-identities - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) - $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Get list of public identities - - try { - Get-V2025PublicIdentities - - # Below is a request that includes all optional parameters - # Get-V2025PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PublicIdentities" - Write-Host $_.ErrorDetails - } -- path: /public-identities-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/public-identities-config#get-public-identity-config - source: | - - # Get the Public Identities Configuration - - try { - Get-V2025PublicIdentityConfig - - # Below is a request that includes all optional parameters - # Get-V2025PublicIdentityConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PublicIdentityConfig" - Write-Host $_.ErrorDetails - } -- path: /public-identities-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/public-identities-config#update-public-identity-config - source: | - $PublicIdentityConfig = @" - { - "modified" : "2018-06-25T20:22:28.104Z", - "attributes" : [ { - "name" : "Country", - "key" : "country" - }, { - "name" : "Country", - "key" : "country" - } ], - "modifiedBy" : { - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - } - "@ - - # Update the Public Identities Configuration - - try { - $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-V2025PublicIdentityConfig -PublicIdentityConfig $Result - - # Below is a request that includes all optional parameters - # Update-V2025PublicIdentityConfig -PublicIdentityConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PublicIdentityConfig" - Write-Host $_.ErrorDetails - } -- path: /reports/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#cancel-report - source: | - $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel - - # Cancel Report - - try { - Suspend-V2025Report -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2025Report -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025Report" - Write-Host $_.ErrorDetails - } -- path: /reports/{taskResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#get-report - source: | - $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report - $FileFormat = "csv" # String | Output format of the requested report file - $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) - $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) - - # Get Report File - - try { - Get-V2025Report -TaskResultId $TaskResultId -FileFormat $FileFormat - - # Below is a request that includes all optional parameters - # Get-V2025Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Report" - Write-Host $_.ErrorDetails - } -- path: /reports/{taskResultId}/result - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#get-report-result - source: | - $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report - $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) - - # Get Report Result - - try { - Get-V2025ReportResult -TaskResultId $TaskResultId - - # Below is a request that includes all optional parameters - # Get-V2025ReportResult -TaskResultId $TaskResultId -Completed $Completed - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReportResult" - Write-Host $_.ErrorDetails - } -- path: /reports/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#start-report - source: | - $ReportDetails = @" - { - "reportType" : "ACCOUNTS", - "arguments" : { - "application" : "2c9180897e7742b2017e781782f705b9", - "sourceName" : "Active Directory" - } - } - "@ - - # Run Report - - try { - $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails - Start-V2025Report -ReportDetails $Result - - # Below is a request that includes all optional parameters - # Start-V2025Report -ReportDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025Report" - Write-Host $_.ErrorDetails - } -- path: /requestable-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/requestable-objects#list-requestable-objects - source: | - $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) - $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) - - $Types = @"ROLE,ACCESS_PROFILE"@ - $Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) - $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) - - $Statuses = @"[ASSIGNED, PENDING]"@ - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Requestable Objects List - - try { - Get-V2025RequestableObjects - - # Below is a request that includes all optional parameters - # Get-V2025RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RequestableObjects" - Write-Host $_.ErrorDetails - } -- path: /role-insights/requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#create-role-insight-requests - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Generate insights for roles - - try { - New-V2025RoleInsightRequests -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # New-V2025RoleInsightRequests -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025RoleInsightRequests" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId}/entitlement-changes/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#download-role-insights-entitlements-changes - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) - $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Download entitlement insights for a role - - try { - Invoke-V2025DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Invoke-V2025DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025DownloadRoleInsightsEntitlementsChanges" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-entitlement-changes-identities - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "name sw "Jan"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) - - # Get identities for a suggested entitlement (for a role) - - try { - Get-V2025EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChangesIdentities" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insight - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a single role insight - - try { - Get-V2025RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsight" - Write-Host $_.ErrorDetails - } -- path: /role-insights - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) - $Filters = "name sw "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) - - # Get role insights - - try { - Get-V2025RoleInsights -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsights -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsights" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId}/current-entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-current-entitlements - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Get current entitlement for a role - - try { - Get-V2025RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsCurrentEntitlements" - Write-Host $_.ErrorDetails - } -- path: /role-insights/{insightId}/entitlement-changes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-entitlements-changes - source: | - $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) - $Filters = "name sw "Admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) - - # Get entitlement insights for a role - - try { - Get-V2025RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsEntitlementsChanges" - Write-Host $_.ErrorDetails - } -- path: /role-insights/requests/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-requests - source: | - $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Returns metadata from prior request. - - try { - Get-V2025RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsRequests" - Write-Host $_.ErrorDetails - } -- path: /role-insights/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-summary - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get role insights summary information - - try { - Get-V2025RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsSummary" - Write-Host $_.ErrorDetails - } -- path: /roles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#create-role - source: | - $Role = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "dimensional" : false, - "created" : "2021-03-01T22:32:58.104Z", - "dimensionRefs" : [ { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - }, { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - } ], - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "membership" : { - "identities" : [ { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } ], - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, - "type" : "IDENTITY_LIST" - }, - "enabled" : true, - "revocationRequestConfig" : { - "commentsRequired" : false, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : false - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "legacyMembershipInfo" : { - "type" : "IDENTITY_LIST" - }, - "accessRequestConfig" : { - "commentsRequired" : true, - "reauthorizationRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "name" : "Role 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "accessModelMetadata" : { - "attributes" : [ { - "key" : "iscPrivacy", - "name" : "Privacy", - "multiselect" : false, - "status" : "active", - "type" : "governance", - "objectTypes" : [ "all" ], - "description" : "Specifies the level of privacy associated with an access item.", - "values" : [ { - "value" : "public", - "name" : "Public", - "status" : "active" - } ] - } ] - }, - "id" : "2c918086749d78830174a1a40e121518", - "requestable" : true - } - "@ - - # Create a Role - - try { - $Result = ConvertFrom-JsonToRole -Json $Role - New-V2025Role -Role $Result - - # Below is a request that includes all optional parameters - # New-V2025Role -Role $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Role" - Write-Host $_.ErrorDetails - } -- path: /roles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-bulk-roles - source: | - $RoleBulkDeleteRequest = @" - { - "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - } - "@ - - # Delete Role(s) - - try { - $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-V2025BulkRoles -RoleBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-V2025BulkRoles -RoleBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025BulkRoles" - Write-Host $_.ErrorDetails - } -- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-metadata-from-role-by-key-and-value - source: | - $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id. - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - - # Remove a Metadata From Role. - - try { - Remove-V2025MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - - # Below is a request that includes all optional parameters - # Remove-V2025MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MetadataFromRoleByKeyAndValue" - Write-Host $_.ErrorDetails - } -- path: /roles/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - - # Delete a Role - - try { - Remove-V2025Role -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Role -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Role" - Write-Host $_.ErrorDetails - } -- path: /roles/access-model-metadata/bulk-update - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-bulk-update-status - source: | - - # Get Bulk-Update Statuses - - try { - Get-V2025BulkUpdateStatus - - # Below is a request that includes all optional parameters - # Get-V2025BulkUpdateStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BulkUpdateStatus" - Write-Host $_.ErrorDetails - } -- path: /roles/access-model-metadata/bulk-update/id - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-bulk-update-status-by-id - source: | - $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. - - # Get Bulk-Update Status by ID - - try { - Get-V2025BulkUpdateStatusById -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025BulkUpdateStatusById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BulkUpdateStatusById" - Write-Host $_.ErrorDetails - } -- path: /roles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - - # Get a Role - - try { - Get-V2025Role -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Role -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Role" - Write-Host $_.ErrorDetails - } -- path: /roles/{id}/assigned-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role-assigned-identities - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) - $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) - - # List Identities assigned a Role - - try { - Get-V2025RoleAssignedIdentities -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignedIdentities" - Write-Host $_.ErrorDetails - } -- path: /roles/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | Containing role's ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Role's Entitlements - - try { - Get-V2025RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleEntitlements" - Write-Host $_.ErrorDetails - } -- path: /roles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#list-roles - source: | - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) - - # List Roles - - try { - Get-V2025Roles - - # Below is a request that includes all optional parameters - # Get-V2025Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Roles" - Write-Host $_.ErrorDetails - } -- path: /roles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#patch-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Role - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Role -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Role -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Role" - Write-Host $_.ErrorDetails - } -- path: /roles/filter - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#search-roles-by-filter - source: | - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) - $RoleListFilterDTO = @" - { - "ammKeyValues" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "secret" ] - } ], - "filters" : "dimensional eq false" - } - "@ - - # Filter Roles by Metadata - - try { - Search-V2025RolesByFilter - - # Below is a request that includes all optional parameters - # Search-V2025RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -RoleListFilterDTO $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025RolesByFilter" - Write-Host $_.ErrorDetails - } -- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#update-attribute-key-and-value-to-role - source: | - $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role - $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. - $AttributeValue = "public" # String | Technical name of the Attribute Value. - - # Add a Metadata to Role. - - try { - Update-V2025AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - - # Below is a request that includes all optional parameters - # Update-V2025AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AttributeKeyAndValueToRole" - Write-Host $_.ErrorDetails - } -- path: /roles/access-model-metadata/bulk-update/filter - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-filter - source: | - $RoleMetadataBulkUpdateByFilterRequest = @" - { - "values" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "topSecret" ] - } ], - "filters" : " requestable eq false", - "replaceScope" : "ALL", - "operation" : "REPLACE" - } - "@ - - # Bulk-Update Roles' Metadata by Filters - - try { - $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest - Update-V2025RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByFilter" - Write-Host $_.ErrorDetails - } -- path: /roles/access-model-metadata/bulk-update/ids - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-ids - source: | - $RoleMetadataBulkUpdateByIdRequest = @" - { - "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], - "values" : [ { - "attribute" : "iscFederalClassifications", - "values" : [ "topSecret" ] - } ], - "replaceScope" : "ALL", - "operation" : "REPLACE" - } - "@ - - # Bulk-Update Roles' Metadata by ID - - try { - $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest - Update-V2025RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByIds" - Write-Host $_.ErrorDetails - } -- path: /roles/access-model-metadata/bulk-update/query - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-query - source: | - $RoleMetadataBulkUpdateByQueryRequest = @" - { - "query" : { - "query\"" : { - "indices" : [ "roles" ], - "queryType" : "TEXT", - "textQuery" : { - "terms" : [ "test123" ], - "fields" : [ "id" ], - "matchAny" : false, - "contains" : true - }, - "includeNested" : false - } - }, - "values" : [ { - "attributeValue" : [ "topSecret" ], - "attributeKey" : "iscFederalClassifications" - }, { - "attributeValue" : [ "topSecret" ], - "attributeKey" : "iscFederalClassifications" - } ], - "replaceScope" : "ALL", - "operation" : "REPLACE" - } - "@ - - # Bulk-Update Roles' Metadata by Query - - try { - $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest - Update-V2025RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByQuery" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration - source: | - $Id = "12345" # String | The id of the integration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a SIM integration - - try { - Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a SIM integration details. - - try { - Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2025SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2025SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2025SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2025SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2025SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-V2025SodPolicies - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2025SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2025SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2025EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2025SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2025SpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2025SpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-V2025SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-V2025SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-V2025SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-V2025SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2025SpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-V2025SpConfigObjects - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" - Write-Host $_.ErrorDetails - } -- path: /saved-searches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#create-saved-search - source: | - $CreateSavedSearchRequest = @" - - "@ - - # Create a saved search - - try { - $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-V2025SavedSearch -CreateSavedSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025SavedSearch -CreateSavedSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#delete-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete document by ID - - try { - Remove-V2025SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id}/execute - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#execute-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SearchArguments = @" - { - "owner" : "", - "recipients" : [ { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - } - "@ - - # Execute a saved search by ID - - try { - $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-V2025ExecuteSavedSearch -Id $Id -SearchArguments $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025ExecuteSavedSearch -Id $Id -SearchArguments $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ExecuteSavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#get-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Return saved search by ID - - try { - Get-V2025SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#list-saved-searches - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) - - # A list of Saved Searches - - try { - Get-V2025SavedSearches - - # Below is a request that includes all optional parameters - # Get-V2025SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedSearches" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/saved-search#put-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SavedSearch = @" - { - "owner" : { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2018-06-25T20:22:28.104Z", - "columns" : { - "identity" : [ { - "field" : "displayName", - "header" : "Display Name" - }, { - "field" : "e-mail", - "header" : "Work Email" - } ] - }, - "query" : "@accounts(disabled:true)", - "description" : "Disabled accounts", - "orderBy" : { - "identity" : [ "lastName", "firstName" ], - "role" : [ "name" ] - }, - "sort" : [ "displayName" ], - "filters" : { - "terms" : [ "account_count", "account_count" ], - "range" : { - "lower" : { - "inclusive" : false, - "value" : "1" - }, - "upper" : { - "inclusive" : false, - "value" : "1" - } - }, - "exclude" : false, - "type" : "RANGE" - }, - "ownerId" : "2c91808568c529c60168cca6f90c1313", - "indices" : [ "identities" ], - "public" : false, - "name" : "Disabled accounts", - "modified" : "2018-06-25T20:22:28.104Z", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "fields" : [ "disabled" ] - } - "@ - - # Updates an existing saved search - - try { - $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-V2025SavedSearch -Id $Id -SavedSearch $Result - - # Below is a request that includes all optional parameters - # Send-V2025SavedSearch -Id $Id -SavedSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#create-scheduled-search - source: | - $CreateScheduledSearchRequest = @" - {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} - "@ - - # Create a new scheduled search - - try { - $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-V2025ScheduledSearch -CreateScheduledSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ScheduledSearch -CreateScheduledSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#delete-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete a Scheduled Search - - try { - Remove-V2025ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#get-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Scheduled Search - - try { - Get-V2025ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#list-scheduled-search - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - - # List scheduled searches - - try { - Get-V2025ScheduledSearch - - # Below is a request that includes all optional parameters - # Get-V2025ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id}/unsubscribe - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#unsubscribe-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $TypedReference = @" - { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - "@ - - # Unsubscribe a recipient from Scheduled Search - - try { - $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-V2025UnsubscribeScheduledSearch -Id $Id -TypedReference $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025UnsubscribeScheduledSearch -Id $Id -TypedReference $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025UnsubscribeScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#update-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $ScheduledSearch = @" - { - "owner" : { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "displayQueryDetails" : false, - "created" : "", - "description" : "Daily disabled accounts", - "ownerId" : "2c9180867624cbd7017642d8c8c81f67", - "enabled" : false, - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "recipients" : [ { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - } ], - "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", - "name" : "Daily disabled accounts", - "modified" : "", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "emailEmptyResults" : false - } - "@ - - # Update an existing Scheduled Search - - try { - $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-V2025ScheduledSearch -Id $Id -ScheduledSearch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ScheduledSearch -Id $Id -ScheduledSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /search/aggregate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search#search-aggregate - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Perform a Search Query Aggregation - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2025Aggregate -Search $Result - - # Below is a request that includes all optional parameters - # Search-V2025Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Aggregate" - Write-Host $_.ErrorDetails - } -- path: /search/count - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search#search-count - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - - # Count Documents Satisfying a Query - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2025Count -Search $Result - - # Below is a request that includes all optional parameters - # Search-V2025Count -Search $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Count" - Write-Host $_.ErrorDetails - } -- path: /search/{index}/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search#search-get - source: | - $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Document by ID - - try { - Search-V2025Get -Index $Index -Id $Id - - # Below is a request that includes all optional parameters - # Search-V2025Get -Index $Index -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Get" - Write-Host $_.ErrorDetails - } -- path: /search - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search#search-post - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Perform Search - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2025Post -Search $Result - - # Below is a request that includes all optional parameters - # Search-V2025Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Post" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#create-search-attribute-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ - - # Create Extended Search Attributes - - try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#delete-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Extended Search Attribute - - try { - Remove-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#get-search-attribute-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Extended Search Attributes - - try { - Get-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Extended Search Attribute - - try { - Get-V2025SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SingleSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#patch-search-attribute-config - source: | - $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Extended Search Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#create-segment - source: | - $Segment = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-V2025Segment -Segment $Result - - # Below is a request that includes all optional parameters - # New-V2025Segment -Segment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Segment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-V2025Segment -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Segment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-V2025Segment -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Segment" - Write-Host $_.ErrorDetails - } -- path: /segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#list-segments - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Segments - - try { - Get-V2025Segments - - # Below is a request that includes all optional parameters - # Get-V2025Segments -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Segments" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/segments#patch-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2025Segment -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2025Segment -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Segment" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#create-service-desk-integration - source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ - - # Create new Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-V2025ServiceDeskIntegration -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-V2025ServiceDeskIntegration -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#delete-service-desk-integration - source: | - $Id = "anId" # String | ID of Service Desk integration to delete - - # Delete a Service Desk integration - - try { - Remove-V2025ServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to get - - # Get a Service Desk integration - - try { - Get-V2025ServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - - # Service Desk integration template by scriptName - - try { - Get-V2025ServiceDeskIntegrationTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-V2025ServiceDeskIntegrationTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegrationTemplate" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration-types - source: | - - # List Service Desk integration types - - try { - Get-V2025ServiceDeskIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-V2025ServiceDeskIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegrationTypes" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integrations - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List existing Service Desk integrations - - try { - Get-V2025ServiceDeskIntegrations - - # Below is a request that includes all optional parameters - # Get-V2025ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegrations" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-status-check-details - source: | - - # Get the time check configuration - - try { - Get-V2025StatusCheckDetails - - # Below is a request that includes all optional parameters - # Get-V2025StatusCheckDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#patch-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - - "@ - - # Patch a Service Desk Integration - - try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2025ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#put-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ - - # Update a Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-V2025ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # Send-V2025ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#update-status-check-details - source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ - - # Update the time check configuration - - try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-V2025StatusCheckDetails -QueuedCheckConfigDetails $Result - - # Below is a request that includes all optional parameters - # Update-V2025StatusCheckDetails -QueuedCheckConfigDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025StatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-V2025StatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025StatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-V2025UsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#create-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - $ProvisioningPolicyDto = @" - { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } - "@ - - # Create Provisioning Policy - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-V2025ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # New-V2025ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source - source: | - $Source = @" - { - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - } - "@ - $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) - - # Creates a source in IdentityNow. - - try { - $Result = ConvertFrom-JsonToSource -Json $Source - New-V2025Source -Source $Result - - # Below is a request that includes all optional parameters - # New-V2025Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schedules - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Schedule1 = @" - - "@ - - # Create Schedule on Source - - try { - $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 - New-V2025SourceSchedule -SourceId $SourceId -Schedule1 $Result - - # Below is a request that includes all optional parameters - # New-V2025SourceSchedule -SourceId $SourceId -Schedule1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceSchedule" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Schema = @" - { - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" - } - "@ - - # Create Schema on Source - - try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - New-V2025SourceSchema -SourceId $SourceId -Schema $Result - - # Below is a request that includes all optional parameters - # New-V2025SourceSchema -SourceId $SourceId -Schema $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/remove-accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-accounts-async - source: | - $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Remove All Accounts in a Source - - try { - Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccountsAsync" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/native-change-detection-config - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-native-change-detection-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Native Change Detection Configuration - - try { - Remove-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - - # Delete Provisioning Policy by UsageType - - try { - Remove-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - - # Below is a request that includes all optional parameters - # Remove-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Delete Source by ID - - try { - Remove-V2025Source -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Source -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schedules/{scheduleType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - - # Delete Source Schedule by type. - - try { - Remove-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - - # Below is a request that includes all optional parameters - # Remove-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceSchedule" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - - # Delete Source Schema by ID - - try { - Remove-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Remove-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/schemas/accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-accounts-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - - # Downloads source accounts schema template - - try { - Get-V2025AccountsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025AccountsSchema -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/correlation-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-correlation-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - - # Get Source Correlation Configuration - - try { - Get-V2025CorrelationConfig -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025CorrelationConfig -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CorrelationConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/schemas/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-entitlements-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) - - # Downloads source entitlements schema template - - try { - Get-V2025EntitlementsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025EntitlementsSchema -Id $Id -SchemaName $SchemaName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/native-change-detection-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-native-change-detection-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Native Change Detection Configuration - - try { - Get-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - - # Get Provisioning Policy by UsageType - - try { - Get-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - - # Below is a request that includes all optional parameters - # Get-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Get Source by ID - - try { - Get-V2025Source -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Source -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/attribute-sync-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-attr-sync-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Attribute Sync Config - - try { - Get-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceAttrSyncConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/connectors/source-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-config - source: | - $Id = "cef3ee201db947c5912551015ba0c679" # String | The Source id - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Gets source config with language-translations - - try { - Get-V2025SourceConfig -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SourceConfig -Id $Id -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connections - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-connections - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Get Source Connections by ID - - try { - Get-V2025SourceConnections -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025SourceConnections -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceConnections" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/entitlement-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-entitlement-request-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Source Entitlement Request Configuration - - try { - Get-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/source-health - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-health - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - - # Fetches source health by id - - try { - Get-V2025SourceHealth -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025SourceHealth -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceHealth" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schedules/{scheduleType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - - # Get Source Schedule by Type - - try { - Get-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - - # Below is a request that includes all optional parameters - # Get-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchedule" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schedules - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schedules - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # List Schedules on Source - - try { - Get-V2025SourceSchedules -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025SourceSchedules -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchedules" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - - # Get Source Schema by ID - - try { - Get-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Get-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schemas - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) - $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) - - # List Schemas on Source - - try { - Get-V2025SourceSchemas -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchemas" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/load-accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-accounts - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) - $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) - - # Account Aggregation - - try { - Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025Accounts" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/schemas/accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-accounts-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $File = # System.IO.FileInfo | (optional) - - # Uploads source accounts schema template - - try { - Import-V2025AccountsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Import-V2025AccountsSchema -Id $Id -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025AccountsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/upload-connector-file - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-connector-file - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $File = # System.IO.FileInfo | (optional) - - # Upload connector file to source - - try { - Import-V2025ConnectorFile -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Import-V2025ConnectorFile -SourceId $SourceId -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025ConnectorFile" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/schemas/entitlements - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-entitlements-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) - $File = # System.IO.FileInfo | (optional) - - # Uploads source entitlements schema template - - try { - Import-V2025EntitlementsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Import-V2025EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/load-uncorrelated-accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#import-uncorrelated-accounts - source: | - $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $File = # System.IO.FileInfo | (optional) - - # Process Uncorrelated Accounts - - try { - Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025UncorrelatedAccounts" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#list-provisioning-policies - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - - # Lists ProvisioningPolicies - - try { - Get-V2025ProvisioningPolicies -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025ProvisioningPolicies -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProvisioningPolicies" - Write-Host $_.ErrorDetails - } -- path: /sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#list-sources - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) - $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) - $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) - - # Lists all sources in IdentityNow. - - try { - Get-V2025Sources - - # Below is a request that includes all optional parameters - # Get-V2025Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Sources" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connector/ping-cluster - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#ping-cluster - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - - # Ping cluster for source connector - - try { - Ping-V2025Cluster -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Ping-V2025Cluster -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2025Cluster" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/correlation-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-correlation-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $CorrelationConfig = @" - { - "attributeAssignments" : [ { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - }, { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - } ], - "name" : "Source [source] Account Correlation", - "id" : "2c9180835d191a86015d28455b4a2329" - } - "@ - - # Update Source Correlation Configuration - - try { - $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig - Send-V2025CorrelationConfig -Id $Id -CorrelationConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025CorrelationConfig -Id $Id -CorrelationConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025CorrelationConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/native-change-detection-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-native-change-detection-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $NativeChangeDetectionConfig = @" - { - "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], - "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], - "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], - "allNonEntitlementAttributes" : false, - "allEntitlements" : false, - "enabled" : true - } - "@ - - # Update Native Change Detection Configuration - - try { - $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig - Send-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025NativeChangeDetectionConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $ProvisioningPolicyDto = @" - { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } - "@ - - # Update Provisioning Policy by UsageType - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Send-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Source = @" - { - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - } - "@ - - # Update Source (Full) - - try { - $Result = ConvertFrom-JsonToSource -Json $Source - Send-V2025Source -Id $Id -Source $Result - - # Below is a request that includes all optional parameters - # Send-V2025Source -Id $Id -Source $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/attribute-sync-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source-attr-sync-config - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AttrSyncSourceConfig = @" - { - "attributes" : [ { - "name" : "email", - "displayName" : "Email", - "enabled" : true, - "target" : "mail" - }, { - "name" : "firstname", - "displayName" : "First Name", - "enabled" : false, - "target" : "givenName" - } ], - "source" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - } - } - "@ - - # Update Attribute Sync Config - - try { - $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig - Send-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result - - # Below is a request that includes all optional parameters - # Send-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SourceAttrSyncConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $Schema = @" - { - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" - } - "@ - - # Update Source Schema (Full) - - try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result - - # Below is a request that includes all optional parameters - # Send-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connector/peek-resource-objects - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#search-resource-objects - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - $ResourceObjectsRequest = @" - { - "maxCount" : 100, - "objectType" : "group" - } - "@ - - # Peek source connector's resource objects - - try { - $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest - Search-V2025ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result - - # Below is a request that includes all optional parameters - # Search-V2025ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025ResourceObjects" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/synchronize-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#sync-attributes-for-source - source: | - $Id = "MyId" # String | The Source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Synchronize single source attributes. - - try { - Sync-V2025AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Sync-V2025AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025AttributesForSource" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connector/test-configuration - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#test-source-configuration - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - - # Test configuration for source connector - - try { - Test-V2025SourceConfiguration -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-V2025SourceConfiguration -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConfiguration" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connector/check-connection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#test-source-connection - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. - - # Check connection for source connector. - - try { - Test-V2025SourceConnection -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-V2025SourceConnection -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConnection" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/password-policies - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-password-policy-holders - source: | - $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $PasswordPolicyHoldersDtoInner = @""@ - - - # Update Password Policy - - try { - $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner - Update-V2025PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PasswordPolicyHolders" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-provisioning-policies-in-bulk - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ProvisioningPolicyDto = @"{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - }"@ - - - # Bulk Update Provisioning Policies - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-V2025ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Update-V2025ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProvisioningPoliciesInBulk" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Partial update of Provisioning Policy - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Source -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Source -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/entitlement-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-entitlement-request-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceEntitlementRequestConfig = @" - { - "accessRequestConfig" : { - "denialCommentRequired" : false, - "approvalSchemes" : [ { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - } ], - "requestCommentRequired" : true - } - } - "@ - - # Update Source Entitlement Request Configuration - - try { - $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Update-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schedules/{scheduleType} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source Schedule (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchedule" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source Schema (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-batches/{batchId}/stats - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#get-sed-batch-stats - source: | - $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id - - # Submit Sed Batch Stats Request - - try { - Get-V2025SedBatchStats -BatchId $BatchId - - # Below is a request that includes all optional parameters - # Get-V2025SedBatchStats -BatchId $BatchId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SedBatchStats" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-batches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#get-sed-batches - source: | - - # List Sed Batch Request - - try { - Get-V2025SedBatches - - # Below is a request that includes all optional parameters - # Get-V2025SedBatches - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SedBatches" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-descriptions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#list-seds - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) - $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) - $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) - $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) - $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) - - # List Suggested Entitlement Descriptions - - try { - Get-V2025Seds - - # Below is a request that includes all optional parameters - # Get-V2025Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Seds" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-descriptions - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#patch-sed - source: | - $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id - $SedPatch = @"{ - "op" : "replace", - "path" : "status", - "value" : "approved" - }"@ - - - # Patch Suggested Entitlement Description - - try { - $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-V2025Sed -Id $Id -SedPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025Sed -Id $Id -SedPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Sed" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-approvals - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-approval - source: | - $SedApproval = @"{ - "items" : "016629d1-1d25-463f-97f3-c6686846650" - }"@ - - - # Submit Bulk Approval Request - - try { - $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-V2025SedApproval -SedApproval $Result - - # Below is a request that includes all optional parameters - # Submit-V2025SedApproval -SedApproval $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedApproval" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-assignments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-assignment - source: | - $SedAssignment = @" - { - "assignee" : { - "type" : "SOURCE_OWNER", - "value" : "016629d1-1d25-463f-97f3-c6686846650" - }, - "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] - } - "@ - - # Submit Sed Assignment Request - - try { - $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-V2025SedAssignment -SedAssignment $Result - - # Below is a request that includes all optional parameters - # Submit-V2025SedAssignment -SedAssignment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedAssignment" - Write-Host $_.ErrorDetails - } -- path: /suggested-entitlement-description-batches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-batch-request - source: | - $SedBatchRequest = @" - { - "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] - } - "@ - - # Submit Sed Batch Request - - try { - Submit-V2025SedBatchRequest - - # Below is a request that includes all optional parameters - # Submit-V2025SedBatchRequest -SedBatchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedBatchRequest" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type}/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#delete-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. - - # Delete Object Tags - - try { - Remove-V2025TaggedObject -Type $Type -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025TaggedObject -Type $Type -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TaggedObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/bulk-remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#delete-tags-to-many-object - source: | - $BulkRemoveTaggedObject = @" - { - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Remove Tags from Multiple Objects - - try { - $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject - Remove-V2025TagsToManyObject -BulkRemoveTaggedObject $Result - - # Below is a request that includes all optional parameters - # Remove-V2025TagsToManyObject -BulkRemoveTaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TagsToManyObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type}/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#get-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - - # Get Tagged Object - - try { - Get-V2025TaggedObject -Type $Type -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025TaggedObject -Type $Type -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#list-tagged-objects - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) - - # List Tagged Objects - - try { - Get-V2025TaggedObjects - - # Below is a request that includes all optional parameters - # Get-V2025TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObjects" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#list-tagged-objects-by-type - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) - - # List Tagged Objects by Type - - try { - Get-V2025TaggedObjectsByType -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObjectsByType" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type}/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#put-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. - $TaggedObject = @" - { - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Update Tagged Object - - try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-V2025TaggedObject -Type $Type -Id $Id -TaggedObject $Result - - # Below is a request that includes all optional parameters - # Send-V2025TaggedObject -Type $Type -Id $Id -TaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TaggedObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#set-tag-to-object - source: | - $TaggedObject = @" - { - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Add Tag to Object - - try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-V2025TagToObject -TaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-V2025TagToObject -TaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TagToObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/bulk-add - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#set-tags-to-many-objects - source: | - $BulkAddTaggedObject = @" - { - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "operation" : "MERGE", - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Tag Multiple Objects - - try { - $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject - Set-V2025TagsToManyObjects -BulkAddTaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-V2025TagsToManyObjects -BulkAddTaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TagsToManyObjects" - Write-Host $_.ErrorDetails - } -- path: /task-status/pending-tasks - method: HEAD - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-pending-task-headers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieve Pending Task List Headers - - try { - Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTaskHeaders" - Write-Host $_.ErrorDetails - } -- path: /task-status/pending-tasks - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-pending-tasks - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Retrieve Pending Task Status List - - try { - Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTasks" - Write-Host $_.ErrorDetails - } -- path: /task-status/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-task-status - source: | - $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Task Status by ID - - try { - Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatus" - Write-Host $_.ErrorDetails - } -- path: /task-status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-task-status-list - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "completionStatus eq "Success"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) - $Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) - - # Retrieve Task Status List - - try { - Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatusList" - Write-Host $_.ErrorDetails - } -- path: /task-status/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/task-management#update-task-status - source: | - $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Task Status by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025TaskStatus" - Write-Host $_.ErrorDetails - } -- path: /tenant - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tenant#get-tenant - source: | - - # Get Tenant Information. - - try { - Get-V2025Tenant - - # Below is a request that includes all optional parameters - # Get-V2025Tenant - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Tenant" - Write-Host $_.ErrorDetails - } -- path: /tenant-context - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tenant-context#get-tenant-context - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Retrieve tenant context - - try { - Get-V2025TenantContext -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TenantContext -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantContext" - Write-Host $_.ErrorDetails - } -- path: /tenant-context - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/tenant-context#patch-tenant-context - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatchOperation = @" - { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } - "@ - - # Update tenant context - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025TenantContext" - Write-Host $_.ErrorDetails - } -- path: /transforms - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#create-transform - source: | - $Transform = @" - { - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" - } - "@ - - # Create transform - - try { - $Result = ConvertFrom-JsonToTransform -Json $Transform - New-V2025Transform -Transform $Result - - # Below is a request that includes all optional parameters - # New-V2025Transform -Transform $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Transform" - Write-Host $_.ErrorDetails - } -- path: /transforms/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#delete-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete - - # Delete a transform - - try { - Remove-V2025Transform -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Transform -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Transform" - Write-Host $_.ErrorDetails - } -- path: /transforms/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#get-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve - - # Transform by ID - - try { - Get-V2025Transform -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Transform -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Transform" - Write-Host $_.ErrorDetails - } -- path: /transforms - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#list-transforms - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) - $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) - - # List transforms - - try { - Get-V2025Transforms - - # Below is a request that includes all optional parameters - # Get-V2025Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Transforms" - Write-Host $_.ErrorDetails - } -- path: /transforms/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/transforms#update-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update - $Transform = @" - { - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" - } - "@ - - # Update a transform - - try { - Update-V2025Transform -Id $Id - - # Below is a request that includes all optional parameters - # Update-V2025Transform -Id $Id -Transform $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Transform" - Write-Host $_.ErrorDetails - } -- path: /trigger-invocations/{id}/complete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#complete-trigger-invocation - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $CompleteInvocation = @" - { - "output" : { - "approved" : false - }, - "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "error" : "Access request is denied." - } - "@ - - # Complete Trigger Invocation - - try { - $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation - Complete-V2025TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result - - # Below is a request that includes all optional parameters - # Complete-V2025TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025TriggerInvocation" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#create-subscription - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SubscriptionPostRequest = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "triggerId" : "idn:access-requested", - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - } - "@ - - # Create a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest - New-V2025Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Subscription" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#delete-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a Subscription - - try { - Remove-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Subscription" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-subscriptions - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) - $Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) - - # List Subscriptions - - try { - Get-V2025Subscriptions -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Subscriptions -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Subscriptions" - Write-Host $_.ErrorDetails - } -- path: /trigger-invocations/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-trigger-invocation-status - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "triggerId eq "idn:access-request-dynamic-approver"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) - - # List Latest Invocation Statuses - - try { - Get-V2025TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TriggerInvocationStatus" - Write-Host $_.ErrorDetails - } -- path: /triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-triggers - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "idn:access-request-post-approval"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) - - # List Triggers - - try { - Get-V2025Triggers -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025Triggers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Triggers" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#patch-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SubscriptionPatchRequestInner = @""@ - - - # Patch a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner - Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Subscription" - Write-Host $_.ErrorDetails - } -- path: /trigger-invocations/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#start-test-trigger-invocation - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TestInvocation = @" - { - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - }, - "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], - "triggerId" : "idn:access-request-post-approval", - "contentJson" : { - "workflowId" : 1234 - } - } - "@ - - # Start a Test Invocation - - try { - $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation - Start-V2025TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result - - # Below is a request that includes all optional parameters - # Start-V2025TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025TestTriggerInvocation" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions/validate-filter - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#test-subscription-filter - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ValidateFilterInputDto = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - } - } - "@ - - # Validate a Subscription Filter - - try { - $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto - Test-V2025SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result - - # Below is a request that includes all optional parameters - # Test-V2025SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SubscriptionFilter" - Write-Host $_.ErrorDetails - } -- path: /trigger-subscriptions/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/triggers#update-subscription - source: | - $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SubscriptionPutRequest = @" - { - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true - } - "@ - - # Update a Subscription - - try { - $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest - Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result - - # Below is a request that includes all optional parameters - # Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Subscription" - Write-Host $_.ErrorDetails - } -- path: /ui-metadata/tenant - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/ui-metadata#get-tenant-ui-metadata - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a tenant UI metadata - - try { - Get-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantUiMetadata" - Write-Host $_.ErrorDetails - } -- path: /ui-metadata/tenant - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/ui-metadata#set-tenant-ui-metadata - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TenantUiMetadataItemUpdateRequest = @" - { - "usernameEmptyText" : "Please provide your work email address...", - "usernameLabel" : "Email", - "iframeWhiteList" : "http://example.com http://example2.com" - } - "@ - - # Update tenant UI metadata - - try { - $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest - Set-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result - - # Below is a request that includes all optional parameters - # Set-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TenantUiMetadata" - Write-Host $_.ErrorDetails - } -- path: /vendor-connector-mappings - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#create-vendor-connector-mapping - source: | - $VendorConnectorMapping = @" - { - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - } - "@ - - # Create Vendor Connector Mapping - - try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-V2025VendorConnectorMapping -VendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # New-V2025VendorConnectorMapping -VendorConnectorMapping $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025VendorConnectorMapping" - Write-Host $_.ErrorDetails - } -- path: /vendor-connector-mappings - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#delete-vendor-connector-mapping - source: | - $VendorConnectorMapping = @" - { - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - } - "@ - - # Delete Vendor Connector Mapping - - try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-V2025VendorConnectorMapping -VendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # Remove-V2025VendorConnectorMapping -VendorConnectorMapping $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025VendorConnectorMapping" - Write-Host $_.ErrorDetails - } -- path: /vendor-connector-mappings - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#get-vendor-connector-mappings - source: | - - # List Vendor Connector Mappings - - try { - Get-V2025VendorConnectorMappings - - # Below is a request that includes all optional parameters - # Get-V2025VendorConnectorMappings - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025VendorConnectorMappings" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#approve-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Approve an Approval Item - - try { - Approve-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Approve-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#approve-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk approve Approval Items - - try { - Approve-V2025ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Approve-V2025ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#complete-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) - - # Complete a Work Item - - try { - Complete-V2025WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Complete-V2025WorkItem -Id $Id -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#forward-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ - - # Forward a Work Item - - try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-V2025ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result - - # Below is a request that includes all optional parameters - # Invoke-V2025ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ForwardWorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Completed Work Items - - try { - Get-V2025CompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-V2025CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-count-completed-work-items - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - - # Count Completed Work Items - - try { - Get-V2025CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CountCompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-count-work-items - source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - - # Count Work Items - - try { - Get-V2025CountWorkItems - - # Below is a request that includes all optional parameters - # Get-V2025CountWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CountWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-work-item - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - - # Get a Work Item - - try { - Get-V2025WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkItem -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-work-items-summary - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Work Items Summary - - try { - Get-V2025WorkItemsSummary - - # Below is a request that includes all optional parameters - # Get-V2025WorkItemsSummary -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItemsSummary" - Write-Host $_.ErrorDetails - } -- path: /work-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#list-work-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # List Work Items - - try { - Get-V2025WorkItems - - # Below is a request that includes all optional parameters - # Get-V2025WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#reject-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Reject an Approval Item - - try { - Deny-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Deny-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#reject-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk reject Approval Items - - try { - Deny-V2025ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Deny-V2025ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-items#submit-account-selection - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - - # Submit Account Selections - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-V2025AccountSelection -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Submit-V2025AccountSelection -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025AccountSelection" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#create-reassignment-configuration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - - # Create a Reassignment Configuration - - try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-V2025ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId}/{configType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#delete-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Reassignment Configuration - - try { - Remove-V2025ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId}/evaluate/{configType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-evaluate-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - - $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ - - # Evaluate Reassignment Configuration - - try { - Get-V2025EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EvaluateReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-reassignment-config-types - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Reassignment Config Types - - try { - Get-V2025ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfigTypes" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Reassignment Configuration - - try { - Get-V2025ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/tenant-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-tenant-config-configuration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Tenant-wide Reassignment Configuration settings - - try { - Get-V2025TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantConfigConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#list-reassignment-configurations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List Reassignment Configurations - - try { - Get-V2025ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfigurations" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#put-reassignment-config - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - - # Update Reassignment Configuration - - try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-V2025ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2025ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ReassignmentConfig" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/tenant-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#put-tenant-configuration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TenantConfigurationRequest = @" - { - "configDetails" : { - "disabled" : true - } - } - "@ - - # Update Tenant-wide Reassignment Configuration settings - - try { - $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-V2025TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2025TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TenantConfiguration" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2025Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2025WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2025WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2025WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-V2025CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-V2025WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2025WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-V2025WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2025Workflows - - # Below is a request that includes all optional parameters - # Get-V2025Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2025Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2025Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" - Write-Host $_.ErrorDetails - } diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index 17fd1c924..139597f9c 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -1,10229 +1,2 @@ -- path: /access-profiles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-profiles#create-access-profile - source: | - $AccessProfile = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "description" : "Collection of entitlements to read/write the employee database", - "source" : { - "name" : "ODS-AD-SOURCE", - "id" : "2c91809773dee3610173fdb0b6061ef4", - "type" : "SOURCE" - }, - "enabled" : true, - "revocationRequestConfig" : { - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ] - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "accessRequestConfig" : { - "commentsRequired" : true, - "reauthorizationRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "name" : "Employee-database-read-write", - "provisioningCriteria" : { - "children" : [ { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, - "modified" : "2021-03-02T20:22:28.104Z", - "id" : "2c91808a7190d06e01719938fcd20792", - "requestable" : true - } - "@ - - # Create Access Profile - - try { - $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile - New-AccessProfile -AccessProfile $Result - - # Below is a request that includes all optional parameters - # New-AccessProfile -AccessProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-profiles#delete-access-profile - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete - - # Delete the specified Access Profile - - try { - Remove-AccessProfile -Id $Id - - # Below is a request that includes all optional parameters - # Remove-AccessProfile -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-profiles#delete-access-profiles-in-bulk - source: | - $AccessProfileBulkDeleteRequest = @" - { - "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], - "bestEffortOnly" : true - } - "@ - - # Delete Access Profile(s) - - try { - $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest - Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfilesInBulk" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-profiles#get-access-profile - source: | - $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile - - # Get an Access Profile - - try { - Get-AccessProfile -Id $Id - - # Below is a request that includes all optional parameters - # Get-AccessProfile -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-profiles#get-access-profile-entitlements - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - - # List Access Profile's Entitlements - - try { - Get-AccessProfileEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfileEntitlements" - Write-Host $_.ErrorDetails - } -- path: /access-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-profiles#list-access-profiles - source: | - $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) - - # List Access Profiles - - try { - Get-AccessProfiles - - # Below is a request that includes all optional parameters - # Get-AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfiles" - Write-Host $_.ErrorDetails - } -- path: /access-profiles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-profiles#patch-access-profile - source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Access Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-AccessProfile -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-AccessProfile -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessProfile" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{approvalId}/approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#approve-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $CommentDto = @" - { - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - } - "@ - - # Approve Access Request Approval - - try { - Approve-AccessRequest -ApprovalId $ApprovalId - - # Below is a request that includes all optional parameters - # Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{approvalId}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#forward-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $ForwardApprovalDto = @" - { - "newOwnerId" : "2c91808568c529c60168cca6f90c1314", - "comment" : "2c91808568c529c60168cca6f90c1313" - } - "@ - - # Forward Access Request Approval - - try { - $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto - Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result - - # Below is a request that includes all optional parameters - # Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ForwardAccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/approval-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#get-access-request-approval-summary - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) - - # Get Access Requests Approvals Number - - try { - Get-AccessRequestApprovalSummary - - # Below is a request that includes all optional parameters - # Get-AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestApprovalSummary" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#list-completed-approvals - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Completed Access Request Approvals List - - try { - Get-CompletedApprovals - - # Below is a request that includes all optional parameters - # Get-CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedApprovals" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/pending - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#list-pending-approvals - source: | - $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) - $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Pending Access Request Approvals List - - try { - Get-PendingApprovals - - # Below is a request that includes all optional parameters - # Get-PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingApprovals" - Write-Host $_.ErrorDetails - } -- path: /access-request-approvals/{approvalId}/reject - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#reject-access-request - source: | - $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. - $CommentDto = @" - { - "created" : "2017-07-11T18:45:37.098Z", - "author" : { - "name" : "john.doe", - "id" : "2c9180847e25f377017e2ae8cae4650b", - "type" : "IDENTITY" - }, - "comment" : "This is a comment." - } - "@ - - # Reject Access Request Approval - - try { - $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - - # Below is a request that includes all optional parameters - # Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-requests/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-requests#cancel-access-request - source: | - $CancelAccessRequest = @" - { - "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I requested this role by mistake." - } - "@ - - # Cancel Access Request - - try { - $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest - Suspend-AccessRequest -CancelAccessRequest $Result - - # Below is a request that includes all optional parameters - # Suspend-AccessRequest -CancelAccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-requests#create-access-request - source: | - $AccessRequest = @" - { - "requestedFor" : "2c918084660f45d6016617daa9210584", - "clientMetadata" : { - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", - "requestedAppName" : "test-app" - }, - "requestType" : "GRANT_ACCESS", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ], - "requestedForWithRequestedItems" : [ { - "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ] - }, { - "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "accountSelection" : [ { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - }, { - "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", - "accounts" : [ { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - }, { - "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", - "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" - } ] - } ], - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" - } ] - } ] - } - "@ - - # Submit Access Request - - try { - $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest - New-AccessRequest -AccessRequest $Result - - # Below is a request that includes all optional parameters - # New-AccessRequest -AccessRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessRequest" - Write-Host $_.ErrorDetails - } -- path: /access-request-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-requests#get-access-request-config - source: | - - # Get Access Request Configuration - - try { - Get-AccessRequestConfig - - # Below is a request that includes all optional parameters - # Get-AccessRequestConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /access-request-status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-requests#list-access-request-status - source: | - $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) - $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) - $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) - $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) - $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - - # Access Request Status - - try { - Get-AccessRequestStatus - - # Below is a request that includes all optional parameters - # Get-AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestStatus" - Write-Host $_.ErrorDetails - } -- path: /access-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/access-requests#set-access-request-config - source: | - $AccessRequestConfig = @" - { - "requestOnBehalfOfConfig" : { - "allowRequestOnBehalfOfEmployeeByManager" : true, - "allowRequestOnBehalfOfAnyoneByAnyone" : true - }, - "approvalReminderAndEscalationConfig" : { - "fallbackApproverRef" : { - "name" : "Alison Ferguso", - "id" : "5168015d32f890ca15812c9180835d2e", - "type" : "IDENTITY", - "email" : "alison.ferguso@identitysoon.com" - }, - "maxReminders" : 1, - "daysUntilEscalation" : 0, - "daysBetweenReminders" : 0 - }, - "autoApprovalEnabled" : true, - "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - }, - "reauthorizationEnabled" : true, - "approvalsMustBeExternal" : true - } - "@ - - # Update Access Request Configuration - - try { - $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig - Set-AccessRequestConfig -AccessRequestConfig $Result - - # Below is a request that includes all optional parameters - # Set-AccessRequestConfig -AccessRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-AccessRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /account-activities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/account-activities#get-account-activity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id - - # Get an Account Activity - - try { - Get-AccountActivity -Id $Id - - # Below is a request that includes all optional parameters - # Get-AccountActivity -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivity" - Write-Host $_.ErrorDetails - } -- path: /account-activities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/account-activities#list-account-activities - source: | - $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) - $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) - - # List Account Activities - - try { - Get-AccountActivities - - # Below is a request that includes all optional parameters - # Get-AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" - Write-Host $_.ErrorDetails - } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" - Write-Host $_.ErrorDetails - } -- path: /accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/accounts#create-account - source: | - $AccountAttributesCreate = @" - { - "attributes" : { - "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - } - "@ - - # Create Account - - try { - $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate - New-Account -AccountAttributesCreate $Result - - # Below is a request that includes all optional parameters - # New-Account -AccountAttributesCreate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/accounts#delete-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - - # Delete Account - - try { - Remove-Account -Id $Id - - # Below is a request that includes all optional parameters - # Remove-Account -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/disable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/accounts#disable-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $AccountToggleRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } - "@ - - # Disable Account - - try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Disable-Account -Id $Id -AccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Disable-Account -Id $Id -AccountToggleRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/enable - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/accounts#enable-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $AccountToggleRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } - "@ - - # Enable Account - - try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Enable-Account -Id $Id -AccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Enable-Account -Id $Id -AccountToggleRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/accounts#get-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - - # Account Details - - try { - Get-Account -Id $Id - - # Below is a request that includes all optional parameters - # Get-Account -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/accounts#get-account-entitlements - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Account Entitlements - - try { - Get-AccountEntitlements -Id $Id - - # Below is a request that includes all optional parameters - # Get-AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountEntitlements" - Write-Host $_.ErrorDetails - } -- path: /accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/accounts#list-accounts - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) - - # Accounts List - - try { - Get-Accounts - - # Below is a request that includes all optional parameters - # Get-Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Accounts" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/accounts#put-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - $AccountAttributes = @" - { - "attributes" : { - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } - } - "@ - - # Update Account - - try { - $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes - Send-Account -Id $Id -AccountAttributes $Result - - # Below is a request that includes all optional parameters - # Send-Account -Id $Id -AccountAttributes $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/reload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/accounts#submit-reload-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - - # Reload Account - - try { - Submit-ReloadAccount -Id $Id - - # Below is a request that includes all optional parameters - # Submit-ReloadAccount -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReloadAccount" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id}/unlock - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/accounts#unlock-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. - $AccountUnlockRequest = @" - { - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", - "unlockIDNAccount" : false - } - "@ - - # Unlock Account - - try { - $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest - Unlock-Account -Id $Id -AccountUnlockRequest $Result - - # Below is a request that includes all optional parameters - # Unlock-Account -Id $Id -AccountUnlockRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-Account" - Write-Host $_.ErrorDetails - } -- path: /accounts/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/accounts#update-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"[{op=remove, path=/identityId}]"@ - - - # Update Account - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-Account -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-Account -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" - Write-Host $_.ErrorDetails - } -- path: /discovered-applications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/application-discovery#get-discovered-applications - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) - $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) - - # Get Discovered Applications for Tenant - - try { - Get-DiscoveredApplications - - # Below is a request that includes all optional parameters - # Get-DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DiscoveredApplications" - Write-Host $_.ErrorDetails - } -- path: /manual-discover-applications-template - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/application-discovery#get-manual-discover-applications-csv-template - source: | - - # Download CSV Template for Discovery - - try { - Get-ManualDiscoverApplicationsCsvTemplate - - # Below is a request that includes all optional parameters - # Get-ManualDiscoverApplicationsCsvTemplate - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails - } -- path: /manual-discover-applications - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/application-discovery#send-manual-discover-applications-csv-template - source: | - $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - - # Upload CSV to Discover Applications - - try { - Send-ManualDiscoverApplicationsCsvTemplate -File $File - - # Below is a request that includes all optional parameters - # Send-ManualDiscoverApplicationsCsvTemplate -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails - } -- path: /auth-users/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/auth-users#get-auth-user - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - - # Auth User Details - - try { - Get-AuthUser -Id $Id - - # Below is a request that includes all optional parameters - # Get-AuthUser -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthUser" - Write-Host $_.ErrorDetails - } -- path: /auth-users/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/auth-users#patch-auth-user - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Auth User Update - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-AuthUser -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-AuthUser -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthUser" - Write-Host $_.ErrorDetails - } -- path: /brandings - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/branding#create-branding-item - source: | - $Name = "MyName" # String | name of branding item - $ProductName = "MyProductName" # String | product name - $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) - $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) - $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) - $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) - $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) - $FileStandard = # System.IO.FileInfo | png file with logo (optional) - - # Create a branding item - - try { - New-BrandingItem -Name $Name -ProductName $ProductName - - # Below is a request that includes all optional parameters - # New-BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BrandingItem" - Write-Host $_.ErrorDetails - } -- path: /brandings/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/branding#delete-branding - source: | - $Name = "default" # String | The name of the branding item to be deleted - - # Delete a branding item - - try { - Remove-Branding -Name $Name - - # Below is a request that includes all optional parameters - # Remove-Branding -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Branding" - Write-Host $_.ErrorDetails - } -- path: /brandings/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/branding#get-branding - source: | - $Name = "default" # String | The name of the branding item to be retrieved - - # Get a branding item - - try { - Get-Branding -Name $Name - - # Below is a request that includes all optional parameters - # Get-Branding -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Branding" - Write-Host $_.ErrorDetails - } -- path: /brandings - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/branding#get-branding-list - source: | - - # List of branding items - - try { - Get-BrandingList - - # Below is a request that includes all optional parameters - # Get-BrandingList - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BrandingList" - Write-Host $_.ErrorDetails - } -- path: /brandings/{name} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/branding#set-branding-item - source: | - $Name = "default" # String | The name of the branding item to be retrieved - $Name2 = "Name_example" # String | name of branding item - $ProductName = "MyProductName" # String | product name - $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) - $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) - $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) - $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) - $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) - $FileStandard = # System.IO.FileInfo | png file with logo (optional) - - # Update a branding item - - try { - Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName - - # Below is a request that includes all optional parameters - # Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BrandingItem" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#create-campaign-filter - source: | - $CampaignFilterDetails = @" - { - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - } - "@ - - # Create Campaign Filter - - try { - $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - New-CampaignFilter -CampaignFilterDetails $Result - - # Below is a request that includes all optional parameters - # New-CampaignFilter -CampaignFilterDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignFilter" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters/delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#delete-campaign-filters - source: | - $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. - $RequestBody = @""@ - - - # Deletes Campaign Filters - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-CampaignFilters -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-CampaignFilters -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignFilters" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#get-campaign-filter-by-id - source: | - $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. - - # Get Campaign Filter by ID - - try { - Get-CampaignFilterById -Id $Id - - # Below is a request that includes all optional parameters - # Get-CampaignFilterById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilterById" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#list-campaign-filters - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) - - # List Campaign Filters - - try { - Get-CampaignFilters - - # Below is a request that includes all optional parameters - # Get-CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilters" - Write-Host $_.ErrorDetails - } -- path: /campaign-filters/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#update-campaign-filter - source: | - $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. - $CampaignFilterDetails = @" - { - "owner" : "SailPoint Support", - "mode" : "INCLUSION", - "isSystemFilter" : false, - "name" : "Identity Attribute Campaign Filter", - "description" : "Campaign filter to certify data based on an identity attribute's specified property.", - "id" : "5ec18cef39020d6fd7a60ad3970aba61", - "criteriaList" : [ { - "type" : "IDENTITY_ATTRIBUTE", - "property" : "displayName", - "value" : "support", - "operation" : "CONTAINS", - "negateResult" : false, - "shortCircuit" : false, - "recordChildMatches" : false, - "suppressMatchedItems" : false - } ] - } - "@ - - # Updates a Campaign Filter - - try { - $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result - - # Below is a request that includes all optional parameters - # Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignFilter" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/complete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#complete-campaign - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. - $CampaignCompleteOptions = @" - { - "autoCompleteAction" : "REVOKE" - } - "@ - - # Complete a Campaign - - try { - Complete-Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Complete-Campaign -Id $Id -CampaignCompleteOptions $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-Campaign" - Write-Host $_.ErrorDetails - } -- path: /campaigns - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#create-campaign - source: | - $Campaign = @" - { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - } - "@ - - # Create a campaign - - try { - $Result = ConvertFrom-JsonToCampaign -Json $Campaign - New-Campaign -Campaign $Result - - # Below is a request that includes all optional parameters - # New-Campaign -Campaign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Campaign" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#create-campaign-template - source: | - $CampaignTemplate = @" - { - "ownerRef" : { - "name" : "Mister Manager", - "id" : "2c918086676d3e0601677611dbde220f", - "type" : "IDENTITY", - "email" : "mr.manager@example.com" - }, - "deadlineDuration" : "P2W", - "created" : "2020-03-05T22:44:00.364Z", - "scheduled" : false, - "name" : "Manager Campaign Template", - "description" : "Template for the annual manager campaign.", - "modified" : "2020-03-05T22:52:09.969Z", - "campaign" : { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - }, - "id" : "2c9079b270a266a60170a277bb960008" - } - "@ - - # Create a Campaign Template - - try { - $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate - New-CampaignTemplate -CampaignTemplate $Result - - # Below is a request that includes all optional parameters - # New-CampaignTemplate -CampaignTemplate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#delete-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. - - # Delete a Campaign Template - - try { - Remove-CampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Remove-CampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#delete-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. - - # Delete Campaign Template Schedule - - try { - Remove-CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-CampaignTemplateSchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } -- path: /campaigns/delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#delete-campaigns - source: | - $CampaignsDeleteRequest = @" - { - "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] - } - "@ - - # Delete Campaigns - - try { - $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest - Remove-Campaigns -CampaignsDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-Campaigns -CampaignsDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Campaigns" - Write-Host $_.ErrorDetails - } -- path: /campaigns - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-active-campaigns - source: | - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) - - # List Campaigns - - try { - Get-ActiveCampaigns - - # Below is a request that includes all optional parameters - # Get-ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ActiveCampaigns" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. - $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - - # Get Campaign - - try { - Get-Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Get-Campaign -Id $Id -Detail $Detail - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Campaign" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/reports - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-reports - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. - - # Get Campaign Reports - - try { - Get-CampaignReports -Id $Id - - # Below is a request that includes all optional parameters - # Get-CampaignReports -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReports" - Write-Host $_.ErrorDetails - } -- path: /campaigns/reports-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-reports-config - source: | - - # Get Campaign Reports Configuration - - try { - Get-CampaignReportsConfig - - # Below is a request that includes all optional parameters - # Get-CampaignReportsConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReportsConfig" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. - - # Get a Campaign Template - - try { - Get-CampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Get-CampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. - - # Get Campaign Template Schedule - - try { - Get-CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-CampaignTemplateSchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-templates - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) - - # List Campaign Templates - - try { - Get-CampaignTemplates - - # Below is a request that includes all optional parameters - # Get-CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplates" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/reassign - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#move - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID - $AdminReviewReassign = @" - { - "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], - "reason" : "reassigned for some reason", - "reassignTo" : { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "IDENTITY" - } - } - "@ - - # Reassign Certifications - - try { - $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign - Move- -Id $Id -AdminReviewReassign $Result - - # Below is a request that includes all optional parameters - # Move- -Id $Id -AdminReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#patch-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update a Campaign Template - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaigns/reports-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#set-campaign-reports-config - source: | - $CampaignReportsConfig = @" - { - "identityAttributeColumns" : [ "firstname", "lastname" ] - } - "@ - - # Set Campaign Reports Configuration - - try { - $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig - Set-CampaignReportsConfig -CampaignReportsConfig $Result - - # Below is a request that includes all optional parameters - # Set-CampaignReportsConfig -CampaignReportsConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignReportsConfig" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#set-campaign-template-schedule - source: | - $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. - $Schedule = @" - { - "hours" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "months" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "timeZoneId" : "CST", - "days" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "expiration" : "2000-01-23T04:56:07.000+00:00", - "type" : "WEEKLY" - } - "@ - - # Set Campaign Template Schedule - - try { - Set-CampaignTemplateSchedule -Id $Id - - # Below is a request that includes all optional parameters - # Set-CampaignTemplateSchedule -Id $Id -Schedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignTemplateSchedule" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/activate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#start-campaign - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. - $ActivateCampaignOptions = @" - { - "timeZone" : "-05:00" - } - "@ - - # Activate a Campaign - - try { - Start-Campaign -Id $Id - - # Below is a request that includes all optional parameters - # Start-Campaign -Id $Id -ActivateCampaignOptions $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Campaign" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/run-remediation-scan - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#start-campaign-remediation-scan - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. - - # Run Campaign Remediation Scan - - try { - Start-CampaignRemediationScan -Id $Id - - # Below is a request that includes all optional parameters - # Start-CampaignRemediationScan -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignRemediationScan" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id}/run-report/{type} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#start-campaign-report - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. - $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. - - # Run Campaign Report - - try { - Start-CampaignReport -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Start-CampaignReport -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignReport" - Write-Host $_.ErrorDetails - } -- path: /campaign-templates/{id}/generate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#start-generate-campaign-template - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. - - # Generate a Campaign from Template - - try { - Start-GenerateCampaignTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Start-GenerateCampaignTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-GenerateCampaignTemplate" - Write-Host $_.ErrorDetails - } -- path: /campaigns/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#update-campaign - source: | - $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update a Campaign - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Campaign -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-Campaign -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" - Write-Host $_.ErrorDetails - } -- path: /certification-tasks/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certifications#get-certification-task - source: | - $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID - - # Certification Task by ID - - try { - Get-CertificationTask -Id $Id - - # Below is a request that includes all optional parameters - # Get-CertificationTask -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationTask" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certifications#get-identity-certification - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id - - # Identity Certification by ID - - try { - Get-IdentityCertification -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentityCertification -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertification" - Write-Host $_.ErrorDetails - } -- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certifications#get-identity-certification-item-permissions - source: | - $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID - $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Permissions for Entitlement Certification Item - - try { - Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId - - # Below is a request that includes all optional parameters - # Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertificationItemPermissions" - Write-Host $_.ErrorDetails - } -- path: /certification-tasks - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certifications#get-pending-certification-tasks - source: | - $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) - - # List of Pending Certification Tasks - - try { - Get-PendingCertificationTasks - - # Below is a request that includes all optional parameters - # Get-PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingCertificationTasks" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/reviewers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certifications#list-certification-reviewers - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) - - # List of Reviewers for certification - - try { - Get-CertificationReviewers -Id $Id - - # Below is a request that includes all optional parameters - # Get-CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationReviewers" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/access-review-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certifications#list-identity-access-review-items - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) - $Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) - $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) - $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) - - # List of Access Review Items - - try { - Get-IdentityAccessReviewItems -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessReviewItems" - Write-Host $_.ErrorDetails - } -- path: /certifications - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certifications#list-identity-certifications - source: | - $ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) - $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) - - # List Identity Campaign Certifications - - try { - Get-IdentityCertifications - - # Below is a request that includes all optional parameters - # Get-IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertifications" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decide - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certifications#make-identity-decision - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions - $ReviewDecision = @"{ - "comments" : "This user no longer needs access to this source", - "decision" : "APPROVE", - "proposedEndDate" : "2017-07-11T18:45:37.098Z", - "recommendation" : { - "reasons" : [ "Reason 1", "Reason 2" ], - "recommendation" : "recommendation", - "timestamp" : "2020-06-01T13:49:37.385Z" - }, - "id" : "ef38f94347e94562b5bb8424a56397d8", - "bulk" : true - }"@ - - - # Decide on a Certification Item - - try { - $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision - Select-IdentityDecision -Id $Id -ReviewDecision $Result - - # Below is a request that includes all optional parameters - # Select-IdentityDecision -Id $Id -ReviewDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-IdentityDecision" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/reassign - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certifications#reassign-identity-certifications - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $ReviewReassign = @" - { - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - } - "@ - - # Reassign Identities or Items - - try { - $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result - - # Below is a request that includes all optional parameters - # Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ReassignIdentityCertifications" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/sign-off - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certifications#sign-off-identity-certification - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - - # Finalize Identity Certification Decisions - - try { - Invoke-SignOffIdentityCertification -Id $Id - - # Below is a request that includes all optional parameters - # Invoke-SignOffIdentityCertification -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-SignOffIdentityCertification" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/reassign-async - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certifications#submit-reassign-certs-async - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $ReviewReassign = @" - { - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] - } - "@ - - # Reassign Certifications Asynchronously - - try { - $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result - - # Below is a request that includes all optional parameters - # Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#create-object-mapping - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingRequest = @" - { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - } - "@ - - # Creates an object mapping - - try { - $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest - New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result - - # Below is a request that includes all optional parameters - # New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMapping" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#create-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingBulkCreateRequest = @" - { - "newObjectsMappings" : [ { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - }, { - "targetValue" : "My New Governance Group Name", - "jsonPath" : "$.name", - "sourceValue" : "My Governance Group Name", - "enabled" : false, - "objectType" : "IDENTITY" - } ] - } - "@ - - # Bulk creates object mappings - - try { - $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest - New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMappings" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/uploads - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#create-uploaded-configuration - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. - - # Upload a Configuration - - try { - New-UploadedConfiguration -Data $Data -Name $Name - - # Below is a request that includes all optional parameters - # New-UploadedConfiguration -Data $Data -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-UploadedConfiguration" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#delete-object-mapping - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. - - # Deletes an object mapping - - try { - Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId - - # Below is a request that includes all optional parameters - # Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ObjectMapping" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/uploads/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#delete-uploaded-configuration - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - - # Delete an Uploaded Configuration - - try { - Remove-UploadedConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-UploadedConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-UploadedConfiguration" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#get-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - - # Gets list of object mappings - - try { - Get-ObjectMappings -SourceOrg $SourceOrg - - # Below is a request that includes all optional parameters - # Get-ObjectMappings -SourceOrg $SourceOrg - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ObjectMappings" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/uploads/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#get-uploaded-configuration - source: | - $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - - # Get an Uploaded Configuration - - try { - Get-UploadedConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-UploadedConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfiguration" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/backups/uploads - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#list-uploaded-configurations - source: | - $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - - # List Uploaded Configurations - - try { - Get-UploadedConfigurations - - # Below is a request that includes all optional parameters - # Get-UploadedConfigurations -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfigurations" - Write-Host $_.ErrorDetails - } -- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#update-object-mappings - source: | - $SourceOrg = "source-org" # String | The name of the source org. - $ObjectMappingBulkPatchRequest = @" - { - "patches" : { - "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : true - } ], - "00bece34-f50d-4227-8878-76f620b5a971" : [ { - "op" : "replace", - "path" : "/targetValue", - "value" : "New Target Value" - } ] - } - } - "@ - - # Bulk updates object mappings - - try { - $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest - Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result - - # Below is a request that includes all optional parameters - # Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ObjectMappings" - Write-Host $_.ErrorDetails - } -- path: /connectors - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#create-custom-connector - source: | - $V3CreateConnectorDto = @" - { - "name" : "custom connector", - "directConnect" : true, - "className" : "sailpoint.connector.OpenConnectorAdapter", - "type" : "custom connector type", - "status" : "RELEASED" - } - "@ - - # Create Custom Connector - - try { - $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto - New-CustomConnector -V3CreateConnectorDto $Result - - # Below is a request that includes all optional parameters - # New-CustomConnector -V3CreateConnectorDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CustomConnector" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#delete-custom-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Delete Connector by Script Name - - try { - Remove-CustomConnector -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Remove-CustomConnector -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CustomConnector" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector by Script Name - - try { - Get-Connector -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-Connector -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Connector" - Write-Host $_.ErrorDetails - } -- path: /connectors - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector-list - source: | - $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector List - - try { - Get-ConnectorList - - # Below is a request that includes all optional parameters - # Get-ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorList" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/source-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector-source-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Get Connector Source Configuration - - try { - Get-ConnectorSourceConfig -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-ConnectorSourceConfig -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceConfig" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/source-template - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector-source-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Get Connector Source Template - - try { - Get-ConnectorSourceTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-ConnectorSourceTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceTemplate" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/translations/{locale} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector-translations - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - - # Get Connector Translations - - try { - Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - - # Below is a request that includes all optional parameters - # Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorTranslations" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/source-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#put-connector-source-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector source config xml file - - # Update Connector Source Configuration - - try { - Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceConfig" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/source-template - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#put-connector-source-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector source template xml file - - # Update Connector Source Template - - try { - Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceTemplate" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName}/translations/{locale} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#put-connector-translations - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - - # Update Connector Translations - - try { - Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - - # Below is a request that includes all optional parameters - # Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorTranslations" - Write-Host $_.ErrorDetails - } -- path: /connectors/{scriptName} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#update-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Connector by Script Name - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Connector" - Write-Host $_.ErrorDetails - } -- path: /auth-org/network-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#create-auth-org-network-config - source: | - $NetworkConfiguration = @" - { - "range" : [ "1.3.7.2", "255.255.255.252/30" ], - "whitelisted" : true, - "geolocation" : [ "CA", "FR", "HT" ] - } - "@ - - # Create security network configuration. - - try { - $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration - New-AuthOrgNetworkConfig -NetworkConfiguration $Result - - # Below is a request that includes all optional parameters - # New-AuthOrgNetworkConfig -NetworkConfiguration $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/lockout-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-lockout-config - source: | - - # Get Auth Org Lockout Configuration. - - try { - Get-AuthOrgLockoutConfig - - # Below is a request that includes all optional parameters - # Get-AuthOrgLockoutConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgLockoutConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/network-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-network-config - source: | - - # Get security network configuration. - - try { - Get-AuthOrgNetworkConfig - - # Below is a request that includes all optional parameters - # Get-AuthOrgNetworkConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/service-provider-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-service-provider-config - source: | - - # Get Service Provider Configuration. - - try { - Get-AuthOrgServiceProviderConfig - - # Below is a request that includes all optional parameters - # Get-AuthOrgServiceProviderConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgServiceProviderConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/session-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-session-config - source: | - - # Get Auth Org Session Configuration. - - try { - Get-AuthOrgSessionConfig - - # Below is a request that includes all optional parameters - # Get-AuthOrgSessionConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgSessionConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/lockout-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#patch-auth-org-lockout-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Auth Org Lockout Configuration - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-AuthOrgLockoutConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-AuthOrgLockoutConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgLockoutConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/network-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#patch-auth-org-network-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update security network configuration. - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-AuthOrgNetworkConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-AuthOrgNetworkConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgNetworkConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/service-provider-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#patch-auth-org-service-provider-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Service Provider Configuration - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgServiceProviderConfig" - Write-Host $_.ErrorDetails - } -- path: /auth-org/session-config - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#patch-auth-org-session-config - source: | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Auth Org Session Configuration - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-AuthOrgSessionConfig -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-AuthOrgSessionConfig -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgSessionConfig" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#create-identity-profile - source: | - $IdentityProfile = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - "@ - - # Create Identity Profile - - try { - $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-IdentityProfile -IdentityProfile $Result - - # Below is a request that includes all optional parameters - # New-IdentityProfile -IdentityProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#delete-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - - # Delete Identity Profile - - try { - Remove-IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Remove-IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#delete-identity-profiles - source: | - $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. - $RequestBody = @""@ - - - # Delete Identity Profiles - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-IdentityProfiles -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-IdentityProfiles -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/export - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#export-identity-profiles - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) - - # Export Identity Profiles - - try { - Export-IdentityProfiles - - # Below is a request that includes all optional parameters - # Export-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-IdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#get-default-identity-attribute-config - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. - - # Get default Identity Attribute Config - - try { - Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultIdentityAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#get-identity-profile - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - - # Get Identity Profile - - try { - Get-IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#import-identity-profiles - source: | - - - - $IdentityProfileExportedObject = @"{ - "self" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "version" : 1, - "object" : { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - }"@ - - - # Import Identity Profiles - - try { - $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-IdentityProfiles -IdentityProfileExportedObject $Result - - # Below is a request that includes all optional parameters - # Import-IdentityProfiles -IdentityProfileExportedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-IdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#list-identity-profiles - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - - # List Identity Profiles - - try { - Get-IdentityProfiles - - # Below is a request that includes all optional parameters - # Get-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfiles" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/identity-preview - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#show-identity-preview - source: | - $IdentityPreviewRequest = @" - { - "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - } - } - "@ - - # Generate Identity Profile Preview - - try { - $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - Show-IdentityPreview -IdentityPreviewRequest $Result - - # Below is a request that includes all optional parameters - # Show-IdentityPreview -IdentityPreviewRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-IdentityPreview" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/process-identities - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#sync-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed - - # Process identities under profile - - try { - Sync-IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Sync-IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#update-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Identity Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-IdentityProfile" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#create-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleState = @" - { - "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], - "emailNotificationOption" : { - "notifyManagers" : true, - "notifySpecificUsers" : true, - "emailAddressList" : [ "test@test.com", "test2@test.com" ], - "notifyAllAdmins" : true - }, - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Lifecycle description", - "accountActions" : [ { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - }, { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } ], - "id" : "id12345", - "identityCount" : 42, - "technicalName" : "Technical Name", - "identityState" : "identityState", - "enabled" : true - } - "@ - - # Create Lifecycle State - - try { - $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState - New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result - - # Below is a request that includes all optional parameters - # New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-LifecycleState" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#delete-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - - # Delete Lifecycle State - - try { - Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-LifecycleState" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#get-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - - # Get Lifecycle State - - try { - Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleState" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#get-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Lists LifecycleStates - - try { - Get-LifecycleStates -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleStates" - Write-Host $_.ErrorDetails - } -- path: /identities/{identity-id}/set-lifecycle-state - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#set-lifecycle-state - source: | - $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. - $SetLifecycleStateRequest = @" - - "@ - - # Set Lifecycle State - - try { - $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest - Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result - - # Below is a request that includes all optional parameters - # Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-LifecycleState" - Write-Host $_.ErrorDetails - } -- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#update-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Lifecycle State - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/delete - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#delete-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # Delete MFA method configuration - - try { - Remove-MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Remove-MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MFAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAKbaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-MFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-MFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-MFAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/token/send - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#create-send-token - source: | - $SendTokenRequest = @" - { - "userAlias" : "will.albin", - "deliveryType" : "EMAIL_WORK" - } - "@ - - # Create and send user token - - try { - $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest - New-SendToken -SendTokenRequest $Result - - # Below is a request that includes all optional parameters - # New-SendToken -SendTokenRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/poll - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#ping-verification-status - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' - $VerificationPollRequest = @" - { - "requestId" : "089899f13a8f4da7824996191587bab9" - } - "@ - - # Polling MFA method by VerificationPollRequest - - try { - $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest - Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result - - # Below is a request that includes all optional parameters - # Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/verify - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-duo-verify-request - source: | - $DuoVerificationRequest = @" - { - "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", - "userId" : "2c9180947f0ef465017f215cbcfd004b" - } - "@ - - # Verifying authentication via Duo method - - try { - $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest - Send-DuoVerifyRequest -DuoVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-DuoVerifyRequest -DuoVerificationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/authenticate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-kba-answers - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Authenticate KBA provided MFA method - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Send-KbaAnswers -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Send-KbaAnswers -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/verify - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-okta-verify-request - source: | - $OktaVerificationRequest = @" - { - "userId" : "example@mail.com" - } - "@ - - # Verifying authentication via Okta method - - try { - $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest - Send-OktaVerifyRequest -OktaVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-OktaVerifyRequest -OktaVerificationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest" - Write-Host $_.ErrorDetails - } -- path: /mfa/token/authenticate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-token-auth-request - source: | - $TokenAuthRequest = @" - { - "userAlias" : "will.albin", - "deliveryType" : "EMAIL_WORK", - "token" : "12345" - } - "@ - - # Authenticate Token provided MFA method - - try { - $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest - Send-TokenAuthRequest -TokenAuthRequest $Result - - # Below is a request that includes all optional parameters - # Send-TokenAuthRequest -TokenAuthRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client - source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ - - # Create Managed Client - - try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-ManagedClient -ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedClient -ManagedClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Delete Managed Client - - try { - Remove-ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Get Managed Client - - try { - Get-ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. - - # Get Managed Client Status - - try { - Get-ManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-ManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - - # Get Managed Clients - - try { - Get-ManagedClients - - # Below is a request that includes all optional parameters - # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-ManagedCluster -ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedCluster -ManagedClusterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-ManagedClusters - - # Below is a request that includes all optional parameters - # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedCluster -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id}/approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#approve-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeApprovalDecision = @" - { - "comment" : "Approved by manager" - } - "@ - - # Approve a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#create-non-employee-record - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-NonEmployeeRecord -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-NonEmployeeRecord -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#create-non-employee-request - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-NonEmployeeRequest -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-NonEmployeeRequest -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#create-non-employee-source - source: | - $NonEmployeeSourceRequestBody = @" - { - "owner" : { - "id" : "2c91808570313110017040b06f344ec9" - }, - "managementWorkgroup" : "123299", - "accountManagers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ], - "name" : "Retail", - "description" : "Source description", - "approvers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ] - } - "@ - - # Create Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result - - # Below is a request that includes all optional parameters - # New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - $NonEmployeeSchemaAttributeBody = @" - { - "helpText" : "The unique identifier for the account", - "label" : "Account Name", - "placeholder" : "Enter a unique user name for this account.", - "type" : "TEXT", - "technicalName" : "account.name", - "required" : true - } - "@ - - # Create a new Schema Attribute for Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - - # Below is a request that includes all optional parameters - # New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - - # Delete Non-Employee Record - - try { - Remove-NonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Remove-NonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk - source: | - $DeleteNonEmployeeRecordsInBulkRequest = @" - - "@ - - # Delete Multiple Non-Employee Records - - try { - $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest - Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result - - # Below is a request that includes all optional parameters - # Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-request - source: | - $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format - - # Delete Non-Employee Request - - try { - Remove-NonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Remove-NonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Delete a Schema Attribute for Non-Employee Source - - try { - Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-source - source: | - $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - - # Delete Non-Employee Source - - try { - Remove-NonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-NonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Delete all custom schema attributes for Non-Employee Source - - try { - Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/non-employees/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#export-non-employee-records - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - - # Exports Non-Employee Records to CSV - - try { - Export-NonEmployeeRecords -Id $Id - - # Below is a request that includes all optional parameters - # Export-NonEmployeeRecords -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeRecords" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/schema-attributes-template/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) - - # Exports Source Schema Template - - try { - Export-NonEmployeeSourceSchemaTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Export-NonEmployeeSourceSchemaTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeSourceSchemaTemplate" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-approval - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) - - # Get a non-employee approval item detail - - try { - Get-NonEmployeeApproval -Id $Id - - # Below is a request that includes all optional parameters - # Get-NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApproval" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/summary/{requested-for} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-approval-summary - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Approval Requests - - try { - Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovalSummary" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/non-employee-bulk-upload/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) - - # Obtain the status of bulk upload on the source - - try { - Get-NonEmployeeBulkUploadStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-NonEmployeeBulkUploadStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeBulkUploadStatus" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - - # Get a Non-Employee Record - - try { - Get-NonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Get-NonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-request - source: | - $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) - - # Get a Non-Employee Request - - try { - Get-NonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Get-NonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests/summary/{requested-for} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-request-summary - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Requests - - try { - Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequestSummary" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Get Schema Attribute Non-Employee Source - - try { - Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-source - source: | - $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id - - # Get a Non-Employee Source - - try { - Get-NonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-NonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # List Schema Attributes Non-Employee Source - - try { - Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{id}/non-employee-bulk-upload - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - $Data = # System.IO.FileInfo | - - # Imports, or Updates, Non-Employee Records - - try { - Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data - - # Below is a request that includes all optional parameters - # Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-NonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-approvals - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Get List of Non-Employee Approval Requests - - try { - Get-NonEmployeeApprovals - - # Below is a request that includes all optional parameters - # Get-NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovals" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-records - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - - # List Non-Employee Records - - try { - Get-NonEmployeeRecords - - # Below is a request that includes all optional parameters - # Get-NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecords" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-requests - source: | - $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - - # List Non-Employee Requests - - try { - Get-NonEmployeeRequests -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequests" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-sources - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) - $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) - $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - - # List Non-Employee Sources - - try { - Get-NonEmployeeSources - - # Below is a request that includes all optional parameters - # Get-NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#patch-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Non-Employee Record - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Schema Attribute for Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#patch-non-employee-source - source: | - $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id}/reject - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#reject-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeRejectApprovalDecision = @" - { - "comment" : "approved" - } - "@ - - # Reject a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#update-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Update Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#create-oauth-client - source: | - $CreateOAuthClientRequest = @" - { - "internal" : false, - "businessName" : "Acme-Solar", - "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", - "refreshTokenValiditySeconds" : 86400, - "type" : "CONFIDENTIAL", - "redirectUris" : [ "http://localhost:12345" ], - "enabled" : true, - "accessType" : "OFFLINE", - "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], - "strongAuthSupported" : false, - "homepageUrl" : "http://localhost:12345", - "accessTokenValiditySeconds" : 750, - "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], - "name" : "Demo API Client", - "claimsSupported" : false - } - "@ - - # Create OAuth Client - - try { - $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-OauthClient -CreateOAuthClientRequest $Result - - # Below is a request that includes all optional parameters - # New-OauthClient -CreateOAuthClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-OauthClient" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#delete-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Delete OAuth Client - - try { - Remove-OauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-OauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-OauthClient" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#get-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Get OAuth Client - - try { - Get-OauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-OauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClient" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#list-oauth-clients - source: | - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - - # List OAuth Clients - - try { - Get-OauthClients - - # Below is a request that includes all optional parameters - # Get-OauthClients -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClients" - Write-Host $_.ErrorDetails - } -- path: /oauth-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#patch-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch OAuth Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-OauthClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-OauthClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-OauthClient" - Write-Host $_.ErrorDetails - } -- path: /password-org-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-configuration#create-password-org-config - source: | - $PasswordOrgConfig = @" - { - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - } - "@ - - # Create Password Org Config - - try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - New-PasswordOrgConfig -PasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # New-PasswordOrgConfig -PasswordOrgConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-org-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-configuration#get-password-org-config - source: | - - # Get Password Org Config - - try { - Get-PasswordOrgConfig - - # Below is a request that includes all optional parameters - # Get-PasswordOrgConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-org-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-configuration#put-password-org-config - source: | - $PasswordOrgConfig = @" - { - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true - } - "@ - - # Update Password Org Config - - try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - Send-PasswordOrgConfig -PasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # Send-PasswordOrgConfig -PasswordOrgConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordOrgConfig" - Write-Host $_.ErrorDetails - } -- path: /password-dictionary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-dictionary#get-password-dictionary - source: | - - # Get Password Dictionary - - try { - Get-PasswordDictionary - - # Below is a request that includes all optional parameters - # Get-PasswordDictionary - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordDictionary" - Write-Host $_.ErrorDetails - } -- path: /password-dictionary - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-dictionary#put-password-dictionary - source: | - $File = # System.IO.FileInfo | (optional) - - # Update Password Dictionary - - try { - Send-PasswordDictionary - - # Below is a request that includes all optional parameters - # Send-PasswordDictionary -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordDictionary" - Write-Host $_.ErrorDetails - } -- path: /password-change-status/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-management#get-password-change-status - source: | - $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID - - # Get Password Change Request Status - - try { - Get-PasswordChangeStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-PasswordChangeStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordChangeStatus" - Write-Host $_.ErrorDetails - } -- path: /query-password-info - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-management#query-password-info - source: | - $PasswordInfoQueryDTO = @" - { - "sourceName" : "My-AD", - "userName" : "Abby.Smith" - } - "@ - - # Query Password Info - - try { - $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO - Search-PasswordInfo -PasswordInfoQueryDTO $Result - - # Below is a request that includes all optional parameters - # Search-PasswordInfo -PasswordInfoQueryDTO $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-PasswordInfo" - Write-Host $_.ErrorDetails - } -- path: /set-password - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-management#set-password - source: | - $PasswordChangeRequest = @" - { - "sourceId" : "8a807d4c73c545510173c545d4b60246", - "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", - "identityId" : "8a807d4c73c545510173c545f0a002ff", - "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", - "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" - } - "@ - - # Set Identity's Password - - try { - $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest - Set-Password -PasswordChangeRequest $Result - - # Below is a request that includes all optional parameters - # Set-Password -PasswordChangeRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-Password" - Write-Host $_.ErrorDetails - } -- path: /password-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-policies#create-password-policy - source: | - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : "2000-01-23T04:56:07.000+00:00", - "validateAgainstAccountId" : false, - "dateCreated" : "2000-01-23T04:56:07.000+00:00", - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Create Password Policy - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-PasswordPolicy -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # New-PasswordPolicy -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordPolicy" - Write-Host $_.ErrorDetails - } -- path: /password-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-policies#delete-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. - - # Delete Password Policy by ID - - try { - Remove-PasswordPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-PasswordPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordPolicy" - Write-Host $_.ErrorDetails - } -- path: /password-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-policies#get-password-policy-by-id - source: | - $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. - - # Get Password Policy by ID - - try { - Get-PasswordPolicyById -Id $Id - - # Below is a request that includes all optional parameters - # Get-PasswordPolicyById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicyById" - Write-Host $_.ErrorDetails - } -- path: /password-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-policies#list-password-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Password Policies - - try { - Get-PasswordPolicies - - # Below is a request that includes all optional parameters - # Get-PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicies" - Write-Host $_.ErrorDetails - } -- path: /password-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-policies#set-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : "2000-01-23T04:56:07.000+00:00", - "validateAgainstAccountId" : false, - "dateCreated" : "2000-01-23T04:56:07.000+00:00", - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Update Password Policy by ID - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-PasswordPolicy" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#create-password-sync-group - source: | - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Create Password Sync Group - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-PasswordSyncGroup -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # New-PasswordSyncGroup -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#delete-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. - - # Delete Password Sync Group by ID - - try { - Remove-PasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Remove-PasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#get-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. - - # Get Password Sync Group by ID - - try { - Get-PasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Get-PasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#get-password-sync-groups - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Get Password Sync Group List - - try { - Get-PasswordSyncGroups - - # Below is a request that includes all optional parameters - # Get-PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroups" - Write-Host $_.ErrorDetails - } -- path: /password-sync-groups/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#update-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Update Password Sync Group by ID - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PasswordSyncGroup" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/personal-access-tokens#create-personal-access-token - source: | - $CreatePersonalAccessTokenRequest = @" - { - "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], - "accessTokenValiditySeconds" : 36900, - "name" : "NodeJS Integration" - } - "@ - - # Create Personal Access Token - - try { - $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result - - # Below is a request that includes all optional parameters - # New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PersonalAccessToken" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/personal-access-tokens#delete-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id - - # Delete Personal Access Token - - try { - Remove-PersonalAccessToken -Id $Id - - # Below is a request that includes all optional parameters - # Remove-PersonalAccessToken -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PersonalAccessToken" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/personal-access-tokens#list-personal-access-tokens - source: | - $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - - # List Personal Access Tokens - - try { - Get-PersonalAccessTokens - - # Below is a request that includes all optional parameters - # Get-PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PersonalAccessTokens" - Write-Host $_.ErrorDetails - } -- path: /personal-access-tokens/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/personal-access-tokens#patch-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Personal Access Token - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PersonalAccessToken" - Write-Host $_.ErrorDetails - } -- path: /public-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/public-identities#get-public-identities - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) - $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Get list of public identities - - try { - Get-PublicIdentities - - # Below is a request that includes all optional parameters - # Get-PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentities" - Write-Host $_.ErrorDetails - } -- path: /public-identities-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/public-identities-config#get-public-identity-config - source: | - - # Get the Public Identities Configuration - - try { - Get-PublicIdentityConfig - - # Below is a request that includes all optional parameters - # Get-PublicIdentityConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentityConfig" - Write-Host $_.ErrorDetails - } -- path: /public-identities-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/public-identities-config#update-public-identity-config - source: | - $PublicIdentityConfig = @" - { - "modified" : "2018-06-25T20:22:28.104Z", - "attributes" : [ { - "name" : "Country", - "key" : "country" - }, { - "name" : "Country", - "key" : "country" - } ], - "modifiedBy" : { - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - } - "@ - - # Update the Public Identities Configuration - - try { - $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-PublicIdentityConfig -PublicIdentityConfig $Result - - # Below is a request that includes all optional parameters - # Update-PublicIdentityConfig -PublicIdentityConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PublicIdentityConfig" - Write-Host $_.ErrorDetails - } -- path: /reports/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/reports-data-extraction#cancel-report - source: | - $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel - - # Cancel Report - - try { - Suspend-Report -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-Report -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-Report" - Write-Host $_.ErrorDetails - } -- path: /reports/{taskResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/reports-data-extraction#get-report - source: | - $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report - $FileFormat = "csv" # String | Output format of the requested report file - $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) - $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) - - # Get Report File - - try { - Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat - - # Below is a request that includes all optional parameters - # Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Report" - Write-Host $_.ErrorDetails - } -- path: /reports/{taskResultId}/result - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/reports-data-extraction#get-report-result - source: | - $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report - $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) - - # Get Report Result - - try { - Get-ReportResult -TaskResultId $TaskResultId - - # Below is a request that includes all optional parameters - # Get-ReportResult -TaskResultId $TaskResultId -Completed $Completed - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ReportResult" - Write-Host $_.ErrorDetails - } -- path: /reports/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/reports-data-extraction#start-report - source: | - $ReportDetails = @" - { - "reportType" : "ACCOUNTS", - "arguments" : { - "application" : "2c9180897e7742b2017e781782f705b9", - "sourceName" : "Active Directory" - } - } - "@ - - # Run Report - - try { - $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails - Start-Report -ReportDetails $Result - - # Below is a request that includes all optional parameters - # Start-Report -ReportDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Report" - Write-Host $_.ErrorDetails - } -- path: /requestable-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/requestable-objects#list-requestable-objects - source: | - $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) - $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) - - $Types = @"ROLE,ACCESS_PROFILE"@ - $Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) - $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) - - $Statuses = @"[ASSIGNED, PENDING]"@ - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Requestable Objects List - - try { - Get-RequestableObjects - - # Below is a request that includes all optional parameters - # Get-RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RequestableObjects" - Write-Host $_.ErrorDetails - } -- path: /roles - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#create-role - source: | - $Role = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "dimensional" : false, - "created" : "2021-03-01T22:32:58.104Z", - "dimensionRefs" : [ { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - }, { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - } ], - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "membership" : { - "identities" : [ { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } ], - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, - "type" : "IDENTITY_LIST" - }, - "enabled" : true, - "revocationRequestConfig" : { - "commentsRequired" : false, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : false - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "legacyMembershipInfo" : { - "type" : "IDENTITY_LIST" - }, - "accessRequestConfig" : { - "commentsRequired" : true, - "reauthorizationRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "name" : "Role 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "accessModelMetadata" : { - "attributes" : [ { - "key" : "iscPrivacy", - "name" : "Privacy", - "multiselect" : false, - "status" : "active", - "type" : "governance", - "objectTypes" : [ "all" ], - "description" : "Specifies the level of privacy associated with an access item.", - "values" : [ { - "value" : "public", - "name" : "Public", - "status" : "active" - } ] - } ] - }, - "id" : "2c918086749d78830174a1a40e121518", - "requestable" : true - } - "@ - - # Create a Role - - try { - $Result = ConvertFrom-JsonToRole -Json $Role - New-Role -Role $Result - - # Below is a request that includes all optional parameters - # New-Role -Role $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Role" - Write-Host $_.ErrorDetails - } -- path: /roles/bulk-delete - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#delete-bulk-roles - source: | - $RoleBulkDeleteRequest = @" - { - "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - } - "@ - - # Delete Role(s) - - try { - $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-BulkRoles -RoleBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-BulkRoles -RoleBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BulkRoles" - Write-Host $_.ErrorDetails - } -- path: /roles/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#delete-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | Role ID. - - # Delete Role - - try { - Remove-Role -Id $Id - - # Below is a request that includes all optional parameters - # Remove-Role -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Role" - Write-Host $_.ErrorDetails - } -- path: /roles/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#get-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | Role ID. - - # Get Role - - try { - Get-Role -Id $Id - - # Below is a request that includes all optional parameters - # Get-Role -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Role" - Write-Host $_.ErrorDetails - } -- path: /roles/{id}/assigned-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#get-role-assigned-identities - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) - $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) - - # List Identities assigned a Role - - try { - Get-RoleAssignedIdentities -Id $Id - - # Below is a request that includes all optional parameters - # Get-RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RoleAssignedIdentities" - Write-Host $_.ErrorDetails - } -- path: /roles - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#list-roles - source: | - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) - - # List Roles - - try { - Get-Roles - - # Below is a request that includes all optional parameters - # Get-Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Roles" - Write-Host $_.ErrorDetails - } -- path: /roles/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#patch-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | Role ID to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Role - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Role -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-Role -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-SodPolicies - - # Below is a request that includes all optional parameters - # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" - Write-Host $_.ErrorDetails - } -- path: /saved-searches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#create-saved-search - source: | - $CreateSavedSearchRequest = @" - - "@ - - # Create a saved search - - try { - $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-SavedSearch -CreateSavedSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-SavedSearch -CreateSavedSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#delete-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete document by ID - - try { - Remove-SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id}/execute - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#execute-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SearchArguments = @" - { - "owner" : "", - "recipients" : [ { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - } - "@ - - # Execute a saved search by ID - - try { - $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result - - # Below is a request that includes all optional parameters - # Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#get-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Return saved search by ID - - try { - Get-SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#list-saved-searches - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) - - # A list of Saved Searches - - try { - Get-SavedSearches - - # Below is a request that includes all optional parameters - # Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearches" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#put-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SavedSearch = @" - { - "owner" : { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2018-06-25T20:22:28.104Z", - "columns" : { - "identity" : [ { - "field" : "displayName", - "header" : "Display Name" - }, { - "field" : "e-mail", - "header" : "Work Email" - } ] - }, - "query" : "@accounts(disabled:true)", - "description" : "Disabled accounts", - "orderBy" : { - "identity" : [ "lastName", "firstName" ], - "role" : [ "name" ] - }, - "sort" : [ "displayName" ], - "filters" : { - "terms" : [ "account_count", "account_count" ], - "range" : { - "lower" : { - "inclusive" : false, - "value" : "1" - }, - "upper" : { - "inclusive" : false, - "value" : "1" - } - }, - "exclude" : false, - "type" : "RANGE" - }, - "ownerId" : "2c91808568c529c60168cca6f90c1313", - "indices" : [ "identities" ], - "public" : false, - "name" : "Disabled accounts", - "modified" : "2018-06-25T20:22:28.104Z", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "fields" : [ "disabled" ] - } - "@ - - # Updates an existing saved search - - try { - $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-SavedSearch -Id $Id -SavedSearch $Result - - # Below is a request that includes all optional parameters - # Send-SavedSearch -Id $Id -SavedSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#create-scheduled-search - source: | - $CreateScheduledSearchRequest = @" - {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} - "@ - - # Create a new scheduled search - - try { - $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-ScheduledSearch -CreateScheduledSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-ScheduledSearch -CreateScheduledSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#delete-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete a Scheduled Search - - try { - Remove-ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#get-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Scheduled Search - - try { - Get-ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#list-scheduled-search - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - - # List scheduled searches - - try { - Get-ScheduledSearch - - # Below is a request that includes all optional parameters - # Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id}/unsubscribe - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#unsubscribe-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $TypedReference = @" - { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - "@ - - # Unsubscribe a recipient from Scheduled Search - - try { - $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result - - # Below is a request that includes all optional parameters - # Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#update-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $ScheduledSearch = @" - { - "owner" : { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "displayQueryDetails" : false, - "created" : "", - "description" : "Daily disabled accounts", - "ownerId" : "2c9180867624cbd7017642d8c8c81f67", - "enabled" : false, - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "recipients" : [ { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - } ], - "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", - "name" : "Daily disabled accounts", - "modified" : "", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "emailEmptyResults" : false - } - "@ - - # Update an existing Scheduled Search - - try { - $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-ScheduledSearch -Id $Id -ScheduledSearch $Result - - # Below is a request that includes all optional parameters - # Update-ScheduledSearch -Id $Id -ScheduledSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /search/aggregate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-aggregate - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Perform a Search Query Aggregation - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Aggregate -Search $Result - - # Below is a request that includes all optional parameters - # Search-Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate" - Write-Host $_.ErrorDetails - } -- path: /search/count - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-count - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - - # Count Documents Satisfying a Query - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Count -Search $Result - - # Below is a request that includes all optional parameters - # Search-Count -Search $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count" - Write-Host $_.ErrorDetails - } -- path: /search/{index}/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-get - source: | - $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Document by ID - - try { - Search-Get -Index $Index -Id $Id - - # Below is a request that includes all optional parameters - # Search-Get -Index $Index -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Get" - Write-Host $_.ErrorDetails - } -- path: /search - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-post - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Perform Search - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Post -Search $Result - - # Below is a request that includes all optional parameters - # Search-Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#create-search-attribute-config - source: | - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ - - # Create Extended Search Attributes - - try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-SearchAttributeConfig -SearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-SearchAttributeConfig -SearchAttributeConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#delete-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - - # Delete Extended Search Attribute - - try { - Remove-SearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Remove-SearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-search-attribute-config - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Extended Search Attributes - - try { - Get-SearchAttributeConfig - - # Below is a request that includes all optional parameters - # Get-SearchAttributeConfig -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. - - # Get Extended Search Attribute - - try { - Get-SingleSearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Get-SingleSearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SingleSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#patch-search-attribute-config - source: | - $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Extended Search Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#create-segment - source: | - $Segment = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-Segment -Segment $Result - - # Below is a request that includes all optional parameters - # New-Segment -Segment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-Segment -Id $Id - - # Below is a request that includes all optional parameters - # Remove-Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Segment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-Segment -Id $Id - - # Below is a request that includes all optional parameters - # Get-Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segment" - Write-Host $_.ErrorDetails - } -- path: /segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#list-segments - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Segments - - try { - Get-Segments - - # Below is a request that includes all optional parameters - # Get-Segments -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segments" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#patch-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-Segment -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-Segment -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#create-service-desk-integration - source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ - - # Create new Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#delete-service-desk-integration - source: | - $Id = "anId" # String | ID of Service Desk integration to delete - - # Delete a Service Desk integration - - try { - Remove-ServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to get - - # Get a Service Desk integration - - try { - Get-ServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - - # Service Desk integration template by scriptName - - try { - Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTemplate" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-types - source: | - - # List Service Desk integration types - - try { - Get-ServiceDeskIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTypes" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integrations - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List existing Service Desk integrations - - try { - Get-ServiceDeskIntegrations - - # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrations" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-status-check-details - source: | - - # Get the time check configuration - - try { - Get-StatusCheckDetails - - # Below is a request that includes all optional parameters - # Get-StatusCheckDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#patch-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - - "@ - - # Patch a Service Desk Integration - - try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - - # Below is a request that includes all optional parameters - # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#put-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ - - # Update a Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#update-status-check-details - source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ - - # Update the time check configuration - - try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-StatusCheckDetails -QueuedCheckConfigDetails $Result - - # Below is a request that includes all optional parameters - # Update-StatusCheckDetails -QueuedCheckConfigDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-StatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-StatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-UsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#create-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - $ProvisioningPolicyDto = @" - { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } - "@ - - # Create Provisioning Policy - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#create-source - source: | - $Source = @" - { - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - } - "@ - $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) - - # Creates a source in IdentityNow. - - try { - $Result = ConvertFrom-JsonToSource -Json $Source - New-Source -Source $Result - - # Below is a request that includes all optional parameters - # New-Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#create-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Schema = @" - { - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" - } - "@ - - # Create Schema on Source - - try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - New-SourceSchema -SourceId $SourceId -Schema $Result - - # Below is a request that includes all optional parameters - # New-SourceSchema -SourceId $SourceId -Schema $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#delete-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - - # Delete Provisioning Policy by UsageType - - try { - Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - - # Below is a request that includes all optional parameters - # Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#delete-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Delete Source by ID - - try { - Remove-Source -Id $Id - - # Below is a request that includes all optional parameters - # Remove-Source -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#delete-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - - # Delete Source Schema by ID - - try { - Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/schemas/accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#get-accounts-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - - # Downloads source accounts schema template - - try { - Get-AccountsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Get-AccountsSchema -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/schemas/entitlements - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#get-entitlements-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) - - # Downloads source entitlements schema template - - try { - Get-EntitlementsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Get-EntitlementsSchema -Id $Id -SchemaName $SchemaName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-EntitlementsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#get-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - - # Get Provisioning Policy by UsageType - - try { - Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - - # Below is a request that includes all optional parameters - # Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#get-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Get Source by ID - - try { - Get-Source -Id $Id - - # Below is a request that includes all optional parameters - # Get-Source -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/connections - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#get-source-connections - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - - # Get Source Connections by ID - - try { - Get-SourceConnections -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-SourceConnections -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceConnections" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/source-health - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#get-source-health - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - - # Fetches source health by id - - try { - Get-SourceHealth -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-SourceHealth -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceHealth" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#get-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - - # Get Source Schema by ID - - try { - Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#get-source-schemas - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) - $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) - - # List Schemas on Source - - try { - Get-SourceSchemas -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchemas" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/schemas/accounts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#import-accounts-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $File = # System.IO.FileInfo | (optional) - - # Uploads source accounts schema template - - try { - Import-AccountsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Import-AccountsSchema -Id $Id -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-AccountsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/upload-connector-file - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#import-connector-file - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $File = # System.IO.FileInfo | (optional) - - # Upload connector file to source - - try { - Import-ConnectorFile -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Import-ConnectorFile -SourceId $SourceId -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-ConnectorFile" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/schemas/entitlements - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#import-entitlements-schema - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) - $File = # System.IO.FileInfo | (optional) - - # Uploads source entitlements schema template - - try { - Import-EntitlementsSchema -Id $Id - - # Below is a request that includes all optional parameters - # Import-EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-EntitlementsSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#list-provisioning-policies - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - - # Lists ProvisioningPolicies - - try { - Get-ProvisioningPolicies -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-ProvisioningPolicies -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicies" - Write-Host $_.ErrorDetails - } -- path: /sources - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#list-sources - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) - $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) - $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) - - # Lists all sources in IdentityNow. - - try { - Get-Sources - - # Below is a request that includes all optional parameters - # Get-Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Sources" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#put-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $ProvisioningPolicyDto = @" - { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } - "@ - - # Update Provisioning Policy by UsageType - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#put-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $Source = @" - { - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" - } - "@ - - # Update Source (Full) - - try { - $Result = ConvertFrom-JsonToSource -Json $Source - Send-Source -Id $Id -Source $Result - - # Below is a request that includes all optional parameters - # Send-Source -Id $Id -Source $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#put-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $Schema = @" - { - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" - } - "@ - - # Update Source Schema (Full) - - try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result - - # Below is a request that includes all optional parameters - # Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/bulk-update - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#update-provisioning-policies-in-bulk - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ProvisioningPolicyDto = @"{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - }"@ - - - # Bulk Update Provisioning Policies - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPoliciesInBulk" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#update-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Partial update of Provisioning Policy - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#update-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Source -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-Source -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sources#update-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source Schema (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type}/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#delete-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. - - # Delete Object Tags - - try { - Remove-TaggedObject -Type $Type -Id $Id - - # Below is a request that includes all optional parameters - # Remove-TaggedObject -Type $Type -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TaggedObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/bulk-remove - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#delete-tags-to-many-object - source: | - $BulkRemoveTaggedObject = @" - { - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Remove Tags from Multiple Objects - - try { - $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject - Remove-TagsToManyObject -BulkRemoveTaggedObject $Result - - # Below is a request that includes all optional parameters - # Remove-TagsToManyObject -BulkRemoveTaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TagsToManyObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type}/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#get-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - - # Get Tagged Object - - try { - Get-TaggedObject -Type $Type -Id $Id - - # Below is a request that includes all optional parameters - # Get-TaggedObject -Type $Type -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#list-tagged-objects - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) - - # List Tagged Objects - - try { - Get-TaggedObjects - - # Below is a request that includes all optional parameters - # Get-TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjects" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#list-tagged-objects-by-type - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) - - # List Tagged Objects by Type - - try { - Get-TaggedObjectsByType -Type $Type - - # Below is a request that includes all optional parameters - # Get-TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjectsByType" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/{type}/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#put-tagged-object - source: | - $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. - $TaggedObject = @" - { - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Update Tagged Object - - try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result - - # Below is a request that includes all optional parameters - # Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TaggedObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#set-tag-to-object - source: | - $TaggedObject = @" - { - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Add Tag to Object - - try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-TagToObject -TaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-TagToObject -TaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagToObject" - Write-Host $_.ErrorDetails - } -- path: /tagged-objects/bulk-add - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#set-tags-to-many-objects - source: | - $BulkAddTaggedObject = @" - { - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "operation" : "MERGE", - "tags" : [ "BU_FINANCE", "PCI" ] - } - "@ - - # Tag Multiple Objects - - try { - $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject - Set-TagsToManyObjects -BulkAddTaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-TagsToManyObjects -BulkAddTaggedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagsToManyObjects" - Write-Host $_.ErrorDetails - } -- path: /transforms - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/transforms#create-transform - source: | - $Transform = @" - { - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" - } - "@ - - # Create transform - - try { - $Result = ConvertFrom-JsonToTransform -Json $Transform - New-Transform -Transform $Result - - # Below is a request that includes all optional parameters - # New-Transform -Transform $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Transform" - Write-Host $_.ErrorDetails - } -- path: /transforms/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/transforms#delete-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete - - # Delete a transform - - try { - Remove-Transform -Id $Id - - # Below is a request that includes all optional parameters - # Remove-Transform -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Transform" - Write-Host $_.ErrorDetails - } -- path: /transforms/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/transforms#get-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve - - # Transform by ID - - try { - Get-Transform -Id $Id - - # Below is a request that includes all optional parameters - # Get-Transform -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transform" - Write-Host $_.ErrorDetails - } -- path: /transforms - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/transforms#list-transforms - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) - $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) - - # List transforms - - try { - Get-Transforms - - # Below is a request that includes all optional parameters - # Get-Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transforms" - Write-Host $_.ErrorDetails - } -- path: /transforms/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/transforms#update-transform - source: | - $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update - $Transform = @" - { - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" - } - "@ - - # Update a transform - - try { - Update-Transform -Id $Id - - # Below is a request that includes all optional parameters - # Update-Transform -Id $Id -Transform $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Transform" - Write-Host $_.ErrorDetails - } -- path: /vendor-connector-mappings - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/vendor-connector-mappings#create-vendor-connector-mapping - source: | - $VendorConnectorMapping = @" - { - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - } - "@ - - # Create Vendor Connector Mapping - - try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-VendorConnectorMapping -VendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # New-VendorConnectorMapping -VendorConnectorMapping $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-VendorConnectorMapping" - Write-Host $_.ErrorDetails - } -- path: /vendor-connector-mappings - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/vendor-connector-mappings#delete-vendor-connector-mapping - source: | - $VendorConnectorMapping = @" - { - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } - } - "@ - - # Delete Vendor Connector Mapping - - try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-VendorConnectorMapping -VendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # Remove-VendorConnectorMapping -VendorConnectorMapping $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-VendorConnectorMapping" - Write-Host $_.ErrorDetails - } -- path: /vendor-connector-mappings - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/vendor-connector-mappings#get-vendor-connector-mappings - source: | - - # List Vendor Connector Mappings - - try { - Get-VendorConnectorMappings - - # Below is a request that includes all optional parameters - # Get-VendorConnectorMappings - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Approve an Approval Item - - try { - Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk approve Approval Items - - try { - Approve-ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Approve-ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) - - # Complete a Work Item - - try { - Complete-WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Complete-WorkItem -Id $Id -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Completed Work Items - - try { - Get-CompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Count Completed Work Items - - try { - Get-CountCompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-CountCompletedWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items - source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - - # Count Work Items - - try { - Get-CountWorkItems - - # Below is a request that includes all optional parameters - # Get-CountWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - - # Get a Work Item - - try { - Get-WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Get-WorkItem -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Work Items Summary - - try { - Get-WorkItemsSummary - - # Below is a request that includes all optional parameters - # Get-WorkItemsSummary -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" - Write-Host $_.ErrorDetails - } -- path: /work-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # List Work Items - - try { - Get-WorkItems - - # Below is a request that includes all optional parameters - # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Reject an Approval Item - - try { - Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk reject Approval Items - - try { - Deny-ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Deny-ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ - - # Forward a Work Item - - try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Send-WorkItemForward -Id $Id -WorkItemForward $Result - - # Below is a request that includes all optional parameters - # Send-WorkItemForward -Id $Id -WorkItemForward $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - - # Submit Account Selections - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-AccountSelection -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Submit-AccountSelection -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) - - # Get Workflow By Id - - try { - Get-Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-Workflow -Id $Id -WorkflowMetrics $WorkflowMetrics - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflows - source: | - $TriggerId = "idn:identity-created" # String | Trigger ID (optional) - $ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Workflows - - try { - Get-Workflows - - # Below is a request that includes all optional parameters - # Get-Workflows -TriggerId $TriggerId -ConnectorInstanceId $ConnectorInstanceId -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" - Write-Host $_.ErrorDetails - } From 7eefbcd0fe273003892fc1c119942a0a5889e49d Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Tue, 29 Apr 2025 16:25:51 +0000 Subject: [PATCH 75/82] Automated commit by github action: 14736382537 --- static/api-specs/idn/v2025/paths/load-accounts.yaml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/static/api-specs/idn/v2025/paths/load-accounts.yaml b/static/api-specs/idn/v2025/paths/load-accounts.yaml index 2b78437d3..ddf74aed8 100644 --- a/static/api-specs/idn/v2025/paths/load-accounts.yaml +++ b/static/api-specs/idn/v2025/paths/load-accounts.yaml @@ -22,14 +22,6 @@ post: x-sailpoint-resource-operation-id: listSources description: Source Id example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true requestBody: content: multipart/form-data: From c641d89cff5e80d33b03d1413de06c0b36d09d4f Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Tue, 29 Apr 2025 16:27:21 +0000 Subject: [PATCH 76/82] Update to powershell SDK docs: 14736414320 --- .../sdk/powershell/Reference/Beta/Models/AccountUsage.md | 2 +- .../Beta/Models/NonEmployeeRequestWithoutApprovalItem.md | 4 ++-- .../sdk/powershell/Reference/Beta/Models/SourceUsage.md | 2 +- .../powershell/Reference/V2024/Models/AccountUsage.md | 2 +- .../Models/NonEmployeeRequestWithoutApprovalItem.md | 4 ++-- .../sdk/powershell/Reference/V2024/Models/SourceUsage.md | 2 +- .../Reference/V2025/Methods/V2025SourcesApi.md | 9 ++------- .../powershell/Reference/V2025/Models/AccountUsage.md | 2 +- .../Models/NonEmployeeRequestWithoutApprovalItem.md | 4 ++-- .../sdk/powershell/Reference/V2025/Models/SourceUsage.md | 2 +- .../sdk/powershell/Reference/V3/Models/AccountUsage.md | 2 +- .../V3/Models/NonEmployeeRequestWithoutApprovalItem.md | 4 ++-- .../sdk/powershell/Reference/V3/Models/SourceUsage.md | 2 +- 13 files changed, 18 insertions(+), 23 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md index f6a1eaaa2..9d6d48011 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index 4eef80103..414c1c740 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md index bb3b65383..05cceab03 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md index 9cb9ee94f..b901e027d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index 54727248f..6393f6ed6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md index 235e4ab2c..3d6b4c94a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md index 1856a8cb5..79a29d61b 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md @@ -1509,9 +1509,6 @@ try { [[Back to top]](#) ## import-accounts -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. @@ -1522,7 +1519,6 @@ You will also need to set the Content-Type header to `multipart/form-data`. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Source Id - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. | File | **System.IO.FileInfo** | (optional) | The CSV file containing the source accounts to aggregate. | DisableOptimization | **String** | (optional) | Use this flag to reprocess every account whether or not the data has changed. @@ -1546,17 +1542,16 @@ Code | Description | Data Type ### Example ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) # Account Aggregation try { - Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental + Import-V2025Accounts -Id $Id # Below is a request that includes all optional parameters - # Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization + # Import-V2025Accounts -Id $Id -File $File -DisableOptimization $DisableOptimization } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025Accounts" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md index f0699a5d6..10c9e238e 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V2025AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2025AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 34280ad09..d31582750 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2025NonEmployee -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md index 7c6c72949..e5a21ea4d 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V2025SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2025SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md index 3b9cae031..35c8a92f6 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index 071f0e39a..17d96a073 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V3NonEmployeeReq -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md index 92919ac01..0328c565b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` From cbe4076092f49d1be2529dde3ac26a640c0ad679 Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Wed, 30 Apr 2025 14:23:58 +0000 Subject: [PATCH 77/82] Automated commit by github action: 14756931030 --- .../idn/beta/paths/service-desk-integration.yaml | 11 +++-------- .../idn/v2024/paths/service-desk-integration.yaml | 11 +++-------- .../idn/v2025/paths/service-desk-integration.yaml | 11 +++-------- .../idn/v3/paths/service-desk-integration.yaml | 11 +++-------- 4 files changed, 12 insertions(+), 32 deletions(-) diff --git a/static/api-specs/idn/beta/paths/service-desk-integration.yaml b/static/api-specs/idn/beta/paths/service-desk-integration.yaml index bca1501e7..b44c49816 100644 --- a/static/api-specs/idn/beta/paths/service-desk-integration.yaml +++ b/static/api-specs/idn/beta/paths/service-desk-integration.yaml @@ -152,14 +152,9 @@ patch: content: application/json-patch+json: schema: - type: object - description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - properties: - operations: - description: Operations to be applied - type: array - items: - $ref: '../schemas/JsonPatchOperation.yaml' + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' example: [ { diff --git a/static/api-specs/idn/v2024/paths/service-desk-integration.yaml b/static/api-specs/idn/v2024/paths/service-desk-integration.yaml index abcdfab55..023bf1667 100644 --- a/static/api-specs/idn/v2024/paths/service-desk-integration.yaml +++ b/static/api-specs/idn/v2024/paths/service-desk-integration.yaml @@ -152,14 +152,9 @@ patch: content: application/json-patch+json: schema: - type: object - description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - properties: - operations: - description: Operations to be applied - type: array - items: - $ref: '../schemas/JsonPatchOperation.yaml' + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' example: [ { diff --git a/static/api-specs/idn/v2025/paths/service-desk-integration.yaml b/static/api-specs/idn/v2025/paths/service-desk-integration.yaml index abcdfab55..023bf1667 100644 --- a/static/api-specs/idn/v2025/paths/service-desk-integration.yaml +++ b/static/api-specs/idn/v2025/paths/service-desk-integration.yaml @@ -152,14 +152,9 @@ patch: content: application/json-patch+json: schema: - type: object - description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - properties: - operations: - description: Operations to be applied - type: array - items: - $ref: '../schemas/JsonPatchOperation.yaml' + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' example: [ { diff --git a/static/api-specs/idn/v3/paths/service-desk-integration.yaml b/static/api-specs/idn/v3/paths/service-desk-integration.yaml index b443fdb00..98528994a 100644 --- a/static/api-specs/idn/v3/paths/service-desk-integration.yaml +++ b/static/api-specs/idn/v3/paths/service-desk-integration.yaml @@ -152,14 +152,9 @@ patch: content: application/json-patch+json: schema: - type: object - description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - properties: - operations: - description: Operations to be applied - type: array - items: - $ref: '../schemas/JsonPatchOperation.yaml' + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' example: [ { From e9f62a9cd970b5168a3263d124997825b1b2203b Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 30 Apr 2025 14:26:13 +0000 Subject: [PATCH 78/82] Update to python SDK docs: 14756983852 --- .../Beta/Methods/ServiceDeskIntegrationApi.md | 12 +++--- .../PatchServiceDeskIntegrationRequest.md | 39 ------------------- .../Methods/ServiceDeskIntegrationApi.md | 12 +++--- .../PatchServiceDeskIntegrationRequest.md | 39 ------------------- .../Methods/ServiceDeskIntegrationApi.md | 12 +++--- .../Reference/V2025/Methods/SourcesApi.md | 18 +-------- .../PatchServiceDeskIntegrationRequest.md | 39 ------------------- .../V3/Methods/ServiceDeskIntegrationApi.md | 12 +++--- .../PatchServiceDeskIntegrationRequest.md | 39 ------------------- .../beta/python_code_examples_overlay.yaml | 10 ++--- .../v2024/python_code_examples_overlay.yaml | 10 ++--- .../v2025/python_code_examples_overlay.yaml | 16 ++++---- .../v3/python_code_examples_overlay.yaml | 10 ++--- 13 files changed, 48 insertions(+), 220 deletions(-) delete mode 100644 docs/tools/sdk/python/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md delete mode 100644 docs/tools/sdk/python/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md delete mode 100644 docs/tools/sdk/python/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md delete mode 100644 docs/tools/sdk/python/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md index ec15150f3..d2e555688 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md @@ -504,7 +504,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | ID of the Service Desk integration to update - Body | patch_service_desk_integration_request | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -529,7 +529,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.beta.api_client import ApiClient -from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -537,14 +537,14 @@ configuration = Configuration() with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index 6e677f1f8..000000000 --- a/docs/tools/sdk/python/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: beta-patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'PatchServiceDeskIntegrationRequest', 'BetaPatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/python/beta/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'BetaPatchServiceDeskIntegrationRequest'] ---- - -# PatchServiceDeskIntegrationRequest - -A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] -} - -## Example - -```python -from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - -patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest( -operations=[ - sailpoint.beta.models.json_patch_operation.JsonPatchOperation( - op = 'replace', - path = '/description', - value = New description, ) - ] -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md index 593283055..a6bf72fa3 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md @@ -507,7 +507,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | ID of the Service Desk integration to update - Body | patch_service_desk_integration_request | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -532,7 +532,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.v2024.api_client import ApiClient -from sailpoint.v2024.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -540,14 +540,14 @@ configuration = Configuration() with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v2024.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index 1d36a030c..000000000 --- a/docs/tools/sdk/python/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: v2024-patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'PatchServiceDeskIntegrationRequest', 'V2024PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/python/v2024/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'V2024PatchServiceDeskIntegrationRequest'] ---- - -# PatchServiceDeskIntegrationRequest - -A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] -} - -## Example - -```python -from sailpoint.v2024.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - -patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest( -operations=[ - sailpoint.v2024.models.json_patch_operation.JsonPatchOperation( - op = 'replace', - path = '/description', - value = New description, ) - ] -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md index fa2571539..a4ceb93ce 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md @@ -507,7 +507,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | ID of the Service Desk integration to update - Body | patch_service_desk_integration_request | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -532,7 +532,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.v2025.api_client import ApiClient -from sailpoint.v2025.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest +from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -540,14 +540,14 @@ configuration = Configuration() with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v2025.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md index 63e94ef60..d341b16a5 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md @@ -1826,17 +1826,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## import-accounts -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Account Aggregation Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. @@ -1849,7 +1838,6 @@ You will also need to set the Content-Type header to `multipart/form-data`. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | Source Id - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. | file | **bytearray** | (optional) | The CSV file containing the source accounts to aggregate. | disable_optimization | **str** | (optional) | Use this flag to reprocess every account whether or not the data has changed. @@ -1879,20 +1867,18 @@ from sailpoint.v2025.models.load_accounts_task import LoadAccountsTask from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') file = None # bytearray | The CSV file containing the source accounts to aggregate. (optional) # bytearray | The CSV file containing the source accounts to aggregate. (optional) disable_optimization = 'disable_optimization_example' # str | Use this flag to reprocess every account whether or not the data has changed. (optional) # str | Use this flag to reprocess every account whether or not the data has changed. (optional) try: # Account Aggregation - results = SourcesApi(api_client).import_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental) + results = SourcesApi(api_client).import_accounts(id=id) # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_accounts(id, x_sail_point_experimental, file, disable_optimization) + # results = SourcesApi(api_client).import_accounts(id, file, disable_optimization) print("The response of SourcesApi->import_accounts:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/python/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index ce772ee64..000000000 --- a/docs/tools/sdk/python/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: v2025-patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'PatchServiceDeskIntegrationRequest', 'V2025PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/python/v2025/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'V2025PatchServiceDeskIntegrationRequest'] ---- - -# PatchServiceDeskIntegrationRequest - -A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] -} - -## Example - -```python -from sailpoint.v2025.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - -patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest( -operations=[ - sailpoint.v2025.models.json_patch_operation.JsonPatchOperation( - op = 'replace', - path = '/description', - value = New description, ) - ] -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md index 9321726f7..db0afa750 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md @@ -507,7 +507,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | ID of the Service Desk integration to update - Body | patch_service_desk_integration_request | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -532,7 +532,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.v3.api_client import ApiClient -from sailpoint.v3.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -540,14 +540,14 @@ configuration = Configuration() with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v3.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/python/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index 9072c4be6..000000000 --- a/docs/tools/sdk/python/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'PatchServiceDeskIntegrationRequest', 'PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/python/v3/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'PatchServiceDeskIntegrationRequest'] ---- - -# PatchServiceDeskIntegrationRequest - -A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] -} - -## Example - -```python -from sailpoint.v3.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - -patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest( -operations=[ - sailpoint.v3.models.json_patch_operation.JsonPatchOperation( - op = 'replace', - path = '/description', - value = New description, ) - ] -) - -``` -[[Back to top]](#) - diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index 4aab27707..35e207b96 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -13253,7 +13253,7 @@ source: | from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -13261,13 +13261,13 @@ with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index 0fd76ddd0..d8c8d527a 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -17779,7 +17779,7 @@ source: | from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -17787,13 +17787,13 @@ with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v2024.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index fdecb0cf9..f7da0320a 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -17797,7 +17797,7 @@ source: | from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -17805,13 +17805,13 @@ with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v2025.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -18725,19 +18725,17 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') file = None # bytearray | The CSV file containing the source accounts to aggregate. (optional) # bytearray | The CSV file containing the source accounts to aggregate. (optional) disable_optimization = 'disable_optimization_example' # str | Use this flag to reprocess every account whether or not the data has changed. (optional) # str | Use this flag to reprocess every account whether or not the data has changed. (optional) try: # Account Aggregation - results = SourcesApi(api_client).import_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental) + results = SourcesApi(api_client).import_accounts(id=id) # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_accounts(id, x_sail_point_experimental, file, disable_optimization) + # results = SourcesApi(api_client).import_accounts(id, file, disable_optimization) print("The response of SourcesApi->import_accounts:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index b17ef427b..15ecb74fc 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -9263,7 +9263,7 @@ source: | from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -9271,13 +9271,13 @@ with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v3.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: From 1dce4ea8d51ed65bda804b6be365b2f46e044995 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 30 Apr 2025 15:58:36 +0000 Subject: [PATCH 79/82] Update to powershell SDK docs: 14758910380 --- .../Methods/BetaServiceDeskIntegrationApi.md | 15 +- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../PatchServiceDeskIntegrationRequest.md | 35 - .../Reference/Beta/Models/SourceUsage.md | 2 +- .../Methods/V2024ServiceDeskIntegrationApi.md | 15 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../PatchServiceDeskIntegrationRequest.md | 35 - .../Reference/V2024/Models/SourceUsage.md | 2 +- .../Methods/V2025ServiceDeskIntegrationApi.md | 15 +- .../Reference/V2025/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../PatchServiceDeskIntegrationRequest.md | 35 - .../Reference/V2025/Models/SourceUsage.md | 2 +- .../V3/Methods/ServiceDeskIntegrationApi.md | 15 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../PatchServiceDeskIntegrationRequest.md | 35 - .../Reference/V3/Models/SourceUsage.md | 2 +- .../powershell_code_examples_overlay.yaml | 14753 ++++++++++++ .../powershell_code_examples_overlay.yaml | 18624 +++++++++++++++ .../powershell_code_examples_overlay.yaml | 18634 ++++++++++++++++ .../v3/powershell_code_examples_overlay.yaml | 10230 +++++++++ 24 files changed, 62297 insertions(+), 176 deletions(-) delete mode 100644 docs/tools/sdk/powershell/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md delete mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md delete mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md delete mode 100644 docs/tools/sdk/powershell/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md index 7ee4a0f56..c4c39a560 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md @@ -419,7 +419,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | ID of the Service Desk integration to update - Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -442,16 +442,21 @@ Code | Description | Data Type ### Example ```powershell $Id = "anId" # String | ID of the Service Desk integration to update -$PatchServiceDeskIntegrationRequest = @""@ + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaServiceDeskIntegration -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Update-BetaServiceDeskIntegration -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md index 9d6d48011..f6a1eaaa2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index 414c1c740..4eef80103 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index dbc47da6f..000000000 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: beta-patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest', 'BetaPatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/powershell/beta/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'BetaPatchServiceDeskIntegrationRequest'] ---- - - -# PatchServiceDeskIntegrationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.BetaPatchServiceDeskIntegrationRequest -Operations null -``` - -- Convert the resource to JSON -```powershell -$PatchServiceDeskIntegrationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md index 05cceab03..bb3b65383 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md index aa0efdb40..f7c2a459c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md @@ -422,7 +422,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | ID of the Service Desk integration to update - Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -445,16 +445,21 @@ Code | Description | Data Type ### Example ```powershell $Id = "anId" # String | ID of the Service Desk integration to update -$PatchServiceDeskIntegrationRequest = @""@ + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Update-V2024ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md index b901e027d..9cb9ee94f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index 6393f6ed6..54727248f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index cb5f459d5..000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: v2024-patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest', 'V2024PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/powershell/v2024/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'V2024PatchServiceDeskIntegrationRequest'] ---- - - -# PatchServiceDeskIntegrationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.V2024PatchServiceDeskIntegrationRequest -Operations null -``` - -- Convert the resource to JSON -```powershell -$PatchServiceDeskIntegrationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md index 3d6b4c94a..235e4ab2c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ServiceDeskIntegrationApi.md index be3b41e09..ec098334f 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ServiceDeskIntegrationApi.md @@ -422,7 +422,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | ID of the Service Desk integration to update - Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -445,16 +445,21 @@ Code | Description | Data Type ### Example ```powershell $Id = "anId" # String | ID of the Service Desk integration to update -$PatchServiceDeskIntegrationRequest = @""@ + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2025ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2025ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Update-V2025ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ServiceDeskIntegration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md index 10c9e238e..f0699a5d6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V2025AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2025AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index d31582750..34280ad09 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2025NonEmployee -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index a49f1bcfb..000000000 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: v2025-patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest', 'V2025PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/powershell/v2025/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'V2025PatchServiceDeskIntegrationRequest'] ---- - - -# PatchServiceDeskIntegrationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.V2025PatchServiceDeskIntegrationRequest -Operations null -``` - -- Convert the resource to JSON -```powershell -$PatchServiceDeskIntegrationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md index e5a21ea4d..7c6c72949 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V2025SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2025SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md index 9a1bd5bf2..839484b75 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md @@ -422,7 +422,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | ID of the Service Desk integration to update - Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -445,16 +445,21 @@ Code | Description | Data Type ### Example ```powershell $Id = "anId" # String | ID of the Service Desk integration to update -$PatchServiceDeskIntegrationRequest = @""@ + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Update-ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md index 35c8a92f6..3b9cae031 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index 17d96a073..071f0e39a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V3NonEmployeeReq -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index 9db62fc2d..000000000 --- a/docs/tools/sdk/powershell/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest', 'PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/powershell/v3/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'PatchServiceDeskIntegrationRequest'] ---- - - -# PatchServiceDeskIntegrationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.V3PatchServiceDeskIntegrationRequest -Operations null -``` - -- Convert the resource to JSON -```powershell -$PatchServiceDeskIntegrationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md index 0328c565b..92919ac01 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index 139597f9c..6bc5a0c96 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -1,2 +1,14755 @@ +- path: /access-model-metadata/attributes/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + + # Get Access Model Metadata Attribute + + try { + Get-BetaAccessModelMetadataAttribute -Key $Key + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttribute -Key $Key + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values/{value} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $Value = "public" # String | Technical name of the Attribute value. + + # Get Access Model Metadata Value + + try { + Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + # List Access Model Metadata Attributes + + try { + Get-BetaAccessModelMetadataAttribute + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttribute -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + + # List Access Model Metadata Values + + try { + Get-BetaAccessModelMetadataAttributeValue -Key $Key + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttributeValue -Key $Key + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#create-access-profile + source: | + $AccessProfile = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-BetaAccessProfile -AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-BetaAccessProfile -AccessProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#delete-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-BetaAccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#delete-access-profiles-in-bulk + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-BetaAccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#get-access-profile + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-BetaAccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#get-access-profile-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + Get-BetaAccessProfileEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfileEntitlements" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#list-access-profiles + source: | + $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) + + # List Access Profiles + + try { + Get-BetaAccessProfiles + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#patch-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaAccessProfile -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccessProfile -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-update-requestable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#update-access-profiles-in-bulk + source: | + $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ + + + # Update Access Profile(s) requestable field. + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner + Update-BetaAccessProfilesInBulk -AccessProfileBulkUpdateRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccessProfilesInBulk -AccessProfileBulkUpdateRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#approve-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Approve-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result + + # Below is a request that includes all optional parameters + # Approve-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#forward-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "newOwnerId", + "comment" : "comment" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/approval-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#get-access-request-approval-summary + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-BetaAccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#list-completed-approvals + source: | + $OwnerId = "MyOwnerId" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Completed Access Request Approvals List + + try { + Get-BetaCompletedApprovals + + # Below is a request that includes all optional parameters + # Get-BetaCompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#list-pending-approvals + source: | + $OwnerId = "MyOwnerId" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-BetaPendingApprovals + + # Below is a request that includes all optional parameters + # Get-BetaPendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#reject-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. + $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. + $Type = "ENTITLEMENT" # String | Requested access item's type. + + # Return access request identity metrics + + try { + Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestIdentityMetrics" + Write-Host $_.ErrorDetails + } +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-requests#cancel-access-request + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-BetaAccessRequest -CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-BetaAccessRequest -CancelAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/close + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-requests#close-access-request + source: | + $CloseAccessRequest = @" + { + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + } + "@ + + # Close Access Request + + try { + $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest + Close-BetaAccessRequest -CloseAccessRequest $Result + + # Below is a request that includes all optional parameters + # Close-BetaAccessRequest -CloseAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-requests#create-access-request + source: | + $AccessRequest = @" + { + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-BetaAccessRequest -AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaAccessRequest -AccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-requests#get-access-request-config + source: | + + # Get Access Request Configuration + + try { + Get-BetaAccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-requests#list-access-request-status + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-BetaAccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-requests#set-access-request-config + source: | + $AccessRequestConfig = @" + { + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-BetaAccessRequestConfig -AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaAccessRequestConfig -AccessRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaAccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-activities#get-account-activity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get Account Activity + + try { + Get-BetaAccountActivity -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountActivity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivity" + Write-Host $_.ErrorDetails + } +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-activities#list-account-activities + source: | + $RequestedFor = "MyRequestedFor" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "MyRequestedBy" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "MyRegardingIdentity" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $Type = "MyType" # String | The type of account activity. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-BetaAccountActivities + + # Below is a request that includes all optional parameters + # Get-BetaAccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivities" + Write-Host $_.ErrorDetails + } +- path: /account-aggregations/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-aggregations#get-account-aggregation-status + source: | + $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id + + # In-progress Account Aggregation status + + try { + Get-BetaAccountAggregationStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountAggregationStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#create-account + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-BetaAccount -AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-BetaAccount -AccountAttributesCreate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#delete-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-BetaAccount -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#delete-account-async + source: | + $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id + + # Remove Account + + try { + Remove-BetaAccountAsync -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccountAsync -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountAsync" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#disable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-BetaAccount -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-BetaAccount -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#disable-account-for-identity + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + + # Disable IDN Account for Identity + + try { + Disable-BetaAccountForIdentity -Id $Id + + # Below is a request that includes all optional parameters + # Disable-BetaAccountForIdentity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#disable-accounts-for-identities + source: | + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Disable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Disable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Disable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#enable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-BetaAccount -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-BetaAccount -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#enable-account-for-identity + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + + # Enable IDN Account for Identity + + try { + Enable-BetaAccountForIdentity -Id $Id + + # Below is a request that includes all optional parameters + # Enable-BetaAccountForIdentity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#enable-accounts-for-identities + source: | + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Enable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Enable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Enable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#get-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-BetaAccount -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#get-account-entitlements + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Account Entitlements + + try { + Get-BetaAccountEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountEntitlements -Id $Id -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountEntitlements" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#list-accounts + source: | + $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) + + # Accounts List + + try { + Get-BetaAccounts + + # Below is a request that includes all optional parameters + # Get-BetaAccounts -DetailLevel $DetailLevel -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccounts" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#put-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-BetaAccount -Id $Id -AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-BetaAccount -Id $Id -AccountAttributes $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#submit-reload-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-BetaReloadAccount -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaReloadAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReloadAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#unlock-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-BetaAccount -Id $Id -AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-BetaAccount -Id $Id -AccountUnlockRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#update-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaAccount -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccount -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-BetaUsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/application-discovery#get-discovered-application-by-id + source: | + $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. + + # Get Discovered Application by ID + + try { + Get-BetaDiscoveredApplicationByID -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaDiscoveredApplicationByID -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplicationByID" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/application-discovery#get-discovered-applications + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + + # Retrieve discovered applications for tenant + + try { + Get-BetaDiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-BetaDiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplications" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + + # Download CSV Template for Discovery + + try { + Get-BetaManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-BetaManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/application-discovery#patch-discovered-application-by-id + source: | + $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. + $JsonPatchOperations = @"{ + "op" : "replace", + "path" : "/dismissed", + "value" : true + }"@ + + + # Patch Discovered Application by ID + + try { + Update-BetaDiscoveredApplicationByID -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaDiscoveredApplicationByID -Id $Id -JsonPatchOperations $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaDiscoveredApplicationByID" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + # Upload CSV to Discover Applications + + try { + Send-BetaManualDiscoverApplicationsCsvTemplate -File $File + + # Below is a request that includes all optional parameters + # Send-BetaManualDiscoverApplicationsCsvTemplate -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/approvals#get-approval + source: | + $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned. + + # Get Approval + + try { + Get-BetaApproval -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaApproval -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApproval" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/approvals#get-approvals + source: | + $Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional) + $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. (optional) + $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) + + # Get Approvals + + try { + Get-BetaApprovals + + # Below is a request that includes all optional parameters + # Get-BetaApprovals -Mine $Mine -RequesterId $RequesterId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApprovals" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#create-source-app + source: | + $SourceAppCreateDto = @" + { + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + } + "@ + + # Create source app + + try { + $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto + New-BetaSourceApp -SourceAppCreateDto $Result + + # Below is a request that includes all optional parameters + # New-BetaSourceApp -SourceAppCreateDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # Bulk remove access profiles from the specified source app + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-BetaAccessProfilesFromSourceAppByBulk -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfilesFromSourceAppByBulk -Id $Id -RequestBody $Result -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesFromSourceAppByBulk" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#delete-source-app + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. + + # Delete source app by ID + + try { + Remove-BetaSourceApp -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSourceApp -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#get-source-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + + # Get source app by ID + + try { + Get-BetaSourceApp -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceApp -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-access-profiles-for-source-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "developer access profile"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List access profiles for the specified source app + + try { + Get-BetaAccessProfilesForSourceApp -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfilesForSourceApp -Id $Id -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfilesForSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-all-source-app + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "enabled eq true" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + # List all source apps + + try { + Get-BetaAllSourceApp + + # Below is a request that includes all optional parameters + # Get-BetaAllSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-all-user-apps + source: | + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List all user apps + + try { + Get-BetaAllUserApps -Filters $Filters + + # Below is a request that includes all optional parameters + # Get-BetaAllUserApps -Filters $Filters -Limit $Limit -Count $Count -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/assigned + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-assigned-source-app + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List assigned source apps + + try { + Get-BetaAssignedSourceApp + + # Below is a request that includes all optional parameters + # Get-BetaAssignedSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAssignedSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id}/available-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-available-accounts-for-user-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List available accounts for user app + + try { + Get-BetaAvailableAccountsForUserApp -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAvailableAccountsForUserApp -Id $Id -Limit $Limit -Count $Count -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableAccountsForUserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-available-source-apps + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List available source apps + + try { + Get-BetaAvailableSourceApps + + # Below is a request that includes all optional parameters + # Get-BetaAvailableSourceApps -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableSourceApps" + Write-Host $_.ErrorDetails + } +- path: /user-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-owned-user-apps + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + # List owned user apps + + try { + Get-BetaOwnedUserApps + + # Below is a request that includes all optional parameters + # Get-BetaOwnedUserApps -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOwnedUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#patch-source-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch source app by ID + + try { + Update-BetaSourceApp -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaSourceApp -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#patch-user-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch user app by ID + + try { + Update-BetaUserApp -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaUserApp -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#update-source-apps-in-bulk + source: | + $SourceAppBulkUpdateRequest = @" + { + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + } + "@ + + # Bulk update source apps + + try { + Update-BetaSourceAppsInBulk + + # Below is a request that includes all optional parameters + # Update-BetaSourceAppsInBulk -SourceAppBulkUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceAppsInBulk" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/auth-profile#get-profile-config + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to get. + + # Get Auth Profile. + + try { + Get-BetaProfileConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaProfileConfig -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/auth-profile#get-profile-config-list + source: | + + # Get list of Auth Profiles. + + try { + Get-BetaProfileConfigList + + # Below is a request that includes all optional parameters + # Get-BetaProfileConfigList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfigList" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/auth-profile#patch-profile-config + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Auth Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaProfileConfig -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaProfileConfig -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#complete-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CompleteCampaignOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-BetaCampaign -Id $Id + + # Below is a request that includes all optional parameters + # Complete-BetaCampaign -Id $Id -CompleteCampaignOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#create-campaign + source: | + $Campaign = @" + { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + } + "@ + + # Create Campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-BetaCampaign -Campaign $Result + + # Below is a request that includes all optional parameters + # New-BetaCampaign -Campaign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#create-campaign-template + source: | + $CampaignTemplate = @" + { + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-BetaCampaignTemplate -CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-BetaCampaignTemplate -CampaignTemplate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#delete-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-BetaCampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#delete-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-BetaCampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaCampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#delete-campaigns + source: | + $DeleteCampaignsRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest + Remove-BetaCampaigns -DeleteCampaignsRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaCampaigns -DeleteCampaignsRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-active-campaigns + source: | + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + + # List Campaigns + + try { + Get-BetaActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-BetaActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaActiveCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + + # Get Campaign + + try { + Get-BetaCampaign -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaign -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-reports + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-BetaCampaignReports -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignReports -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReports" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-reports-config + source: | + + # Get Campaign Reports Configuration + + try { + Get-BetaCampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-BetaCampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-BetaCampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-BetaCampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-templates + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-BetaCampaignTemplates + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplates" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#move + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move-Beta -Id $Id -AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move-Beta -Id $Id -AdminReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-Beta" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#patch-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaCampaignTemplate -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaCampaignTemplate -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#set-campaign-reports-config + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-BetaCampaignReportsConfig -CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaCampaignReportsConfig -CampaignReportsConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#set-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. + $Schedule = @" + { + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-BetaCampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Set-BetaCampaignTemplateSchedule -Id $Id -Schedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-BetaCampaign -Id $Id + + # Below is a request that includes all optional parameters + # Start-BetaCampaign -Id $Id -ActivateCampaignOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-campaign-remediation-scan + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-BetaCampaignRemediationScan -Id $Id + + # Below is a request that includes all optional parameters + # Start-BetaCampaignRemediationScan -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignRemediationScan" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-report/{type} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-campaign-report + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of report to run. + + # Run Campaign Report + + try { + Start-BetaCampaignReport -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Start-BetaCampaignReport -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignReport" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-generate-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-BetaGenerateCampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Start-BetaGenerateCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaGenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#update-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign being modified. + $RequestBody = # SystemCollectionsHashtable[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + $RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaCampaign -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaCampaign -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certifications#get-identity-certification-item-permissions + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Permissions for Entitlement Certification Item + + try { + Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/tasks-pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certifications#get-identity-certification-pending-tasks + source: | + $Id = "MyId" # String | The identity campaign certification ID + + # Pending Certification Tasks + + try { + Get-BetaIdentityCertificationPendingTasks -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationPendingTasks -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationPendingTasks" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/tasks/{taskId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certifications#get-identity-certification-task-status + source: | + $Id = "MyId" # String | The identity campaign certification ID + $TaskId = "MyTaskId" # String | The certification task ID + + # Certification Task Status + + try { + Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationTaskStatus" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certifications#list-certification-reviewers + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + + # List of Reviewers for certification + + try { + Get-BetaCertificationReviewers -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaCertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertificationReviewers" + Write-Host $_.ErrorDetails + } +- path: /certifications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certifications#list-certifications + source: | + $ReviewerIdentitiy = "MyReviewerIdentitiy" # String | The ID of reviewer identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) + + # Certifications by IDs + + try { + Get-BetaCertifications + + # Below is a request that includes all optional parameters + # Get-BetaCertifications -ReviewerIdentitiy $ReviewerIdentitiy -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certifications#submit-reassign-certs-async + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-BetaReassignCertsAsync -Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-BetaReassignCertsAsync -Id $Id -ReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReassignCertsAsync" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#create-connector-rule + source: | + $ConnectorRuleCreateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + } + "@ + + # Create Connector Rule + + try { + $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest + New-BetaConnectorRule -ConnectorRuleCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaConnectorRule -ConnectorRuleCreateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#delete-connector-rule + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete + + # Delete a Connector-Rule + + try { + Remove-BetaConnectorRule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaConnectorRule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#get-connector-rule + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve + + # Connector-Rule by ID + + try { + Get-BetaConnectorRule -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaConnectorRule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#get-connector-rule-list + source: | + + # List Connector Rules + + try { + Get-BetaConnectorRuleList + + # Below is a request that includes all optional parameters + # Get-BetaConnectorRuleList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRuleList" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#update-connector-rule + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update + $ConnectorRuleUpdateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + } + "@ + + # Update a Connector Rule + + try { + Update-BetaConnectorRule -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaConnectorRule -Id $Id -ConnectorRuleUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/validate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#validate-connector-rule + source: | + $SourceCode = @" + { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } + "@ + + # Validate Connector Rule + + try { + $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode + Confirm-BetaConnectorRule -SourceCode $Result + + # Below is a request that includes all optional parameters + # Confirm-BetaConnectorRule -SourceCode $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Confirm-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connectors#get-connector-list + source: | + $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector List + + try { + Get-BetaConnectorList + + # Below is a request that includes all optional parameters + # Get-BetaConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorList" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition + source: | + $CreateFormDefinitionRequest = @" + { + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + } + "@ + + # Creates a form definition. + + try { + New-BetaFormDefinition + + # Below is a request that includes all optional parameters + # New-BetaFormDefinition -CreateFormDefinitionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/template + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition-by-template + source: | + $CreateFormDefinitionRequest = @" + { + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + } + "@ + + # Create a form definition by template. + + try { + New-BetaFormDefinitionByTemplate + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionByTemplate -CreateFormDefinitionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionByTemplate" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/forms-action-dynamic-schema + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition-dynamic-schema + source: | + $Body = @" + { + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + } + "@ + + # Generate JSON Schema dynamically. + + try { + New-BetaFormDefinitionDynamicSchema + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionDynamicSchema -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionDynamicSchema" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition-file-request + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID + $File = # System.IO.FileInfo | File specifying the multipart + + # Upload new form definition file. + + try { + New-BetaFormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionFileRequest" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-instance + source: | + $Body = @" + { + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + } + "@ + + # Creates a form instance. + + try { + New-BetaFormInstance + + # Below is a request that includes all optional parameters + # New-BetaFormInstance -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#delete-form-definition + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + + # Deletes a form definition. + + try { + Remove-BetaFormDefinition -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Remove-BetaFormDefinition -FormDefinitionID $FormDefinitionID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaFormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#export-form-definitions-by-tenant + source: | + $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # List form definitions by tenant. + + try { + Export-BetaFormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Export-BetaFormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaFormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-file-from-s3 + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + + # Download definition file by fileId. + + try { + Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID + + # Below is a request that includes all optional parameters + # Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFileFromS3" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-form-definition-by-key + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + + # Return a form definition. + + try { + Get-BetaFormDefinitionByKey -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Get-BetaFormDefinitionByKey -FormDefinitionID $FormDefinitionID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormDefinitionByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-form-instance-by-key + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + + # Returns a form instance. + + try { + Get-BetaFormInstanceByKey -FormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Get-BetaFormInstanceByKey -FormInstanceID $FormInstanceID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-form-instance-file + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + + # Download instance file by fileId. + + try { + Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID + + # Below is a request that includes all optional parameters + # Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceFile" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#import-form-definitions + source: | + + + + + $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ + + + # Import form definitions from export. + + try { + Import-BetaFormDefinitions + + # Below is a request that includes all optional parameters + # Import-BetaFormDefinitions -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaFormDefinitions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#patch-form-definition + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/description, value=test-description}]"@ + + + # Patch a form definition. + + try { + Update-BetaFormDefinition -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Update-BetaFormDefinition -FormDefinitionID $FormDefinitionID -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#patch-form-instance + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ + + + # Patch a form instance. + + try { + Update-BetaFormInstance -FormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Update-BetaFormInstance -FormInstanceID $FormInstanceID -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-form-definitions-by-tenant + source: | + $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # Export form definitions by tenant. + + try { + Search-BetaFormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Search-BetaFormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-form-element-data-by-element-id + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $FormElementID = "1" # String | Form element ID + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + + # Retrieves dynamic data by element. + + try { + Search-BetaFormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID + + # Below is a request that includes all optional parameters + # Search-BetaFormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormElementDataByElementID" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-form-instances-by-tenant + source: | + + # List form instances by tenant. + + try { + Search-BetaFormInstancesByTenant + + # Below is a request that includes all optional parameters + # Search-BetaFormInstancesByTenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormInstancesByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/predefined-select-options + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-pre-defined-select-options + source: | + + # List predefined select options. + + try { + Search-BetaPreDefinedSelectOptions + + # Below is a request that includes all optional parameters + # Search-BetaPreDefinedSelectOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPreDefinedSelectOptions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/data-source + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#show-preview-data-source + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + $FormElementPreviewRequest = @" + { + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + } + "@ + + # Preview form definition data source. + + try { + Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaPreviewDataSource" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-password-instructions#create-custom-password-instructions + source: | + $CustomPasswordInstruction = @" + { + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + } + "@ + + # Create Custom Password Instructions + + try { + $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction + New-BetaCustomPasswordInstructions -CustomPasswordInstruction $Result + + # Below is a request that includes all optional parameters + # New-BetaCustomPasswordInstructions -CustomPasswordInstruction $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-password-instructions#delete-custom-password-instructions + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Delete Custom Password Instructions by page ID + + try { + Remove-BetaCustomPasswordInstructions -PageId $PageId + + # Below is a request that includes all optional parameters + # Remove-BetaCustomPasswordInstructions -PageId $PageId -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-password-instructions#get-custom-password-instructions + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Get Custom Password Instructions by Page ID + + try { + Get-BetaCustomPasswordInstructions -PageId $PageId + + # Below is a request that includes all optional parameters + # Get-BetaCustomPasswordInstructions -PageId $PageId -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Add metadata to an entitlement. + + try { + New-BetaAccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # New-BetaAccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessModelMetadataForEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Remove metadata from an entitlement. + + try { + Remove-BetaAccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Remove-BetaAccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessModelMetadataFromEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#get-entitlement + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID + + # Get an entitlement + + try { + Get-BetaEntitlement -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlement -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#get-entitlement-request-config + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + + # Get Entitlement Request Config + + try { + Get-BetaEntitlementRequestConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementRequestConfig -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/aggregate/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#import-entitlements-by-source + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Aggregate Entitlements + + try { + Import-BetaEntitlementsBySource -Id $Id + + # Below is a request that includes all optional parameters + # Import-BetaEntitlementsBySource -Id $Id -CsvFile $CsvFile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlementsBySource" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/children + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#list-entitlement-children + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements children + + try { + Get-BetaEntitlementChildren -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementChildren -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChildren" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/parents + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#list-entitlement-parents + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements parents + + try { + Get-BetaEntitlementParents -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementParents -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementParents" + Write-Host $_.ErrorDetails + } +- path: /entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#list-entitlements + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) + $SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + $IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + # Gets a list of entitlements. + + try { + Get-BetaEntitlements + + # Below is a request that includes all optional parameters + # Get-BetaEntitlements -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#patch-entitlement + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an entitlement + + try { + Update-BetaEntitlement -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaEntitlement -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#put-entitlement-request-config + source: | + $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID + $EntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Replace Entitlement Request Config + + try { + $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig + Send-BetaEntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaEntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/reset/sources/{sourceId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#reset-source-entitlements + source: | + $SourceId = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset + + # Reset Source Entitlements + + try { + Reset-BetaSourceEntitlements -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Reset-BetaSourceEntitlements -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaSourceEntitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#update-entitlements-in-bulk + source: | + $EntitlementBulkUpdateRequest = @" + { + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + } + "@ + + # Bulk update an entitlement list + + try { + $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest + Update-BetaEntitlementsInBulk -EntitlementBulkUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaEntitlementsInBulk -EntitlementBulkUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsInBulk" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#create-workgroup + source: | + $WorkgroupDto = @" + { + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Create a new Governance Group. + + try { + $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto + New-BetaWorkgroup -WorkgroupDto $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkgroup -WorkgroupDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#delete-workgroup + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + + # Delete a Governance Group + + try { + Remove-BetaWorkgroup -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#delete-workgroup-members + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $BulkWorkgroupMembersRequestInner = @""@ + + + # Remove members from Governance Group + + try { + $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner + Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#delete-workgroups-in-bulk + source: | + $WorkgroupBulkDeleteRequest = @" + { + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + } + "@ + + # Delete Governance Group(s) + + try { + $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest + Remove-BetaWorkgroupsInBulk -WorkgroupBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroupsInBulk -WorkgroupBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupsInBulk" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#get-workgroup + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + + # Get Governance Group by Id + + try { + Get-BetaWorkgroup -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#list-connections + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List connections for Governance Group + + try { + Get-BetaConnections -WorkgroupId $WorkgroupId + + # Below is a request that includes all optional parameters + # Get-BetaConnections -WorkgroupId $WorkgroupId -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnections" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#list-workgroup-members + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Governance Group Members + + try { + Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#list-workgroups + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "Test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) + + # List Governance Groups + + try { + Get-BetaWorkgroups + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroups -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroups" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#patch-workgroup + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Governance Group + + try { + Update-BetaWorkgroup -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaWorkgroup -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#update-workgroup-members + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $BulkWorkgroupMembersRequestInner = @""@ + + + # Add members to Governance Group + + try { + $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner + Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Ignore Access Request Recommendation + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsIgnoredItem -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsIgnoredItem -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsIgnoredItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Accept Access Request Recommendation + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsRequestedItem -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsRequestedItem -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsRequestedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Mark Viewed Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsViewedItem -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsViewedItem -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + $AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }"@ + + + # Bulk Mark Viewed Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsViewedItems -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsViewedItems -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + $Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) + $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + # Identity Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendations + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendations -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendations" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List Ignored Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendationsIgnoredItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsIgnoredItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsIgnoredItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List Accepted Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendationsRequestedItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsRequestedItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsRequestedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List Viewed Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendationsViewedItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsViewedItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-common-access#create-common-access + source: | + $CommonAccessItemRequest = @" + { + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + } + "@ + + # Create common access items + + try { + $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest + New-BetaCommonAccess -CommonAccessItemRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaCommonAccess -CommonAccessItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-common-access#get-common-access + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.type eq "ROLE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + # Get a paginated list of common access + + try { + Get-BetaCommonAccess + + # Below is a request that includes all optional parameters + # Get-BetaCommonAccess -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access/update-status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-common-access#update-common-access-status-in-bulk + source: | + $CommonAccessIDStatus = @"{ + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + }"@ + + + # Bulk update common access status + + try { + $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus + Update-BetaCommonAccessStatusInBulk -CommonAccessIDStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaCommonAccessStatusInBulk -CommonAccessIDStatus $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCommonAccessStatusInBulk" + Write-Host $_.ErrorDetails + } +- path: /translation-catalogs/{catalog-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-message-catalogs#get-message-catalogs + source: | + $CatalogId = "recommender" # String | The ID of the message catalog. + + # Get Message catalogs + + try { + Get-BetaMessageCatalogs -CatalogId $CatalogId + + # Below is a request that includes all optional parameters + # Get-BetaMessageCatalogs -CatalogId $CatalogId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMessageCatalogs" + Write-Host $_.ErrorDetails + } +- path: /outliers/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#export-outliers-zip + source: | + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Export + + try { + Export-BetaOutliersZip + + # Below is a request that includes all optional parameters + # Export-BetaOutliersZip -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaOutliersZip" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-identity-outlier-snapshots + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) + $Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) + + # IAI Identity Outliers Summary + + try { + Get-BetaIdentityOutlierSnapshots + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOutlierSnapshots -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-identity-outliers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) + + # IAI Get Identity Outliers + + try { + Get-BetaIdentityOutliers + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOutliers -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries/latest + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Latest Summary + + try { + Get-BetaLatestIdentityOutlierSnapshots + + # Below is a request that includes all optional parameters + # Get-BetaLatestIdentityOutlierSnapshots -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLatestIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outlier-feature-summaries/{outlierFeatureId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id + + # Get identity outlier contibuting feature summary + + try { + Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId + + # Below is a request that includes all optional parameters + # Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutlierContributingFeatureSummary" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/contributing-features + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) + $Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) + + # Get identity outlier's contibuting features + + try { + Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId + + # Below is a request that includes all optional parameters + # Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliersContributingFeatures" + Write-Host $_.ErrorDetails + } +- path: /outliers/ignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#ignore-identity-outliers + source: | + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Ignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + $Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) + + # Gets a list of access items associated with each identity outlier contributing feature + + try { + Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName + + # Below is a request that includes all optional parameters + # Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutliersContributingFeatureAccessItems" + Write-Host $_.ErrorDetails + } +- path: /outliers/unignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#un-ignore-identity-outliers + source: | + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Unignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaUnIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /peer-group-strategies/{strategy}/identity-outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Identity Outliers List + + try { + Get-BetaPeerGroupOutliers -Strategy $Strategy + + # Below is a request that includes all optional parameters + # Get-BetaPeerGroupOutliers -Strategy $Strategy -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliers" + Write-Host $_.ErrorDetails + } +- path: /recommendations/request + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#get-recommendations + source: | + $RecommendationRequestDto = @" + { + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + } + "@ + + # Returns Recommendation Based on Object + + try { + $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto + Get-BetaRecommendations -RecommendationRequestDto $Result + + # Below is a request that includes all optional parameters + # Get-BetaRecommendations -RecommendationRequestDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#get-recommendations-config + source: | + + # Get certification recommendation config values + + try { + Get-BetaRecommendationsConfig + + # Below is a request that includes all optional parameters + # Get-BetaRecommendationsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#update-recommendations-config + source: | + $RecommendationConfigDto = @" + { + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + } + "@ + + # Update certification recommendation config values + + try { + $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto + Update-BetaRecommendationsConfig -RecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Update-BetaRecommendationsConfig -RecommendationConfigDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#create-potential-role-provision-request + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) + $RoleMiningPotentialRoleProvisionRequest = @" + { + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + } + "@ + + # Create request to provision a potential role into an actual role. + + try { + New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPotentialRoleProvisionRequest" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#create-role-mining-sessions + source: | + $RoleMiningSessionDto = @" + { + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + } + "@ + + # Create a role mining session + + try { + $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto + New-BetaRoleMiningSessions -RoleMiningSessionDto $Result + + # Below is a request that includes all optional parameters + # New-BetaRoleMiningSessions -RoleMiningSessionDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + + # Export (download) details for a potential role in a role mining session + + try { + Invoke-BetaDownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId + + # Below is a request that includes all optional parameters + # Invoke-BetaDownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleMiningPotentialRoleZip" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#export-role-mining-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + + # Export (download) details for a potential role in a role mining session + + try { + Export-BetaRoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $RoleMiningPotentialRoleExportRequest = @" + { + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + } + "@ + + # Asynchronously export details for a potential role in a role mining session and upload to S3 + + try { + Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleExportRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleAsync" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + + # Retrieve status of a potential role export job + + try { + Export-BetaRoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-all-potential-role-summaries + source: | + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all potential role summaries + + try { + Get-BetaAllPotentialRoleSummaries + + # Below is a request that includes all optional parameters + # Get-BetaAllPotentialRoleSummaries -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) + + # Retrieves entitlement popularity distribution for a potential role in a role mining session + + try { + Get-BetaEntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -IncludeCommonAccess $IncludeCommonAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementDistributionPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-entitlements-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) + $Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves entitlements for a potential role in a role mining session + + try { + Get-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves excluded entitlements for a potential role in a role mining session + + try { + Get-BetaExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaExcludedEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-identities-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves identities for a potential role in a role mining session + + try { + Get-BetaIdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaIdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitiesPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + + # Retrieve potential role in session + + try { + Get-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-applications + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the applications of a potential role for a role mining session + + try { + Get-BetaPotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleApplications" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-entitlements + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the entitlements of a potential role for a role mining session + + try { + Get-BetaPotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id + $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id + $Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves potential role source usage + + try { + Get-BetaPotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSourceIdentityUsage" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-summaries + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) + $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve session's potential role summaries + + try { + Get-BetaPotentialRoleSummaries -SessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleSummaries -SessionId $SessionId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-potential-role + source: | + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id + + # Retrieves a specific potential role + + try { + Get-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-session + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. + + # Get a role mining session + + try { + Get-BetaRoleMiningSession -SessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSession -SessionId $SessionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-session-status + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + + # Get role mining session status state + + try { + Get-BetaRoleMiningSessionStatus -SessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSessionStatus -SessionId $SessionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessionStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-sessions + source: | + $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) + $Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all role mining sessions + + try { + Get-BetaRoleMiningSessions + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSessions -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/saved + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-saved-potential-roles + source: | + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all saved potential roles + + try { + Get-BetaSavedPotentialRoles + + # Below is a request that includes all optional parameters + # Get-BetaSavedPotentialRoles -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSavedPotentialRoles" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#patch-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role in session + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#patch-role-mining-potential-role + source: | + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#patch-role-mining-session + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a role mining session + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaRoleMiningSession -SessionId $SessionId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaRoleMiningSession -SessionId $SessionId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#update-entitlements-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $RoleMiningPotentialRoleEditEntitlements = @" + { + "ids" : [ "entId1", "entId2" ], + "exclude" : true + } + "@ + + # Edit entitlements for a potential role to exclude some entitlements + + try { + $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements + Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleEditEntitlements $Result + + # Below is a request that includes all optional parameters + # Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleEditEntitlements $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/icons#delete-icon + source: | + $ObjectType = "application" # String | Object type + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + + # Delete an icon + + try { + Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId + + # Below is a request that includes all optional parameters + # Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIcon" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/icons#set-icon + source: | + $ObjectType = "application" # String | Object type + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + # Update an icon + + try { + Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image + + # Below is a request that includes all optional parameters + # Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIcon" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#delete-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + + # Delete identity + + try { + Remove-BetaIdentity -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaIdentity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#get-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + + # Identity Details + + try { + Get-BetaIdentity -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/ownership + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#get-identity-ownership-details + source: | + $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. + + # Get ownership details + + try { + Get-BetaIdentityOwnershipDetails -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOwnershipDetails -IdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOwnershipDetails" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#get-role-assignment + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id + + # Role assignment details + + try { + Get-BetaRoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignment" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#get-role-assignments + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for + $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) + $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) + + # List role assignments + + try { + Get-BetaRoleAssignments -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignments -IdentityId $IdentityId -RoleId $RoleId -RoleName $RoleName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignments" + Write-Host $_.ErrorDetails + } +- path: /identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#list-identities + source: | + $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) + $Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) + $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Identities + + try { + Get-BetaIdentities + + # Below is a request that includes all optional parameters + # Get-BetaIdentities -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentities" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/reset + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#reset-identity + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + + # Reset an identity + + try { + Reset-BetaIdentity -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Reset-BetaIdentity -IdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/verification/account/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#send-identity-verification-account-token + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $SendAccountVerificationRequest = @" + { + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + } + "@ + + # Send password reset email + + try { + $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest + Send-BetaIdentityVerificationAccountToken -Id $Id -SendAccountVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaIdentityVerificationAccountToken -Id $Id -SendAccountVerificationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityVerificationAccountToken" + Write-Host $_.ErrorDetails + } +- path: /identities/invite + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#start-identities-invite + source: | + $InviteIdentitiesRequest = @" + { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } + "@ + + # Invite identities to register + + try { + $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest + Start-BetaIdentitiesInvite -InviteIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-BetaIdentitiesInvite -InviteIdentitiesRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentitiesInvite" + Write-Host $_.ErrorDetails + } +- path: /identities/process + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#start-identity-processing + source: | + $ProcessIdentitiesRequest = @" + { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } + "@ + + # Process a list of identityIds + + try { + $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest + Start-BetaIdentityProcessing -ProcessIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-BetaIdentityProcessing -ProcessIdentitiesRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentityProcessing" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#synchronize-attributes-for-identity + source: | + $IdentityId = "MyIdentityId" # String | The Identity id + + # Attribute synchronization for single identity. + + try { + Sync-BetahronizeAttributesForIdentity -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Sync-BetahronizeAttributesForIdentity -IdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetahronizeAttributesForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#create-identity-attribute + source: | + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Create Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + New-BetaIdentityAttribute -IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # New-BetaIdentityAttribute -IdentityAttribute $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#delete-identity-attribute + source: | + $Name = "displayName" # String | The attribute's technical name. + + # Delete Identity Attribute + + try { + Remove-BetaIdentityAttribute -Name $Name + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityAttribute -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/bulk-delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + $IdentityAttributeNames = @" + { + "ids" : [ "name", "displayName" ] + } + "@ + + # Bulk delete Identity Attributes + + try { + $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames + Remove-BetaIdentityAttributesInBulk -IdentityAttributeNames $Result + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityAttributesInBulk -IdentityAttributeNames $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#get-identity-attribute + source: | + $Name = "displayName" # String | The attribute's technical name. + + # Get Identity Attribute + + try { + Get-BetaIdentityAttribute -Name $Name + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAttribute -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#list-identity-attributes + source: | + $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) + $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) + $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Identity Attributes + + try { + Get-BetaIdentityAttributes + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAttributes -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttributes" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#put-identity-attribute + source: | + $Name = "displayName" # String | The attribute's technical name. + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Update Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + Send-BetaIdentityAttribute -Name $Name -IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # Send-BetaIdentityAttribute -Name $Name -IdentityAttribute $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#compare-identity-snapshots + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a difference of count for each access item types for the given identity between 2 snapshots + + try { + Compare-BetaIdentitySnapshots -Id $Id + + # Below is a request that includes all optional parameters + # Compare-BetaIdentitySnapshots -Id $Id -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare/{accessType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#compare-identity-snapshots-access-type + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $AccessType = "accessProfile" # String | The specific type which needs to be compared + $AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + $Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a list of differences of specific accessType for the given identity between 2 snapshots + + try { + Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType + + # Below is a request that includes all optional parameters + # Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshotsAccessType" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-historical-identity + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + + # Get latest snapshot of identity + + try { + Get-BetaHistoricalIdentity -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentity" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/events + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-historical-identity-events + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) + $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) + + $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + $AccessItemTypes = @"[entitlement, account]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all events for the given identity + + try { + Get-BetaHistoricalIdentityEvents -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentityEvents -Id $Id -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentityEvents" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-identity-snapshot + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + + # Gets an identity snapshot at a given date + + try { + Get-BetaIdentitySnapshot -Id $Id -Date $Date + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshot -Id $Id -Date $Date + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshot" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshot-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-identity-snapshot-summary + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) + $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) + $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets the summary for the event count for a specific identity + + try { + Get-BetaIdentitySnapshotSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshotSummary -Id $Id -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotSummary" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/start-date + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-identity-start-date + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + + # Gets the start date of the identity + + try { + Get-BetaIdentityStartDate -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityStartDate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityStartDate" + Write-Host $_.ErrorDetails + } +- path: /historical-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-historical-identities + source: | + $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) + $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) + $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # Lists all the identities + + try { + Get-BetaHistoricalIdentities + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentities -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentities" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-identity-access-items + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) + $Filters = "source eq "DataScienceDataset"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) + $Query = "Dr. Arden" # String | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Access Items by Identity + + try { + Get-BetaIdentityAccessItems -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAccessItems -Id $Id -Type $Type -Filters $Filters -Sorters $Sorters -Query $Query -Limit $Limit -Count $Count -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-identity-snapshot-access-items + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Identity ID. + $Date = "2007-03-01T13:00:00Z" # String | Specified date. + $Type = "role" # String | Access item type. (optional) + + # Get Identity Access Items Snapshot + + try { + Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-identity-snapshots + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) + $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all the snapshots for the identity + + try { + Get-BetaIdentitySnapshots -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshots -Id $Id -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#create-identity-profile + source: | + $IdentityProfile = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2023-01-03T21:16:22.432Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "id" : "id12345" + } + "@ + + # Create Identity Profile + + try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-BetaIdentityProfile -IdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-BetaIdentityProfile -IdentityProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#delete-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + + # Delete Identity Profile + + try { + Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#delete-identity-profiles + source: | + $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ + + + # Delete Identity Profiles + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-BetaIdentityProfiles -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityProfiles -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#export-identity-profiles + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + $Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + + # Export Identity Profiles + + try { + Export-BetaIdentityProfiles + + # Below is a request that includes all optional parameters + # Export-BetaIdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#get-default-identity-attribute-config + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + + # Default identity attribute config + + try { + Get-BetaDefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-BetaDefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#get-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + + # Get Identity Profile + + try { + Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#import-identity-profiles + source: | + + + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + }"@ + + + # Import Identity Profiles + + try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-BetaIdentityProfiles -IdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-BetaIdentityProfiles -IdentityProfileExportedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#list-identity-profiles + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + $Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + # List Identity Profiles + + try { + Get-BetaIdentityProfiles + + # Below is a request that includes all optional parameters + # Get-BetaIdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#show-generate-identity-preview + source: | + $IdentityPreviewRequest = @" + { + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + } + "@ + + # Generate Identity Profile Preview + + try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + Show-BetaGenerateIdentityPreview -IdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # Show-BetaGenerateIdentityPreview -IdentityPreviewRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaGenerateIdentityPreview" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#sync-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + + # Process identities under profile + + try { + Sync-BetaIdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-BetaIdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#update-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Identity Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /launchers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/launchers#create-launcher + source: | + $LauncherRequest = @" + { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } + "@ + + # Create launcher + + try { + $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest + New-BetaLauncher -LauncherRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaLauncher -LauncherRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /launchers/{launcherID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/launchers#delete-launcher + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted + + # Delete Launcher + + try { + Remove-BetaLauncher -LauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Remove-BetaLauncher -LauncherID $LauncherID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /launchers/{launcherID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/launchers#get-launcher + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved + + # Get Launcher by ID + + try { + Get-BetaLauncher -LauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Get-BetaLauncher -LauncherID $LauncherID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /launchers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/launchers#get-launchers + source: | + $Filters = "disabled eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) + $Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional) + $Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10) + + # List all Launchers for tenant + + try { + Get-BetaLaunchers + + # Below is a request that includes all optional parameters + # Get-BetaLaunchers -Filters $Filters -Next $Next -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLaunchers" + Write-Host $_.ErrorDetails + } +- path: /launchers/{launcherID} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/launchers#put-launcher + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced + $LauncherRequest = @" + { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } + "@ + + # Replace Launcher + + try { + $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest + Send-BetaLauncher -LauncherID $LauncherID -LauncherRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaLauncher -LauncherID $LauncherID -LauncherRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /beta/launchers/{launcherID}/launch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/launchers#start-launcher + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched + + # Launch a Launcher + + try { + Start-BetaLauncher -LauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Start-BetaLauncher -LauncherID $LauncherID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/lifecycle-states#get-lifecycle-states + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. + + # Get Lifecycle State + + try { + Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/lifecycle-states#update-lifecycle-states + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Lifecycle State + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to get + $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get + + # Specified Managed Client Status. + + try { + Get-BetaManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-BetaManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to update + $ManagedClientStatus = @" + { + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } + "@ + + # Handle status request from client + + try { + $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus + Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for + + # Get managed cluster's log configuration + + try { + Get-BetaClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster + source: | + $Id = "aClusterId" # String | ID of the ManagedCluster to get + + # Get a specified ManagedCluster. + + try { + Get-BetaManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq operation" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Retrieve all Managed Clusters. + + try { + Get-BetaManagedClusters + + # Below is a request that includes all optional parameters + # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for + $ClientLogConfiguration = @" + { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } + "@ + + # Update managed cluster's log configuration + + try { + Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result + + # Below is a request that includes all optional parameters + # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#delete-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # Delete MFA method configuration + + try { + Remove-BetaMFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Remove-BetaMFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMFAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-BetaMFADuoConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-kba-config + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-BetaMFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-BetaMFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#set-mfa-duo-config + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-BetaMFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#set-mfakba-config + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-BetaMFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#set-mfa-okta-config + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-BetaMFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#test-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-BetaMFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-BetaMFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaMFAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#create-send-token + source: | + $SendTokenRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } + "@ + + # Create and send user token + + try { + $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest + New-BetaSendToken -SendTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaSendToken -SendTokenRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSendToken" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/poll + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#ping-verification-status + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + $VerificationPollRequest = @" + { + "requestId" : "089899f13a8f4da7824996191587bab9" + } + "@ + + # Polling MFA method by VerificationPollRequest + + try { + $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest + Ping-BetaVerificationStatus -Method $Method -VerificationPollRequest $Result + + # Below is a request that includes all optional parameters + # Ping-BetaVerificationStatus -Method $Method -VerificationPollRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaVerificationStatus" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#send-duo-verify-request + source: | + $DuoVerificationRequest = @" + { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } + "@ + + # Verifying authentication via Duo method + + try { + $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest + Send-BetaDuoVerifyRequest -DuoVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaDuoVerifyRequest -DuoVerificationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaDuoVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#send-kba-answers + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Authenticate KBA provided MFA method + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Send-BetaKbaAnswers -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Send-BetaKbaAnswers -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaKbaAnswers" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#send-okta-verify-request + source: | + $OktaVerificationRequest = @" + { + "userId" : "example@mail.com" + } + "@ + + # Verifying authentication via Okta method + + try { + $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest + Send-BetaOktaVerifyRequest -OktaVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaOktaVerifyRequest -OktaVerificationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaOktaVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#send-token-auth-request + source: | + $TokenAuthRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } + "@ + + # Authenticate Token provided MFA method + + try { + $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest + Send-BetaTokenAuthRequest -TokenAuthRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaTokenAuthRequest -TokenAuthRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" + Write-Host $_.ErrorDetails + } +- path: /multihosts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-multi-host-integration + source: | + $MultiHostIntegrationsCreate = @" + { + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + } + "@ + + # Create Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate + New-BetaMultiHostIntegration -MultiHostIntegrationsCreate $Result + + # Below is a request that includes all optional parameters + # New-BetaMultiHostIntegration -MultiHostIntegrationsCreate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-sources-within-multi-host + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + $MultiHostIntegrationsCreateSources = @"{ + "connectorAttributes" : { + "authType" : "SQLAuthentication", + "url" : "jdbc:sqlserver://178.18.41.118:1433", + "user" : "username", + "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "name" : "My Source", + "description" : "This is the corporate directory." + }"@ + + + # Create Sources Within Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources + New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result + + # Below is a request that includes all optional parameters + # New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourcesWithinMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#delete-multi-host + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. + + # Delete Multi-Host Integration + + try { + Remove-BetaMultiHost -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Remove-BetaMultiHost -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/acctAggregationGroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-acct-aggregation-groups + source: | + $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + + # Get Account Aggregation Groups Within Multi-Host Integration ID + + try { + Get-BetaAcctAggregationGroups -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Get-BetaAcctAggregationGroups -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAcctAggregationGroups" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multiHostId}/entitlementAggregationGroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-entitlement-aggregation-groups + source: | + $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + + # Get Entitlement Aggregation Groups Within Multi-Host Integration ID + + try { + Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementAggregationGroups" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multi-host-integrations + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + + # Get Multi-Host Integration By ID + + try { + Get-BetaMultiHostIntegrations -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostIntegrations -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrations" + Write-Host $_.ErrorDetails + } +- path: /multihosts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multi-host-integrations-list + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + + # List All Existing Multi-Host Integrations + + try { + Get-BetaMultiHostIntegrationsList + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrationsList" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multiHostId}/sources/errors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multi-host-source-creation-errors + source: | + $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration + + # List Multi-Host Source Creation Errors + + try { + Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostSourceCreationErrors" + Write-Host $_.ErrorDetails + } +- path: /multihosts/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multihost-integration-types + source: | + + # List Multi-Host Integration Types + + try { + Get-BetaMultihostIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaMultihostIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultihostIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-sources-within-multi-host + source: | + $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Sources Within Multi-Host Integration + + try { + Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourcesWithinMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/sources/testConnection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#test-connection-multi-host-sources + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration + + # Test Configuration For Multi-Host Integration + + try { + Test-BetaConnectionMultiHostSources -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Test-BetaConnectionMultiHostSources -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaConnectionMultiHostSources" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#test-source-connection-multihost + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration + $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration + + # Test Configuration For Multi-Host Integration's Single Source + + try { + Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnectionMultihost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#update-multi-host-sources + source: | + $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. + $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ + + + # Update Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner + Update-BetaMultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaMultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaMultiHostSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + $Id = "MyId" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "comment" + } + "@ + + # Approve a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-BetaNonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-BetaNonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-BetaNonEmployeeRecord -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeRecord -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-BetaNonEmployeeRequest -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeRequest -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + $NonEmployeeSourceRequestBody = @" + { + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + } + "@ + + # Create Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-BetaNonEmployeeSource -NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeSource -NonEmployeeSourceRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + $NonEmployeeSchemaAttributeBody = @" + { + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + } + "@ + + # Create Non-Employee Source Schema Attribute + + try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) + + # Delete Non-Employee Record + + try { + Remove-BetaNonEmployeeRecord -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-record-in-bulk + source: | + $DeleteNonEmployeeRecordInBulkRequest = @" + + "@ + + # Delete Multiple Non-Employee Records + + try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest + Remove-BetaNonEmployeeRecordInBulk -DeleteNonEmployeeRecordInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRecordInBulk -DeleteNonEmployeeRecordInBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in the UUID format + + # Delete Non-Employee Request + + try { + Remove-BetaNonEmployeeRequest -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + + # Delete Non-Employee Source's Schema Attribute + + try { + Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id + + # Delete Non-Employee Source + + try { + Remove-BetaNonEmployeeSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + + # Delete all custom schema attributes + + try { + Remove-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) + + # Exports Non-Employee Records to CSV + + try { + Export-BetaNonEmployeeRecords -Id $Id + + # Below is a request that includes all optional parameters + # Export-BetaNonEmployeeRecords -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) + + # Exports Source Schema Template + + try { + Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + $Id = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | Non-Employee approval item id (UUID) + $IncludeDetail = "include-detail=false" # String | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + # Get a non-employee approval item detail + + try { + Get-BetaNonEmployeeApproval -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Approval Requests + + try { + Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + $Id = "2c918085842e69ae018432d22ccb212f" # String | Source ID (UUID) + + # Bulk upload status on source + + try { + Get-BetaNonEmployeeBulkUploadStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeBulkUploadStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) + + # Get a Non-Employee Record + + try { + Get-BetaNonEmployeeRecord -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUID) + + # Get a Non-Employee Request + + try { + Get-BetaNonEmployeeRequest -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Requests + + try { + Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequestSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + $AttributeId = "2c918085842e69ae018432d22ccb212f" # String | The Schema Attribute Id (UUID) + $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id + + # Get Schema Attribute Non-Employee Source + + try { + Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + + # Get a Non-Employee Source + + try { + Get-BetaNonEmployeeSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id + + # List Schema Attributes Non-Employee Source + + try { + Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + $Data = # System.IO.FileInfo | + + # Imports, or Updates, Non-Employee Records + + try { + Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data + + # Below is a request that includes all optional parameters + # Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaNonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-approval + source: | + $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity for whom the request was made. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "approvalStatus eq "PENDING"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Get List of Non-Employee Approval Requests + + try { + Get-BetaNonEmployeeApproval + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApproval -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-records + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Records + + try { + Get-BetaNonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "approvalStatus,firstName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Requests + + try { + Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequests" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-sources + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) + $NonEmployeeCount = $false # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) + $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + + # List Non-Employee Sources + + try { + Get-BetaNonEmployeeSources + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Record + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeRecord -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeRecord -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Source's Schema Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + $Id = "MyId" # String | Non-Employee approval item id (UUID) + $NonEmployeeRejectApprovalDecision = @" + { + "comment" : "comment" + } + "@ + + # Reject a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-BetaNonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-BetaNonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Update Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-BetaNonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#create-domain-dkim + source: | + $DomainAddress = @" + { + "domain" : "sailpoint.com" + } + "@ + + # Verify domain address via DKIM + + try { + $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress + New-BetaDomainDkim -DomainAddress $Result + + # Below is a request that includes all optional parameters + # New-BetaDomainDkim -DomainAddress $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#create-notification-template + source: | + $TemplateDto = @" + { + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Create Notification Template + + try { + $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto + New-BetaNotificationTemplate -TemplateDto $Result + + # Below is a request that includes all optional parameters + # New-BetaNotificationTemplate -TemplateDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#create-verified-from-address + source: | + $EmailStatusDto = @" + { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } + "@ + + # Create Verified From Address + + try { + $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto + New-BetaVerifiedFromAddress -EmailStatusDto $Result + + # Below is a request that includes all optional parameters + # New-BetaVerifiedFromAddress -EmailStatusDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#delete-notification-templates-in-bulk + source: | + $TemplateBulkDeleteDto = @"{ + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + }"@ + + + # Bulk Delete Notification Templates + + try { + $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto + Remove-BetaNotificationTemplatesInBulk -TemplateBulkDeleteDto $Result + + # Below is a request that includes all optional parameters + # Remove-BetaNotificationTemplatesInBulk -TemplateBulkDeleteDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#delete-verified-from-address + source: | + $Id = "MyId" # String | + + # Delete Verified From Address + + try { + Remove-BetaVerifiedFromAddress -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaVerifiedFromAddress -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#get-dkim-attributes + source: | + + # Get DKIM Attributes + + try { + Get-BetaDkimAttributes + + # Below is a request that includes all optional parameters + # Get-BetaDkimAttributes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDkimAttributes" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#get-mail-from-attributes + source: | + $IdentityId = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + + # Get MAIL FROM Attributes + + try { + Get-BetaMailFromAttributes -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaMailFromAttributes -IdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#get-notification-template + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template + + # Get Notification Template By Id + + try { + Get-BetaNotificationTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /notification-template-context + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#get-notifications-template-context + source: | + + # Get Notification Template Context + + try { + Get-BetaNotificationsTemplateContext + + # Below is a request that includes all optional parameters + # Get-BetaNotificationsTemplateContext + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationsTemplateContext" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#list-from-addresses + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "email eq "john.doe@company.com"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) + $Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) + + # List From Addresses + + try { + Get-BetaFromAddresses + + # Below is a request that includes all optional parameters + # Get-BetaFromAddresses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFromAddresses" + Write-Host $_.ErrorDetails + } +- path: /notification-preferences/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#list-notification-preferences + source: | + $Key = "cloud_manual_work_item_summary" # String | The notification key. + + # List Notification Preferences for tenant. + + try { + Get-BetaNotificationPreferences -Key $Key + + # Below is a request that includes all optional parameters + # Get-BetaNotificationPreferences -Key $Key + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationPreferences" + Write-Host $_.ErrorDetails + } +- path: /notification-template-defaults + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#list-notification-template-defaults + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "key eq "cloud_manual_work_item_summary"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Template Defaults + + try { + Get-BetaNotificationTemplateDefaults + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplateDefaults -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplateDefaults" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#list-notification-templates + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "medium eq "EMAIL"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Templates + + try { + Get-BetaNotificationTemplates + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplates -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplates" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#put-mail-from-attributes + source: | + $MailFromAttributesDto = @" + { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } + "@ + + # Change MAIL FROM domain + + try { + $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto + Send-BetaMailFromAttributes -MailFromAttributesDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaMailFromAttributes -MailFromAttributesDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /send-test-notification + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#send-test-notification + source: | + $SendTestNotificationRequestDto = @" + { + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Send Test Notification + + try { + $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto + Send-BetaTestNotification -SendTestNotificationRequestDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaTestNotification -SendTestNotificationRequestDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTestNotification" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#create-oauth-client + source: | + $CreateOAuthClientRequest = @" + { + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345", "http://localhost:67890" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + } + "@ + + # Create OAuth Client + + try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-BetaOauthClient -CreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaOauthClient -CreateOAuthClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaOauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#delete-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Delete OAuth Client + + try { + Remove-BetaOauthClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaOauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaOauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#get-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Get OAuth Client + + try { + Get-BetaOauthClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaOauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#list-oauth-clients + source: | + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List OAuth Clients + + try { + Get-BetaOauthClients + + # Below is a request that includes all optional parameters + # Get-BetaOauthClients -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClients" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#patch-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch OAuth Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaOauthClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaOauthClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOauthClient" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/org-config#get-org-config + source: | + + # Get Org configuration settings + + try { + Get-BetaOrgConfig + + # Below is a request that includes all optional parameters + # Get-BetaOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /org-config/valid-time-zones + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/org-config#get-valid-time-zones + source: | + + # Get list of time zones + + try { + Get-BetaValidTimeZones + + # Below is a request that includes all optional parameters + # Get-BetaValidTimeZones + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaValidTimeZones" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/org-config#patch-org-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an Org configuration property + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaOrgConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaOrgConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-configuration#create-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-BetaPasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-configuration#get-password-org-config + source: | + + # Get Password Org Config + + try { + Get-BetaPasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-BetaPasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-configuration#put-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-BetaPasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaPasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-dictionary#get-password-dictionary + source: | + + # Get Password Dictionary + + try { + Get-BetaPasswordDictionary + + # Below is a request that includes all optional parameters + # Get-BetaPasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-dictionary#put-password-dictionary + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-BetaPasswordDictionary + + # Below is a request that includes all optional parameters + # Send-BetaPasswordDictionary -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /generate-password-reset-token/digit + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-management#create-digit-token + source: | + $PasswordDigitTokenReset = @" + { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } + "@ + + # Generate a digit token + + try { + $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset + New-BetaDigitToken -PasswordDigitTokenReset $Result + + # Below is a request that includes all optional parameters + # New-BetaDigitToken -PasswordDigitTokenReset $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken" + Write-Host $_.ErrorDetails + } +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-management#get-identity-password-change-status + source: | + $Id = "MyId" # String | + + # Get Password Change Request Status + + try { + Get-BetaIdentityPasswordChangeStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityPasswordChangeStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityPasswordChangeStatus" + Write-Host $_.ErrorDetails + } +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-management#query-password-info + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-BetaPasswordInfo -PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-BetaPasswordInfo -PasswordInfoQueryDTO $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo" + Write-Host $_.ErrorDetails + } +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-management#set-identity-password + source: | + $PasswordChangeRequest = @" + { + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-BetaIdentityPassword -PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-BetaIdentityPassword -PasswordChangeRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIdentityPassword" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-policies#create-password-policy + source: | + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Create Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-BetaPasswordPolicy -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordPolicy -PasswordPolicyV3Dto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-policies#delete-password-policy + source: | + $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + + # Delete Password Policy by ID + + try { + Remove-BetaPasswordPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPasswordPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-policies#get-password-policy-by-id + source: | + $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + + # Get Password Policy by ID + + try { + Get-BetaPasswordPolicyById -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaPasswordPolicyById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicyById" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-policies#list-password-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Password Policies + + try { + Get-BetaPasswordPolicies + + # Below is a request that includes all optional parameters + # Get-BetaPasswordPolicies -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicies" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-policies#set-password-policy + source: | + $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Update Password Policy by ID + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-BetaPasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-BetaPasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaPasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#create-password-sync-group + source: | + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Create Password Sync Group + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-BetaPasswordSyncGroup -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordSyncGroup -PasswordSyncGroup $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#delete-password-sync-group + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + + # Delete Password Sync Group by ID + + try { + Remove-BetaPasswordSyncGroup -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#get-password-sync-group + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + + # Get Password Sync Group by ID + + try { + Get-BetaPasswordSyncGroup -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaPasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#get-password-sync-groups + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Password Sync Group List + + try { + Get-BetaPasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-BetaPasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#update-password-sync-group + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Update Password Sync Group by ID + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-BetaPasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-BetaPasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#create-personal-access-token + source: | + $CreatePersonalAccessTokenRequest = @" + { + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + } + "@ + + # Create Personal Access Token + + try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-BetaPersonalAccessToken -CreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaPersonalAccessToken -CreatePersonalAccessTokenRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#delete-personal-access-token + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + + # Delete Personal Access Token + + try { + Remove-BetaPersonalAccessToken -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPersonalAccessToken -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#list-personal-access-tokens + source: | + $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List Personal Access Tokens + + try { + Get-BetaPersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-BetaPersonalAccessTokens -OwnerId $OwnerId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPersonalAccessTokens" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#patch-personal-access-token + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Personal Access Token + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaPersonalAccessToken -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaPersonalAccessToken -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/public-identities-config#get-public-identity-config + source: | + + # Get Public Identity Config + + try { + Get-BetaPublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-BetaPublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/public-identities-config#update-public-identity-config + source: | + $PublicIdentityConfig = @" + { + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + } + "@ + + # Update Public Identity Config + + try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-BetaPublicIdentityConfig -PublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-BetaPublicIdentityConfig -PublicIdentityConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /requestable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/requestable-objects#list-requestable-objects + source: | + $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) + + $Types = @"ROLE,ACCESS_PROFILE"@ + $Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) + $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) + + $Statuses = @"[ASSIGNED, PENDING]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Requestable Objects List + + try { + Get-BetaRequestableObjects + + # Below is a request that includes all optional parameters + # Get-BetaRequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRequestableObjects" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#create-role-insight-requests + source: | + + # Generate insights for roles + + try { + New-BetaRoleInsightRequests + + # Below is a request that includes all optional parameters + # New-BetaRoleInsightRequests + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleInsightRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#download-role-insights-entitlements-changes + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Download entitlement insights for a role + + try { + Invoke-BetaDownloadRoleInsightsEntitlementsChanges -InsightId $InsightId + + # Below is a request that includes all optional parameters + # Invoke-BetaDownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-entitlement-changes-identities + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id + $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name sw "Jan"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + + # Get identities for a suggested entitlement (for a role) + + try { + Get-BetaEntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChangesIdentities" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insight + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + + # Get a single role insight + + try { + Get-BetaRoleInsight -InsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsight -InsightId $InsightId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsight" + Write-Host $_.ErrorDetails + } +- path: /role-insights + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + $Filters = "name sw "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + # Get role insights + + try { + Get-BetaRoleInsights + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsights -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsights" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/current-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-current-entitlements + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get current entitlement for a role + + try { + Get-BetaRoleInsightsCurrentEntitlements -InsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsCurrentEntitlements -InsightId $InsightId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsCurrentEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-entitlements-changes + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) + $Filters = "name sw "Admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get entitlement insights for a role + + try { + Get-BetaRoleInsightsEntitlementsChanges -InsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsEntitlementsChanges -InsightId $InsightId -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-requests + source: | + $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id + + # Returns metadata from prior request. + + try { + Get-BetaRoleInsightsRequests -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsRequests -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-summary + source: | + + # Get role insights summary information + + try { + Get-BetaRoleInsightsSummary + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsSummary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsSummary" + Write-Host $_.ErrorDetails + } +- path: /roles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/roles#create-role + source: | + $Role = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + } + "@ + + # Create a Role + + try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-BetaRole -Role $Result + + # Below is a request that includes all optional parameters + # New-BetaRole -Role $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRole" + Write-Host $_.ErrorDetails + } +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/roles#delete-bulk-roles + source: | + $RoleBulkDeleteRequest = @" + { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Role(s) + + try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-BetaBulkRoles -RoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaBulkRoles -RoleBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaBulkRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/roles#delete-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Delete a Role + + try { + Remove-BetaRole -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaRole -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaRole" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/roles#get-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Get a Role + + try { + Get-BetaRole -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaRole -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRole" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/roles#get-role-assigned-identities + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + + # Identities assigned a Role + + try { + Get-BetaRoleAssignedIdentities -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignedIdentities" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/roles#get-role-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | Containing role's ID. + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Role's Entitlements + + try { + Get-BetaRoleEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/roles#list-roles + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Roles + + try { + Get-BetaRoles + + # Below is a request that includes all optional parameters + # Get-BetaRoles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/roles#patch-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Role + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaRole -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaRole -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-BetaSearchAttributeConfig -SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-BetaSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Remove-BetaSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Extended Search Attributes + + try { + Get-BetaSearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-BetaSearchAttributeConfig -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. + + # Get Extended Search Attribute + + try { + Get-BetaSingleSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Get-BetaSingleSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-BetaSegment -Segment $Result + + # Below is a request that includes all optional parameters + # New-BetaSegment -Segment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-BetaSegment -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSegment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-BetaSegment -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSegment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-BetaSegments + + # Below is a request that includes all optional parameters + # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSegment -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSegment -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-BetaServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-BetaServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-BetaServiceDeskIntegrationList + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-BetaServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details + source: | + + # Get the time check configuration + + try { + Get-BetaStatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-BetaStatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaServiceDeskIntegration -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaServiceDeskIntegration -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#create-sim-integration + source: | + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-BetaSIMIntegration -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-BetaSIMIntegration -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#delete-sim-integration + source: | + $Id = "12345" # String | The id of the integration to delete. + + # Delete a SIM integration + + try { + Remove-BetaSIMIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSIMIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + + # Get a SIM integration details. + + try { + Get-BetaSIMIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSIMIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integrations + source: | + + # List the existing SIM integrations. + + try { + Get-BetaSIMIntegrations + + # Below is a request that includes all optional parameters + # Get-BetaSIMIntegrations + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaBeforeProvisioningRule -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaBeforeProvisioningRule -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaSIMAttributes -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaSIMAttributes -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-BetaSIMIntegration -Id $Id -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-BetaSIMIntegration -Id $Id -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-BetaSodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-BetaSodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-BetaSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-BetaSodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-BetaDefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-BetaDefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-BetaSodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-BetaSodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get SOD policy by ID + + try { + Get-BetaSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get SOD policy schedule + + try { + Get-BetaSodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get SOD violation report status + + try { + Get-BetaSodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#list-sod-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-BetaSodPolicies + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified. + $RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + $RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ + + + # Patch a SOD policy + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSodPolicy -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSodPolicy -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-BetaPolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-BetaPolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-BetaSodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-BetaSodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] + } + "@ + + # Runs all policies for org + + try { + Start-BetaSodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-BetaSodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-BetaSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-BetaSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-BetaPredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-BetaPredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#create-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-BetaProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-BetaProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#create-source + source: | + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-BetaSource -Source $Result + + # Below is a request that includes all optional parameters + # New-BetaSource -Source $Result -ProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#create-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-BetaSourceSchema -SourceId $SourceId -Schema $Result + + # Below is a request that includes all optional parameters + # New-BetaSourceSchema -SourceId $SourceId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#delete + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-Beta -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Beta -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Beta" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/remove-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#delete-accounts-async + source: | + $SourceId = "ebbf35756e1140699ce52b233121384a" # String | The source id + + # Remove All Accounts in a Source + + try { + Remove-BetaAccountsAsync -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaAccountsAsync -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountsAsync" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#delete-native-change-detection-config + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Delete Native Change Detection Configuration + + try { + Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#delete-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Delete Provisioning Policy by UsageType + + try { + Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#delete-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + + # Delete Source Schema by ID + + try { + Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-correlation-config + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Get Source Correlation Configuration + + try { + Get-BetaCorrelationConfig -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaCorrelationConfig -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-native-change-detection-config + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Native Change Detection Configuration + + try { + Get-BetaNativeChangeDetectionConfig -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNativeChangeDetectionConfig -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Get Provisioning Policy by UsageType + + try { + Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-BetaSource -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSource -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-accounts-schema + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-BetaSourceAccountsSchema -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaSourceAccountsSchema -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-attr-sync-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Attribute Sync Config + + try { + Get-BetaSourceAttrSyncConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceAttrSyncConfig -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/connectors/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-config + source: | + $Id = "MyId" # String | The Source id + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Gets source config with language translations + + try { + Get-BetaSourceConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceConfig -Id $Id -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-entitlement-request-config + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Get Source Entitlement Request Configuration + + try { + Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-entitlements-schema + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-BetaSourceEntitlementsSchema -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaSourceEntitlementsSchema -SourceId $SourceId -SchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + + # Get Source Schema by ID + + try { + Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-schemas + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-BetaSourceSchemas -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaSourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchemas" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/load-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#import-accounts + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) + $DisableOptimization = "true" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) + + # Account Aggregation + + try { + Import-BetaAccounts -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaAccounts -SourceId $SourceId -File $File -DisableOptimization $DisableOptimization + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaAccounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/load-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#import-entitlements + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Entitlement Aggregation + + try { + Import-BetaEntitlements -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaEntitlements -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlements" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#import-source-accounts-schema + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-BetaSourceAccountsSchema -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaSourceAccountsSchema -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceAccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#import-source-connector-file + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-BetaSourceConnectorFile -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaSourceConnectorFile -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceConnectorFile" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#import-source-entitlements-schema + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-BetaSourceEntitlementsSchema -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaSourceEntitlementsSchema -SourceId $SourceId -SchemaName $SchemaName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceEntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/load-uncorrelated-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#import-uncorrelated-accounts + source: | + $SourceId = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id + $File = # System.IO.FileInfo | (optional) + + # Process Uncorrelated Accounts + + try { + Import-BetaUncorrelatedAccounts -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaUncorrelatedAccounts -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaUncorrelatedAccounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#list-provisioning-policies + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-BetaProvisioningPolicies -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaProvisioningPolicies -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicies" + Write-Host $_.ErrorDetails + } +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#list-sources + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-BetaSources + + # Below is a request that includes all optional parameters + # Get-BetaSources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSources" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/peek-resource-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#peek-resource-objects + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + $ResourceObjectsRequest = @" + { + "maxCount" : 100, + "objectType" : "group" + } + "@ + + # Peek source connector's resource objects + + try { + $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest + Receive-BetaResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result + + # Below is a request that includes all optional parameters + # Receive-BetaResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-BetaResourceObjects" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/ping-cluster + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#ping-cluster + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Ping cluster for source connector + + try { + Ping-BetaCluster -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Ping-BetaCluster -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaCluster" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#put-correlation-config + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id + $CorrelationConfig = @" + { + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + } + "@ + + # Update Source Correlation Configuration + + try { + $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig + Send-BetaCorrelationConfig -SourceId $SourceId -CorrelationConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaCorrelationConfig -SourceId $SourceId -CorrelationConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#put-native-change-detection-config + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id + $NativeChangeDetectionConfig = @" + { + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + } + "@ + + # Update Native Change Detection Configuration + + try { + $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig + Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -NativeChangeDetectionConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -NativeChangeDetectionConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#put-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#put-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-BetaSource -Id $Id -Source $Result + + # Below is a request that includes all optional parameters + # Send-BetaSource -Id $Id -Source $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#put-source-attr-sync-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $AttrSyncSourceConfig = @" + { + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + } + "@ + + # Update Attribute Sync Config + + try { + $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig + Send-BetaSourceAttrSyncConfig -Id $Id -AttrSyncSourceConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaSourceAttrSyncConfig -Id $Id -AttrSyncSourceConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#put-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + + # Below is a request that includes all optional parameters + # Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#sync-attributes-for-source + source: | + $SourceId = "MySourceId" # String | The Source id + + # Synchronize single source attributes. + + try { + Sync-BetaAttributesForSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Sync-BetaAttributesForSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaAttributesForSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/test-configuration + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#test-source-configuration + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Test configuration for source connector + + try { + Test-BetaSourceConfiguration -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConfiguration -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConfiguration" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/check-connection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#test-source-connection + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. + + # Check connection for source connector. + + try { + Test-BetaSourceConnection -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConnection -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnection" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#update-provisioning-policies-in-bulk + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#update-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#update-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSource -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSource -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#update-source-entitlement-request-config + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SourceEntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Update Source Entitlement Request Configuration + + try { + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -SourceEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -SourceEntitlementRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#update-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-BetaStatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaStatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-BetaUsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-BetaSpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-BetaSpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-BetaSpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-BetaSpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-BetaSpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-BetaSpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-BetaSpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-BetaSpConfigObjects + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id + + # Submit Sed Batch Stats Request + + try { + Get-BetaSedBatchStats -BatchId $BatchId + + # Below is a request that includes all optional parameters + # Get-BetaSedBatchStats -BatchId $BatchId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatchStats" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#get-sed-batches + source: | + + # List Sed Batch Request + + try { + Get-BetaSedBatches + + # Below is a request that includes all optional parameters + # Get-BetaSedBatches + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatches" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#list-seds + source: | + $Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) + $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) + $Count = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) + $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) + $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) + + # List Suggested Entitlement Descriptions + + try { + Get-BetaSeds + + # Below is a request that includes all optional parameters + # Get-BetaSeds -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSeds" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#patch-sed + source: | + $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id + $SedPatch = @"{ + "op" : "replace", + "path" : "status", + "value" : "approved" + }"@ + + + # Patch Suggested Entitlement Description + + try { + $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch + Update-BetaSed -Id $Id -SedPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaSed -Id $Id -SedPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-approvals + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#submit-sed-approval + source: | + $SedApproval = @"{ + "items" : "016629d1-1d25-463f-97f3-c6686846650" + }"@ + + + # Submit Bulk Approval Request + + try { + $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval + Submit-BetaSedApproval -SedApproval $Result + + # Below is a request that includes all optional parameters + # Submit-BetaSedApproval -SedApproval $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-assignments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#submit-sed-assignment + source: | + $SedAssignment = @" + { + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + } + "@ + + # Submit Sed Assignment Request + + try { + $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment + Submit-BetaSedAssignment -SedAssignment $Result + + # Below is a request that includes all optional parameters + # Submit-BetaSedAssignment -SedAssignment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + $SedBatchRequest = @" + { + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + } + "@ + + # Submit Sed Batch Request + + try { + Submit-BetaSedBatchRequest + + # Below is a request that includes all optional parameters + # Submit-BetaSedBatchRequest -SedBatchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedBatchRequest" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#delete-tagged-object + source: | + $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + + # Delete Object Tags + + try { + Remove-BetaTaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#delete-tags-to-many-object + source: | + $BulkTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject + Remove-BetaTagsToManyObject -BulkTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-BetaTagsToManyObject -BulkTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagsToManyObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#get-tagged-object + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get Tagged Object + + try { + Get-BetaTaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#list-tagged-objects + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-BetaTaggedObjects + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjects" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#list-tagged-objects-by-type + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + Get-BetaTaggedObjectsByType -Type $Type + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjectsByType" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#put-tagged-object + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-BetaTaggedObject -Type $Type -Id $Id -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-BetaTaggedObject -Type $Type -Id $Id -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#set-tag-to-object + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-BetaTagToObject -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-BetaTagToObject -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagToObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#set-tags-to-many-objects + source: | + $BulkTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject + Set-BetaTagsToManyObjects -BulkTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-BetaTagsToManyObjects -BulkTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagsToManyObjects" + Write-Host $_.ErrorDetails + } +- path: /tags + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tags#create-tag + source: | + $Tag = @" + { + "created" : "2022-05-04T14:48:49Z", + "tagCategoryRefs" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "name" : "PCI", + "modified" : "2022-07-14T16:31:11Z", + "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" + } + "@ + + # Create Tag + + try { + $Result = ConvertFrom-JsonToTag -Json $Tag + New-BetaTag -Tag $Result + + # Below is a request that includes all optional parameters + # New-BetaTag -Tag $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag" + Write-Host $_.ErrorDetails + } +- path: /tags/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tags#delete-tag-by-id + source: | + $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete. + + # Delete Tag + + try { + Remove-BetaTagById -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTagById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagById" + Write-Host $_.ErrorDetails + } +- path: /tags/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tags#get-tag-by-id + source: | + $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve. + + # Get Tag By Id + + try { + Get-BetaTagById -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaTagById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTagById" + Write-Host $_.ErrorDetails + } +- path: /tags + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tags#list-tags + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) + + # List Tags + + try { + Get-BetaTags + + # Below is a request that includes all optional parameters + # Get-BetaTags -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTags" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: HEAD + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/task-management#get-pending-task-headers + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task List Headers + + try { + Get-BetaPendingTaskHeaders + + # Below is a request that includes all optional parameters + # Get-BetaPendingTaskHeaders -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTaskHeaders" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/task-management#get-pending-tasks + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task Status List + + try { + Get-BetaPendingTasks + + # Below is a request that includes all optional parameters + # Get-BetaPendingTasks -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTasks" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/task-management#get-task-status + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + + # Get Task Status by ID + + try { + Get-BetaTaskStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaTaskStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatus" + Write-Host $_.ErrorDetails + } +- path: /task-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/task-management#get-task-status-list + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "completionStatus eq "Success"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + $Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) + + # Retrieve Task Status List + + try { + Get-BetaTaskStatusList + + # Below is a request that includes all optional parameters + # Get-BetaTaskStatusList -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatusList" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/task-management#update-task-status + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Task Status by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaTaskStatus -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaTaskStatus -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTaskStatus" + Write-Host $_.ErrorDetails + } +- path: /tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tenant#get-tenant + source: | + + # Get Tenant Information. + + try { + Get-BetaTenant + + # Below is a request that includes all optional parameters + # Get-BetaTenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenant" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/transforms#create-transform + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-BetaTransform -Transform $Result + + # Below is a request that includes all optional parameters + # New-BetaTransform -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTransform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/transforms#delete-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-BetaTransform -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTransform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTransform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/transforms#get-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-BetaTransform -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaTransform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransform" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/transforms#list-transforms + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-BetaTransforms + + # Below is a request that includes all optional parameters + # Get-BetaTransforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransforms" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/transforms#update-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-BetaTransform -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaTransform -Id $Id -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTransform" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#complete-trigger-invocation + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. + $CompleteInvocation = @" + { + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + } + "@ + + # Complete Trigger Invocation + + try { + $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation + Complete-BetaTriggerInvocation -Id $Id -CompleteInvocation $Result + + # Below is a request that includes all optional parameters + # Complete-BetaTriggerInvocation -Id $Id -CompleteInvocation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaTriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#create-subscription + source: | + $SubscriptionPostRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Create a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest + New-BetaSubscription -SubscriptionPostRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaSubscription -SubscriptionPostRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSubscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#delete-subscription + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + + # Delete a Subscription + + try { + Remove-BetaSubscription -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSubscription -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSubscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#list-subscriptions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) + $Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) + + # List Subscriptions + + try { + Get-BetaSubscriptions + + # Below is a request that includes all optional parameters + # Get-BetaSubscriptions -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSubscriptions" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#list-trigger-invocation-status + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "triggerId eq "idn:access-request-dynamic-approver"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) + + # List Latest Invocation Statuses + + try { + Get-BetaTriggerInvocationStatus + + # Below is a request that includes all optional parameters + # Get-BetaTriggerInvocationStatus -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggerInvocationStatus" + Write-Host $_.ErrorDetails + } +- path: /triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#list-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "idn:access-request-post-approval"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) + + # List Triggers + + try { + Get-BetaTriggers + + # Below is a request that includes all optional parameters + # Get-BetaTriggers -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggers" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#patch-subscription + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch + $SubscriptionPatchRequestInner = @""@ + + + # Patch a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner + Update-BetaSubscription -Id $Id -SubscriptionPatchRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaSubscription -Id $Id -SubscriptionPatchRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#start-test-trigger-invocation + source: | + $TestInvocation = @" + { + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + } + "@ + + # Start a Test Invocation + + try { + $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation + Start-BetaTestTriggerInvocation -TestInvocation $Result + + # Below is a request that includes all optional parameters + # Start-BetaTestTriggerInvocation -TestInvocation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaTestTriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/validate-filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#test-subscription-filter + source: | + $ValidateFilterInputDto = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } + "@ + + # Validate a Subscription Filter + + try { + $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto + Test-BetaSubscriptionFilter -ValidateFilterInputDto $Result + + # Below is a request that includes all optional parameters + # Test-BetaSubscriptionFilter -ValidateFilterInputDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSubscriptionFilter" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#update-subscription + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + $SubscriptionPutRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Update a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest + Update-BetaSubscription -Id $Id -SubscriptionPutRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaSubscription -Id $Id -SubscriptionPutRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/ui-metadata#get-tenant-ui-metadata + source: | + + # Get a tenant UI metadata + + try { + Get-BetaTenantUiMetadata + + # Below is a request that includes all optional parameters + # Get-BetaTenantUiMetadata + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/ui-metadata#set-tenant-ui-metadata + source: | + $TenantUiMetadataItemUpdateRequest = @" + { + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + } + "@ + + # Update tenant UI metadata + + try { + $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest + Set-BetaTenantUiMetadata -TenantUiMetadataItemUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Set-BetaTenantUiMetadata -TenantUiMetadataItemUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-BetaVendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-BetaVendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-BetaVendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-BetaVendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + + # List Vendor Connector Mappings + + try { + Get-BetaVendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-BetaVendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-BetaWorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-BetaWorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-BetaWorkflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-BetaWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) + + # Get Workflow By Id + + try { + Get-BetaWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflow -Id $Id -WorkflowMetrics $WorkflowMetrics + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-BetaWorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-BetaWorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-BetaWorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-BetaCompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-BetaWorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-BetaWorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-BetaWorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $TriggerId = "idn:identity-created" # String | Trigger ID (optional) + $ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) + + # List Workflows + + try { + Get-BetaWorkflows + + # Below is a request that includes all optional parameters + # Get-BetaWorkflows -Limit $Limit -Offset $Offset -TriggerId $TriggerId -ConnectorInstanceId $ConnectorInstanceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $PostExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + Submit-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + Submit-BetaWorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaWorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-BetaWorkflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-BetaWorkflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-BetaApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Approve-BetaApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) + + # Complete a Work Item + + try { + Complete-BetaWorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Complete-BetaWorkItem -Id $Id -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#forward-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-completed-work-items + source: | + $OwnerId = "MyOwnerId" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-BetaCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-completed-work-items + source: | + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-BetaCountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-work-items + source: | + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-BetaCountWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + $OwnerId = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item owner. (optional) + + # Get a Work Item + + try { + Get-BetaWorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkItem -Id $Id -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-items-summary + source: | + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-BetaWorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-BetaWorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#list-work-items + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-BetaWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaWorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-BetaApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Deny-BetaApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#submit-account-selection + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-BetaAccountSelection -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-BetaAccountSelection -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#create-reassignment-configuration + source: | + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Create a Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#delete-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + + # Delete Reassignment Configuration + + try { + Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + + # Below is a request that includes all optional parameters + # Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration + + try { + Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + + # Below is a request that includes all optional parameters + # Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -ExclusionFilters $ExclusionFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-config-types + source: | + + # List Reassignment Config Types + + try { + Get-BetaReassignmentConfigTypes + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfigTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + + # Get Reassignment Configuration + + try { + Get-BetaReassignmentConfiguration -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfiguration -IdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-tenant-config-configuration + source: | + + # Get Tenant-wide Reassignment Configuration settings + + try { + Get-BetaTenantConfigConfiguration + + # Below is a request that includes all optional parameters + # Get-BetaTenantConfigConfiguration + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#list-reassignment-configurations + source: | + $Limit = 20 # Int32 | Max number of results to return. (optional) (default to 20) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + + # List Reassignment Configurations + + try { + Get-BetaReassignmentConfigurations + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfigurations -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-reassignment-config + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Update Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-tenant-configuration + source: | + $TenantConfigurationRequest = @" + { + "configDetails" : { + "disabled" : true + } + } + "@ + + # Update Tenant-wide Reassignment Configuration settings + + try { + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-BetaTenantConfiguration -TenantConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaTenantConfiguration -TenantConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" + Write-Host $_.ErrorDetails + } diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index 139597f9c..3f25ac9e9 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -1,2 +1,18626 @@ +- path: /access-model-metadata/attributes/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Access Model Metadata Attribute + + try { + Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values/{value} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $Value = "public" # String | Technical name of the Attribute value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Access Model Metadata Value + + try { + Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + # List Access Model Metadata Attributes + + try { + Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Access Model Metadata Values + + try { + Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#create-access-profile + source: | + $AccessProfile = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-V2024AccessProfile -AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-V2024AccessProfile -AccessProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#delete-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-V2024AccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#delete-access-profiles-in-bulk + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-V2024AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#get-access-profile + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-V2024AccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#get-access-profile-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + Get-V2024AccessProfileEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfileEntitlements" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#list-access-profiles + source: | + $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) + + # List Access Profiles + + try { + Get-V2024AccessProfiles + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#patch-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AccessProfile -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AccessProfile -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-update-requestable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#update-access-profiles-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ + + + # Update Access Profile(s) requestable field. + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner + Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#approve-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + Approve-V2024AccessRequest -ApprovalId $ApprovalId + + # Below is a request that includes all optional parameters + # Approve-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#forward-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/approval-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#get-access-request-approval-summary + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-V2024AccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{accessRequestId}/approvers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#list-access-request-approvers + source: | + $AccessRequestId = "2c91808568c529c60168cca6f90c1313" # String | Access Request ID. + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + + # Access Request Approvers + + try { + Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovers" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#list-completed-approvals + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Completed Access Request Approvals List + + try { + Get-V2024CompletedApprovals + + # Below is a request that includes all optional parameters + # Get-V2024CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#list-pending-approvals + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-V2024PendingApprovals + + # Below is a request that includes all optional parameters + # Get-V2024PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#reject-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. + $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. + $Type = "ENTITLEMENT" # String | Requested access item's type. + + # Return access request identity metrics + + try { + Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/bulk-approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#approve-bulk-access-request + source: | + $BulkApproveAccessRequest = @" + { + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + } + "@ + + # Bulk Approve Access Request + + try { + $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest + Approve-V2024BulkAccessRequest -BulkApproveAccessRequest $Result + + # Below is a request that includes all optional parameters + # Approve-V2024BulkAccessRequest -BulkApproveAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024BulkAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#cancel-access-request + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-V2024AccessRequest -CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-V2024AccessRequest -CancelAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/bulk-cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#cancel-access-request-in-bulk + source: | + $BulkCancelAccessRequest = @" + { + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + } + "@ + + # Bulk Cancel Access Request + + try { + $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest + Suspend-V2024AccessRequestInBulk -BulkCancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-V2024AccessRequestInBulk -BulkCancelAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequestInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-requests/close + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#close-access-request + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CloseAccessRequest = @" + { + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + } + "@ + + # Close Access Request + + try { + $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest + Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result + + # Below is a request that includes all optional parameters + # Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#create-access-request + source: | + $AccessRequest = @" + { + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-V2024AccessRequest -AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024AccessRequest -AccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#get-access-request-config + source: | + + # Get Access Request Configuration + + try { + Get-V2024AccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#list-access-request-status + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-V2024AccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-request-administration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#list-administrators-access-request-status + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status for Administrators + + try { + Get-V2024AdministratorsAccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-V2024AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-requests/accounts-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#load-account-selections + source: | + $AccountsSelectionRequest = @" + { + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } + "@ + + # Get accounts selections for identity + + try { + $Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest + Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024LoadAccountSelections" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#set-access-request-config + source: | + $AccessRequestConfig = @" + { + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-V2024AccessRequestConfig -AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024AccessRequestConfig -AccessRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/account-activities#get-account-activity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get an Account Activity + + try { + Get-V2024AccountActivity -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountActivity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivity" + Write-Host $_.ErrorDetails + } +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/account-activities#list-account-activities + source: | + $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-V2024AccountActivities + + # Below is a request that includes all optional parameters + # Get-V2024AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivities" + Write-Host $_.ErrorDetails + } +- path: /account-aggregations/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/account-aggregations#get-account-aggregation-status + source: | + $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # In-progress Account Aggregation status + + try { + Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#create-account + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-V2024Account -AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-V2024Account -AccountAttributesCreate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#delete-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-V2024Account -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#delete-account-async + source: | + $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove Account + + try { + Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#disable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-V2024Account -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-V2024Account -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#disable-account-for-identity + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Disable IDN Account for Identity + + try { + Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#disable-accounts-for-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Disable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#enable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-V2024Account -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-V2024Account -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#enable-account-for-identity + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Enable IDN Account for Identity + + try { + Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#enable-accounts-for-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Enable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#get-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-V2024Account -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#get-account-entitlements + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Account Entitlements + + try { + Get-V2024AccountEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountEntitlements" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#list-accounts + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + # Accounts List + + try { + Get-V2024Accounts + + # Below is a request that includes all optional parameters + # Get-V2024Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Accounts" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#put-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-V2024Account -Id $Id -AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-V2024Account -Id $Id -AccountAttributes $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#submit-reload-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-V2024ReloadAccount -Id $Id + + # Below is a request that includes all optional parameters + # Submit-V2024ReloadAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReloadAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#unlock-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-V2024Account -Id $Id -AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-V2024Account -Id $Id -AccountUnlockRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#update-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=remove, path=/identityId}]"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024Account -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024Account -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2024UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/application-discovery#get-discovered-applications + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + + # Get Discovered Applications for Tenant + + try { + Get-V2024DiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-V2024DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DiscoveredApplications" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + + # Download CSV Template for Discovery + + try { + Get-V2024ManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-V2024ManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + # Upload CSV to Discover Applications + + try { + Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File + + # Below is a request that includes all optional parameters + # Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/approvals#get-approval + source: | + $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that is to be returned + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get an approval + + try { + Get-V2024Approval -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Approval -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approval" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/approvals#get-approvals + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Mine = $true # Boolean | Returns the list of approvals for the current caller (optional) + $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID (optional) + $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) + + # Get Approvals + + try { + Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approvals" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#create-source-app + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceAppCreateDto = @" + { + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + } + "@ + + # Create source app + + try { + $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto + New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @"[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]"@ + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # Bulk remove access profiles from the specified source app + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesFromSourceAppByBulk" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#delete-source-app + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete source app by ID + + try { + Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#get-source-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get source app by ID + + try { + Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#list-access-profiles-for-source-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "developer access profile"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List access profiles for the specified source app + + try { + Get-V2024AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfilesForSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#list-all-source-app + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "enabled eq true" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + # List all source apps + + try { + Get-V2024AllSourceApp -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AllSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#list-all-user-apps + source: | + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List all user apps + + try { + Get-V2024AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/assigned + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#list-assigned-source-app + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List assigned source apps + + try { + Get-V2024AssignedSourceApp -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AssignedSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AssignedSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id}/available-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#list-available-accounts-for-user-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List available accounts for user app + + try { + Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableAccountsForUserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#list-available-source-apps + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List available source apps + + try { + Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableSourceApps" + Write-Host $_.ErrorDetails + } +- path: /user-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#list-owned-user-apps + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + # List owned user apps + + try { + Get-V2024OwnedUserApps -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OwnedUserApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OwnedUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#patch-source-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch source app by ID + + try { + Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#patch-user-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch user app by ID + + try { + Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024UserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#update-source-apps-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceAppBulkUpdateRequest = @" + { + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + } + "@ + + # Bulk update source apps + + try { + Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -SourceAppBulkUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceAppsInBulk" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/auth-profile#get-profile-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + + # Get Auth Profile + + try { + Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/auth-profile#get-profile-config-list + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get list of Auth Profiles + + try { + Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfigList" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/auth-profile#patch-profile-config + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Auth Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/auth-users#get-auth-user + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + + # Auth User Details + + try { + Get-V2024AuthUser -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AuthUser -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthUser" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/auth-users#patch-auth-user + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Auth User Update + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthUser -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthUser -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthUser" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/branding#create-branding-item + source: | + $Name = "MyName" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Create a branding item + + try { + New-V2024BrandingItem -Name $Name -ProductName $ProductName + + # Below is a request that includes all optional parameters + # New-V2024BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/branding#delete-branding + source: | + $Name = "default" # String | The name of the branding item to be deleted + + # Delete a branding item + + try { + Remove-V2024Branding -Name $Name + + # Below is a request that includes all optional parameters + # Remove-V2024Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/branding#get-branding + source: | + $Name = "default" # String | The name of the branding item to be retrieved + + # Get a branding item + + try { + Get-V2024Branding -Name $Name + + # Below is a request that includes all optional parameters + # Get-V2024Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/branding#get-branding-list + source: | + + # List of branding items + + try { + Get-V2024BrandingList + + # Below is a request that includes all optional parameters + # Get-V2024BrandingList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BrandingList" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/branding#set-branding-item + source: | + $Name = "default" # String | The name of the branding item to be retrieved + $Name2 = "Name_example" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Update a branding item + + try { + Set-V2024BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName + + # Below is a request that includes all optional parameters + # Set-V2024BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#create-campaign-filter + source: | + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Create Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + New-V2024CampaignFilter -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024CampaignFilter -CampaignFilterDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#delete-campaign-filters + source: | + $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. + $RequestBody = @""@ + + + # Deletes Campaign Filters + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024CampaignFilters -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignFilters -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. + + # Get Campaign Filter by ID + + try { + Get-V2024CampaignFilterById -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignFilterById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilterById" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#list-campaign-filters + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) + + # List Campaign Filters + + try { + Get-V2024CampaignFilters + + # Below is a request that includes all optional parameters + # Get-V2024CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#update-campaign-filter + source: | + $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Updates a Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + Update-V2024CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2024CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#complete-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CampaignCompleteOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-V2024Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Complete-V2024Campaign -Id $Id -CampaignCompleteOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#create-campaign + source: | + $Campaign = @" + { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + } + "@ + + # Create a campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-V2024Campaign -Campaign $Result + + # Below is a request that includes all optional parameters + # New-V2024Campaign -Campaign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#create-campaign-template + source: | + $CampaignTemplate = @" + { + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-V2024CampaignTemplate -CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-V2024CampaignTemplate -CampaignTemplate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#delete-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-V2024CampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#delete-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-V2024CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#delete-campaigns + source: | + $CampaignsDeleteRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest + Remove-V2024Campaigns -CampaignsDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024Campaigns -CampaignsDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Campaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-active-campaigns + source: | + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + + # List Campaigns + + try { + Get-V2024ActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-V2024ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ActiveCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + # Get Campaign + + try { + Get-V2024Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Campaign -Id $Id -Detail $Detail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-reports + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-V2024CampaignReports -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignReports -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReports" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-reports-config + source: | + + # Get Campaign Reports Configuration + + try { + Get-V2024CampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-V2024CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-V2024CampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-V2024CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-templates + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-V2024CampaignTemplates + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplates" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#move + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move-V2024 -Id $Id -AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move-V2024 -Id $Id -AdminReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2024" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#patch-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024CampaignTemplate -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024CampaignTemplate -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#set-campaign-reports-config + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-V2024CampaignReportsConfig -CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024CampaignReportsConfig -CampaignReportsConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#set-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. + $Schedule = @" + { + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-V2024CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Set-V2024CampaignTemplateSchedule -Id $Id -Schedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#start-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-V2024Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024Campaign -Id $Id -ActivateCampaignOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#start-campaign-remediation-scan + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-V2024CampaignRemediationScan -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024CampaignRemediationScan -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignRemediationScan" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-report/{type} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#start-campaign-report + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. + + # Run Campaign Report + + try { + Start-V2024CampaignReport -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Start-V2024CampaignReport -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignReport" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#start-generate-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-V2024GenerateCampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024GenerateCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024GenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#update-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Campaign -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Campaign -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-certification-task + source: | + $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID + + # Certification Task by ID + + try { + Get-V2024CertificationTask -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CertificationTask -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationTask" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-identity-certification + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id + + # Identity Certification by ID + + try { + Get-V2024IdentityCertification -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-identity-certification-item-permissions + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Permissions for Entitlement Certification Item + + try { + Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-pending-certification-tasks + source: | + $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) + + # List of Pending Certification Tasks + + try { + Get-V2024PendingCertificationTasks + + # Below is a request that includes all optional parameters + # Get-V2024PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingCertificationTasks" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#list-certification-reviewers + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + + # List of Reviewers for certification + + try { + Get-V2024CertificationReviewers -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationReviewers" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-review-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#list-identity-access-review-items + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + $Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + # List of Access Review Items + + try { + Get-V2024IdentityAccessReviewItems -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessReviewItems" + Write-Host $_.ErrorDetails + } +- path: /certifications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#list-identity-certifications + source: | + $ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) + + # List Identity Campaign Certifications + + try { + Get-V2024IdentityCertifications + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decide + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#make-identity-decision + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions + $ReviewDecision = @"{ + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + }"@ + + + # Decide on a Certification Item + + try { + $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision + Select-V2024IdentityDecision -Id $Id -ReviewDecision $Result + + # Below is a request that includes all optional parameters + # Select-V2024IdentityDecision -Id $Id -ReviewDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2024IdentityDecision" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#reassign-identity-certifications + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Identities or Items + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Invoke-V2024ReassignIdentityCertifications -Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ReassignIdentityCertifications -Id $Id -ReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ReassignIdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/sign-off + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#sign-off-identity-certification + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + + # Finalize Identity Certification Decisions + + try { + Invoke-V2024SignOffIdentityCertification -Id $Id + + # Below is a request that includes all optional parameters + # Invoke-V2024SignOffIdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024SignOffIdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#submit-reassign-certs-async + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-V2024ReassignCertsAsync -Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-V2024ReassignCertsAsync -Id $Id -ReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2024IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2024IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2024IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/deploys + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-deploy + source: | + $DeployRequest = @" + { + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + } + "@ + + # Create a Deploy + + try { + $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest + New-V2024Deploy -DeployRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Deploy -DeployRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-object-mapping + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingRequest = @" + { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } + "@ + + # Creates an object mapping + + try { + $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest + New-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkCreateRequest = @" + { + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + } + "@ + + # Bulk creates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest + New-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/scheduled-actions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-scheduled-action + source: | + $ScheduledActionPayload = @" + { + "cronString" : "0 0 12 * * * *", + "timeZoneId" : "America/Chicago", + "startTime" : "2024-08-16T14:16:58.389Z", + "jobType" : "BACKUP", + "content" : { + "sourceTenant" : "tenant-name", + "draftId" : "9012b87d-48ca-439a-868f-2160001da8c3", + "name" : "Daily Backup", + "backupOptions" : { + "includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ], + "objectOptions" : { + "SOURCE" : { + "includedNames" : [ "Source1", "Source2" ] + }, + "ROLE" : { + "includedNames" : [ "Admin Role", "User Role" ] + } + } + }, + "sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2" + } + } + "@ + + # Create Scheduled Action + + try { + $Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload + New-V2024ScheduledAction -ScheduledActionPayload $Result + + # Below is a request that includes all optional parameters + # New-V2024ScheduledAction -ScheduledActionPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledAction" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-uploaded-configuration + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. + + # Upload a Configuration + + try { + New-V2024UploadedConfiguration -Data $Data -Name $Name + + # Below is a request that includes all optional parameters + # New-V2024UploadedConfiguration -Data $Data -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-backup + source: | + $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. + + # Delete a Backup + + try { + Remove-V2024Backup -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Backup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Backup" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/drafts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-draft + source: | + $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to delete. + + # Delete a draft + + try { + Remove-V2024Draft -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Draft -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Draft" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-object-mapping + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. + + # Deletes an object mapping + + try { + Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + + # Below is a request that includes all optional parameters + # Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/scheduled-actions/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-scheduled-action + source: | + $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. + + # Delete Scheduled Action + + try { + Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId + + # Below is a request that includes all optional parameters + # Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledAction" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-uploaded-configuration + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Delete an Uploaded Configuration + + try { + Remove-V2024UploadedConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/deploys/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#get-deploy + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. + + # Get a Deploy + + try { + Get-V2024Deploy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Deploy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploy" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#get-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + + # Gets list of object mappings + + try { + Get-V2024ObjectMappings -SourceOrg $SourceOrg + + # Below is a request that includes all optional parameters + # Get-V2024ObjectMappings -SourceOrg $SourceOrg + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#get-uploaded-configuration + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Get an Uploaded Configuration + + try { + Get-V2024UploadedConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-backups + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + + # List Backups + + try { + Get-V2024Backups + + # Below is a request that includes all optional parameters + # Get-V2024Backups -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Backups" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/deploys + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-deploys + source: | + + # List Deploys + + try { + Get-V2024Deploys + + # Below is a request that includes all optional parameters + # Get-V2024Deploys + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploys" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/drafts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-drafts + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) + + # List Drafts + + try { + Get-V2024Drafts + + # Below is a request that includes all optional parameters + # Get-V2024Drafts -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/scheduled-actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-scheduled-actions + source: | + + # List Scheduled Actions + + try { + Get-V2024ScheduledActions + + # Below is a request that includes all optional parameters + # Get-V2024ScheduledActions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledActions" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-uploaded-configurations + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + + # List Uploaded Configurations + + try { + Get-V2024UploadedConfigurations + + # Below is a request that includes all optional parameters + # Get-V2024UploadedConfigurations -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfigurations" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#update-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkPatchRequest = @" + { + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + } + "@ + + # Bulk updates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest + Update-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/scheduled-actions/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#update-scheduled-action + source: | + $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Update Scheduled Action + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledAction" + Write-Host $_.ErrorDetails + } +- path: /connector-customizers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#create-connector-customizer + source: | + $ConnectorCustomizerCreateRequest = @" + { + "name" : "My Custom Connector" + } + "@ + + # Create Connector Customizer + + try { + $Result = ConvertFrom-JsonToConnectorCustomizerCreateRequest -Json $ConnectorCustomizerCreateRequest + New-V2024ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorCustomizer" + Write-Host $_.ErrorDetails + } +- path: /connector-customizers/{id}/versions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#create-connector-customizer-version + source: | + $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | The id of the connector customizer. + + # Creates a connector customizer version + + try { + New-V2024ConnectorCustomizerVersion -Id $Id + + # Below is a request that includes all optional parameters + # New-V2024ConnectorCustomizerVersion -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorCustomizerVersion" + Write-Host $_.ErrorDetails + } +- path: /connector-customizers/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#delete-connector-customizer + source: | + $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete. + + # Delete Connector Customizer + + try { + Remove-V2024ConnectorCustomizer -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ConnectorCustomizer -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ConnectorCustomizer" + Write-Host $_.ErrorDetails + } +- path: /connector-customizers/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#get-connector-customizer + source: | + $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to get. + + # Get connector customizer + + try { + Get-V2024ConnectorCustomizer -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorCustomizer -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCustomizer" + Write-Host $_.ErrorDetails + } +- path: /connector-customizers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#list-connector-customizers + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # List All Connector Customizers + + try { + Get-V2024ConnectorCustomizers + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorCustomizers -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCustomizers" + Write-Host $_.ErrorDetails + } +- path: /connector-customizers/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#put-connector-customizer + source: | + $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to update. + $ConnectorCustomizerUpdateRequest = @" + { + "name" : "My Custom Connector" + } + "@ + + # Update Connector Customizer + + try { + Send-V2024ConnectorCustomizer -Id $Id + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorCustomizer -Id $Id -ConnectorCustomizerUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCustomizer" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#create-connector-rule + source: | + $ConnectorRuleCreateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + } + "@ + + # Create Connector Rule + + try { + $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest + New-V2024ConnectorRule -ConnectorRuleCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ConnectorRule -ConnectorRuleCreateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#delete-connector-rule + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. + + # Delete Connector Rule + + try { + Remove-V2024ConnectorRule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ConnectorRule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#get-connector-rule + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. + + # Get Connector Rule + + try { + Get-V2024ConnectorRule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorRule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#get-connector-rule-list + source: | + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Connector Rules + + try { + Get-V2024ConnectorRuleList + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorRuleList -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRuleList" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#put-connector-rule + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update. + $ConnectorRuleUpdateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + } + "@ + + # Update Connector Rule + + try { + Send-V2024ConnectorRule -Id $Id + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorRule -Id $Id -ConnectorRuleUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/validate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#test-connector-rule + source: | + $SourceCode = @" + { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } + "@ + + # Validate Connector Rule + + try { + $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode + Test-V2024ConnectorRule -SourceCode $Result + + # Below is a request that includes all optional parameters + # Test-V2024ConnectorRule -SourceCode $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#create-custom-connector + source: | + $V3CreateConnectorDto = @" + { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } + "@ + + # Create Custom Connector + + try { + $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto + New-V2024CustomConnector -V3CreateConnectorDto $Result + + # Below is a request that includes all optional parameters + # New-V2024CustomConnector -V3CreateConnectorDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#delete-custom-connector + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Delete Connector by Script Name + + try { + Remove-V2024CustomConnector -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Remove-V2024CustomConnector -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector by Script Name + + try { + Get-V2024Connector -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024Connector -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector-correlation-config + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + + # Get Connector Correlation Configuration + + try { + Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector-list + source: | + $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector List + + try { + Get-V2024ConnectorList + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorList" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector-source-config + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Configuration + + try { + Get-V2024ConnectorSourceConfig -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorSourceConfig -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector-source-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Template + + try { + Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector-translations + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Get Connector Translations + + try { + Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#put-connector-correlation-config + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector correlation config xml file + + # Update Connector Correlation Configuration + + try { + Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#put-connector-source-config + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source config xml file + + # Update Connector Source Configuration + + try { + Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#put-connector-source-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source template xml file + + # Update Connector Source Template + + try { + Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#put-connector-translations + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Update Connector Translations + + try { + Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#update-connector + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Connector by Script Name + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Connector -ScriptName $ScriptName -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Connector -ScriptName $ScriptName -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Connector" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition + source: | + $Body = @" + { + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + } + "@ + + # Creates a form definition. + + try { + New-V2024FormDefinition + + # Below is a request that includes all optional parameters + # New-V2024FormDefinition -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/forms-action-dynamic-schema + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-dynamic-schema + source: | + $Body = @" + { + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + } + "@ + + # Generate JSON Schema dynamically. + + try { + New-V2024FormDefinitionDynamicSchema + + # Below is a request that includes all optional parameters + # New-V2024FormDefinitionDynamicSchema -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-file-request + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID + $File = # System.IO.FileInfo | File specifying the multipart + + # Upload new form definition file. + + try { + New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File + + # Below is a request that includes all optional parameters + # New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-instance + source: | + $Body = @" + { + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + } + "@ + + # Creates a form instance. + + try { + New-V2024FormInstance + + # Below is a request that includes all optional parameters + # New-V2024FormInstance -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#delete-form-definition + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + + # Deletes a form definition. + + try { + Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#export-form-definitions-by-tenant + source: | + $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # List form definitions by tenant. + + try { + Export-V2024FormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Export-V2024FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-file-from-s3 + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + + # Download definition file by fileId. + + try { + Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID + + # Below is a request that includes all optional parameters + # Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-definition-by-key + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + + # Return a form definition. + + try { + Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-instance-by-key + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + + # Returns a form instance. + + try { + Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-instance-file + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + + # Download instance file by fileId. + + try { + Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID + + # Below is a request that includes all optional parameters + # Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#import-form-definitions + source: | + + + + + $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ + + + # Import form definitions from export. + + try { + Import-V2024FormDefinitions + + # Below is a request that includes all optional parameters + # Import-V2024FormDefinitions -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-definition + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/description, value=test-description}]"@ + + + # Patch a form definition. + + try { + Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-instance + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ + + + # Patch a form instance. + + try { + Update-V2024FormInstance -FormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Update-V2024FormInstance -FormInstanceID $FormInstanceID -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-definitions-by-tenant + source: | + $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # Export form definitions by tenant. + + try { + Search-V2024FormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Search-V2024FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-element-data-by-element-id + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $FormElementID = "1" # String | Form element ID + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + + # Retrieves dynamic data by element. + + try { + Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID + + # Below is a request that includes all optional parameters + # Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-instances-by-tenant + source: | + + # List form instances by tenant. + + try { + Search-V2024FormInstancesByTenant + + # Below is a request that includes all optional parameters + # Search-V2024FormInstancesByTenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/predefined-select-options + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-pre-defined-select-options + source: | + + # List predefined select options. + + try { + Search-V2024PreDefinedSelectOptions + + # Below is a request that includes all optional parameters + # Search-V2024PreDefinedSelectOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/data-source + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#show-preview-data-source + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + $FormElementPreviewRequest = @" + { + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + } + "@ + + # Preview form definition data source. + + try { + Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-password-instructions#create-custom-password-instructions + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CustomPasswordInstruction = @" + { + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + } + "@ + + # Create Custom Password Instructions + + try { + $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction + New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result + + # Below is a request that includes all optional parameters + # New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-password-instructions#delete-custom-password-instructions + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Delete Custom Password Instructions by page ID + + try { + Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-password-instructions#get-custom-password-instructions + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Get Custom Password Instructions by Page ID + + try { + Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /data-segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#create-data-segment + source: | + $DataSegment = @" + + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment + New-V2024DataSegment -DataSegment $Result + + # Below is a request that includes all optional parameters + # New-V2024DataSegment -DataSegment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DataSegment" + Write-Host $_.ErrorDetails + } +- path: /data-segments/{segmentId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#delete-data-segment + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false) + + # Delete Segment by ID + + try { + Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -Published $Published + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024DataSegment" + Write-Host $_.ErrorDetails + } +- path: /data-segments/{segmentId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segment + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Segment by ID + + try { + Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegment" + Write-Host $_.ErrorDetails + } +- path: /data-segments/membership/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segment-identity-membership + source: | + $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get SegmentMembership by Identity ID + + try { + Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentIdentityMembership" + Write-Host $_.ErrorDetails + } +- path: /data-segments/user-enabled/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segmentation-enabled-for-user + source: | + $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Is Segmentation enabled by Identity + + try { + Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentationEnabledForUser" + Write-Host $_.ErrorDetails + } +- path: /data-segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#list-data-segments + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Enabled = $true # Boolean | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to $true) + $Unique = $false # Boolean | This returns only one record if set to true and that would be the published record if exists. (optional) (default to $false) + $Published = $true # Boolean | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to $true) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq """ # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) + + # Get Segments + + try { + Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental -Enabled $Enabled -Unique $Unique -Published $Published -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegments" + Write-Host $_.ErrorDetails + } +- path: /data-segments/{segmentId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#patch-data-segment + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to modify. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled + $RequestBody = @"[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024DataSegment" + Write-Host $_.ErrorDetails + } +- path: /data-segments/{segmentId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#publish-data-segment + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish to publish + $RequestBody = @""@ + + $PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true) + + # Publish segment by ID + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Publish-V2024DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Publish-V2024DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -PublishAll $PublishAll + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2024DataSegment" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#create-dimension + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $Dimension = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + } + "@ + + # Create a Dimension + + try { + $Result = ConvertFrom-JsonToDimension -Json $Dimension + New-V2024Dimension -RoleId $RoleId -Dimension $Result + + # Below is a request that includes all optional parameters + # New-V2024Dimension -RoleId $RoleId -Dimension $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Dimension" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#delete-bulk-dimensions + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimensions. + $DimensionBulkDeleteRequest = @" + { + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Dimension(s) + + try { + $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest + Remove-V2024BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkDimensions" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#delete-dimension + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + + # Delete a Dimension + + try { + Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Dimension" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#get-dimension + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + + # Get a Dimension under Role. + + try { + Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimension" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#get-dimension-entitlements + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Dimension's Entitlements + + try { + Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionEntitlements" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#list-dimension-access-profiles + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "source.id eq "2c91808982f979270182f99e386d00fa"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Dimension's Access Profiles + + try { + Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionAccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#list-dimensions + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq '2c918086749d78830174a1a40e121518'" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Dimensions + + try { + Get-V2024Dimensions -RoleId $RoleId + + # Below is a request that includes all optional parameters + # Get-V2024Dimensions -RoleId $RoleId -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimensions" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#patch-dimension + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Dimension + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Dimension" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Add metadata to an entitlement. + + try { + New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove metadata from an entitlement. + + try { + Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#get-entitlement + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get an entitlement + + try { + Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#get-entitlement-request-config + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Entitlement Request Config + + try { + Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/aggregate/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#import-entitlements-by-source + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Aggregate Entitlements + + try { + Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/children + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlement-children + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements children + + try { + Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/parents + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlement-parents + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements parents + + try { + Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents" + Write-Host $_.ErrorDetails + } +- path: /entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlements + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) + $SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + $IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + # Gets a list of entitlements. + + try { + Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#patch-entitlement + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an entitlement + + try { + Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#put-entitlement-request-config + source: | + $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EntitlementRequestConfig = @" + { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + } + "@ + + # Replace Entitlement Request Config + + try { + $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig + Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/reset/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#reset-source-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Reset Source Entitlements + + try { + Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#update-entitlements-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EntitlementBulkUpdateRequest = @" + { + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + } + "@ + + # Bulk update an entitlement list + + try { + $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest + Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + $NetworkConfiguration = @" + { + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + } + "@ + + # Create security network configuration. + + try { + $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration + New-V2024AuthOrgNetworkConfig -NetworkConfiguration $Result + + # Below is a request that includes all optional parameters + # New-V2024AuthOrgNetworkConfig -NetworkConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + + # Get Auth Org Lockout Configuration. + + try { + Get-V2024AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgLockoutConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + + # Get security network configuration. + + try { + Get-V2024AuthOrgNetworkConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgNetworkConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + + # Get Service Provider Configuration. + + try { + Get-V2024AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgServiceProviderConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + + # Get Auth Org Session Configuration. + + try { + Get-V2024AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgSessionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Lockout Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update security network configuration. + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgNetworkConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgNetworkConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Service Provider Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Session Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#create-workgroup + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $WorkgroupDto = @" + { + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Create a new Governance Group. + + try { + $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto + New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result + + # Below is a request that includes all optional parameters + # New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroup + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a Governance Group + + try { + Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroup-members + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityPreviewResponseIdentity = @""@ + + + # Remove members from Governance Group + + try { + $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity + Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + + # Below is a request that includes all optional parameters + # Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroups-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $WorkgroupBulkDeleteRequest = @" + { + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + } + "@ + + # Delete Governance Group(s) + + try { + $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest + Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#get-workgroup + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Governance Group by Id + + try { + Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#list-connections + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List connections for Governance Group + + try { + Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connections" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#list-workgroup-members + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Governance Group Members + + try { + Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#list-workgroups + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "Test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) + + # List Governance Groups + + try { + Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroups" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#patch-workgroup + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Governance Group + + try { + Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#update-workgroup-members + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityPreviewResponseIdentity = @""@ + + + # Add members to Governance Group + + try { + $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity + Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + + # Below is a request that includes all optional parameters + # Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Ignore Access Request Recommendation + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsIgnoredItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Accept Access Request Recommendation + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsRequestedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Mark Viewed Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }"@ + + + # Bulk Mark Viewed Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + $Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) + $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + # Identity Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Access Request Recommendations config + + try { + Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List Ignored Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsIgnoredItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List Accepted Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsRequestedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List Viewed Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationConfigDto = @" + { + "scoreThreshold" : 0.5, + "startDateAttribute" : "startDate", + "restrictionAttribute" : "location", + "moverAttribute" : "isMover", + "joinerAttribute" : "isJoiner", + "useRestrictionAttribute" : true + } + "@ + + # Update Access Request Recommendations config + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto + Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-common-access#create-common-access + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CommonAccessItemRequest = @" + { + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + } + "@ + + # Create common access items + + try { + $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest + New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-common-access#get-common-access + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.type eq "ROLE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + # Get a paginated list of common access + + try { + Get-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access/update-status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-common-access#update-common-access-status-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CommonAccessIDStatus = @"{ + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + }"@ + + + # Bulk update common access status + + try { + $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus + Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result + + # Below is a request that includes all optional parameters + # Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CommonAccessStatusInBulk" + Write-Host $_.ErrorDetails + } +- path: /outliers/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#export-outliers-zip + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Export + + try { + Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024OutliersZip" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-identity-outlier-snapshots + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) + $Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) + + # IAI Identity Outliers Summary + + try { + Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-identity-outliers + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) + + # IAI Get Identity Outliers + + try { + Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries/latest + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Latest Summary + + try { + Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LatestIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outlier-feature-summaries/{outlierFeatureId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get identity outlier contibuting feature summary + + try { + Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutlierContributingFeatureSummary" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/contributing-features + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) + $Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) + + # Get identity outlier's contibuting features + + try { + Get-V2024PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliersContributingFeatures" + Write-Host $_.ErrorDetails + } +- path: /outliers/ignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#ignore-identity-outliers + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Ignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024IgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + $Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) + + # Gets a list of access items associated with each identity outlier contributing feature + + try { + Get-V2024OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutliersContributingFeatureAccessItems" + Write-Host $_.ErrorDetails + } +- path: /outliers/unignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#un-ignore-identity-outliers + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Unignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /peer-group-strategies/{strategy}/identity-outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Identity Outliers List + + try { + Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliers" + Write-Host $_.ErrorDetails + } +- path: /recommendations/request + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-recommendations#get-recommendations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RecommendationRequestDto = @" + { + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + } + "@ + + # Returns Recommendation Based on Object + + try { + $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto + Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result + + # Below is a request that includes all optional parameters + # Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Recommendations" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-recommendations#get-recommendations-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get certification recommendation config values + + try { + Get-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-recommendations#update-recommendations-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RecommendationConfigDto = @" + { + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + } + "@ + + # Update certification recommendation config values + + try { + $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto + Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#create-potential-role-provision-request + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) + $RoleMiningPotentialRoleProvisionRequest = @" + { + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + } + "@ + + # Create request to provision a potential role into an actual role. + + try { + New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PotentialRoleProvisionRequest" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#create-role-mining-sessions + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningSessionDto = @" + { + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + } + "@ + + # Create a role mining session + + try { + $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto + New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result + + # Below is a request that includes all optional parameters + # New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Export (download) details for a potential role in a role mining session + + try { + Invoke-V2024DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Invoke-V2024DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleMiningPotentialRoleZip" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#export-role-mining-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Export (download) details for a potential role in a role mining session + + try { + Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningPotentialRoleExportRequest = @" + { + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + } + "@ + + # Asynchronously export details for a potential role in a role mining session and upload to S3 + + try { + Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleExportRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleAsync" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieve status of a potential role export job + + try { + Export-V2024RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-all-potential-role-summaries + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all potential role summaries + + try { + Get-V2024AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) + + # Retrieves entitlement popularity distribution for a potential role in a role mining session + + try { + Get-V2024EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementDistributionPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-entitlements-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) + $Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves entitlements for a potential role in a role mining session + + try { + Get-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves excluded entitlements for a potential role in a role mining session + + try { + Get-V2024ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ExcludedEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-identities-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves identities for a potential role in a role mining session + + try { + Get-V2024IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitiesPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieves a specific potential role + + try { + Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-applications + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the applications of a potential role for a role mining session + + try { + Get-V2024PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleApplications" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-entitlements + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the entitlements of a potential role for a role mining session + + try { + Get-V2024PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id + $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves potential role source usage + + try { + Get-V2024PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSourceIdentityUsage" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-summaries + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) + $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all potential role summaries + + try { + Get-V2024PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-potential-role + source: | + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieves a specific potential role + + try { + Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-session + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a role mining session + + try { + Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-session-status + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get role mining session status state + + try { + Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessionStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-sessions + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) + $Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all role mining sessions + + try { + Get-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/saved + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-saved-potential-roles + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all saved potential roles + + try { + Get-V2024SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedPotentialRoles" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#patch-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#patch-potential-role-0 + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole0" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#patch-role-mining-session + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a role mining session + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#update-entitlements-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningPotentialRoleEditEntitlements = @" + { + "ids" : [ "entId1", "entId2" ], + "exclude" : true + } + "@ + + # Edit entitlements for a potential role to exclude some entitlements + + try { + $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements + Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result + + # Below is a request that includes all optional parameters + # Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/icons#delete-icon + source: | + $ObjectType = "application" # String | Object type. Available options ['application'] + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete an icon + + try { + Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Icon" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/icons#set-icon + source: | + $ObjectType = "application" # String | Object type. Available options ['application'] + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + # Update an icon + + try { + Set-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image + + # Below is a request that includes all optional parameters + # Set-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Icon" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#delete-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete identity + + try { + Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Identity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#get-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Identity Details + + try { + Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identity" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/ownership + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#get-identity-ownership-details + source: | + $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get ownership details + + try { + Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOwnershipDetails" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#get-role-assignment + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Role assignment details + + try { + Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignment" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#get-role-assignments + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) + $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) + + # List role assignments + + try { + Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -RoleId $RoleId -RoleName $RoleName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignments" + Write-Host $_.ErrorDetails + } +- path: /identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#list-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) + $Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) + $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Identities + + try { + Get-V2024Identities -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Identities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identities" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/reset + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#reset-identity + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Reset an identity + + try { + Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024Identity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/verification/account/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#send-identity-verification-account-token + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $SendAccountVerificationRequest = @" + { + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + } + "@ + + # Send password reset email + + try { + $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest + Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityVerificationAccountToken" + Write-Host $_.ErrorDetails + } +- path: /identities/invite + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#start-identities-invite + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $InviteIdentitiesRequest = @" + { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } + "@ + + # Invite identities to register + + try { + $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest + Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite" + Write-Host $_.ErrorDetails + } +- path: /identities/process + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#start-identity-processing + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ProcessIdentitiesRequest = @" + { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } + "@ + + # Process a list of identityIds + + try { + $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest + Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentityProcessing" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#synchronize-attributes-for-identity + source: | + $IdentityId = "MyIdentityId" # String | The Identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Attribute synchronization for single identity. + + try { + Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024hronizeAttributesForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#create-identity-attribute + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Create Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#delete-identity-attribute + source: | + $Name = "displayName" # String | The attribute's technical name. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Identity Attribute + + try { + Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/bulk-delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttributeNames = @" + { + "ids" : [ "name", "displayName" ] + } + "@ + + # Bulk delete Identity Attributes + + try { + $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames + Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#get-identity-attribute + source: | + $Name = "displayName" # String | The attribute's technical name. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Identity Attribute + + try { + Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#list-identity-attributes + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) + $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) + $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Identity Attributes + + try { + Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttributes" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#put-identity-attribute + source: | + $Name = "displayName" # String | The attribute's technical name. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Update Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-history#compare-identity-snapshots + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a difference of count for each access item types for the given identity between 2 snapshots + + try { + Compare-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Compare-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare/{access-type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-history#compare-identity-snapshots-access-type + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $AccessType = "accessProfile" # String | The specific type which needs to be compared + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + $Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a list of differences of specific accessType for the given identity between 2 snapshots + + try { + Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshotsAccessType" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-historical-identity + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get latest snapshot of identity + + try { + Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentity" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/events + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-historical-identity-events + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) + $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) + + $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + $AccessItemTypes = @"[entitlement, account]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all events for the given identity + + try { + Get-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentityEvents" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-identity-snapshot + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Gets an identity snapshot at a given date + + try { + Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshot" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshot-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-identity-snapshot-summary + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) + $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) + $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets the summary for the event count for a specific identity + + try { + Get-V2024IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotSummary" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/start-date + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-identity-start-date + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Gets the start date of the identity + + try { + Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityStartDate" + Write-Host $_.ErrorDetails + } +- path: /historical-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-history#list-historical-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) + $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) + $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # Lists all the identities + + try { + Get-V2024HistoricalIdentities -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentities -XSailPointExperimental $XSailPointExperimental -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentities" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-history#list-identity-access-items + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Access Items by Identity + + try { + Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental -Type $Type -Limit $Limit -Count $Count -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-history#list-identity-snapshot-access-items + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "account" # String | The access item type (optional) + + # Gets the list of identity access items at a given date filterd by item type + + try { + Get-V2024IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-history#list-identity-snapshots + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) + $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all the snapshots for the identity + + try { + Get-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#create-identity-profile + source: | + $IdentityProfile = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + "@ + + # Create Identity Profile + + try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-V2024IdentityProfile -IdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-V2024IdentityProfile -IdentityProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#delete-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + + # Delete Identity Profile + + try { + Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#delete-identity-profiles + source: | + $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ + + + # Delete Identity Profiles + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024IdentityProfiles -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityProfiles -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#export-identity-profiles + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + + # Export Identity Profiles + + try { + Export-V2024IdentityProfiles + + # Below is a request that includes all optional parameters + # Export-V2024IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#generate-identity-preview + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityPreviewRequest = @" + { + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + } + "@ + + # Generate Identity Profile Preview + + try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityPreview" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#get-default-identity-attribute-config + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + + # Get default Identity Attribute Config + + try { + Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#get-identity-profile + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + + # Get Identity Profile + + try { + Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#import-identity-profiles + source: | + + + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + }"@ + + + # Import Identity Profiles + + try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-V2024IdentityProfiles -IdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-V2024IdentityProfiles -IdentityProfileExportedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#list-identity-profiles + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + # List Identity Profiles + + try { + Get-V2024IdentityProfiles + + # Below is a request that includes all optional parameters + # Get-V2024IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#sync-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + + # Process identities under profile + + try { + Sync-V2024IdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-V2024IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#update-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Identity Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/lifecycle-states#create-lifecycle-state + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleState = @" + { + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + } + "@ + + # Create Lifecycle State + + try { + $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState + New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result + + # Below is a request that includes all optional parameters + # New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/lifecycle-states#delete-lifecycle-state + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Delete Lifecycle State + + try { + Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/lifecycle-states#get-lifecycle-state + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Get Lifecycle State + + try { + Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/lifecycle-states#get-lifecycle-states + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Lists LifecycleStates + + try { + Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /identities/{identity-id}/set-lifecycle-state + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/lifecycle-states#set-lifecycle-state + source: | + $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. + $SetLifecycleStateRequest = @" + + "@ + + # Set Lifecycle State + + try { + $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest + Set-V2024LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/lifecycle-states#update-lifecycle-states + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Lifecycle State + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /machine-accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#get-machine-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Machine Account Details + + try { + Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount" + Write-Host $_.ErrorDetails + } +- path: /machine-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#list-machine-accounts + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) + + # Machine Accounts List + + try { + Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccounts" + Write-Host $_.ErrorDetails + } +- path: /machine-accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#update-machine-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + $RequestBody = @"[{op=add, path=/environment, value=test}]"@ + + + # Update a Machine Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount" + Write-Host $_.ErrorDetails + } +- path: /machine-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#create-machine-identity + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MachineIdentity = @" + { + "created" : "2015-05-28T14:07:17Z", + "businessApplication" : "ADService", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "", + "attributes" : "{\"Region\":\"EU\"}", + "id" : "id12345", + "manuallyEdited" : true + } + "@ + + # Create Machine Identities + + try { + $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity + New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result + + # Below is a request that includes all optional parameters + # New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity" + Write-Host $_.ErrorDetails + } +- path: /machine-identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#delete-machine-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete machine identity + + try { + Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity" + Write-Host $_.ErrorDetails + } +- path: /machine-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#get-machine-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Machine Identity Details + + try { + Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity" + Write-Host $_.ErrorDetails + } +- path: /machine-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#list-machine-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) + $Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Machine Identities + + try { + Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities" + Write-Host $_.ErrorDetails + } +- path: /machine-identities/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#update-machine-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ + + + # Update a Machine Identity + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#create-managed-client + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-V2024ManagedClient -ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedClient -ManagedClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#delete-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-V2024ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-V2024ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-V2024ManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-clients + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-V2024ManagedClients + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#update-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#create-managed-cluster + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-V2024ManagedCluster -ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedCluster -ManagedClusterRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#delete-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-V2024ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-V2024ClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-V2024ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-V2024ManagedClusters + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/manualUpgrade + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. + + # Trigger Manual Upgrade for Managed Cluster + + try { + Update-V2024 -Id $Id + + # Below is a request that includes all optional parameters + # Update-V2024 -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#create-managed-cluster-type + source: | + $ManagedClusterType = @" + { + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + } + "@ + + # Create new Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType + New-V2024ManagedClusterType -ManagedClusterType $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedClusterType -ManagedClusterType $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#delete-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Delete a Managed Cluster Type + + try { + Remove-V2024ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Get a Managed Cluster Type + + try { + Get-V2024ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-types + source: | + $Type = "IDN" # String | Type descriptor (optional) + $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) + $Org = "denali-xyz" # String | Pinned org (or default) (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # Get Managed Cluster Types + + try { + Get-V2024ManagedClusterTypes + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterTypes" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#update-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Update a Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-V2024MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-V2024MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-V2024MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2024MFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2024MFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-V2024MFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-V2024MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" + Write-Host $_.ErrorDetails + } +- path: /multihosts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#create-multi-host-integration + source: | + $MultiHostIntegrationsCreate = @" + { + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + } + "@ + + # Create Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate + New-V2024MultiHostIntegration -MultiHostIntegrationsCreate $Result + + # Below is a request that includes all optional parameters + # New-V2024MultiHostIntegration -MultiHostIntegrationsCreate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MultiHostIntegration" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#create-sources-within-multi-host + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + $MultiHostIntegrationsCreateSources = @"{ + "connectorAttributes" : { + "authType" : "SQLAuthentication", + "url" : "jdbc:sqlserver://178.18.41.118:1433", + "user" : "username", + "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "name" : "My Source", + "description" : "This is the corporate directory." + }"@ + + + # Create Sources Within Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources + New-V2024SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result + + # Below is a request that includes all optional parameters + # New-V2024SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourcesWithinMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#delete-multi-host + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. + + # Delete Multi-Host Integration + + try { + Remove-V2024MultiHost -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Remove-V2024MultiHost -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/acctAggregationGroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-acct-aggregation-groups + source: | + $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # List Account-Aggregation-Groups by Multi-Host ID + + try { + Get-V2024AcctAggregationGroups -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Get-V2024AcctAggregationGroups -MultihostId $MultihostId -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AcctAggregationGroups" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multiHostId}/entitlementAggregationGroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-entitlement-aggregation-groups + source: | + $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # List Entitlement-Aggregation-Groups by Integration ID + + try { + Get-V2024EntitlementAggregationGroups -MultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementAggregationGroups -MultiHostId $MultiHostId -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementAggregationGroups" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multi-host-integrations + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + + # Get Multi-Host Integration By ID + + try { + Get-V2024MultiHostIntegrations -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Get-V2024MultiHostIntegrations -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MultiHostIntegrations" + Write-Host $_.ErrorDetails + } +- path: /multihosts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multi-host-integrations-list + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + + # List All Existing Multi-Host Integrations + + try { + Get-V2024MultiHostIntegrationsList + + # Below is a request that includes all optional parameters + # Get-V2024MultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MultiHostIntegrationsList" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multiHostId}/sources/errors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multi-host-source-creation-errors + source: | + $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration + + # List Multi-Host Source Creation Errors + + try { + Get-V2024MultiHostSourceCreationErrors -MultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-V2024MultiHostSourceCreationErrors -MultiHostId $MultiHostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MultiHostSourceCreationErrors" + Write-Host $_.ErrorDetails + } +- path: /multihosts/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multihost-integration-types + source: | + + # List Multi-Host Integration Types + + try { + Get-V2024MultihostIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-V2024MultihostIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MultihostIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-sources-within-multi-host + source: | + $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Sources Within Multi-Host Integration + + try { + Get-V2024SourcesWithinMultiHost -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Get-V2024SourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourcesWithinMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/sources/testConnection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#test-connection-multi-host-sources + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration + + # Test Configuration For Multi-Host Integration + + try { + Test-V2024ConnectionMultiHostSources -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Test-V2024ConnectionMultiHostSources -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectionMultiHostSources" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#test-source-connection-multihost + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration + $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration + + # Test Configuration For Multi-Host Integration's Single Source + + try { + Test-V2024SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-V2024SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConnectionMultihost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#update-multi-host-sources + source: | + $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. + $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ + + + # Update Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner + Update-V2024MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MultiHostSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "Approved by manager" + } + "@ + + # Approve a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-V2024NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-V2024NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2024NonEmployeeRecord -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeRecord -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2024NonEmployeeRequest -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeRequest -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + $NonEmployeeSourceRequestBody = @" + { + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + } + "@ + + # Create Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-V2024NonEmployeeSource -NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeSource -NonEmployeeSourceRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $NonEmployeeSchemaAttributeBody = @" + { + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + } + "@ + + # Create a new Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Delete Non-Employee Record + + try { + Remove-V2024NonEmployeeRecord -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk + source: | + $DeleteNonEmployeeRecordsInBulkRequest = @" + + "@ + + # Delete Multiple Non-Employee Records + + try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest + Remove-V2024NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format + + # Delete Non-Employee Request + + try { + Remove-V2024NonEmployeeRequest -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete a Schema Attribute for Non-Employee Source + + try { + Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + + # Delete Non-Employee Source + + try { + Remove-V2024NonEmployeeSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete all custom schema attributes for Non-Employee Source + + try { + Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + + # Exports Non-Employee Records to CSV + + try { + Export-V2024NonEmployeeRecords -Id $Id + + # Below is a request that includes all optional parameters + # Export-V2024NonEmployeeRecords -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) + + # Exports Source Schema Template + + try { + Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + # Get a non-employee approval item detail + + try { + Get-V2024NonEmployeeApproval -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Approval Requests + + try { + Get-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) + + # Obtain the status of bulk upload on the source + + try { + Get-V2024NonEmployeeBulkUploadStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeBulkUploadStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Get a Non-Employee Record + + try { + Get-V2024NonEmployeeRecord -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) + + # Get a Non-Employee Request + + try { + Get-V2024NonEmployeeRequest -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Requests + + try { + Get-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequestSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Get Schema Attribute Non-Employee Source + + try { + Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + + # Get a Non-Employee Source + + try { + Get-V2024NonEmployeeSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # List Schema Attributes Non-Employee Source + + try { + Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + $Data = # System.IO.FileInfo | + + # Imports, or Updates, Non-Employee Records + + try { + Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-approvals + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Get List of Non-Employee Approval Requests + + try { + Get-V2024NonEmployeeApprovals + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovals" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-records + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Records + + try { + Get-V2024NonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Requests + + try { + Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequests" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-sources + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) + $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) + $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + + # List Non-Employee Sources + + try { + Get-V2024NonEmployeeSources + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Record + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024NonEmployeeRecord -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeRecord -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeRejectApprovalDecision = @" + { + "comment" : "approved" + } + "@ + + # Reject a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-V2024NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-V2024NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Update Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-V2024NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#create-domain-dkim + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $DomainAddress = @" + { + "domain" : "sailpoint.com" + } + "@ + + # Verify domain address via DKIM + + try { + $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress + New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result + + # Below is a request that includes all optional parameters + # New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#create-notification-template + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TemplateDto = @" + { + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Create Notification Template + + try { + $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto + New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result + + # Below is a request that includes all optional parameters + # New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#create-verified-from-address + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EmailStatusDto = @" + { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } + "@ + + # Create Verified From Address + + try { + $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto + New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result + + # Below is a request that includes all optional parameters + # New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#delete-notification-templates-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TemplateBulkDeleteDto = @"{ + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + }"@ + + + # Bulk Delete Notification Templates + + try { + $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto + Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result + + # Below is a request that includes all optional parameters + # Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#delete-verified-from-address + source: | + $Id = "MyId" # String | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Verified From Address + + try { + Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#get-dkim-attributes + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get DKIM Attributes + + try { + Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DkimAttributes" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes/{identity} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#get-mail-from-attributes + source: | + $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get MAIL FROM Attributes + + try { + Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#get-notification-template + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Notification Template By Id + + try { + Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /notification-template-context + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#get-notifications-template-context + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Notification Template Context + + try { + Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationsTemplateContext" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#list-from-addresses + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "email eq "john.doe@company.com"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) + $Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) + + # List From Addresses + + try { + Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FromAddresses" + Write-Host $_.ErrorDetails + } +- path: /notification-preferences/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#list-notification-preferences + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Notification Preferences for tenant. + + try { + Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationPreferences" + Write-Host $_.ErrorDetails + } +- path: /notification-template-defaults + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#list-notification-template-defaults + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "key eq "cloud_manual_work_item_summary"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Template Defaults + + try { + Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplateDefaults" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#list-notification-templates + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "medium eq "EMAIL"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Templates + + try { + Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplates" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#put-mail-from-attributes + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MailFromAttributesDto = @" + { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } + "@ + + # Change MAIL FROM domain + + try { + $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto + Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /send-test-notification + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#send-test-notification + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SendTestNotificationRequestDto = @" + { + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Send Test Notification + + try { + $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto + Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TestNotification" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/o-auth-clients#create-oauth-client + source: | + $CreateOAuthClientRequest = @" + { + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + } + "@ + + # Create OAuth Client + + try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-V2024OauthClient -CreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024OauthClient -CreateOAuthClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/o-auth-clients#delete-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Delete OAuth Client + + try { + Remove-V2024OauthClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024OauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/o-auth-clients#get-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Get OAuth Client + + try { + Get-V2024OauthClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024OauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/o-auth-clients#list-oauth-clients + source: | + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List OAuth Clients + + try { + Get-V2024OauthClients + + # Below is a request that includes all optional parameters + # Get-V2024OauthClients -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClients" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/o-auth-clients#patch-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch OAuth Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024OauthClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024OauthClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OauthClient" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/org-config#get-org-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Org Config Settings + + try { + Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OrgConfig" + Write-Host $_.ErrorDetails + } +- path: /org-config/valid-time-zones + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/org-config#get-valid-time-zones + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Valid Time Zones + + try { + Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ValidTimeZones" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/org-config#patch-org-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Org Config + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-configuration#create-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-V2024PasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-configuration#get-password-org-config + source: | + + # Get Password Org Config + + try { + Get-V2024PasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-V2024PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-configuration#put-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-V2024PasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024PasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-dictionary#get-password-dictionary + source: | + + # Get Password Dictionary + + try { + Get-V2024PasswordDictionary + + # Below is a request that includes all optional parameters + # Get-V2024PasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-dictionary#put-password-dictionary + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-V2024PasswordDictionary + + # Below is a request that includes all optional parameters + # Send-V2024PasswordDictionary -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /generate-password-reset-token/digit + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-management#create-digit-token + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PasswordDigitTokenReset = @" + { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } + "@ + + # Generate a digit token + + try { + $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset + New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result + + # Below is a request that includes all optional parameters + # New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DigitToken" + Write-Host $_.ErrorDetails + } +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-management#get-password-change-status + source: | + $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID + + # Get Password Change Request Status + + try { + Get-V2024PasswordChangeStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordChangeStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordChangeStatus" + Write-Host $_.ErrorDetails + } +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-management#query-password-info + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-V2024PasswordInfo -PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-V2024PasswordInfo -PasswordInfoQueryDTO $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PasswordInfo" + Write-Host $_.ErrorDetails + } +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-management#set-password + source: | + $PasswordChangeRequest = @" + { + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-V2024Password -PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024Password -PasswordChangeRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Password" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-policies#create-password-policy + source: | + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Create Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-V2024PasswordPolicy -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordPolicy -PasswordPolicyV3Dto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-policies#delete-password-policy + source: | + $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + + # Delete Password Policy by ID + + try { + Remove-V2024PasswordPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PasswordPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-policies#get-password-policy-by-id + source: | + $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + + # Get Password Policy by ID + + try { + Get-V2024PasswordPolicyById -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordPolicyById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicyById" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-policies#list-password-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Password Policies + + try { + Get-V2024PasswordPolicies + + # Below is a request that includes all optional parameters + # Get-V2024PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicies" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-policies#set-password-policy + source: | + $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Update Password Policy by ID + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-V2024PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-V2024PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-sync-groups#create-password-sync-group + source: | + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Create Password Sync Group + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-V2024PasswordSyncGroup -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordSyncGroup -PasswordSyncGroup $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-sync-groups#delete-password-sync-group + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + + # Delete Password Sync Group by ID + + try { + Remove-V2024PasswordSyncGroup -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-sync-groups#get-password-sync-group + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + + # Get Password Sync Group by ID + + try { + Get-V2024PasswordSyncGroup -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-sync-groups#get-password-sync-groups + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Password Sync Group List + + try { + Get-V2024PasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-V2024PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroups" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-sync-groups#update-password-sync-group + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Update Password Sync Group by ID + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-V2024PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-V2024PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/personal-access-tokens#create-personal-access-token + source: | + $CreatePersonalAccessTokenRequest = @" + { + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + } + "@ + + # Create Personal Access Token + + try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-V2024PersonalAccessToken -CreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024PersonalAccessToken -CreatePersonalAccessTokenRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/personal-access-tokens#delete-personal-access-token + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + + # Delete Personal Access Token + + try { + Remove-V2024PersonalAccessToken -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PersonalAccessToken -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/personal-access-tokens#list-personal-access-tokens + source: | + $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List Personal Access Tokens + + try { + Get-V2024PersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-V2024PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PersonalAccessTokens" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/personal-access-tokens#patch-personal-access-token + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Personal Access Token + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024PersonalAccessToken -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024PersonalAccessToken -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /public-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/public-identities#get-public-identities + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Get list of public identities + + try { + Get-V2024PublicIdentities + + # Below is a request that includes all optional parameters + # Get-V2024PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentities" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/public-identities-config#get-public-identity-config + source: | + + # Get the Public Identities Configuration + + try { + Get-V2024PublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-V2024PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/public-identities-config#update-public-identity-config + source: | + $PublicIdentityConfig = @" + { + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + } + "@ + + # Update the Public Identities Configuration + + try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-V2024PublicIdentityConfig -PublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2024PublicIdentityConfig -PublicIdentityConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /reports/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/reports-data-extraction#cancel-report + source: | + $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel + + # Cancel Report + + try { + Suspend-V2024Report -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024Report -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/reports-data-extraction#get-report + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $FileFormat = "csv" # String | Output format of the requested report file + $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) + $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) + + # Get Report File + + try { + Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat + + # Below is a request that includes all optional parameters + # Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId}/result + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/reports-data-extraction#get-report-result + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) + + # Get Report Result + + try { + Get-V2024ReportResult -TaskResultId $TaskResultId + + # Below is a request that includes all optional parameters + # Get-V2024ReportResult -TaskResultId $TaskResultId -Completed $Completed + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReportResult" + Write-Host $_.ErrorDetails + } +- path: /reports/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/reports-data-extraction#start-report + source: | + $ReportDetails = @" + { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } + "@ + + # Run Report + + try { + $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails + Start-V2024Report -ReportDetails $Result + + # Below is a request that includes all optional parameters + # Start-V2024Report -ReportDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Report" + Write-Host $_.ErrorDetails + } +- path: /requestable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/requestable-objects#list-requestable-objects + source: | + $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) + + $Types = @"ROLE,ACCESS_PROFILE"@ + $Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) + $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) + + $Statuses = @"[ASSIGNED, PENDING]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Requestable Objects List + + try { + Get-V2024RequestableObjects + + # Below is a request that includes all optional parameters + # Get-V2024RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RequestableObjects" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/role-insights#create-role-insight-requests + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Generate insights for roles + + try { + New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleInsightRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/role-insights#download-role-insights-entitlements-changes + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Download entitlement insights for a role + + try { + Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-entitlement-changes-identities + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name sw "Jan"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + + # Get identities for a suggested entitlement (for a role) + + try { + Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChangesIdentities" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insight + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a single role insight + + try { + Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsight" + Write-Host $_.ErrorDetails + } +- path: /role-insights + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + $Filters = "name sw "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + # Get role insights + + try { + Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsights" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/current-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-current-entitlements + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get current entitlement for a role + + try { + Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsCurrentEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-entitlements-changes + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) + $Filters = "name sw "Admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get entitlement insights for a role + + try { + Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-requests + source: | + $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Returns metadata from prior request. + + try { + Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-summary + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get role insights summary information + + try { + Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsSummary" + Write-Host $_.ErrorDetails + } +- path: /roles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#create-role + source: | + $Role = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + } + "@ + + # Create a Role + + try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-V2024Role -Role $Result + + # Below is a request that includes all optional parameters + # New-V2024Role -Role $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Role" + Write-Host $_.ErrorDetails + } +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#delete-bulk-roles + source: | + $RoleBulkDeleteRequest = @" + { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Role(s) + + try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-V2024BulkRoles -RoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024BulkRoles -RoleBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#delete-metadata-from-role-by-key-and-value + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Remove a Metadata From Role. + + try { + Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MetadataFromRoleByKeyAndValue" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#delete-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Delete a Role + + try { + Remove-V2024Role -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Role -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Role" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#get-bulk-update-status + source: | + + # Get Bulk-Update Statuses + + try { + Get-V2024BulkUpdateStatus + + # Below is a request that includes all optional parameters + # Get-V2024BulkUpdateStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatus" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/id + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#get-bulk-update-status-by-id + source: | + $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. + + # Get Bulk-Update Status by ID + + try { + Get-V2024BulkUpdateStatusById -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024BulkUpdateStatusById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatusById" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#get-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Get a Role + + try { + Get-V2024Role -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Role -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Role" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#get-role-assigned-identities + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + + # List Identities assigned a Role + + try { + Get-V2024RoleAssignedIdentities -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignedIdentities" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#get-role-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | Containing role's ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Role's Entitlements + + try { + Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#list-roles + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Roles + + try { + Get-V2024Roles + + # Below is a request that includes all optional parameters + # Get-V2024Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Roles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#patch-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Role + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Role -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Role -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Role" + Write-Host $_.ErrorDetails + } +- path: /roles/filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#search-roles-by-filter + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + $RoleListFilterDTO = @" + { + "ammKeyValues" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "secret" ] + } ], + "filters" : "dimensional eq false" + } + "@ + + # Filter Roles by Metadata + + try { + Search-V2024RolesByFilter + + # Below is a request that includes all optional parameters + # Search-V2024RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -RoleListFilterDTO $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024RolesByFilter" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#update-attribute-key-and-value-to-role + source: | + $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Add a Metadata to Role. + + try { + Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AttributeKeyAndValueToRole" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-filter + source: | + $RoleMetadataBulkUpdateByFilterRequest = @" + { + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "filters" : " requestable eq false", + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by Filters + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest + Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByFilter" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/ids + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-ids + source: | + $RoleMetadataBulkUpdateByIdRequest = @" + { + "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by ID + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest + Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByIds" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/query + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-query + source: | + $RoleMetadataBulkUpdateByQueryRequest = @" + { + "query" : { + "query\"" : { + "indices" : [ "roles" ], + "queryType" : "TEXT", + "textQuery" : { + "terms" : [ "test123" ], + "fields" : [ "id" ], + "matchAny" : false, + "contains" : true + }, + "includeNested" : false + } + }, + "values" : [ { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + }, { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by Query + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest + Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#create-saved-search + source: | + $CreateSavedSearchRequest = @" + + "@ + + # Create a saved search + + try { + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-V2024SavedSearch -CreateSavedSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024SavedSearch -CreateSavedSearchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#delete-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete document by ID + + try { + Remove-V2024SavedSearch -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id}/execute + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#execute-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SearchArguments = @" + { + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + } + "@ + + # Execute a saved search by ID + + try { + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-V2024ExecuteSavedSearch -Id $Id -SearchArguments $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ExecuteSavedSearch -Id $Id -SearchArguments $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#get-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Return saved search by ID + + try { + Get-V2024SavedSearch -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#list-saved-searches + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) + + # A list of Saved Searches + + try { + Get-V2024SavedSearches + + # Below is a request that includes all optional parameters + # Get-V2024SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#put-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SavedSearch = @" + { + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + } + "@ + + # Updates an existing saved search + + try { + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-V2024SavedSearch -Id $Id -SavedSearch $Result + + # Below is a request that includes all optional parameters + # Send-V2024SavedSearch -Id $Id -SavedSearch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#create-scheduled-search + source: | + $CreateScheduledSearchRequest = @" + {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} + "@ + + # Create a new scheduled search + + try { + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-V2024ScheduledSearch -CreateScheduledSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ScheduledSearch -CreateScheduledSearchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#delete-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete a Scheduled Search + + try { + Remove-V2024ScheduledSearch -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#get-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Scheduled Search + + try { + Get-V2024ScheduledSearch -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#list-scheduled-search + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + # List scheduled searches + + try { + Get-V2024ScheduledSearch + + # Below is a request that includes all optional parameters + # Get-V2024ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id}/unsubscribe + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#unsubscribe-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $TypedReference = @" + { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + "@ + + # Unsubscribe a recipient from Scheduled Search + + try { + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-V2024UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#update-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ScheduledSearch = @" + { + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + } + "@ + + # Update an existing Scheduled Search + + try { + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-V2024ScheduledSearch -Id $Id -ScheduledSearch $Result + + # Below is a request that includes all optional parameters + # Update-V2024ScheduledSearch -Id $Id -ScheduledSearch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /search/aggregate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/search#search-aggregate + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform a Search Query Aggregation + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Aggregate -Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" + Write-Host $_.ErrorDetails + } +- path: /search/count + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/search#search-count + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + + # Count Documents Satisfying a Query + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Count -Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Count -Search $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" + Write-Host $_.ErrorDetails + } +- path: /search/{index}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/search#search-get + source: | + $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Document by ID + + try { + Search-V2024Get -Index $Index -Id $Id + + # Below is a request that includes all optional parameters + # Search-V2024Get -Index $Index -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get" + Write-Host $_.ErrorDetails + } +- path: /search + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/search#search-post + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform Search + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Post -Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#create-search-attribute-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#delete-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Extended Search Attribute + + try { + Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-search-attribute-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Extended Search Attributes + + try { + Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Extended Search Attribute + + try { + Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#patch-search-attribute-config + source: | + $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/segments#create-segment + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-V2024Segment -Segment $Result + + # Below is a request that includes all optional parameters + # New-V2024Segment -Segment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/segments#delete-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-V2024Segment -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/segments#get-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-V2024Segment -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/segments#list-segments + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-V2024Segments + + # Below is a request that includes all optional parameters + # Get-V2024Segments -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/segments#patch-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024Segment -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024Segment -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#create-service-desk-integration + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-V2024ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-V2024ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#delete-service-desk-integration + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-V2024ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-V2024ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-V2024ServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integrations + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-V2024ServiceDeskIntegrations + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrations" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-status-check-details + source: | + + # Get the time check configuration + + try { + Get-V2024StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-V2024StatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-V2024ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#update-status-check-details + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-V2024StatusCheckDetails -QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2024StatusCheckDetails -QueuedCheckConfigDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration + source: | + $Id = "12345" # String | The id of the integration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a SIM integration + + try { + Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a SIM integration details. + + try { + Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2024SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2024SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2024SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-V2024SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2024SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2024SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2024SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-V2024SodPolicies + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2024SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2024SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2024EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2024SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#create-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#create-source + source: | + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-V2024Source -Source $Result + + # Below is a request that includes all optional parameters + # New-V2024Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#create-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schedule1 = @" + + "@ + + # Create Schedule on Source + + try { + $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 + New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#create-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-V2024SourceSchema -SourceId $SourceId -Schema $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceSchema -SourceId $SourceId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/remove-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-accounts-async + source: | + $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove All Accounts in a Source + + try { + Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountsAsync" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-native-change-detection-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Native Change Detection Configuration + + try { + Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Delete Provisioning Policy by UsageType + + try { + Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-V2024Source -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + + # Delete Source Schedule by type. + + try { + Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + + # Below is a request that includes all optional parameters + # Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Delete Source Schema by ID + + try { + Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-accounts-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-V2024AccountsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountsSchema -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-correlation-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Get Source Correlation Configuration + + try { + Get-V2024CorrelationConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CorrelationConfig -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-entitlements-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-V2024EntitlementsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementsSchema -Id $Id -SchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-native-change-detection-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Native Change Detection Configuration + + try { + Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Get Provisioning Policy by UsageType + + try { + Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-V2024Source -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-attr-sync-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Attribute Sync Config + + try { + Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/connectors/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-config + source: | + $Id = "cef3ee201db947c5912551015ba0c679" # String | The Source id + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Gets source config with language-translations + + try { + Get-V2024SourceConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SourceConfig -Id $Id -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-connections + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source Connections by ID + + try { + Get-V2024SourceConnections -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceConnections -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConnections" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-entitlement-request-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Source Entitlement Request Configuration + + try { + Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/source-health + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-health + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + + # Fetches source health by id + + try { + Get-V2024SourceHealth -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceHealth -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceHealth" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + + # Get Source Schedule by Type + + try { + Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schedules + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # List Schedules on Source + + try { + Get-V2024SourceSchedules -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchedules -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedules" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Get Source Schema by ID + + try { + Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schemas + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-V2024SourceSchemas -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchemas" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#import-accounts + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) + $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) + + # Account Aggregation + + try { + Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Accounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#import-accounts-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-V2024AccountsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Import-V2024AccountsSchema -Id $Id -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#import-connector-file + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-V2024ConnectorFile -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-V2024ConnectorFile -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024ConnectorFile" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#import-entitlements-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-V2024EntitlementsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Import-V2024EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-uncorrelated-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#import-uncorrelated-accounts + source: | + $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $File = # System.IO.FileInfo | (optional) + + # Process Uncorrelated Accounts + + try { + Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024UncorrelatedAccounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#list-provisioning-policies + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-V2024ProvisioningPolicies -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024ProvisioningPolicies -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicies" + Write-Host $_.ErrorDetails + } +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#list-sources + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-V2024Sources + + # Below is a request that includes all optional parameters + # Get-V2024Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Sources" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/ping-cluster + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#ping-cluster + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Ping cluster for source connector + + try { + Ping-V2024Cluster -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Ping-V2024Cluster -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2024Cluster" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#put-correlation-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $CorrelationConfig = @" + { + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + } + "@ + + # Update Source Correlation Configuration + + try { + $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig + Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024CorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#put-native-change-detection-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $NativeChangeDetectionConfig = @" + { + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + } + "@ + + # Update Native Change Detection Configuration + + try { + $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig + Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#put-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#put-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-V2024Source -Id $Id -Source $Result + + # Below is a request that includes all optional parameters + # Send-V2024Source -Id $Id -Source $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#put-source-attr-sync-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AttrSyncSourceConfig = @" + { + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + } + "@ + + # Update Attribute Sync Config + + try { + $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig + Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#put-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + + # Below is a request that includes all optional parameters + # Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/peek-resource-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#search-resource-objects + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + $ResourceObjectsRequest = @" + { + "maxCount" : 100, + "objectType" : "group" + } + "@ + + # Peek source connector's resource objects + + try { + $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest + Search-V2024ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result + + # Below is a request that includes all optional parameters + # Search-V2024ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024ResourceObjects" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#sync-attributes-for-source + source: | + $Id = "MyId" # String | The Source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Synchronize single source attributes. + + try { + Sync-V2024AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Sync-V2024AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024AttributesForSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/test-configuration + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#test-source-configuration + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Test configuration for source connector + + try { + Test-V2024SourceConfiguration -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-V2024SourceConfiguration -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConfiguration" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/check-connection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#test-source-connection + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. + + # Check connection for source connector. + + try { + Test-V2024SourceConnection -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-V2024SourceConnection -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConnection" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/password-policies + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-password-policy-holders + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $PasswordPolicyHoldersDtoInner = @""@ + + + # Update Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner + Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordPolicyHolders" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policies-in-bulk + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Source -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Source -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-entitlement-request-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceEntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Update Source Entitlement Request Configuration + + try { + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schedule (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-V2024StatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-V2024UsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2024SpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2024SpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-V2024SpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-V2024SpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-V2024SpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-V2024SpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2024SpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-V2024SpConfigObjects + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id + + # Submit Sed Batch Stats Request + + try { + Get-V2024SedBatchStats -BatchId $BatchId + + # Below is a request that includes all optional parameters + # Get-V2024SedBatchStats -BatchId $BatchId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batches + source: | + + # List Sed Batch Request + + try { + Get-V2024SedBatches + + # Below is a request that includes all optional parameters + # Get-V2024SedBatches + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#list-seds + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) + $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) + $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) + $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) + + # List Suggested Entitlement Descriptions + + try { + Get-V2024Seds + + # Below is a request that includes all optional parameters + # Get-V2024Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#patch-sed + source: | + $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id + $SedPatch = @"{ + "op" : "replace", + "path" : "status", + "value" : "approved" + }"@ + + + # Patch Suggested Entitlement Description + + try { + $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch + Update-V2024Sed -Id $Id -SedPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024Sed -Id $Id -SedPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-approvals + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-approval + source: | + $SedApproval = @"{ + "items" : "016629d1-1d25-463f-97f3-c6686846650" + }"@ + + + # Submit Bulk Approval Request + + try { + $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval + Submit-V2024SedApproval -SedApproval $Result + + # Below is a request that includes all optional parameters + # Submit-V2024SedApproval -SedApproval $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-assignments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-assignment + source: | + $SedAssignment = @" + { + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + } + "@ + + # Submit Sed Assignment Request + + try { + $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment + Submit-V2024SedAssignment -SedAssignment $Result + + # Below is a request that includes all optional parameters + # Submit-V2024SedAssignment -SedAssignment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + $SedBatchRequest = @" + { + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + } + "@ + + # Submit Sed Batch Request + + try { + Submit-V2024SedBatchRequest + + # Below is a request that includes all optional parameters + # Submit-V2024SedBatchRequest -SedBatchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#delete-tagged-object + source: | + $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + + # Delete Object Tags + + try { + Remove-V2024TaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#delete-tags-to-many-object + source: | + $BulkRemoveTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject + Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#get-tagged-object + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get Tagged Object + + try { + Get-V2024TaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#list-tagged-objects + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-V2024TaggedObjects + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjects" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#list-tagged-objects-by-type + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + Get-V2024TaggedObjectsByType -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjectsByType" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#put-tagged-object + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#set-tag-to-object + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-V2024TagToObject -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-V2024TagToObject -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#set-tags-to-many-objects + source: | + $BulkAddTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject + Set-V2024TagsToManyObjects -BulkAddTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-V2024TagsToManyObjects -BulkAddTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: HEAD + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-pending-task-headers + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task List Headers + + try { + Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTaskHeaders" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-pending-tasks + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task Status List + + try { + Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTasks" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-task-status + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Task Status by ID + + try { + Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatus" + Write-Host $_.ErrorDetails + } +- path: /task-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-task-status-list + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "completionStatus eq "Success"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + $Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) + + # Retrieve Task Status List + + try { + Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatusList" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/task-management#update-task-status + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Task Status by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus" + Write-Host $_.ErrorDetails + } +- path: /tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tenant#get-tenant + source: | + + # Get Tenant Information. + + try { + Get-V2024Tenant + + # Below is a request that includes all optional parameters + # Get-V2024Tenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant" + Write-Host $_.ErrorDetails + } +- path: /tenant-context + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tenant-context#get-tenant-context + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieve tenant context + + try { + Get-V2024TenantContext -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TenantContext -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantContext" + Write-Host $_.ErrorDetails + } +- path: /tenant-context + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tenant-context#patch-tenant-context + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @" + { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } + "@ + + # Update tenant context + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TenantContext" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/transforms#create-transform + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-V2024Transform -Transform $Result + + # Below is a request that includes all optional parameters + # New-V2024Transform -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/transforms#delete-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-V2024Transform -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/transforms#get-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-V2024Transform -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/transforms#list-transforms + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-V2024Transforms + + # Below is a request that includes all optional parameters + # Get-V2024Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transforms" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/transforms#update-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-V2024Transform -Id $Id + + # Below is a request that includes all optional parameters + # Update-V2024Transform -Id $Id -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Transform" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#complete-trigger-invocation + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CompleteInvocation = @" + { + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + } + "@ + + # Complete Trigger Invocation + + try { + $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation + Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result + + # Below is a request that includes all optional parameters + # Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#create-subscription + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPostRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Create a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest + New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#delete-subscription + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a Subscription + + try { + Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Subscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#list-subscriptions + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) + $Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) + + # List Subscriptions + + try { + Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Subscriptions" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#list-trigger-invocation-status + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "triggerId eq "idn:access-request-dynamic-approver"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) + + # List Latest Invocation Statuses + + try { + Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TriggerInvocationStatus" + Write-Host $_.ErrorDetails + } +- path: /triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#list-triggers + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "idn:access-request-post-approval"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) + + # List Triggers + + try { + Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Triggers" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#patch-subscription + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPatchRequestInner = @""@ + + + # Patch a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner + Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#start-test-trigger-invocation + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TestInvocation = @" + { + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + } + "@ + + # Start a Test Invocation + + try { + $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation + Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result + + # Below is a request that includes all optional parameters + # Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/validate-filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#test-subscription-filter + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ValidateFilterInputDto = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } + "@ + + # Validate a Subscription Filter + + try { + $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto + Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result + + # Below is a request that includes all optional parameters + # Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#update-subscription + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPutRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Update a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest + Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/ui-metadata#get-tenant-ui-metadata + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a tenant UI metadata + + try { + Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/ui-metadata#set-tenant-ui-metadata + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TenantUiMetadataItemUpdateRequest = @" + { + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + } + "@ + + # Update tenant UI metadata + + try { + $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest + Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-V2024VendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-V2024VendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + + # List Vendor Connector Mappings + + try { + Get-V2024VendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-V2024VendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2024WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2024ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2024Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2024WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-V2024WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2024Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2024Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2024WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2024WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2024WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-V2024CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-V2024WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-V2024WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-V2024WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-V2024Workflows + + # Below is a request that includes all optional parameters + # Get-V2024Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2024Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2024Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2024ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-V2024ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Approve-V2024ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#complete-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) + + # Complete a Work Item + + try { + Complete-V2024WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Complete-V2024WorkItem -Id $Id -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#forward-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Invoke-V2024ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-V2024CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-completed-work-items + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-work-items + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-V2024CountWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-item + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-V2024WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-items-summary + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-V2024WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-V2024WorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#list-work-items + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-V2024WorkItems + + # Below is a request that includes all optional parameters + # Get-V2024WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-V2024ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Deny-V2024ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#submit-account-selection + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-V2024AccountSelection -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-V2024AccountSelection -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#create-reassignment-configuration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Create a Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#delete-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Reassignment Configuration + + try { + Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration + + try { + Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-config-types + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Reassignment Config Types + + try { + Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Reassignment Configuration + + try { + Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-tenant-config-configuration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Tenant-wide Reassignment Configuration settings + + try { + Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#list-reassignment-configurations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Reassignment Configurations + + try { + Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-reassignment-config + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Update Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-tenant-configuration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TenantConfigurationRequest = @" + { + "configDetails" : { + "disabled" : true + } + } + "@ + + # Update Tenant-wide Reassignment Configuration settings + + try { + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" + Write-Host $_.ErrorDetails + } diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index 139597f9c..5d0110c58 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -1,2 +1,18636 @@ +- path: /access-model-metadata/attributes/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Access Model Metadata Attribute + + try { + Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values/{value} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $Value = "public" # String | Technical name of the Attribute value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Access Model Metadata Value + + try { + Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + # List Access Model Metadata Attributes + + try { + Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Access Model Metadata Values + + try { + Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#create-access-profile + source: | + $AccessProfile = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-V2025AccessProfile -AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-V2025AccessProfile -AccessProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#delete-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-V2025AccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#delete-access-profiles-in-bulk + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-V2025AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2025AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#get-access-profile + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-V2025AccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#get-access-profile-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + Get-V2025AccessProfileEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfileEntitlements" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#list-access-profiles + source: | + $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) + + # List Access Profiles + + try { + Get-V2025AccessProfiles + + # Below is a request that includes all optional parameters + # Get-V2025AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#patch-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AccessProfile -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AccessProfile -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-update-requestable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#update-access-profiles-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ + + + # Update Access Profile(s) requestable field. + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner + Update-V2025AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2025AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#approve-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + Approve-V2025AccessRequest -ApprovalId $ApprovalId + + # Below is a request that includes all optional parameters + # Approve-V2025AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#forward-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-V2025ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-V2025ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ForwardAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/approval-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#get-access-request-approval-summary + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-V2025AccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-V2025AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{accessRequestId}/approvers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#list-access-request-approvers + source: | + $AccessRequestId = "2c91808568c529c60168cca6f90c1313" # String | Access Request ID. + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + + # Access Request Approvers + + try { + Get-V2025AccessRequestApprovers -AccessRequestId $AccessRequestId + + # Below is a request that includes all optional parameters + # Get-V2025AccessRequestApprovers -AccessRequestId $AccessRequestId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestApprovers" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#list-completed-approvals + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Completed Access Request Approvals List + + try { + Get-V2025CompletedApprovals + + # Below is a request that includes all optional parameters + # Get-V2025CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompletedApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#list-pending-approvals + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-V2025PendingApprovals + + # Below is a request that includes all optional parameters + # Get-V2025PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-request-approvals#reject-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-V2025AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-V2025AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. + $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. + $Type = "ENTITLEMENT" # String | Requested access item's type. + + # Return access request identity metrics + + try { + Get-V2025AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2025AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestIdentityMetrics" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/bulk-approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#approve-bulk-access-request + source: | + $BulkApproveAccessRequest = @" + { + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + } + "@ + + # Bulk Approve Access Request + + try { + $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest + Approve-V2025BulkAccessRequest -BulkApproveAccessRequest $Result + + # Below is a request that includes all optional parameters + # Approve-V2025BulkAccessRequest -BulkApproveAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025BulkAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#cancel-access-request + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-V2025AccessRequest -CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-V2025AccessRequest -CancelAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/bulk-cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#cancel-access-request-in-bulk + source: | + $BulkCancelAccessRequest = @" + { + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + } + "@ + + # Bulk Cancel Access Request + + try { + $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest + Suspend-V2025AccessRequestInBulk -BulkCancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-V2025AccessRequestInBulk -BulkCancelAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025AccessRequestInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-requests/close + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#close-access-request + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CloseAccessRequest = @" + { + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + } + "@ + + # Close Access Request + + try { + $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest + Close-V2025AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result + + # Below is a request that includes all optional parameters + # Close-V2025AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2025AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#create-access-request + source: | + $AccessRequest = @" + { + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-V2025AccessRequest -AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025AccessRequest -AccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#get-access-request-config + source: | + + # Get Access Request Configuration + + try { + Get-V2025AccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-V2025AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /access-requests/revocable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#get-entitlement-details-for-identity + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityId = "7025c863c2704ba6beeaedf3cb091573" # String | The identity ID. + $EntitlementId = "ef38f94347e94562b5bb8424a56397d8" # String | The entitlement ID + + # Identity Entitlement Details + + try { + Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementDetailsForIdentity" + Write-Host $_.ErrorDetails + } +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#list-access-request-status + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-V2025AccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-V2025AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-request-administration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#list-administrators-access-request-status + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status for Administrators + + try { + Get-V2025AdministratorsAccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-V2025AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AdministratorsAccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-requests/accounts-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#load-account-selections + source: | + $AccountsSelectionRequest = @" + { + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } + "@ + + # Get accounts selections for identity + + try { + $Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest + Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result + + # Below is a request that includes all optional parameters + # Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025LoadAccountSelections" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#set-access-request-config + source: | + $AccessRequestConfig = @" + { + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-V2025AccessRequestConfig -AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2025AccessRequestConfig -AccessRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/account-activities#get-account-activity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get an Account Activity + + try { + Get-V2025AccountActivity -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025AccountActivity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountActivity" + Write-Host $_.ErrorDetails + } +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/account-activities#list-account-activities + source: | + $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-V2025AccountActivities + + # Below is a request that includes all optional parameters + # Get-V2025AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountActivities" + Write-Host $_.ErrorDetails + } +- path: /account-aggregations/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/account-aggregations#get-account-aggregation-status + source: | + $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # In-progress Account Aggregation status + + try { + Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountAggregationStatus" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#create-account + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-V2025Account -AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-V2025Account -AccountAttributesCreate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#delete-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-V2025Account -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#delete-account-async + source: | + $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove Account + + try { + Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccountAsync" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-V2025Account -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-V2025Account -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025Account" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-account-for-identity + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Disable IDN Account for Identity + + try { + Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025AccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-accounts-for-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Disable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Disable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Disable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025AccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-V2025Account -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-V2025Account -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025Account" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-account-for-identity + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Enable IDN Account for Identity + + try { + Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025AccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-accounts-for-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Enable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Enable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Enable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025AccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#get-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-V2025Account -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#get-account-entitlements + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Account Entitlements + + try { + Get-V2025AccountEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountEntitlements" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#list-accounts + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + # Accounts List + + try { + Get-V2025Accounts + + # Below is a request that includes all optional parameters + # Get-V2025Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Accounts" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#put-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-V2025Account -Id $Id -AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-V2025Account -Id $Id -AccountAttributes $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#submit-reload-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-V2025ReloadAccount -Id $Id + + # Below is a request that includes all optional parameters + # Submit-V2025ReloadAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025ReloadAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#unlock-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-V2025Account -Id $Id -AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-V2025Account -Id $Id -AccountUnlockRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2025Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/accounts#update-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=remove, path=/identityId}]"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2025Account -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2025Account -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Account" + Write-Host $_.ErrorDetails + } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2025UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#get-discovered-applications + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + + # Get Discovered Applications for Tenant + + try { + Get-V2025DiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-V2025DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DiscoveredApplications" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + + # Download CSV Template for Discovery + + try { + Get-V2025ManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-V2025ManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + # Upload CSV to Discover Applications + + try { + Send-V2025ManualDiscoverApplicationsCsvTemplate -File $File + + # Below is a request that includes all optional parameters + # Send-V2025ManualDiscoverApplicationsCsvTemplate -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/approvals#get-approval + source: | + $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that is to be returned + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get an approval + + try { + Get-V2025Approval -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025Approval -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approval" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/approvals#get-approvals + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Mine = $true # Boolean | Returns the list of approvals for the current caller (optional) + $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID (optional) + $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) + + # Get Approvals + + try { + Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approvals" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#create-source-app + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceAppCreateDto = @" + { + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + } + "@ + + # Create source app + + try { + $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto + New-V2025SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result + + # Below is a request that includes all optional parameters + # New-V2025SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @"[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]"@ + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # Bulk remove access profiles from the specified source app + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2025AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2025AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfilesFromSourceAppByBulk" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#delete-source-app + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete source app by ID + + try { + Remove-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#get-source-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get source app by ID + + try { + Get-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-access-profiles-for-source-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "developer access profile"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List access profiles for the specified source app + + try { + Get-V2025AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfilesForSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-all-source-app + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "enabled eq true" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + # List all source apps + + try { + Get-V2025AllSourceApp -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AllSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-all-user-apps + source: | + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List all user apps + + try { + Get-V2025AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/assigned + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-assigned-source-app + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List assigned source apps + + try { + Get-V2025AssignedSourceApp -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AssignedSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AssignedSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id}/available-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-available-accounts-for-user-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List available accounts for user app + + try { + Get-V2025AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AvailableAccountsForUserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-available-source-apps + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List available source apps + + try { + Get-V2025AvailableSourceApps -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AvailableSourceApps" + Write-Host $_.ErrorDetails + } +- path: /user-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-owned-user-apps + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + # List owned user apps + + try { + Get-V2025OwnedUserApps -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025OwnedUserApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OwnedUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#patch-source-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch source app by ID + + try { + Update-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#patch-user-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch user app by ID + + try { + Update-V2025UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2025UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025UserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/apps#update-source-apps-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceAppBulkUpdateRequest = @" + { + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + } + "@ + + # Bulk update source apps + + try { + Update-V2025SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2025SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -SourceAppBulkUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceAppsInBulk" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#get-profile-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + + # Get Auth Profile + + try { + Get-V2025ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#get-profile-config-list + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get list of Auth Profiles + + try { + Get-V2025ProfileConfigList -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025ProfileConfigList -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProfileConfigList" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#patch-profile-config + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Auth Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/auth-users#get-auth-user + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + + # Auth User Details + + try { + Get-V2025AuthUser -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025AuthUser -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthUser" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/auth-users#patch-auth-user + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Auth User Update + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthUser -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthUser -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthUser" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/branding#create-branding-item + source: | + $Name = "MyName" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Create a branding item + + try { + New-V2025BrandingItem -Name $Name -ProductName $ProductName + + # Below is a request that includes all optional parameters + # New-V2025BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/branding#delete-branding + source: | + $Name = "default" # String | The name of the branding item to be deleted + + # Delete a branding item + + try { + Remove-V2025Branding -Name $Name + + # Below is a request that includes all optional parameters + # Remove-V2025Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/branding#get-branding + source: | + $Name = "default" # String | The name of the branding item to be retrieved + + # Get a branding item + + try { + Get-V2025Branding -Name $Name + + # Below is a request that includes all optional parameters + # Get-V2025Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/branding#get-branding-list + source: | + + # List of branding items + + try { + Get-V2025BrandingList + + # Below is a request that includes all optional parameters + # Get-V2025BrandingList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BrandingList" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/branding#set-branding-item + source: | + $Name = "default" # String | The name of the branding item to be retrieved + $Name2 = "Name_example" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Update a branding item + + try { + Set-V2025BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName + + # Below is a request that includes all optional parameters + # Set-V2025BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#create-campaign-filter + source: | + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Create Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + New-V2025CampaignFilter -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # New-V2025CampaignFilter -CampaignFilterDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#delete-campaign-filters + source: | + $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. + $RequestBody = @""@ + + + # Deletes Campaign Filters + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2025CampaignFilters -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2025CampaignFilters -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. + + # Get Campaign Filter by ID + + try { + Get-V2025CampaignFilterById -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025CampaignFilterById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignFilterById" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#list-campaign-filters + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) + + # List Campaign Filters + + try { + Get-V2025CampaignFilters + + # Below is a request that includes all optional parameters + # Get-V2025CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaign-filters#update-campaign-filter + source: | + $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Updates a Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + Update-V2025CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2025CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#complete-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CampaignCompleteOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-V2025Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Complete-V2025Campaign -Id $Id -CampaignCompleteOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#create-campaign + source: | + $Campaign = @" + { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + } + "@ + + # Create a campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-V2025Campaign -Campaign $Result + + # Below is a request that includes all optional parameters + # New-V2025Campaign -Campaign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#create-campaign-template + source: | + $CampaignTemplate = @" + { + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-V2025CampaignTemplate -CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-V2025CampaignTemplate -CampaignTemplate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#delete-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-V2025CampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#delete-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-V2025CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#delete-campaigns + source: | + $CampaignsDeleteRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest + Remove-V2025Campaigns -CampaignsDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2025Campaigns -CampaignsDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Campaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-active-campaigns + source: | + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + + # List Campaigns + + try { + Get-V2025ActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-V2025ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ActiveCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + # Get Campaign + + try { + Get-V2025Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025Campaign -Id $Id -Detail $Detail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-reports + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-V2025CampaignReports -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025CampaignReports -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignReports" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-reports-config + source: | + + # Get Campaign Reports Configuration + + try { + Get-V2025CampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-V2025CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-V2025CampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-V2025CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-templates + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-V2025CampaignTemplates + + # Below is a request that includes all optional parameters + # Get-V2025CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CampaignTemplates" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#move + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move-V2025 -Id $Id -AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move-V2025 -Id $Id -AdminReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2025" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#patch-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025CampaignTemplate -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025CampaignTemplate -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#set-campaign-reports-config + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-V2025CampaignReportsConfig -CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2025CampaignReportsConfig -CampaignReportsConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#set-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. + $Schedule = @" + { + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-V2025CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Set-V2025CampaignTemplateSchedule -Id $Id -Schedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-V2025Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025Campaign -Id $Id -ActivateCampaignOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-campaign-remediation-scan + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-V2025CampaignRemediationScan -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025CampaignRemediationScan -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025CampaignRemediationScan" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-report/{type} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-campaign-report + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. + + # Run Campaign Report + + try { + Start-V2025CampaignReport -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Start-V2025CampaignReport -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025CampaignReport" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#start-generate-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-V2025GenerateCampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025GenerateCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025GenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#update-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025Campaign -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025Campaign -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Campaign" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-certification-task + source: | + $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID + + # Certification Task by ID + + try { + Get-V2025CertificationTask -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025CertificationTask -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CertificationTask" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-identity-certification + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id + + # Identity Certification by ID + + try { + Get-V2025IdentityCertification -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025IdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-identity-certification-item-permissions + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Permissions for Entitlement Certification Item + + try { + Get-V2025IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-V2025IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certifications#get-pending-certification-tasks + source: | + $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) + + # List of Pending Certification Tasks + + try { + Get-V2025PendingCertificationTasks + + # Below is a request that includes all optional parameters + # Get-V2025PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingCertificationTasks" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certifications#list-certification-reviewers + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + + # List of Reviewers for certification + + try { + Get-V2025CertificationReviewers -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CertificationReviewers" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-review-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certifications#list-identity-access-review-items + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + $Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + # List of Access Review Items + + try { + Get-V2025IdentityAccessReviewItems -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessReviewItems" + Write-Host $_.ErrorDetails + } +- path: /certifications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certifications#list-identity-certifications + source: | + $ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) + + # List Identity Campaign Certifications + + try { + Get-V2025IdentityCertifications + + # Below is a request that includes all optional parameters + # Get-V2025IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decide + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certifications#make-identity-decision + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions + $ReviewDecision = @"{ + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + }"@ + + + # Decide on a Certification Item + + try { + $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision + Select-V2025IdentityDecision -Id $Id -ReviewDecision $Result + + # Below is a request that includes all optional parameters + # Select-V2025IdentityDecision -Id $Id -ReviewDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2025IdentityDecision" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certifications#reassign-identity-certifications + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Identities or Items + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Invoke-V2025ReassignIdentityCertifications -Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Invoke-V2025ReassignIdentityCertifications -Id $Id -ReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ReassignIdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/sign-off + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certifications#sign-off-identity-certification + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + + # Finalize Identity Certification Decisions + + try { + Invoke-V2025SignOffIdentityCertification -Id $Id + + # Below is a request that includes all optional parameters + # Invoke-V2025SignOffIdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025SignOffIdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certifications#submit-reassign-certs-async + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-V2025ReassignCertsAsync -Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-V2025ReassignCertsAsync -Id $Id -ReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025ReassignCertsAsync" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2025IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2025IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2025IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2025IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummary" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/deploys + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-deploy + source: | + $DeployRequest = @" + { + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + } + "@ + + # Create a Deploy + + try { + $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest + New-V2025Deploy -DeployRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025Deploy -DeployRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Deploy" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-object-mapping + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingRequest = @" + { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } + "@ + + # Creates an object mapping + + try { + $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest + New-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkCreateRequest = @" + { + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + } + "@ + + # Bulk creates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest + New-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/scheduled-actions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-scheduled-action + source: | + $ScheduledActionPayload = @" + { + "cronString" : "0 0 * * * *", + "timeZoneId" : "America/Chicago", + "startTime" : "2024-08-16T14:16:58.389Z", + "jobType" : "BACKUP", + "content" : { + "sourceTenant" : "tenant-name", + "draftId" : "9012b87d-48ca-439a-868f-2160001da8c3", + "name" : "Daily Backup", + "backupOptions" : { + "includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ], + "objectOptions" : { + "SOURCE" : { + "includedNames" : [ "Source1", "Source2" ] + }, + "ROLE" : { + "includedNames" : [ "Admin Role", "User Role" ] + } + } + }, + "sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2" + } + } + "@ + + # Create Scheduled Action + + try { + $Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload + New-V2025ScheduledAction -ScheduledActionPayload $Result + + # Below is a request that includes all optional parameters + # New-V2025ScheduledAction -ScheduledActionPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ScheduledAction" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#create-uploaded-configuration + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. + + # Upload a Configuration + + try { + New-V2025UploadedConfiguration -Data $Data -Name $Name + + # Below is a request that includes all optional parameters + # New-V2025UploadedConfiguration -Data $Data -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-backup + source: | + $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. + + # Delete a Backup + + try { + Remove-V2025Backup -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025Backup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Backup" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/drafts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-draft + source: | + $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to delete. + + # Delete a draft + + try { + Remove-V2025Draft -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025Draft -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Draft" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-object-mapping + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. + + # Deletes an object mapping + + try { + Remove-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + + # Below is a request that includes all optional parameters + # Remove-V2025ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/scheduled-actions/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-scheduled-action + source: | + $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. + + # Delete Scheduled Action + + try { + Remove-V2025ScheduledAction -ScheduledActionId $ScheduledActionId + + # Below is a request that includes all optional parameters + # Remove-V2025ScheduledAction -ScheduledActionId $ScheduledActionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ScheduledAction" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#delete-uploaded-configuration + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Delete an Uploaded Configuration + + try { + Remove-V2025UploadedConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/deploys/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#get-deploy + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. + + # Get a Deploy + + try { + Get-V2025Deploy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025Deploy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Deploy" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#get-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + + # Gets list of object mappings + + try { + Get-V2025ObjectMappings -SourceOrg $SourceOrg + + # Below is a request that includes all optional parameters + # Get-V2025ObjectMappings -SourceOrg $SourceOrg + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#get-uploaded-configuration + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Get an Uploaded Configuration + + try { + Get-V2025UploadedConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-backups + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + + # List Backups + + try { + Get-V2025Backups + + # Below is a request that includes all optional parameters + # Get-V2025Backups -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Backups" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/deploys + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-deploys + source: | + + # List Deploys + + try { + Get-V2025Deploys + + # Below is a request that includes all optional parameters + # Get-V2025Deploys + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Deploys" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/drafts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-drafts + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) + + # List Drafts + + try { + Get-V2025Drafts + + # Below is a request that includes all optional parameters + # Get-V2025Drafts -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Drafts" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/scheduled-actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-scheduled-actions + source: | + + # List Scheduled Actions + + try { + Get-V2025ScheduledActions + + # Below is a request that includes all optional parameters + # Get-V2025ScheduledActions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ScheduledActions" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-uploaded-configurations + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + + # List Uploaded Configurations + + try { + Get-V2025UploadedConfigurations + + # Below is a request that includes all optional parameters + # Get-V2025UploadedConfigurations -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UploadedConfigurations" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#update-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkPatchRequest = @" + { + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + } + "@ + + # Bulk updates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest + Update-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2025ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/scheduled-actions/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#update-scheduled-action + source: | + $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Update Scheduled Action + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ScheduledAction" + Write-Host $_.ErrorDetails + } +- path: /connector-customizers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#create-connector-customizer + source: | + $ConnectorCustomizerCreateRequest = @" + { + "name" : "My Custom Connector" + } + "@ + + # Create Connector Customizer + + try { + $Result = ConvertFrom-JsonToConnectorCustomizerCreateRequest -Json $ConnectorCustomizerCreateRequest + New-V2025ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ConnectorCustomizer" + Write-Host $_.ErrorDetails + } +- path: /connector-customizers/{id}/versions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#create-connector-customizer-version + source: | + $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | The id of the connector customizer. + + # Creates a connector customizer version + + try { + New-V2025ConnectorCustomizerVersion -Id $Id + + # Below is a request that includes all optional parameters + # New-V2025ConnectorCustomizerVersion -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ConnectorCustomizerVersion" + Write-Host $_.ErrorDetails + } +- path: /connector-customizers/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#delete-connector-customizer + source: | + $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete. + + # Delete Connector Customizer + + try { + Remove-V2025ConnectorCustomizer -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025ConnectorCustomizer -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ConnectorCustomizer" + Write-Host $_.ErrorDetails + } +- path: /connector-customizers/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#get-connector-customizer + source: | + $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to get. + + # Get connector customizer + + try { + Get-V2025ConnectorCustomizer -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ConnectorCustomizer -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorCustomizer" + Write-Host $_.ErrorDetails + } +- path: /connector-customizers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#list-connector-customizers + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # List All Connector Customizers + + try { + Get-V2025ConnectorCustomizers + + # Below is a request that includes all optional parameters + # Get-V2025ConnectorCustomizers -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorCustomizers" + Write-Host $_.ErrorDetails + } +- path: /connector-customizers/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connector-customizers#put-connector-customizer + source: | + $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to update. + $ConnectorCustomizerUpdateRequest = @" + { + "name" : "My Custom Connector" + } + "@ + + # Update Connector Customizer + + try { + Send-V2025ConnectorCustomizer -Id $Id + + # Below is a request that includes all optional parameters + # Send-V2025ConnectorCustomizer -Id $Id -ConnectorCustomizerUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorCustomizer" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#create-connector-rule + source: | + $ConnectorRuleCreateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + } + "@ + + # Create Connector Rule + + try { + $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest + New-V2025ConnectorRule -ConnectorRuleCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025ConnectorRule -ConnectorRuleCreateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#delete-connector-rule + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. + + # Delete Connector Rule + + try { + Remove-V2025ConnectorRule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025ConnectorRule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#get-connector-rule + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. + + # Get Connector Rule + + try { + Get-V2025ConnectorRule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ConnectorRule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#get-connector-rule-list + source: | + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Connector Rules + + try { + Get-V2025ConnectorRuleList + + # Below is a request that includes all optional parameters + # Get-V2025ConnectorRuleList -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorRuleList" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#put-connector-rule + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update. + $ConnectorRuleUpdateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + } + "@ + + # Update Connector Rule + + try { + Send-V2025ConnectorRule -Id $Id + + # Below is a request that includes all optional parameters + # Send-V2025ConnectorRule -Id $Id -ConnectorRuleUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/validate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connector-rule-management#test-connector-rule + source: | + $SourceCode = @" + { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } + "@ + + # Validate Connector Rule + + try { + $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode + Test-V2025ConnectorRule -SourceCode $Result + + # Below is a request that includes all optional parameters + # Test-V2025ConnectorRule -SourceCode $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#create-custom-connector + source: | + $V3CreateConnectorDto = @" + { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } + "@ + + # Create Custom Connector + + try { + $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto + New-V2025CustomConnector -V3CreateConnectorDto $Result + + # Below is a request that includes all optional parameters + # New-V2025CustomConnector -V3CreateConnectorDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#delete-custom-connector + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Delete Connector by Script Name + + try { + Remove-V2025CustomConnector -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Remove-V2025CustomConnector -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector by Script Name + + try { + Get-V2025Connector -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2025Connector -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Connector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-correlation-config + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + + # Get Connector Correlation Configuration + + try { + Get-V2025ConnectorCorrelationConfig -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2025ConnectorCorrelationConfig -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-list + source: | + $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector List + + try { + Get-V2025ConnectorList + + # Below is a request that includes all optional parameters + # Get-V2025ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorList" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-source-config + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Configuration + + try { + Get-V2025ConnectorSourceConfig -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2025ConnectorSourceConfig -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-source-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Template + + try { + Get-V2025ConnectorSourceTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2025ConnectorSourceTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#get-connector-translations + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Get Connector Translations + + try { + Get-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Get-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-correlation-config + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector correlation config xml file + + # Update Connector Correlation Configuration + + try { + Send-V2025ConnectorCorrelationConfig -ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-V2025ConnectorCorrelationConfig -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-source-config + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source config xml file + + # Update Connector Source Configuration + + try { + Send-V2025ConnectorSourceConfig -ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-V2025ConnectorSourceConfig -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-source-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source template xml file + + # Update Connector Source Template + + try { + Send-V2025ConnectorSourceTemplate -ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-V2025ConnectorSourceTemplate -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#put-connector-translations + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Update Connector Translations + + try { + Send-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Send-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/connectors#update-connector + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Connector by Script Name + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025Connector -ScriptName $ScriptName -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025Connector -ScriptName $ScriptName -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Connector" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition + source: | + $Body = @" + { + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + } + "@ + + # Creates a form definition. + + try { + New-V2025FormDefinition + + # Below is a request that includes all optional parameters + # New-V2025FormDefinition -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/forms-action-dynamic-schema + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition-dynamic-schema + source: | + $Body = @" + { + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + } + "@ + + # Generate JSON Schema dynamically. + + try { + New-V2025FormDefinitionDynamicSchema + + # Below is a request that includes all optional parameters + # New-V2025FormDefinitionDynamicSchema -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinitionDynamicSchema" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition-file-request + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID + $File = # System.IO.FileInfo | File specifying the multipart + + # Upload new form definition file. + + try { + New-V2025FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File + + # Below is a request that includes all optional parameters + # New-V2025FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinitionFileRequest" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-instance + source: | + $Body = @" + { + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + } + "@ + + # Creates a form instance. + + try { + New-V2025FormInstance + + # Below is a request that includes all optional parameters + # New-V2025FormInstance -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#delete-form-definition + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + + # Deletes a form definition. + + try { + Remove-V2025FormDefinition -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Remove-V2025FormDefinition -FormDefinitionID $FormDefinitionID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025FormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#export-form-definitions-by-tenant + source: | + $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # List form definitions by tenant. + + try { + Export-V2025FormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Export-V2025FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025FormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-file-from-s3 + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + + # Download definition file by fileId. + + try { + Get-V2025FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID + + # Below is a request that includes all optional parameters + # Get-V2025FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FileFromS3" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-definition-by-key + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + + # Return a form definition. + + try { + Get-V2025FormDefinitionByKey -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Get-V2025FormDefinitionByKey -FormDefinitionID $FormDefinitionID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormDefinitionByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-instance-by-key + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + + # Returns a form instance. + + try { + Get-V2025FormInstanceByKey -FormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Get-V2025FormInstanceByKey -FormInstanceID $FormInstanceID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormInstanceByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-instance-file + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + + # Download instance file by fileId. + + try { + Get-V2025FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID + + # Below is a request that includes all optional parameters + # Get-V2025FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormInstanceFile" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#import-form-definitions + source: | + + + + + $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ + + + # Import form definitions from export. + + try { + Import-V2025FormDefinitions + + # Below is a request that includes all optional parameters + # Import-V2025FormDefinitions -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025FormDefinitions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#patch-form-definition + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/description, value=test-description}]"@ + + + # Patch a form definition. + + try { + Update-V2025FormDefinition -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Update-V2025FormDefinition -FormDefinitionID $FormDefinitionID -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025FormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#patch-form-instance + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ + + + # Patch a form instance. + + try { + Update-V2025FormInstance -FormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Update-V2025FormInstance -FormInstanceID $FormInstanceID -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025FormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-definitions-by-tenant + source: | + $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # Export form definitions by tenant. + + try { + Search-V2025FormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Search-V2025FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-element-data-by-element-id + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $FormElementID = "1" # String | Form element ID + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + + # Retrieves dynamic data by element. + + try { + Search-V2025FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID + + # Below is a request that includes all optional parameters + # Search-V2025FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormElementDataByElementID" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-instances-by-tenant + source: | + + # List form instances by tenant. + + try { + Search-V2025FormInstancesByTenant + + # Below is a request that includes all optional parameters + # Search-V2025FormInstancesByTenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormInstancesByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/predefined-select-options + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-pre-defined-select-options + source: | + + # List predefined select options. + + try { + Search-V2025PreDefinedSelectOptions + + # Below is a request that includes all optional parameters + # Search-V2025PreDefinedSelectOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025PreDefinedSelectOptions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/data-source + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#show-preview-data-source + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + $FormElementPreviewRequest = @" + { + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + } + "@ + + # Preview form definition data source. + + try { + Show-V2025PreviewDataSource -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Show-V2025PreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2025PreviewDataSource" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#create-custom-password-instructions + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CustomPasswordInstruction = @" + { + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + } + "@ + + # Create Custom Password Instructions + + try { + $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction + New-V2025CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result + + # Below is a request that includes all optional parameters + # New-V2025CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#delete-custom-password-instructions + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Delete Custom Password Instructions by page ID + + try { + Remove-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#get-custom-password-instructions + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Get Custom Password Instructions by Page ID + + try { + Get-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /data-segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#create-data-segment + source: | + $DataSegment = @" + + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment + New-V2025DataSegment -DataSegment $Result + + # Below is a request that includes all optional parameters + # New-V2025DataSegment -DataSegment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DataSegment" + Write-Host $_.ErrorDetails + } +- path: /data-segments/{segmentId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#delete-data-segment + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false) + + # Delete Segment by ID + + try { + Remove-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -Published $Published + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025DataSegment" + Write-Host $_.ErrorDetails + } +- path: /data-segments/{segmentId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#get-data-segment + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Segment by ID + + try { + Get-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegment" + Write-Host $_.ErrorDetails + } +- path: /data-segments/membership/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#get-data-segment-identity-membership + source: | + $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get SegmentMembership by Identity ID + + try { + Get-V2025DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegmentIdentityMembership" + Write-Host $_.ErrorDetails + } +- path: /data-segments/user-enabled/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#get-data-segmentation-enabled-for-user + source: | + $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Is Segmentation enabled by Identity + + try { + Get-V2025DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegmentationEnabledForUser" + Write-Host $_.ErrorDetails + } +- path: /data-segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#list-data-segments + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Enabled = $true # Boolean | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to $true) + $Unique = $false # Boolean | This returns only one record if set to true and that would be the published record if exists. (optional) (default to $false) + $Published = $true # Boolean | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to $true) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq """ # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) + + # Get Segments + + try { + Get-V2025DataSegments -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025DataSegments -XSailPointExperimental $XSailPointExperimental -Enabled $Enabled -Unique $Unique -Published $Published -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegments" + Write-Host $_.ErrorDetails + } +- path: /data-segments/{segmentId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#patch-data-segment + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to modify. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled + $RequestBody = @"[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025DataSegment" + Write-Host $_.ErrorDetails + } +- path: /data-segments/{segmentId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/data-segmentation#publish-data-segment + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish to publish + $RequestBody = @""@ + + $PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true) + + # Publish segment by ID + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Publish-V2025DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Publish-V2025DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -PublishAll $PublishAll + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2025DataSegment" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/dimensions#create-dimension + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $Dimension = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + } + "@ + + # Create a Dimension + + try { + $Result = ConvertFrom-JsonToDimension -Json $Dimension + New-V2025Dimension -RoleId $RoleId -Dimension $Result + + # Below is a request that includes all optional parameters + # New-V2025Dimension -RoleId $RoleId -Dimension $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Dimension" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/dimensions#delete-bulk-dimensions + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimensions. + $DimensionBulkDeleteRequest = @" + { + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Dimension(s) + + try { + $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest + Remove-V2025BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2025BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025BulkDimensions" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/dimensions#delete-dimension + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + + # Delete a Dimension + + try { + Remove-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Remove-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Dimension" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/dimensions#get-dimension + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + + # Get a Dimension under Role. + + try { + Get-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Dimension" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/dimensions#get-dimension-entitlements + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Dimension's Entitlements + + try { + Get-V2025DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2025DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DimensionEntitlements" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/dimensions#list-dimension-access-profiles + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "source.id eq "2c91808982f979270182f99e386d00fa"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Dimension's Access Profiles + + try { + Get-V2025DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2025DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DimensionAccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/dimensions#list-dimensions + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq '2c918086749d78830174a1a40e121518'" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Dimensions + + try { + Get-V2025Dimensions -RoleId $RoleId + + # Below is a request that includes all optional parameters + # Get-V2025Dimensions -RoleId $RoleId -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Dimensions" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/dimensions#patch-dimension + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Dimension + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Dimension" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Add metadata to an entitlement. + + try { + New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessModelMetadataForEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove metadata from an entitlement. + + try { + Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessModelMetadataFromEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get an entitlement + + try { + Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement-request-config + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Entitlement Request Config + + try { + Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/aggregate/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#import-entitlements-by-source + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Aggregate Entitlements + + try { + Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsBySource" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/children + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-children + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements children + + try { + Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChildren" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/parents + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-parents + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements parents + + try { + Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementParents" + Write-Host $_.ErrorDetails + } +- path: /entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlements + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) + $SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + $IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + # Gets a list of entitlements. + + try { + Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#patch-entitlement + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an entitlement + + try { + Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Entitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#put-entitlement-request-config + source: | + $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EntitlementRequestConfig = @" + { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + } + "@ + + # Replace Entitlement Request Config + + try { + $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig + Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025EntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/reset/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#reset-source-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Reset Source Entitlements + + try { + Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025SourceEntitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#update-entitlements-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EntitlementBulkUpdateRequest = @" + { + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + } + "@ + + # Bulk update an entitlement list + + try { + $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest + Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsInBulk" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + $NetworkConfiguration = @" + { + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + } + "@ + + # Create security network configuration. + + try { + $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration + New-V2025AuthOrgNetworkConfig -NetworkConfiguration $Result + + # Below is a request that includes all optional parameters + # New-V2025AuthOrgNetworkConfig -NetworkConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + + # Get Auth Org Lockout Configuration. + + try { + Get-V2025AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgLockoutConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + + # Get security network configuration. + + try { + Get-V2025AuthOrgNetworkConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgNetworkConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + + # Get Service Provider Configuration. + + try { + Get-V2025AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgServiceProviderConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + + # Get Auth Org Session Configuration. + + try { + Get-V2025AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgSessionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Lockout Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgLockoutConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgLockoutConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update security network configuration. + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgNetworkConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgNetworkConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Service Provider Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgServiceProviderConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgServiceProviderConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Session Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgSessionConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgSessionConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#create-workgroup + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $WorkgroupDto = @" + { + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Create a new Governance Group. + + try { + $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto + New-V2025Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result + + # Below is a request that includes all optional parameters + # New-V2025Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroup + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a Governance Group + + try { + Remove-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroup-members + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityPreviewResponseIdentity = @""@ + + + # Remove members from Governance Group + + try { + $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity + Remove-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + + # Below is a request that includes all optional parameters + # Remove-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025WorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroups-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $WorkgroupBulkDeleteRequest = @" + { + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + } + "@ + + # Delete Governance Group(s) + + try { + $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest + Remove-V2025WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2025WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025WorkgroupsInBulk" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#get-workgroup + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Governance Group by Id + + try { + Get-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-connections + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List connections for Governance Group + + try { + Get-V2025Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Connections" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-workgroup-members + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Governance Group Members + + try { + Get-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-workgroups + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "Test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) + + # List Governance Groups + + try { + Get-V2025Workgroups -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025Workgroups -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workgroups" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#patch-workgroup + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Governance Group + + try { + Update-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#update-workgroup-members + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityPreviewResponseIdentity = @""@ + + + # Add members to Governance Group + + try { + $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity + Update-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + + # Below is a request that includes all optional parameters + # Update-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025WorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Ignore Access Request Recommendation + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2025AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2025AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsIgnoredItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Accept Access Request Recommendation + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2025AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2025AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsRequestedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Mark Viewed Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2025AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2025AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsViewedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }"@ + + + # Bulk Mark Viewed Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + $Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) + $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + # Identity Access Request Recommendations + + try { + Get-V2025AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendations" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Access Request Recommendations config + + try { + Get-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List Ignored Access Request Recommendations + + try { + Get-V2025AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsIgnoredItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List Accepted Access Request Recommendations + + try { + Get-V2025AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsRequestedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List Viewed Access Request Recommendations + + try { + Get-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#set-access-request-recommendations-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationConfigDto = @" + { + "scoreThreshold" : 0.5, + "startDateAttribute" : "startDate", + "restrictionAttribute" : "location", + "moverAttribute" : "isMover", + "joinerAttribute" : "isJoiner", + "useRestrictionAttribute" : true + } + "@ + + # Update Access Request Recommendations config + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto + Set-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Set-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025AccessRequestRecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#create-common-access + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CommonAccessItemRequest = @" + { + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + } + "@ + + # Create common access items + + try { + $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest + New-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#get-common-access + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.type eq "ROLE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + # Get a paginated list of common access + + try { + Get-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access/update-status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#update-common-access-status-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CommonAccessIDStatus = @"{ + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + }"@ + + + # Bulk update common access status + + try { + $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus + Update-V2025CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result + + # Below is a request that includes all optional parameters + # Update-V2025CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CommonAccessStatusInBulk" + Write-Host $_.ErrorDetails + } +- path: /outliers/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#export-outliers-zip + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Export + + try { + Export-V2025OutliersZip -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2025OutliersZip -XSailPointExperimental $XSailPointExperimental -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025OutliersZip" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-identity-outlier-snapshots + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) + $Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) + + # IAI Identity Outliers Summary + + try { + Get-V2025IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-identity-outliers + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) + + # IAI Get Identity Outliers + + try { + Get-V2025IdentityOutliers -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025IdentityOutliers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries/latest + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Latest Summary + + try { + Get-V2025LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LatestIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outlier-feature-summaries/{outlierFeatureId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get identity outlier contibuting feature summary + + try { + Get-V2025OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OutlierContributingFeatureSummary" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/contributing-features + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) + $Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) + + # Get identity outlier's contibuting features + + try { + Get-V2025PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PeerGroupOutliersContributingFeatures" + Write-Host $_.ErrorDetails + } +- path: /outliers/ignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#ignore-identity-outliers + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Ignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-V2025IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-V2025IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025IgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + $Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) + + # Gets a list of access items associated with each identity outlier contributing feature + + try { + Get-V2025OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OutliersContributingFeatureAccessItems" + Write-Host $_.ErrorDetails + } +- path: /outliers/unignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#un-ignore-identity-outliers + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Unignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-V2025UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-V2025UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025UnIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /peer-group-strategies/{strategy}/identity-outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Identity Outliers List + + try { + Get-V2025PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PeerGroupOutliers" + Write-Host $_.ErrorDetails + } +- path: /recommendations/request + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#get-recommendations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RecommendationRequestDto = @" + { + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + } + "@ + + # Returns Recommendation Based on Object + + try { + $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto + Get-V2025Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result + + # Below is a request that includes all optional parameters + # Get-V2025Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Recommendations" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#get-recommendations-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get certification recommendation config values + + try { + Get-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#update-recommendations-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RecommendationConfigDto = @" + { + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + } + "@ + + # Update certification recommendation config values + + try { + $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto + Update-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Update-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#create-potential-role-provision-request + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) + $RoleMiningPotentialRoleProvisionRequest = @" + { + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + } + "@ + + # Create request to provision a potential role into an actual role. + + try { + New-V2025PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2025PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PotentialRoleProvisionRequest" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#create-role-mining-sessions + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningSessionDto = @" + { + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + } + "@ + + # Create a role mining session + + try { + $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto + New-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result + + # Below is a request that includes all optional parameters + # New-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025RoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Export (download) details for a potential role in a role mining session + + try { + Invoke-V2025DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Invoke-V2025DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025DownloadRoleMiningPotentialRoleZip" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Export (download) details for a potential role in a role mining session + + try { + Export-V2025RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2025RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningPotentialRoleExportRequest = @" + { + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + } + "@ + + # Asynchronously export details for a potential role in a role mining session and upload to S3 + + try { + Export-V2025RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2025RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleExportRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRoleAsync" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieve status of a potential role export job + + try { + Export-V2025RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2025RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRoleStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-all-potential-role-summaries + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all potential role summaries + + try { + Get-V2025AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) + + # Retrieves entitlement popularity distribution for a potential role in a role mining session + + try { + Get-V2025EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementDistributionPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-entitlements-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) + $Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves entitlements for a potential role in a role mining session + + try { + Get-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves excluded entitlements for a potential role in a role mining session + + try { + Get-V2025ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ExcludedEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-identities-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves identities for a potential role in a role mining session + + try { + Get-V2025IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitiesPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieves a specific potential role + + try { + Get-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-applications + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the applications of a potential role for a role mining session + + try { + Get-V2025PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleApplications" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-entitlements + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the entitlements of a potential role for a role mining session + + try { + Get-V2025PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id + $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves potential role source usage + + try { + Get-V2025PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleSourceIdentityUsage" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-summaries + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) + $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all potential role summaries + + try { + Get-V2025PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-potential-role + source: | + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieves a specific potential role + + try { + Get-V2025RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-session + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a role mining session + + try { + Get-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-session-status + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get role mining session status state + + try { + Get-V2025RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSessionStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-sessions + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) + $Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all role mining sessions + + try { + Get-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/saved + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-saved-potential-roles + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all saved potential roles + + try { + Get-V2025SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedPotentialRoles" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-potential-role-0 + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-V2025PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2025PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PotentialRole0" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-role-mining-session + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a role mining session + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#update-entitlements-potential-role + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningPotentialRoleEditEntitlements = @" + { + "ids" : [ "entId1", "entId2" ], + "exclude" : true + } + "@ + + # Edit entitlements for a potential role to exclude some entitlements + + try { + $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements + Update-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result + + # Below is a request that includes all optional parameters + # Update-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/icons#delete-icon + source: | + $ObjectType = "application" # String | Object type. Available options ['application'] + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete an icon + + try { + Remove-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Icon" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/icons#set-icon + source: | + $ObjectType = "application" # String | Object type. Available options ['application'] + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + # Update an icon + + try { + Set-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image + + # Below is a request that includes all optional parameters + # Set-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025Icon" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identities#delete-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete identity + + try { + Remove-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Identity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identities#get-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Identity Details + + try { + Get-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Identity" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/ownership + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identities#get-identity-ownership-details + source: | + $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get ownership details + + try { + Get-V2025IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOwnershipDetails" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identities#get-role-assignment + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Role assignment details + + try { + Get-V2025RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignment" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identities#get-role-assignments + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) + $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) + + # List role assignments + + try { + Get-V2025RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -RoleId $RoleId -RoleName $RoleName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignments" + Write-Host $_.ErrorDetails + } +- path: /identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identities#list-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) + $Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) + $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Identities + + try { + Get-V2025Identities -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025Identities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Identities" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/reset + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identities#reset-identity + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Reset an identity + + try { + Reset-V2025Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Reset-V2025Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025Identity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/verification/account/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identities#send-identity-verification-account-token + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $SendAccountVerificationRequest = @" + { + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + } + "@ + + # Send password reset email + + try { + $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest + Send-V2025IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2025IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025IdentityVerificationAccountToken" + Write-Host $_.ErrorDetails + } +- path: /identities/invite + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identities#start-identities-invite + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $InviteIdentitiesRequest = @" + { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } + "@ + + # Invite identities to register + + try { + $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest + Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentitiesInvite" + Write-Host $_.ErrorDetails + } +- path: /identities/process + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identities#start-identity-processing + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ProcessIdentitiesRequest = @" + { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } + "@ + + # Process a list of identityIds + + try { + $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest + Start-V2025IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-V2025IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentityProcessing" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identities#synchronize-attributes-for-identity + source: | + $IdentityId = "MyIdentityId" # String | The Identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Attribute synchronization for single identity. + + try { + Sync-V2025hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Sync-V2025hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025hronizeAttributesForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#create-identity-attribute + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Create Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + New-V2025IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # New-V2025IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#delete-identity-attribute + source: | + $Name = "displayName" # String | The attribute's technical name. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Identity Attribute + + try { + Remove-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/bulk-delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttributeNames = @" + { + "ids" : [ "name", "displayName" ] + } + "@ + + # Bulk delete Identity Attributes + + try { + $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames + Remove-V2025IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result + + # Below is a request that includes all optional parameters + # Remove-V2025IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityAttributesInBulk" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#get-identity-attribute + source: | + $Name = "displayName" # String | The attribute's technical name. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Identity Attribute + + try { + Get-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#list-identity-attributes + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) + $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) + $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Identity Attributes + + try { + Get-V2025IdentityAttributes -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025IdentityAttributes -XSailPointExperimental $XSailPointExperimental -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAttributes" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#put-identity-attribute + source: | + $Name = "displayName" # String | The attribute's technical name. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Update Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + Send-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # Send-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#compare-identity-snapshots + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a difference of count for each access item types for the given identity between 2 snapshots + + try { + Compare-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Compare-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2025IdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare/{access-type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#compare-identity-snapshots-access-type + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $AccessType = "accessProfile" # String | The specific type which needs to be compared + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + $Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a list of differences of specific accessType for the given identity between 2 snapshots + + try { + Compare-V2025IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Compare-V2025IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2025IdentitySnapshotsAccessType" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-historical-identity + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get latest snapshot of identity + + try { + Get-V2025HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentity" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/events + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-historical-identity-events + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) + $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) + + $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + $AccessItemTypes = @"[entitlement, account]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all events for the given identity + + try { + Get-V2025HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentityEvents" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-snapshot + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Gets an identity snapshot at a given date + + try { + Get-V2025IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshot" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshot-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-snapshot-summary + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) + $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) + $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets the summary for the event count for a specific identity + + try { + Get-V2025IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshotSummary" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/start-date + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-start-date + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Gets the start date of the identity + + try { + Get-V2025IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityStartDate" + Write-Host $_.ErrorDetails + } +- path: /historical-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-historical-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) + $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) + $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # Lists all the identities + + try { + Get-V2025HistoricalIdentities -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025HistoricalIdentities -XSailPointExperimental $XSailPointExperimental -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentities" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-access-items + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Access Items by Identity + + try { + Get-V2025IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental -Type $Type -Limit $Limit -Count $Count -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-snapshot-access-items + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "account" # String | The access item type (optional) + + # Gets the list of identity access items at a given date filterd by item type + + try { + Get-V2025IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshotAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-snapshots + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) + $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all the snapshots for the identity + + try { + Get-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#create-identity-profile + source: | + $IdentityProfile = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + "@ + + # Create Identity Profile + + try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-V2025IdentityProfile -IdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-V2025IdentityProfile -IdentityProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#delete-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + + # Delete Identity Profile + + try { + Remove-V2025IdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-V2025IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#delete-identity-profiles + source: | + $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ + + + # Delete Identity Profiles + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2025IdentityProfiles -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2025IdentityProfiles -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#export-identity-profiles + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + + # Export Identity Profiles + + try { + Export-V2025IdentityProfiles + + # Below is a request that includes all optional parameters + # Export-V2025IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#generate-identity-preview + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityPreviewRequest = @" + { + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + } + "@ + + # Generate Identity Profile Preview + + try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityPreview" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#get-default-identity-attribute-config + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + + # Get default Identity Attribute Config + + try { + Get-V2025DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2025DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#get-identity-profile + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + + # Get Identity Profile + + try { + Get-V2025IdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2025IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#import-identity-profiles + source: | + + + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + }"@ + + + # Import Identity Profiles + + try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-V2025IdentityProfiles -IdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-V2025IdentityProfiles -IdentityProfileExportedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#list-identity-profiles + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + # List Identity Profiles + + try { + Get-V2025IdentityProfiles + + # Below is a request that includes all optional parameters + # Get-V2025IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#sync-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + + # Process identities under profile + + try { + Sync-V2025IdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-V2025IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#update-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Identity Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#create-lifecycle-state + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleState = @" + { + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + } + "@ + + # Create Lifecycle State + + try { + $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState + New-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result + + # Below is a request that includes all optional parameters + # New-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#delete-lifecycle-state + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Delete Lifecycle State + + try { + Remove-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Remove-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#get-lifecycle-state + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Get Lifecycle State + + try { + Get-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#get-lifecycle-states + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Lists LifecycleStates + + try { + Get-V2025LifecycleStates -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2025LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /identities/{identity-id}/set-lifecycle-state + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#set-lifecycle-state + source: | + $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. + $SetLifecycleStateRequest = @" + + "@ + + # Set Lifecycle State + + try { + $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest + Set-V2025LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2025LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/lifecycle-states#update-lifecycle-states + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Lifecycle State + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /machine-accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#get-machine-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Machine Account Details + + try { + Get-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccount" + Write-Host $_.ErrorDetails + } +- path: /machine-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#list-machine-accounts + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) + + # Machine Accounts List + + try { + Get-V2025MachineAccounts -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccounts" + Write-Host $_.ErrorDetails + } +- path: /machine-accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#update-machine-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + $RequestBody = @"[{op=add, path=/environment, value=test}]"@ + + + # Update a Machine Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MachineAccount" + Write-Host $_.ErrorDetails + } +- path: /machine-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#create-machine-identity + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MachineIdentity = @" + { + "created" : "2015-05-28T14:07:17Z", + "businessApplication" : "ADService", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "", + "attributes" : "{\"Region\":\"EU\"}", + "id" : "id12345", + "manuallyEdited" : true + } + "@ + + # Create Machine Identities + + try { + $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity + New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result + + # Below is a request that includes all optional parameters + # New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025MachineIdentity" + Write-Host $_.ErrorDetails + } +- path: /machine-identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#delete-machine-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete machine identity + + try { + Remove-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MachineIdentity" + Write-Host $_.ErrorDetails + } +- path: /machine-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#get-machine-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Machine Identity Details + + try { + Get-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineIdentity" + Write-Host $_.ErrorDetails + } +- path: /machine-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#list-machine-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) + $Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Machine Identities + + try { + Get-V2025MachineIdentities -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025MachineIdentities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineIdentities" + Write-Host $_.ErrorDetails + } +- path: /machine-identities/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#update-machine-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ + + + # Update a Machine Identity + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MachineIdentity" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#create-managed-client + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-V2025ManagedClient -ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025ManagedClient -ManagedClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#delete-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-V2025ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-V2025ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-V2025ManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#get-managed-clients + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-V2025ManagedClients + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clients#update-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025ManagedClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025ManagedClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#create-managed-cluster + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-V2025ManagedCluster -ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025ManagedCluster -ManagedClusterRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#delete-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-V2025ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-V2025ClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#get-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-V2025ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-V2025ManagedClusters + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-V2025ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2025ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/manualUpgrade + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#update + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. + + # Trigger Manual Upgrade for Managed Cluster + + try { + Update-V2025 -Id $Id + + # Below is a request that includes all optional parameters + # Update-V2025 -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-clusters#update-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025ManagedCluster -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025ManagedCluster -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#create-managed-cluster-type + source: | + $ManagedClusterType = @" + { + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + } + "@ + + # Create new Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType + New-V2025ManagedClusterType -ManagedClusterType $Result + + # Below is a request that includes all optional parameters + # New-V2025ManagedClusterType -ManagedClusterType $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#delete-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Delete a Managed Cluster Type + + try { + Remove-V2025ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Get a Managed Cluster Type + + try { + Get-V2025ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-types + source: | + $Type = "IDN" # String | Type descriptor (optional) + $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) + $Org = "denali-xyz" # String | Pinned org (or default) (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # List Managed Cluster Types + + try { + Get-V2025ManagedClusterTypes + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterTypes" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#update-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Update a Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-V2025MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-kba-config + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-V2025MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-V2025MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-duo-config + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2025MFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfakba-config + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-okta-config + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2025MFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#test-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-V2025MFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-V2025MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025MFAConfig" + Write-Host $_.ErrorDetails + } +- path: /multihosts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#create-multi-host-integration + source: | + $MultiHostIntegrationsCreate = @" + { + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + } + "@ + + # Create Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate + New-V2025MultiHostIntegration -MultiHostIntegrationsCreate $Result + + # Below is a request that includes all optional parameters + # New-V2025MultiHostIntegration -MultiHostIntegrationsCreate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025MultiHostIntegration" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#create-sources-within-multi-host + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + $MultiHostIntegrationsCreateSources = @"{ + "connectorAttributes" : { + "authType" : "SQLAuthentication", + "url" : "jdbc:sqlserver://178.18.41.118:1433", + "user" : "username", + "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "name" : "My Source", + "description" : "This is the corporate directory." + }"@ + + + # Create Sources Within Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources + New-V2025SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result + + # Below is a request that includes all optional parameters + # New-V2025SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourcesWithinMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#delete-multi-host + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. + + # Delete Multi-Host Integration + + try { + Remove-V2025MultiHost -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Remove-V2025MultiHost -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/acctAggregationGroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-acct-aggregation-groups + source: | + $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # List Account-Aggregation-Groups by Multi-Host ID + + try { + Get-V2025AcctAggregationGroups -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Get-V2025AcctAggregationGroups -MultihostId $MultihostId -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AcctAggregationGroups" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multiHostId}/entitlementAggregationGroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-entitlement-aggregation-groups + source: | + $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # List Entitlement-Aggregation-Groups by Integration ID + + try { + Get-V2025EntitlementAggregationGroups -MultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementAggregationGroups -MultiHostId $MultiHostId -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementAggregationGroups" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multi-host-integrations + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + + # Get Multi-Host Integration By ID + + try { + Get-V2025MultiHostIntegrations -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Get-V2025MultiHostIntegrations -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultiHostIntegrations" + Write-Host $_.ErrorDetails + } +- path: /multihosts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multi-host-integrations-list + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + + # List All Existing Multi-Host Integrations + + try { + Get-V2025MultiHostIntegrationsList + + # Below is a request that includes all optional parameters + # Get-V2025MultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultiHostIntegrationsList" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multiHostId}/sources/errors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multi-host-source-creation-errors + source: | + $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration + + # List Multi-Host Source Creation Errors + + try { + Get-V2025MultiHostSourceCreationErrors -MultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-V2025MultiHostSourceCreationErrors -MultiHostId $MultiHostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultiHostSourceCreationErrors" + Write-Host $_.ErrorDetails + } +- path: /multihosts/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multihost-integration-types + source: | + + # List Multi-Host Integration Types + + try { + Get-V2025MultihostIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-V2025MultihostIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MultihostIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-sources-within-multi-host + source: | + $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Sources Within Multi-Host Integration + + try { + Get-V2025SourcesWithinMultiHost -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Get-V2025SourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourcesWithinMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/sources/testConnection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#test-connection-multi-host-sources + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration + + # Test Configuration For Multi-Host Integration + + try { + Test-V2025ConnectionMultiHostSources -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Test-V2025ConnectionMultiHostSources -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ConnectionMultiHostSources" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#test-source-connection-multihost + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration + $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration + + # Test Configuration For Multi-Host Integration's Single Source + + try { + Test-V2025SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-V2025SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConnectionMultihost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#update-multi-host-sources + source: | + $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. + $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ + + + # Update Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner + Update-V2025MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2025MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MultiHostSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "Approved by manager" + } + "@ + + # Approve a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-V2025NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-V2025NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2025NonEmployeeRecord -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2025NonEmployeeRecord -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2025NonEmployeeRequest -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2025NonEmployeeRequest -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + $NonEmployeeSourceRequestBody = @" + { + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + } + "@ + + # Create Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-V2025NonEmployeeSource -NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2025NonEmployeeSource -NonEmployeeSourceRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $NonEmployeeSchemaAttributeBody = @" + { + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + } + "@ + + # Create a new Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Delete Non-Employee Record + + try { + Remove-V2025NonEmployeeRecord -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025NonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk + source: | + $DeleteNonEmployeeRecordsInBulkRequest = @" + + "@ + + # Delete Multiple Non-Employee Records + + try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest + Remove-V2025NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2025NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format + + # Delete Non-Employee Request + + try { + Remove-V2025NonEmployeeRequest -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025NonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete a Schema Attribute for Non-Employee Source + + try { + Remove-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + + # Delete Non-Employee Source + + try { + Remove-V2025NonEmployeeSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2025NonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete all custom schema attributes for Non-Employee Source + + try { + Remove-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + + # Exports Non-Employee Records to CSV + + try { + Export-V2025NonEmployeeRecords -Id $Id + + # Below is a request that includes all optional parameters + # Export-V2025NonEmployeeRecords -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) + + # Exports Source Schema Template + + try { + Export-V2025NonEmployeeSourceSchemaTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Export-V2025NonEmployeeSourceSchemaTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025NonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + # Get a non-employee approval item detail + + try { + Get-V2025NonEmployeeApproval -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Approval Requests + + try { + Get-V2025NonEmployeeApprovalSummary -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeApprovalSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) + + # Obtain the status of bulk upload on the source + + try { + Get-V2025NonEmployeeBulkUploadStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeBulkUploadStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Get a Non-Employee Record + + try { + Get-V2025NonEmployeeRecord -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) + + # Get a Non-Employee Request + + try { + Get-V2025NonEmployeeRequest -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Requests + + try { + Get-V2025NonEmployeeRequestSummary -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeRequestSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRequestSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Get Schema Attribute Non-Employee Source + + try { + Get-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + + # Get a Non-Employee Source + + try { + Get-V2025NonEmployeeSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # List Schema Attributes Non-Employee Source + + try { + Get-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + $Data = # System.IO.FileInfo | + + # Imports, or Updates, Non-Employee Records + + try { + Import-V2025NonEmployeeRecordsInBulk -Id $Id -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2025NonEmployeeRecordsInBulk -Id $Id -Data $Data + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-approvals + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Get List of Non-Employee Approval Requests + + try { + Get-V2025NonEmployeeApprovals + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeApprovals" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-records + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Records + + try { + Get-V2025NonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Requests + + try { + Get-V2025NonEmployeeRequests -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeRequests" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#list-non-employee-sources + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) + $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) + $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + + # List Non-Employee Sources + + try { + Get-V2025NonEmployeeSources + + # Below is a request that includes all optional parameters + # Get-V2025NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NonEmployeeSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Record + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025NonEmployeeRecord -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025NonEmployeeRecord -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeRejectApprovalDecision = @" + { + "comment" : "approved" + } + "@ + + # Reject a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-V2025NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-V2025NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Update Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-V2025NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2025NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-domain-dkim + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $DomainAddress = @" + { + "domain" : "sailpoint.com" + } + "@ + + # Verify domain address via DKIM + + try { + $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress + New-V2025DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result + + # Below is a request that includes all optional parameters + # New-V2025DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DomainDkim" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-notification-template + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TemplateDto = @" + { + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Create Notification Template + + try { + $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto + New-V2025NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result + + # Below is a request that includes all optional parameters + # New-V2025NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-verified-from-address + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EmailStatusDto = @" + { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } + "@ + + # Create Verified From Address + + try { + $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto + New-V2025VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result + + # Below is a request that includes all optional parameters + # New-V2025VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025VerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#delete-notification-templates-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TemplateBulkDeleteDto = @"{ + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + }"@ + + + # Bulk Delete Notification Templates + + try { + $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto + Remove-V2025NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result + + # Below is a request that includes all optional parameters + # Remove-V2025NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NotificationTemplatesInBulk" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#delete-verified-from-address + source: | + $Id = "MyId" # String | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Verified From Address + + try { + Remove-V2025VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025VerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-dkim-attributes + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get DKIM Attributes + + try { + Get-V2025DkimAttributes -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025DkimAttributes -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DkimAttributes" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes/{identity} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-mail-from-attributes + source: | + $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get MAIL FROM Attributes + + try { + Get-V2025MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-notification-template + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Notification Template By Id + + try { + Get-V2025NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /notification-template-context + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-notifications-template-context + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Notification Template Context + + try { + Get-V2025NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationsTemplateContext" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-from-addresses + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "email eq "john.doe@company.com"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) + $Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) + + # List From Addresses + + try { + Get-V2025FromAddresses -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025FromAddresses -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FromAddresses" + Write-Host $_.ErrorDetails + } +- path: /notification-preferences/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-preferences + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Notification Preferences for tenant. + + try { + Get-V2025NotificationPreferences -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025NotificationPreferences -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationPreferences" + Write-Host $_.ErrorDetails + } +- path: /notification-template-defaults + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-template-defaults + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "key eq "cloud_manual_work_item_summary"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Template Defaults + + try { + Get-V2025NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplateDefaults" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-templates + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "medium eq "EMAIL"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Templates + + try { + Get-V2025NotificationTemplates -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplates" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#put-mail-from-attributes + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MailFromAttributesDto = @" + { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } + "@ + + # Change MAIL FROM domain + + try { + $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto + Send-V2025MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result + + # Below is a request that includes all optional parameters + # Send-V2025MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025MailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /send-test-notification + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/notifications#send-test-notification + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SendTestNotificationRequestDto = @" + { + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Send Test Notification + + try { + $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto + Send-V2025TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result + + # Below is a request that includes all optional parameters + # Send-V2025TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TestNotification" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#create-oauth-client + source: | + $CreateOAuthClientRequest = @" + { + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + } + "@ + + # Create OAuth Client + + try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-V2025OauthClient -CreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025OauthClient -CreateOAuthClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#delete-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Delete OAuth Client + + try { + Remove-V2025OauthClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025OauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#get-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Get OAuth Client + + try { + Get-V2025OauthClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025OauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#list-oauth-clients + source: | + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List OAuth Clients + + try { + Get-V2025OauthClients + + # Below is a request that includes all optional parameters + # Get-V2025OauthClients -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OauthClients" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/o-auth-clients#patch-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch OAuth Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025OauthClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025OauthClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025OauthClient" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/org-config#get-org-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Org Config Settings + + try { + Get-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OrgConfig" + Write-Host $_.ErrorDetails + } +- path: /org-config/valid-time-zones + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/org-config#get-valid-time-zones + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Valid Time Zones + + try { + Get-V2025ValidTimeZones -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ValidTimeZones" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/org-config#patch-org-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Org Config + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025OrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#create-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-V2025PasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-V2025PasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#get-password-org-config + source: | + + # Get Password Org Config + + try { + Get-V2025PasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-V2025PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#put-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-V2025PasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2025PasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-dictionary#get-password-dictionary + source: | + + # Get Password Dictionary + + try { + Get-V2025PasswordDictionary + + # Below is a request that includes all optional parameters + # Get-V2025PasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-dictionary#put-password-dictionary + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-V2025PasswordDictionary + + # Below is a request that includes all optional parameters + # Send-V2025PasswordDictionary -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /generate-password-reset-token/digit + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-management#create-digit-token + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PasswordDigitTokenReset = @" + { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } + "@ + + # Generate a digit token + + try { + $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset + New-V2025DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result + + # Below is a request that includes all optional parameters + # New-V2025DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DigitToken" + Write-Host $_.ErrorDetails + } +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-management#get-password-change-status + source: | + $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID + + # Get Password Change Request Status + + try { + Get-V2025PasswordChangeStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025PasswordChangeStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordChangeStatus" + Write-Host $_.ErrorDetails + } +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-management#query-password-info + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-V2025PasswordInfo -PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-V2025PasswordInfo -PasswordInfoQueryDTO $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025PasswordInfo" + Write-Host $_.ErrorDetails + } +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-management#set-password + source: | + $PasswordChangeRequest = @" + { + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-V2025Password -PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2025Password -PasswordChangeRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025Password" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-policies#create-password-policy + source: | + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Create Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-policies#delete-password-policy + source: | + $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + + # Delete Password Policy by ID + + try { + Remove-V2025PasswordPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025PasswordPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-policies#get-password-policy-by-id + source: | + $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + + # Get Password Policy by ID + + try { + Get-V2025PasswordPolicyById -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025PasswordPolicyById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicyById" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-policies#list-password-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Password Policies + + try { + Get-V2025PasswordPolicies + + # Below is a request that includes all optional parameters + # Get-V2025PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicies" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-policies#set-password-policy + source: | + $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Update Password Policy by ID + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#create-password-sync-group + source: | + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Create Password Sync Group + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-V2025PasswordSyncGroup -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-V2025PasswordSyncGroup -PasswordSyncGroup $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#delete-password-sync-group + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + + # Delete Password Sync Group by ID + + try { + Remove-V2025PasswordSyncGroup -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025PasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#get-password-sync-group + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + + # Get Password Sync Group by ID + + try { + Get-V2025PasswordSyncGroup -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025PasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#get-password-sync-groups + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Password Sync Group List + + try { + Get-V2025PasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-V2025PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordSyncGroups" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/password-sync-groups#update-password-sync-group + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Update Password Sync Group by ID + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-V2025PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-V2025PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#create-personal-access-token + source: | + $CreatePersonalAccessTokenRequest = @" + { + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + } + "@ + + # Create Personal Access Token + + try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-V2025PersonalAccessToken -CreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025PersonalAccessToken -CreatePersonalAccessTokenRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#delete-personal-access-token + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + + # Delete Personal Access Token + + try { + Remove-V2025PersonalAccessToken -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025PersonalAccessToken -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#list-personal-access-tokens + source: | + $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List Personal Access Tokens + + try { + Get-V2025PersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-V2025PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PersonalAccessTokens" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/personal-access-tokens#patch-personal-access-token + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Personal Access Token + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025PersonalAccessToken -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025PersonalAccessToken -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /public-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/public-identities#get-public-identities + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Get list of public identities + + try { + Get-V2025PublicIdentities + + # Below is a request that includes all optional parameters + # Get-V2025PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PublicIdentities" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/public-identities-config#get-public-identity-config + source: | + + # Get the Public Identities Configuration + + try { + Get-V2025PublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-V2025PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/public-identities-config#update-public-identity-config + source: | + $PublicIdentityConfig = @" + { + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + } + "@ + + # Update the Public Identities Configuration + + try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-V2025PublicIdentityConfig -PublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2025PublicIdentityConfig -PublicIdentityConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /reports/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#cancel-report + source: | + $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel + + # Cancel Report + + try { + Suspend-V2025Report -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2025Report -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#get-report + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $FileFormat = "csv" # String | Output format of the requested report file + $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) + $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) + + # Get Report File + + try { + Get-V2025Report -TaskResultId $TaskResultId -FileFormat $FileFormat + + # Below is a request that includes all optional parameters + # Get-V2025Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId}/result + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#get-report-result + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) + + # Get Report Result + + try { + Get-V2025ReportResult -TaskResultId $TaskResultId + + # Below is a request that includes all optional parameters + # Get-V2025ReportResult -TaskResultId $TaskResultId -Completed $Completed + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReportResult" + Write-Host $_.ErrorDetails + } +- path: /reports/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#start-report + source: | + $ReportDetails = @" + { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } + "@ + + # Run Report + + try { + $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails + Start-V2025Report -ReportDetails $Result + + # Below is a request that includes all optional parameters + # Start-V2025Report -ReportDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025Report" + Write-Host $_.ErrorDetails + } +- path: /requestable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/requestable-objects#list-requestable-objects + source: | + $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) + + $Types = @"ROLE,ACCESS_PROFILE"@ + $Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) + $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) + + $Statuses = @"[ASSIGNED, PENDING]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Requestable Objects List + + try { + Get-V2025RequestableObjects + + # Below is a request that includes all optional parameters + # Get-V2025RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RequestableObjects" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#create-role-insight-requests + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Generate insights for roles + + try { + New-V2025RoleInsightRequests -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2025RoleInsightRequests -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025RoleInsightRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#download-role-insights-entitlements-changes + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Download entitlement insights for a role + + try { + Invoke-V2025DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Invoke-V2025DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025DownloadRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-entitlement-changes-identities + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name sw "Jan"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + + # Get identities for a suggested entitlement (for a role) + + try { + Get-V2025EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChangesIdentities" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insight + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a single role insight + + try { + Get-V2025RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsight" + Write-Host $_.ErrorDetails + } +- path: /role-insights + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + $Filters = "name sw "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + # Get role insights + + try { + Get-V2025RoleInsights -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleInsights -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsights" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/current-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-current-entitlements + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get current entitlement for a role + + try { + Get-V2025RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsCurrentEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-entitlements-changes + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) + $Filters = "name sw "Admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get entitlement insights for a role + + try { + Get-V2025RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-requests + source: | + $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Returns metadata from prior request. + + try { + Get-V2025RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-summary + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get role insights summary information + + try { + Get-V2025RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsSummary" + Write-Host $_.ErrorDetails + } +- path: /roles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#create-role + source: | + $Role = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + } + "@ + + # Create a Role + + try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-V2025Role -Role $Result + + # Below is a request that includes all optional parameters + # New-V2025Role -Role $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Role" + Write-Host $_.ErrorDetails + } +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-bulk-roles + source: | + $RoleBulkDeleteRequest = @" + { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Role(s) + + try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-V2025BulkRoles -RoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2025BulkRoles -RoleBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025BulkRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-metadata-from-role-by-key-and-value + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Remove a Metadata From Role. + + try { + Remove-V2025MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Remove-V2025MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MetadataFromRoleByKeyAndValue" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Delete a Role + + try { + Remove-V2025Role -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025Role -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Role" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#get-bulk-update-status + source: | + + # Get Bulk-Update Statuses + + try { + Get-V2025BulkUpdateStatus + + # Below is a request that includes all optional parameters + # Get-V2025BulkUpdateStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BulkUpdateStatus" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/id + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#get-bulk-update-status-by-id + source: | + $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. + + # Get Bulk-Update Status by ID + + try { + Get-V2025BulkUpdateStatusById -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025BulkUpdateStatusById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BulkUpdateStatusById" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Get a Role + + try { + Get-V2025Role -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025Role -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Role" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role-assigned-identities + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + + # List Identities assigned a Role + + try { + Get-V2025RoleAssignedIdentities -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignedIdentities" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | Containing role's ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Role's Entitlements + + try { + Get-V2025RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#list-roles + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Roles + + try { + Get-V2025Roles + + # Below is a request that includes all optional parameters + # Get-V2025Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Roles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#patch-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Role + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025Role -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025Role -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Role" + Write-Host $_.ErrorDetails + } +- path: /roles/filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#search-roles-by-filter + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + $RoleListFilterDTO = @" + { + "ammKeyValues" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "secret" ] + } ], + "filters" : "dimensional eq false" + } + "@ + + # Filter Roles by Metadata + + try { + Search-V2025RolesByFilter + + # Below is a request that includes all optional parameters + # Search-V2025RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -RoleListFilterDTO $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025RolesByFilter" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#update-attribute-key-and-value-to-role + source: | + $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Add a Metadata to Role. + + try { + Update-V2025AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Update-V2025AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AttributeKeyAndValueToRole" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-filter + source: | + $RoleMetadataBulkUpdateByFilterRequest = @" + { + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "filters" : " requestable eq false", + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by Filters + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest + Update-V2025RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2025RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByFilter" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/ids + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-ids + source: | + $RoleMetadataBulkUpdateByIdRequest = @" + { + "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by ID + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest + Update-V2025RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2025RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByIds" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/query + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-query + source: | + $RoleMetadataBulkUpdateByQueryRequest = @" + { + "query" : { + "query\"" : { + "indices" : [ "roles" ], + "queryType" : "TEXT", + "textQuery" : { + "terms" : [ "test123" ], + "fields" : [ "id" ], + "matchAny" : false, + "contains" : true + }, + "includeNested" : false + } + }, + "values" : [ { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + }, { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by Query + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest + Update-V2025RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2025RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByQuery" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/saved-search#create-saved-search + source: | + $CreateSavedSearchRequest = @" + + "@ + + # Create a saved search + + try { + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-V2025SavedSearch -CreateSavedSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025SavedSearch -CreateSavedSearchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/saved-search#delete-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete document by ID + + try { + Remove-V2025SavedSearch -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id}/execute + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/saved-search#execute-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SearchArguments = @" + { + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + } + "@ + + # Execute a saved search by ID + + try { + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-V2025ExecuteSavedSearch -Id $Id -SearchArguments $Result + + # Below is a request that includes all optional parameters + # Invoke-V2025ExecuteSavedSearch -Id $Id -SearchArguments $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ExecuteSavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/saved-search#get-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Return saved search by ID + + try { + Get-V2025SavedSearch -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/saved-search#list-saved-searches + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) + + # A list of Saved Searches + + try { + Get-V2025SavedSearches + + # Below is a request that includes all optional parameters + # Get-V2025SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedSearches" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/saved-search#put-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SavedSearch = @" + { + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + } + "@ + + # Updates an existing saved search + + try { + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-V2025SavedSearch -Id $Id -SavedSearch $Result + + # Below is a request that includes all optional parameters + # Send-V2025SavedSearch -Id $Id -SavedSearch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#create-scheduled-search + source: | + $CreateScheduledSearchRequest = @" + {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} + "@ + + # Create a new scheduled search + + try { + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-V2025ScheduledSearch -CreateScheduledSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025ScheduledSearch -CreateScheduledSearchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#delete-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete a Scheduled Search + + try { + Remove-V2025ScheduledSearch -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#get-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Scheduled Search + + try { + Get-V2025ScheduledSearch -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#list-scheduled-search + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + # List scheduled searches + + try { + Get-V2025ScheduledSearch + + # Below is a request that includes all optional parameters + # Get-V2025ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id}/unsubscribe + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#unsubscribe-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $TypedReference = @" + { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + "@ + + # Unsubscribe a recipient from Scheduled Search + + try { + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-V2025UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + + # Below is a request that includes all optional parameters + # Invoke-V2025UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025UnsubscribeScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/scheduled-search#update-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ScheduledSearch = @" + { + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + } + "@ + + # Update an existing Scheduled Search + + try { + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-V2025ScheduledSearch -Id $Id -ScheduledSearch $Result + + # Below is a request that includes all optional parameters + # Update-V2025ScheduledSearch -Id $Id -ScheduledSearch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /search/aggregate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/search#search-aggregate + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform a Search Query Aggregation + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2025Aggregate -Search $Result + + # Below is a request that includes all optional parameters + # Search-V2025Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Aggregate" + Write-Host $_.ErrorDetails + } +- path: /search/count + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/search#search-count + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + + # Count Documents Satisfying a Query + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2025Count -Search $Result + + # Below is a request that includes all optional parameters + # Search-V2025Count -Search $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Count" + Write-Host $_.ErrorDetails + } +- path: /search/{index}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/search#search-get + source: | + $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Document by ID + + try { + Search-V2025Get -Index $Index -Id $Id + + # Below is a request that includes all optional parameters + # Search-V2025Get -Index $Index -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Get" + Write-Host $_.ErrorDetails + } +- path: /search + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/search#search-post + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform Search + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2025Post -Search $Result + + # Below is a request that includes all optional parameters + # Search-V2025Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025Post" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#create-search-attribute-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#delete-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Extended Search Attribute + + try { + Remove-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#get-search-attribute-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Extended Search Attributes + + try { + Get-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Extended Search Attribute + + try { + Get-V2025SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#patch-search-attribute-config + source: | + $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/segments#create-segment + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-V2025Segment -Segment $Result + + # Below is a request that includes all optional parameters + # New-V2025Segment -Segment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/segments#delete-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-V2025Segment -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/segments#get-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-V2025Segment -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Segment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/segments#list-segments + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-V2025Segments + + # Below is a request that includes all optional parameters + # Get-V2025Segments -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Segments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/segments#patch-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2025Segment -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2025Segment -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Segment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#create-service-desk-integration + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-V2025ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-V2025ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#delete-service-desk-integration + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-V2025ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-V2025ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-V2025ServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2025ServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-V2025ServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-V2025ServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integrations + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-V2025ServiceDeskIntegrations + + # Below is a request that includes all optional parameters + # Get-V2025ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ServiceDeskIntegrations" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-status-check-details + source: | + + # Get the time check configuration + + try { + Get-V2025StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-V2025StatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-V2025ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-V2025ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#update-status-check-details + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-V2025StatusCheckDetails -QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2025StatusCheckDetails -QueuedCheckConfigDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration + source: | + $Id = "12345" # String | The id of the integration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a SIM integration + + try { + Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a SIM integration details. + + try { + Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2025SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2025SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2025SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2025DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-V2025SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2025SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2025SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2025SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-V2025SodPolicies + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2025SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2025SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2025EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2025SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2025PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#create-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-V2025ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-V2025ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source + source: | + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-V2025Source -Source $Result + + # Below is a request that includes all optional parameters + # New-V2025Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schedule1 = @" + + "@ + + # Create Schedule on Source + + try { + $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 + New-V2025SourceSchedule -SourceId $SourceId -Schedule1 $Result + + # Below is a request that includes all optional parameters + # New-V2025SourceSchedule -SourceId $SourceId -Schedule1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-V2025SourceSchema -SourceId $SourceId -Schema $Result + + # Below is a request that includes all optional parameters + # New-V2025SourceSchema -SourceId $SourceId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/remove-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-accounts-async + source: | + $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove All Accounts in a Source + + try { + Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccountsAsync" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-native-change-detection-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Native Change Detection Configuration + + try { + Remove-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Delete Provisioning Policy by UsageType + + try { + Remove-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-V2025Source -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + + # Delete Source Schedule by type. + + try { + Remove-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + + # Below is a request that includes all optional parameters + # Remove-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Delete Source Schema by ID + + try { + Remove-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-accounts-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-V2025AccountsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025AccountsSchema -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-correlation-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Get Source Correlation Configuration + + try { + Get-V2025CorrelationConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025CorrelationConfig -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-entitlements-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-V2025EntitlementsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementsSchema -Id $Id -SchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-native-change-detection-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Native Change Detection Configuration + + try { + Get-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Get Provisioning Policy by UsageType + + try { + Get-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-V2025Source -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-attr-sync-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Attribute Sync Config + + try { + Get-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/connectors/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-config + source: | + $Id = "cef3ee201db947c5912551015ba0c679" # String | The Source id + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Gets source config with language-translations + + try { + Get-V2025SourceConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SourceConfig -Id $Id -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-connections + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source Connections by ID + + try { + Get-V2025SourceConnections -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025SourceConnections -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceConnections" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-entitlement-request-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Source Entitlement Request Configuration + + try { + Get-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/source-health + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-health + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + + # Fetches source health by id + + try { + Get-V2025SourceHealth -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025SourceHealth -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceHealth" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + + # Get Source Schedule by Type + + try { + Get-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + + # Below is a request that includes all optional parameters + # Get-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schedules + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # List Schedules on Source + + try { + Get-V2025SourceSchedules -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025SourceSchedules -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchedules" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Get Source Schema by ID + + try { + Get-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schemas + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-V2025SourceSchemas -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchemas" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#import-accounts + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) + $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) + + # Account Aggregation + + try { + Import-V2025Accounts -Id $Id + + # Below is a request that includes all optional parameters + # Import-V2025Accounts -Id $Id -File $File -DisableOptimization $DisableOptimization + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025Accounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#import-accounts-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-V2025AccountsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Import-V2025AccountsSchema -Id $Id -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#import-connector-file + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-V2025ConnectorFile -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-V2025ConnectorFile -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025ConnectorFile" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#import-entitlements-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-V2025EntitlementsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Import-V2025EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-uncorrelated-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#import-uncorrelated-accounts + source: | + $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $File = # System.IO.FileInfo | (optional) + + # Process Uncorrelated Accounts + + try { + Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025UncorrelatedAccounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#list-provisioning-policies + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-V2025ProvisioningPolicies -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025ProvisioningPolicies -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProvisioningPolicies" + Write-Host $_.ErrorDetails + } +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#list-sources + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-V2025Sources + + # Below is a request that includes all optional parameters + # Get-V2025Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Sources" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/ping-cluster + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#ping-cluster + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Ping cluster for source connector + + try { + Ping-V2025Cluster -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Ping-V2025Cluster -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2025Cluster" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#put-correlation-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $CorrelationConfig = @" + { + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + } + "@ + + # Update Source Correlation Configuration + + try { + $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig + Send-V2025CorrelationConfig -Id $Id -CorrelationConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2025CorrelationConfig -Id $Id -CorrelationConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025CorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#put-native-change-detection-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $NativeChangeDetectionConfig = @" + { + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + } + "@ + + # Update Native Change Detection Configuration + + try { + $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig + Send-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#put-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-V2025Source -Id $Id -Source $Result + + # Below is a request that includes all optional parameters + # Send-V2025Source -Id $Id -Source $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source-attr-sync-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AttrSyncSourceConfig = @" + { + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + } + "@ + + # Update Attribute Sync Config + + try { + $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig + Send-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + + # Below is a request that includes all optional parameters + # Send-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/peek-resource-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#search-resource-objects + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + $ResourceObjectsRequest = @" + { + "maxCount" : 100, + "objectType" : "group" + } + "@ + + # Peek source connector's resource objects + + try { + $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest + Search-V2025ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result + + # Below is a request that includes all optional parameters + # Search-V2025ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025ResourceObjects" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#sync-attributes-for-source + source: | + $Id = "MyId" # String | The Source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Synchronize single source attributes. + + try { + Sync-V2025AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Sync-V2025AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025AttributesForSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/test-configuration + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#test-source-configuration + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Test configuration for source connector + + try { + Test-V2025SourceConfiguration -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-V2025SourceConfiguration -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConfiguration" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/check-connection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#test-source-connection + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. + + # Check connection for source connector. + + try { + Test-V2025SourceConnection -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-V2025SourceConnection -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConnection" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/password-policies + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-password-policy-holders + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $PasswordPolicyHoldersDtoInner = @""@ + + + # Update Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner + Update-V2025PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result + + # Below is a request that includes all optional parameters + # Update-V2025PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PasswordPolicyHolders" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-provisioning-policies-in-bulk + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-V2025ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-V2025ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025Source -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025Source -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-entitlement-request-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceEntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Update Source Entitlement Request Configuration + + try { + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schedule (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-V2025StatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-V2025UsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2025SpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2025SpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-V2025SpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-V2025SpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-V2025SpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-V2025SpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2025SpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-V2025SpConfigObjects + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id + + # Submit Sed Batch Stats Request + + try { + Get-V2025SedBatchStats -BatchId $BatchId + + # Below is a request that includes all optional parameters + # Get-V2025SedBatchStats -BatchId $BatchId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SedBatchStats" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#get-sed-batches + source: | + + # List Sed Batch Request + + try { + Get-V2025SedBatches + + # Below is a request that includes all optional parameters + # Get-V2025SedBatches + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SedBatches" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#list-seds + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) + $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) + $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) + $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) + + # List Suggested Entitlement Descriptions + + try { + Get-V2025Seds + + # Below is a request that includes all optional parameters + # Get-V2025Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Seds" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#patch-sed + source: | + $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id + $SedPatch = @"{ + "op" : "replace", + "path" : "status", + "value" : "approved" + }"@ + + + # Patch Suggested Entitlement Description + + try { + $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch + Update-V2025Sed -Id $Id -SedPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025Sed -Id $Id -SedPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Sed" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-approvals + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-approval + source: | + $SedApproval = @"{ + "items" : "016629d1-1d25-463f-97f3-c6686846650" + }"@ + + + # Submit Bulk Approval Request + + try { + $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval + Submit-V2025SedApproval -SedApproval $Result + + # Below is a request that includes all optional parameters + # Submit-V2025SedApproval -SedApproval $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedApproval" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-assignments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-assignment + source: | + $SedAssignment = @" + { + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + } + "@ + + # Submit Sed Assignment Request + + try { + $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment + Submit-V2025SedAssignment -SedAssignment $Result + + # Below is a request that includes all optional parameters + # Submit-V2025SedAssignment -SedAssignment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedAssignment" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + $SedBatchRequest = @" + { + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + } + "@ + + # Submit Sed Batch Request + + try { + Submit-V2025SedBatchRequest + + # Below is a request that includes all optional parameters + # Submit-V2025SedBatchRequest -SedBatchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedBatchRequest" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#delete-tagged-object + source: | + $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + + # Delete Object Tags + + try { + Remove-V2025TaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#delete-tags-to-many-object + source: | + $BulkRemoveTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject + Remove-V2025TagsToManyObject -BulkRemoveTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-V2025TagsToManyObject -BulkRemoveTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TagsToManyObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#get-tagged-object + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get Tagged Object + + try { + Get-V2025TaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#list-tagged-objects + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-V2025TaggedObjects + + # Below is a request that includes all optional parameters + # Get-V2025TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObjects" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#list-tagged-objects-by-type + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + Get-V2025TaggedObjectsByType -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2025TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObjectsByType" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#put-tagged-object + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-V2025TaggedObject -Type $Type -Id $Id -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-V2025TaggedObject -Type $Type -Id $Id -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#set-tag-to-object + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-V2025TagToObject -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-V2025TagToObject -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TagToObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#set-tags-to-many-objects + source: | + $BulkAddTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject + Set-V2025TagsToManyObjects -BulkAddTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-V2025TagsToManyObjects -BulkAddTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TagsToManyObjects" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: HEAD + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-pending-task-headers + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task List Headers + + try { + Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTaskHeaders" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-pending-tasks + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task Status List + + try { + Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTasks" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-task-status + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Task Status by ID + + try { + Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatus" + Write-Host $_.ErrorDetails + } +- path: /task-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-task-status-list + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "completionStatus eq "Success"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + $Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) + + # Retrieve Task Status List + + try { + Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatusList" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/task-management#update-task-status + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Task Status by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025TaskStatus" + Write-Host $_.ErrorDetails + } +- path: /tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tenant#get-tenant + source: | + + # Get Tenant Information. + + try { + Get-V2025Tenant + + # Below is a request that includes all optional parameters + # Get-V2025Tenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Tenant" + Write-Host $_.ErrorDetails + } +- path: /tenant-context + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tenant-context#get-tenant-context + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieve tenant context + + try { + Get-V2025TenantContext -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025TenantContext -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantContext" + Write-Host $_.ErrorDetails + } +- path: /tenant-context + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tenant-context#patch-tenant-context + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @" + { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } + "@ + + # Update tenant context + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025TenantContext" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/transforms#create-transform + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-V2025Transform -Transform $Result + + # Below is a request that includes all optional parameters + # New-V2025Transform -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/transforms#delete-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-V2025Transform -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/transforms#get-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-V2025Transform -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/transforms#list-transforms + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-V2025Transforms + + # Below is a request that includes all optional parameters + # Get-V2025Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Transforms" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/transforms#update-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-V2025Transform -Id $Id + + # Below is a request that includes all optional parameters + # Update-V2025Transform -Id $Id -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Transform" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/triggers#complete-trigger-invocation + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CompleteInvocation = @" + { + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + } + "@ + + # Complete Trigger Invocation + + try { + $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation + Complete-V2025TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result + + # Below is a request that includes all optional parameters + # Complete-V2025TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025TriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/triggers#create-subscription + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPostRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Create a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest + New-V2025Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Subscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/triggers#delete-subscription + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a Subscription + + try { + Remove-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Subscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-subscriptions + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) + $Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) + + # List Subscriptions + + try { + Get-V2025Subscriptions -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025Subscriptions -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Subscriptions" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-trigger-invocation-status + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "triggerId eq "idn:access-request-dynamic-approver"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) + + # List Latest Invocation Statuses + + try { + Get-V2025TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TriggerInvocationStatus" + Write-Host $_.ErrorDetails + } +- path: /triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-triggers + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "idn:access-request-post-approval"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) + + # List Triggers + + try { + Get-V2025Triggers -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025Triggers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Triggers" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/triggers#patch-subscription + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPatchRequestInner = @""@ + + + # Patch a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner + Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Subscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/triggers#start-test-trigger-invocation + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TestInvocation = @" + { + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + } + "@ + + # Start a Test Invocation + + try { + $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation + Start-V2025TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result + + # Below is a request that includes all optional parameters + # Start-V2025TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025TestTriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/validate-filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/triggers#test-subscription-filter + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ValidateFilterInputDto = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } + "@ + + # Validate a Subscription Filter + + try { + $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto + Test-V2025SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result + + # Below is a request that includes all optional parameters + # Test-V2025SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SubscriptionFilter" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/triggers#update-subscription + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPutRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Update a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest + Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Subscription" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/ui-metadata#get-tenant-ui-metadata + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a tenant UI metadata + + try { + Get-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/ui-metadata#set-tenant-ui-metadata + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TenantUiMetadataItemUpdateRequest = @" + { + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + } + "@ + + # Update tenant UI metadata + + try { + $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest + Set-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-V2025VendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-V2025VendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-V2025VendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-V2025VendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + + # List Vendor Connector Mappings + + try { + Get-V2025VendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-V2025VendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025VendorConnectorMappings" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2025WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2025WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2025ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2025Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2025WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-V2025WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2025Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2025Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2025WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2025WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2025WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-V2025CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-V2025WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-V2025WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-V2025WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-V2025Workflows + + # Below is a request that includes all optional parameters + # Get-V2025Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2025Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2025Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2025ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#approve-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#approve-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-V2025ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Approve-V2025ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#complete-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) + + # Complete a Work Item + + try { + Complete-V2025WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Complete-V2025WorkItem -Id $Id -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#forward-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Invoke-V2025ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Invoke-V2025ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ForwardWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-V2025CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-V2025CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-count-completed-work-items + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-V2025CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-count-work-items + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-V2025CountWorkItems + + # Below is a request that includes all optional parameters + # Get-V2025CountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-work-item + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-V2025WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-work-items-summary + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-V2025WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-V2025WorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#list-work-items + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-V2025WorkItems + + # Below is a request that includes all optional parameters + # Get-V2025WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#reject-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#reject-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-V2025ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Deny-V2025ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-items#submit-account-selection + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-V2025AccountSelection -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-V2025AccountSelection -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025AccountSelection" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#create-reassignment-configuration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Create a Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-V2025ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#delete-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Reassignment Configuration + + try { + Remove-V2025ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration + + try { + Get-V2025EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EvaluateReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-reassignment-config-types + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Reassignment Config Types + + try { + Get-V2025ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfigTypes" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Reassignment Configuration + + try { + Get-V2025ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-tenant-config-configuration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Tenant-wide Reassignment Configuration settings + + try { + Get-V2025TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantConfigConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#list-reassignment-configurations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Reassignment Configurations + + try { + Get-V2025ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfigurations" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#put-reassignment-config + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Update Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-V2025ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2025ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ReassignmentConfig" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#put-tenant-configuration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TenantConfigurationRequest = @" + { + "configDetails" : { + "disabled" : true + } + } + "@ + + # Update Tenant-wide Reassignment Configuration settings + + try { + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-V2025TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2025TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TenantConfiguration" + Write-Host $_.ErrorDetails + } diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index 139597f9c..3c8a3e36c 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -1,2 +1,10232 @@ +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#create-access-profile + source: | + $AccessProfile = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-AccessProfile -AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-AccessProfile -AccessProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#delete-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-AccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Remove-AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#delete-access-profiles-in-bulk + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#get-access-profile + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-AccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Get-AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#get-access-profile-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + Get-AccessProfileEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfileEntitlements" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#list-access-profiles + source: | + $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) + + # List Access Profiles + + try { + Get-AccessProfiles + + # Below is a request that includes all optional parameters + # Get-AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#patch-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AccessProfile -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AccessProfile -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#approve-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + Approve-AccessRequest -ApprovalId $ApprovalId + + # Below is a request that includes all optional parameters + # Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#forward-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ForwardAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/approval-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#get-access-request-approval-summary + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-AccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#list-completed-approvals + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Completed Access Request Approvals List + + try { + Get-CompletedApprovals + + # Below is a request that includes all optional parameters + # Get-CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#list-pending-approvals + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-PendingApprovals + + # Below is a request that includes all optional parameters + # Get-PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#reject-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-requests#cancel-access-request + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-AccessRequest -CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-AccessRequest -CancelAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-requests#create-access-request + source: | + $AccessRequest = @" + { + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-AccessRequest -AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-AccessRequest -AccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-requests#get-access-request-config + source: | + + # Get Access Request Configuration + + try { + Get-AccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-requests#list-access-request-status + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-AccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-requests#set-access-request-config + source: | + $AccessRequestConfig = @" + { + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-AccessRequestConfig -AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-AccessRequestConfig -AccessRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/account-activities#get-account-activity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get an Account Activity + + try { + Get-AccountActivity -Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountActivity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivity" + Write-Host $_.ErrorDetails + } +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/account-activities#list-account-activities + source: | + $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-AccountActivities + + # Below is a request that includes all optional parameters + # Get-AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#create-account + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-Account -AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-Account -AccountAttributesCreate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#delete-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-Account -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#disable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-Account -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-Account -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#enable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-Account -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-Account -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#get-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-Account -Id $Id + + # Below is a request that includes all optional parameters + # Get-Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#get-account-entitlements + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Account Entitlements + + try { + Get-AccountEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountEntitlements" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#list-accounts + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + # Accounts List + + try { + Get-Accounts + + # Below is a request that includes all optional parameters + # Get-Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Accounts" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#put-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-Account -Id $Id -AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-Account -Id $Id -AccountAttributes $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#submit-reload-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-ReloadAccount -Id $Id + + # Below is a request that includes all optional parameters + # Submit-ReloadAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReloadAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#unlock-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-Account -Id $Id -AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-Account -Id $Id -AccountUnlockRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#update-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=remove, path=/identityId}]"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-Account -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-Account -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" + Write-Host $_.ErrorDetails + } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/application-discovery#get-discovered-applications + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + + # Get Discovered Applications for Tenant + + try { + Get-DiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DiscoveredApplications" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + + # Download CSV Template for Discovery + + try { + Get-ManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-ManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + # Upload CSV to Discover Applications + + try { + Send-ManualDiscoverApplicationsCsvTemplate -File $File + + # Below is a request that includes all optional parameters + # Send-ManualDiscoverApplicationsCsvTemplate -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/auth-users#get-auth-user + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + + # Auth User Details + + try { + Get-AuthUser -Id $Id + + # Below is a request that includes all optional parameters + # Get-AuthUser -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthUser" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/auth-users#patch-auth-user + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Auth User Update + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthUser -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthUser -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthUser" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/branding#create-branding-item + source: | + $Name = "MyName" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Create a branding item + + try { + New-BrandingItem -Name $Name -ProductName $ProductName + + # Below is a request that includes all optional parameters + # New-BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/branding#delete-branding + source: | + $Name = "default" # String | The name of the branding item to be deleted + + # Delete a branding item + + try { + Remove-Branding -Name $Name + + # Below is a request that includes all optional parameters + # Remove-Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/branding#get-branding + source: | + $Name = "default" # String | The name of the branding item to be retrieved + + # Get a branding item + + try { + Get-Branding -Name $Name + + # Below is a request that includes all optional parameters + # Get-Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/branding#get-branding-list + source: | + + # List of branding items + + try { + Get-BrandingList + + # Below is a request that includes all optional parameters + # Get-BrandingList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BrandingList" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/branding#set-branding-item + source: | + $Name = "default" # String | The name of the branding item to be retrieved + $Name2 = "Name_example" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Update a branding item + + try { + Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName + + # Below is a request that includes all optional parameters + # Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#create-campaign-filter + source: | + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Create Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + New-CampaignFilter -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # New-CampaignFilter -CampaignFilterDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#delete-campaign-filters + source: | + $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. + $RequestBody = @""@ + + + # Deletes Campaign Filters + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-CampaignFilters -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-CampaignFilters -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. + + # Get Campaign Filter by ID + + try { + Get-CampaignFilterById -Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignFilterById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilterById" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#list-campaign-filters + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) + + # List Campaign Filters + + try { + Get-CampaignFilters + + # Below is a request that includes all optional parameters + # Get-CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#update-campaign-filter + source: | + $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Updates a Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#complete-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CampaignCompleteOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Complete-Campaign -Id $Id -CampaignCompleteOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#create-campaign + source: | + $Campaign = @" + { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + } + "@ + + # Create a campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-Campaign -Campaign $Result + + # Below is a request that includes all optional parameters + # New-Campaign -Campaign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#create-campaign-template + source: | + $CampaignTemplate = @" + { + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-CampaignTemplate -CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-CampaignTemplate -CampaignTemplate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#delete-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-CampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Remove-CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#delete-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#delete-campaigns + source: | + $CampaignsDeleteRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest + Remove-Campaigns -CampaignsDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-Campaigns -CampaignsDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Campaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-active-campaigns + source: | + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + + # List Campaigns + + try { + Get-ActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ActiveCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + # Get Campaign + + try { + Get-Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Get-Campaign -Id $Id -Detail $Detail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-reports + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-CampaignReports -Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignReports -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReports" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-reports-config + source: | + + # Get Campaign Reports Configuration + + try { + Get-CampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-CampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-templates + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-CampaignTemplates + + # Below is a request that includes all optional parameters + # Get-CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplates" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#move + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move- -Id $Id -AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move- -Id $Id -AdminReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#patch-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#set-campaign-reports-config + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-CampaignReportsConfig -CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-CampaignReportsConfig -CampaignReportsConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#set-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. + $Schedule = @" + { + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Set-CampaignTemplateSchedule -Id $Id -Schedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#start-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Start-Campaign -Id $Id -ActivateCampaignOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#start-campaign-remediation-scan + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-CampaignRemediationScan -Id $Id + + # Below is a request that includes all optional parameters + # Start-CampaignRemediationScan -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignRemediationScan" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-report/{type} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#start-campaign-report + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. + + # Run Campaign Report + + try { + Start-CampaignReport -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Start-CampaignReport -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignReport" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#start-generate-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-GenerateCampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Start-GenerateCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-GenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#update-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Campaign -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Campaign -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#get-certification-task + source: | + $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID + + # Certification Task by ID + + try { + Get-CertificationTask -Id $Id + + # Below is a request that includes all optional parameters + # Get-CertificationTask -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationTask" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#get-identity-certification + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id + + # Identity Certification by ID + + try { + Get-IdentityCertification -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#get-identity-certification-item-permissions + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Permissions for Entitlement Certification Item + + try { + Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#get-pending-certification-tasks + source: | + $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) + + # List of Pending Certification Tasks + + try { + Get-PendingCertificationTasks + + # Below is a request that includes all optional parameters + # Get-PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingCertificationTasks" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#list-certification-reviewers + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + + # List of Reviewers for certification + + try { + Get-CertificationReviewers -Id $Id + + # Below is a request that includes all optional parameters + # Get-CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationReviewers" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-review-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#list-identity-access-review-items + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + $Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + # List of Access Review Items + + try { + Get-IdentityAccessReviewItems -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessReviewItems" + Write-Host $_.ErrorDetails + } +- path: /certifications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#list-identity-certifications + source: | + $ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) + + # List Identity Campaign Certifications + + try { + Get-IdentityCertifications + + # Below is a request that includes all optional parameters + # Get-IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decide + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#make-identity-decision + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions + $ReviewDecision = @"{ + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + }"@ + + + # Decide on a Certification Item + + try { + $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision + Select-IdentityDecision -Id $Id -ReviewDecision $Result + + # Below is a request that includes all optional parameters + # Select-IdentityDecision -Id $Id -ReviewDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-IdentityDecision" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#reassign-identity-certifications + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Identities or Items + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ReassignIdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/sign-off + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#sign-off-identity-certification + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + + # Finalize Identity Certification Decisions + + try { + Invoke-SignOffIdentityCertification -Id $Id + + # Below is a request that includes all optional parameters + # Invoke-SignOffIdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-SignOffIdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#submit-reassign-certs-async + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#create-object-mapping + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingRequest = @" + { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } + "@ + + # Creates an object mapping + + try { + $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest + New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result + + # Below is a request that includes all optional parameters + # New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#create-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkCreateRequest = @" + { + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + } + "@ + + # Bulk creates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest + New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#create-uploaded-configuration + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. + + # Upload a Configuration + + try { + New-UploadedConfiguration -Data $Data -Name $Name + + # Below is a request that includes all optional parameters + # New-UploadedConfiguration -Data $Data -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#delete-object-mapping + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. + + # Deletes an object mapping + + try { + Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + + # Below is a request that includes all optional parameters + # Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#delete-uploaded-configuration + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Delete an Uploaded Configuration + + try { + Remove-UploadedConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#get-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + + # Gets list of object mappings + + try { + Get-ObjectMappings -SourceOrg $SourceOrg + + # Below is a request that includes all optional parameters + # Get-ObjectMappings -SourceOrg $SourceOrg + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#get-uploaded-configuration + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Get an Uploaded Configuration + + try { + Get-UploadedConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#list-uploaded-configurations + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + + # List Uploaded Configurations + + try { + Get-UploadedConfigurations + + # Below is a request that includes all optional parameters + # Get-UploadedConfigurations -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfigurations" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#update-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkPatchRequest = @" + { + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + } + "@ + + # Bulk updates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest + Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + + # Below is a request that includes all optional parameters + # Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/connectors#create-custom-connector + source: | + $V3CreateConnectorDto = @" + { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } + "@ + + # Create Custom Connector + + try { + $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto + New-CustomConnector -V3CreateConnectorDto $Result + + # Below is a request that includes all optional parameters + # New-CustomConnector -V3CreateConnectorDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/connectors#delete-custom-connector + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Delete Connector by Script Name + + try { + Remove-CustomConnector -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Remove-CustomConnector -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector by Script Name + + try { + Get-Connector -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-Connector -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Connector" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector-list + source: | + $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector List + + try { + Get-ConnectorList + + # Below is a request that includes all optional parameters + # Get-ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorList" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector-source-config + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Configuration + + try { + Get-ConnectorSourceConfig -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ConnectorSourceConfig -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector-source-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Template + + try { + Get-ConnectorSourceTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ConnectorSourceTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector-translations + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Get Connector Translations + + try { + Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/connectors#put-connector-source-config + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source config xml file + + # Update Connector Source Configuration + + try { + Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/connectors#put-connector-source-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source template xml file + + # Update Connector Source Template + + try { + Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/connectors#put-connector-translations + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Update Connector Translations + + try { + Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/connectors#update-connector + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Connector by Script Name + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Connector" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + $NetworkConfiguration = @" + { + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + } + "@ + + # Create security network configuration. + + try { + $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration + New-AuthOrgNetworkConfig -NetworkConfiguration $Result + + # Below is a request that includes all optional parameters + # New-AuthOrgNetworkConfig -NetworkConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + + # Get Auth Org Lockout Configuration. + + try { + Get-AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgLockoutConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + + # Get security network configuration. + + try { + Get-AuthOrgNetworkConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgNetworkConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + + # Get Service Provider Configuration. + + try { + Get-AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgServiceProviderConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + + # Get Auth Org Session Configuration. + + try { + Get-AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgSessionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Lockout Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgLockoutConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgLockoutConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update security network configuration. + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgNetworkConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgNetworkConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Service Provider Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Session Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgSessionConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgSessionConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#create-identity-profile + source: | + $IdentityProfile = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + "@ + + # Create Identity Profile + + try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-IdentityProfile -IdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-IdentityProfile -IdentityProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#delete-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + + # Delete Identity Profile + + try { + Remove-IdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#delete-identity-profiles + source: | + $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ + + + # Delete Identity Profiles + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-IdentityProfiles -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-IdentityProfiles -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#export-identity-profiles + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + + # Export Identity Profiles + + try { + Export-IdentityProfiles + + # Below is a request that includes all optional parameters + # Export-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#get-default-identity-attribute-config + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + + # Get default Identity Attribute Config + + try { + Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#get-identity-profile + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + + # Get Identity Profile + + try { + Get-IdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#import-identity-profiles + source: | + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + }"@ + + + # Import Identity Profiles + + try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-IdentityProfiles -IdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-IdentityProfiles -IdentityProfileExportedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#list-identity-profiles + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + # List Identity Profiles + + try { + Get-IdentityProfiles + + # Below is a request that includes all optional parameters + # Get-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#show-identity-preview + source: | + $IdentityPreviewRequest = @" + { + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + } + "@ + + # Generate Identity Profile Preview + + try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + Show-IdentityPreview -IdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # Show-IdentityPreview -IdentityPreviewRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-IdentityPreview" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#sync-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + + # Process identities under profile + + try { + Sync-IdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#update-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Identity Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#create-lifecycle-state + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleState = @" + { + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + } + "@ + + # Create Lifecycle State + + try { + $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState + New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result + + # Below is a request that includes all optional parameters + # New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#delete-lifecycle-state + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Delete Lifecycle State + + try { + Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#get-lifecycle-state + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Get Lifecycle State + + try { + Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#get-lifecycle-states + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Lists LifecycleStates + + try { + Get-LifecycleStates -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /identities/{identity-id}/set-lifecycle-state + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#set-lifecycle-state + source: | + $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. + $SetLifecycleStateRequest = @" + + "@ + + # Set Lifecycle State + + try { + $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest + Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result + + # Below is a request that includes all optional parameters + # Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#update-lifecycle-states + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Lifecycle State + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-ManagedClient -ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedClient -ManagedClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-ManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-ManagedClients + + # Below is a request that includes all optional parameters + # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-ManagedCluster -ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedCluster -ManagedClusterRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-ClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-ManagedClusters + + # Below is a request that includes all optional parameters + # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#delete-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # Delete MFA method configuration + + try { + Remove-MFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Remove-MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MFAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-kba-config + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-duo-config + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-MFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-MFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfakba-config + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-MFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-MFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-okta-config + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-MFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-MFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#test-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-MFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-MFAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#create-send-token + source: | + $SendTokenRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } + "@ + + # Create and send user token + + try { + $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest + New-SendToken -SendTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-SendToken -SendTokenRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/poll + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#ping-verification-status + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + $VerificationPollRequest = @" + { + "requestId" : "089899f13a8f4da7824996191587bab9" + } + "@ + + # Polling MFA method by VerificationPollRequest + + try { + $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest + Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result + + # Below is a request that includes all optional parameters + # Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-duo-verify-request + source: | + $DuoVerificationRequest = @" + { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } + "@ + + # Verifying authentication via Duo method + + try { + $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest + Send-DuoVerifyRequest -DuoVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-DuoVerifyRequest -DuoVerificationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-kba-answers + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Authenticate KBA provided MFA method + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Send-KbaAnswers -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Send-KbaAnswers -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-okta-verify-request + source: | + $OktaVerificationRequest = @" + { + "userId" : "example@mail.com" + } + "@ + + # Verifying authentication via Okta method + + try { + $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest + Send-OktaVerifyRequest -OktaVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-OktaVerifyRequest -OktaVerificationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-token-auth-request + source: | + $TokenAuthRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } + "@ + + # Authenticate Token provided MFA method + + try { + $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest + Send-TokenAuthRequest -TokenAuthRequest $Result + + # Below is a request that includes all optional parameters + # Send-TokenAuthRequest -TokenAuthRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "Approved by manager" + } + "@ + + # Approve a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-NonEmployeeRecord -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeRecord -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-NonEmployeeRequest -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeRequest -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + $NonEmployeeSourceRequestBody = @" + { + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + } + "@ + + # Create Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $NonEmployeeSchemaAttributeBody = @" + { + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + } + "@ + + # Create a new Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Delete Non-Employee Record + + try { + Remove-NonEmployeeRecord -Id $Id + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk + source: | + $DeleteNonEmployeeRecordsInBulkRequest = @" + + "@ + + # Delete Multiple Non-Employee Records + + try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest + Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format + + # Delete Non-Employee Request + + try { + Remove-NonEmployeeRequest -Id $Id + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete a Schema Attribute for Non-Employee Source + + try { + Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + + # Delete Non-Employee Source + + try { + Remove-NonEmployeeSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete all custom schema attributes for Non-Employee Source + + try { + Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + + # Exports Non-Employee Records to CSV + + try { + Export-NonEmployeeRecords -Id $Id + + # Below is a request that includes all optional parameters + # Export-NonEmployeeRecords -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) + + # Exports Source Schema Template + + try { + Export-NonEmployeeSourceSchemaTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Export-NonEmployeeSourceSchemaTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + # Get a non-employee approval item detail + + try { + Get-NonEmployeeApproval -Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Approval Requests + + try { + Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) + + # Obtain the status of bulk upload on the source + + try { + Get-NonEmployeeBulkUploadStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeBulkUploadStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Get a Non-Employee Record + + try { + Get-NonEmployeeRecord -Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) + + # Get a Non-Employee Request + + try { + Get-NonEmployeeRequest -Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Requests + + try { + Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequestSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Get Schema Attribute Non-Employee Source + + try { + Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + + # Get a Non-Employee Source + + try { + Get-NonEmployeeSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # List Schema Attributes Non-Employee Source + + try { + Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + $Data = # System.IO.FileInfo | + + # Imports, or Updates, Non-Employee Records + + try { + Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data + + # Below is a request that includes all optional parameters + # Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-approvals + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Get List of Non-Employee Approval Requests + + try { + Get-NonEmployeeApprovals + + # Below is a request that includes all optional parameters + # Get-NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovals" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-records + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Records + + try { + Get-NonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Requests + + try { + Get-NonEmployeeRequests -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequests" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-sources + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) + $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) + $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + + # List Non-Employee Sources + + try { + Get-NonEmployeeSources + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Record + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeRejectApprovalDecision = @" + { + "comment" : "approved" + } + "@ + + # Reject a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Update Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#create-oauth-client + source: | + $CreateOAuthClientRequest = @" + { + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + } + "@ + + # Create OAuth Client + + try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-OauthClient -CreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-OauthClient -CreateOAuthClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#delete-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Delete OAuth Client + + try { + Remove-OauthClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-OauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#get-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Get OAuth Client + + try { + Get-OauthClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-OauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#list-oauth-clients + source: | + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List OAuth Clients + + try { + Get-OauthClients + + # Below is a request that includes all optional parameters + # Get-OauthClients -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClients" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#patch-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch OAuth Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-OauthClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-OauthClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-OauthClient" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-configuration#create-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-PasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-PasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-configuration#get-password-org-config + source: | + + # Get Password Org Config + + try { + Get-PasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-configuration#put-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-PasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-PasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-dictionary#get-password-dictionary + source: | + + # Get Password Dictionary + + try { + Get-PasswordDictionary + + # Below is a request that includes all optional parameters + # Get-PasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-dictionary#put-password-dictionary + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-PasswordDictionary + + # Below is a request that includes all optional parameters + # Send-PasswordDictionary -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-management#get-password-change-status + source: | + $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID + + # Get Password Change Request Status + + try { + Get-PasswordChangeStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordChangeStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordChangeStatus" + Write-Host $_.ErrorDetails + } +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-management#query-password-info + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-PasswordInfo -PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-PasswordInfo -PasswordInfoQueryDTO $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-PasswordInfo" + Write-Host $_.ErrorDetails + } +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-management#set-password + source: | + $PasswordChangeRequest = @" + { + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-Password -PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-Password -PasswordChangeRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-Password" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-policies#create-password-policy + source: | + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Create Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-PasswordPolicy -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-PasswordPolicy -PasswordPolicyV3Dto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-policies#delete-password-policy + source: | + $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + + # Delete Password Policy by ID + + try { + Remove-PasswordPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-PasswordPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-policies#get-password-policy-by-id + source: | + $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + + # Get Password Policy by ID + + try { + Get-PasswordPolicyById -Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordPolicyById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicyById" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-policies#list-password-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Password Policies + + try { + Get-PasswordPolicies + + # Below is a request that includes all optional parameters + # Get-PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicies" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-policies#set-password-policy + source: | + $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Update Password Policy by ID + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#create-password-sync-group + source: | + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Create Password Sync Group + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-PasswordSyncGroup -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-PasswordSyncGroup -PasswordSyncGroup $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#delete-password-sync-group + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + + # Delete Password Sync Group by ID + + try { + Remove-PasswordSyncGroup -Id $Id + + # Below is a request that includes all optional parameters + # Remove-PasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#get-password-sync-group + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + + # Get Password Sync Group by ID + + try { + Get-PasswordSyncGroup -Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#get-password-sync-groups + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Password Sync Group List + + try { + Get-PasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroups" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#update-password-sync-group + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Update Password Sync Group by ID + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/personal-access-tokens#create-personal-access-token + source: | + $CreatePersonalAccessTokenRequest = @" + { + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + } + "@ + + # Create Personal Access Token + + try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/personal-access-tokens#delete-personal-access-token + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + + # Delete Personal Access Token + + try { + Remove-PersonalAccessToken -Id $Id + + # Below is a request that includes all optional parameters + # Remove-PersonalAccessToken -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/personal-access-tokens#list-personal-access-tokens + source: | + $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List Personal Access Tokens + + try { + Get-PersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PersonalAccessTokens" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/personal-access-tokens#patch-personal-access-token + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Personal Access Token + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /public-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/public-identities#get-public-identities + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Get list of public identities + + try { + Get-PublicIdentities + + # Below is a request that includes all optional parameters + # Get-PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentities" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/public-identities-config#get-public-identity-config + source: | + + # Get the Public Identities Configuration + + try { + Get-PublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/public-identities-config#update-public-identity-config + source: | + $PublicIdentityConfig = @" + { + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + } + "@ + + # Update the Public Identities Configuration + + try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-PublicIdentityConfig -PublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-PublicIdentityConfig -PublicIdentityConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /reports/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/reports-data-extraction#cancel-report + source: | + $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel + + # Cancel Report + + try { + Suspend-Report -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-Report -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/reports-data-extraction#get-report + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $FileFormat = "csv" # String | Output format of the requested report file + $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) + $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) + + # Get Report File + + try { + Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat + + # Below is a request that includes all optional parameters + # Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId}/result + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/reports-data-extraction#get-report-result + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) + + # Get Report Result + + try { + Get-ReportResult -TaskResultId $TaskResultId + + # Below is a request that includes all optional parameters + # Get-ReportResult -TaskResultId $TaskResultId -Completed $Completed + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ReportResult" + Write-Host $_.ErrorDetails + } +- path: /reports/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/reports-data-extraction#start-report + source: | + $ReportDetails = @" + { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } + "@ + + # Run Report + + try { + $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails + Start-Report -ReportDetails $Result + + # Below is a request that includes all optional parameters + # Start-Report -ReportDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Report" + Write-Host $_.ErrorDetails + } +- path: /requestable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/requestable-objects#list-requestable-objects + source: | + $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) + + $Types = @"ROLE,ACCESS_PROFILE"@ + $Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) + $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) + + $Statuses = @"[ASSIGNED, PENDING]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Requestable Objects List + + try { + Get-RequestableObjects + + # Below is a request that includes all optional parameters + # Get-RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RequestableObjects" + Write-Host $_.ErrorDetails + } +- path: /roles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/roles#create-role + source: | + $Role = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + } + "@ + + # Create a Role + + try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-Role -Role $Result + + # Below is a request that includes all optional parameters + # New-Role -Role $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Role" + Write-Host $_.ErrorDetails + } +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/roles#delete-bulk-roles + source: | + $RoleBulkDeleteRequest = @" + { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Role(s) + + try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-BulkRoles -RoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BulkRoles -RoleBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BulkRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/roles#delete-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | Role ID. + + # Delete Role + + try { + Remove-Role -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Role -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Role" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/roles#get-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | Role ID. + + # Get Role + + try { + Get-Role -Id $Id + + # Below is a request that includes all optional parameters + # Get-Role -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Role" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/roles#get-role-assigned-identities + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + + # List Identities assigned a Role + + try { + Get-RoleAssignedIdentities -Id $Id + + # Below is a request that includes all optional parameters + # Get-RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RoleAssignedIdentities" + Write-Host $_.ErrorDetails + } +- path: /roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/roles#list-roles + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Roles + + try { + Get-Roles + + # Below is a request that includes all optional parameters + # Get-Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Roles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/roles#patch-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | Role ID to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Role + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Role -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Role -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/saved-search#create-saved-search + source: | + $CreateSavedSearchRequest = @" + + "@ + + # Create a saved search + + try { + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-SavedSearch -CreateSavedSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-SavedSearch -CreateSavedSearchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/saved-search#delete-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete document by ID + + try { + Remove-SavedSearch -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id}/execute + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/saved-search#execute-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SearchArguments = @" + { + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + } + "@ + + # Execute a saved search by ID + + try { + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result + + # Below is a request that includes all optional parameters + # Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/saved-search#get-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Return saved search by ID + + try { + Get-SavedSearch -Id $Id + + # Below is a request that includes all optional parameters + # Get-SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/saved-search#list-saved-searches + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) + + # A list of Saved Searches + + try { + Get-SavedSearches + + # Below is a request that includes all optional parameters + # Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearches" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/saved-search#put-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SavedSearch = @" + { + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + } + "@ + + # Updates an existing saved search + + try { + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-SavedSearch -Id $Id -SavedSearch $Result + + # Below is a request that includes all optional parameters + # Send-SavedSearch -Id $Id -SavedSearch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#create-scheduled-search + source: | + $CreateScheduledSearchRequest = @" + {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} + "@ + + # Create a new scheduled search + + try { + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-ScheduledSearch -CreateScheduledSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-ScheduledSearch -CreateScheduledSearchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#delete-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete a Scheduled Search + + try { + Remove-ScheduledSearch -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#get-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Scheduled Search + + try { + Get-ScheduledSearch -Id $Id + + # Below is a request that includes all optional parameters + # Get-ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#list-scheduled-search + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + # List scheduled searches + + try { + Get-ScheduledSearch + + # Below is a request that includes all optional parameters + # Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id}/unsubscribe + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#unsubscribe-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $TypedReference = @" + { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + "@ + + # Unsubscribe a recipient from Scheduled Search + + try { + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + + # Below is a request that includes all optional parameters + # Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#update-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ScheduledSearch = @" + { + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + } + "@ + + # Update an existing Scheduled Search + + try { + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-ScheduledSearch -Id $Id -ScheduledSearch $Result + + # Below is a request that includes all optional parameters + # Update-ScheduledSearch -Id $Id -ScheduledSearch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /search/aggregate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search#search-aggregate + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform a Search Query Aggregation + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Aggregate -Search $Result + + # Below is a request that includes all optional parameters + # Search-Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate" + Write-Host $_.ErrorDetails + } +- path: /search/count + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search#search-count + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + + # Count Documents Satisfying a Query + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Count -Search $Result + + # Below is a request that includes all optional parameters + # Search-Count -Search $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count" + Write-Host $_.ErrorDetails + } +- path: /search/{index}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search#search-get + source: | + $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Document by ID + + try { + Search-Get -Index $Index -Id $Id + + # Below is a request that includes all optional parameters + # Search-Get -Index $Index -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Get" + Write-Host $_.ErrorDetails + } +- path: /search + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search#search-post + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform Search + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Post -Search $Result + + # Below is a request that includes all optional parameters + # Search-Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#create-search-attribute-config + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-SearchAttributeConfig -SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-SearchAttributeConfig -SearchAttributeConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#delete-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-SearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Remove-SearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-search-attribute-config + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Extended Search Attributes + + try { + Get-SearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-SearchAttributeConfig -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. + + # Get Extended Search Attribute + + try { + Get-SingleSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Get-SingleSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#patch-search-attribute-config + source: | + $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/segments#create-segment + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-Segment -Segment $Result + + # Below is a request that includes all optional parameters + # New-Segment -Segment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/segments#delete-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-Segment -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/segments#get-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-Segment -Id $Id + + # Below is a request that includes all optional parameters + # Get-Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/segments#list-segments + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-Segments + + # Below is a request that includes all optional parameters + # Get-Segments -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/segments#patch-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-Segment -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-Segment -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#create-service-desk-integration + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#delete-service-desk-integration + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-ServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integrations + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-ServiceDeskIntegrations + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrations" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-status-check-details + source: | + + # Get the time check configuration + + try { + Get-StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-StatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#update-status-check-details + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-StatusCheckDetails -QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-StatusCheckDetails -QueuedCheckConfigDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-SodPolicies + + # Below is a request that includes all optional parameters + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#create-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#create-source + source: | + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-Source -Source $Result + + # Below is a request that includes all optional parameters + # New-Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#create-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-SourceSchema -SourceId $SourceId -Schema $Result + + # Below is a request that includes all optional parameters + # New-SourceSchema -SourceId $SourceId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#delete-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Delete Provisioning Policy by UsageType + + try { + Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#delete-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-Source -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#delete-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Delete Source Schema by ID + + try { + Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-accounts-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-AccountsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountsSchema -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-entitlements-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-EntitlementsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Get-EntitlementsSchema -Id $Id -SchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Get Provisioning Policy by UsageType + + try { + Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-Source -Id $Id + + # Below is a request that includes all optional parameters + # Get-Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-source-connections + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source Connections by ID + + try { + Get-SourceConnections -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-SourceConnections -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceConnections" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/source-health + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-source-health + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + + # Fetches source health by id + + try { + Get-SourceHealth -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-SourceHealth -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceHealth" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Get Source Schema by ID + + try { + Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-source-schemas + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-SourceSchemas -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchemas" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#import-accounts-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-AccountsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Import-AccountsSchema -Id $Id -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#import-connector-file + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-ConnectorFile -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-ConnectorFile -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-ConnectorFile" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#import-entitlements-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-EntitlementsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Import-EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#list-provisioning-policies + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-ProvisioningPolicies -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-ProvisioningPolicies -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicies" + Write-Host $_.ErrorDetails + } +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#list-sources + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-Sources + + # Below is a request that includes all optional parameters + # Get-Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Sources" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#put-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#put-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-Source -Id $Id -Source $Result + + # Below is a request that includes all optional parameters + # Send-Source -Id $Id -Source $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#put-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + + # Below is a request that includes all optional parameters + # Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#update-provisioning-policies-in-bulk + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#update-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#update-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Source -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Source -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#update-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-StatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-UsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#delete-tagged-object + source: | + $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + + # Delete Object Tags + + try { + Remove-TaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Remove-TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#delete-tags-to-many-object + source: | + $BulkRemoveTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject + Remove-TagsToManyObject -BulkRemoveTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-TagsToManyObject -BulkRemoveTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TagsToManyObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#get-tagged-object + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get Tagged Object + + try { + Get-TaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Get-TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#list-tagged-objects + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-TaggedObjects + + # Below is a request that includes all optional parameters + # Get-TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjects" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#list-tagged-objects-by-type + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + Get-TaggedObjectsByType -Type $Type + + # Below is a request that includes all optional parameters + # Get-TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjectsByType" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#put-tagged-object + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#set-tag-to-object + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-TagToObject -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-TagToObject -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagToObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#set-tags-to-many-objects + source: | + $BulkAddTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject + Set-TagsToManyObjects -BulkAddTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-TagsToManyObjects -BulkAddTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagsToManyObjects" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/transforms#create-transform + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-Transform -Transform $Result + + # Below is a request that includes all optional parameters + # New-Transform -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/transforms#delete-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-Transform -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/transforms#get-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-Transform -Id $Id + + # Below is a request that includes all optional parameters + # Get-Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/transforms#list-transforms + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-Transforms + + # Below is a request that includes all optional parameters + # Get-Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transforms" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/transforms#update-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-Transform -Id $Id + + # Below is a request that includes all optional parameters + # Update-Transform -Id $Id -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Transform" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-VendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-VendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-VendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-VendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + + # List Vendor Connector Mappings + + try { + Get-VendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-VendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) + + # Get Workflow By Id + + try { + Get-Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-Workflow -Id $Id -WorkflowMetrics $WorkflowMetrics + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflows + source: | + $TriggerId = "idn:identity-created" # String | Trigger ID (optional) + $ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Workflows + + try { + Get-Workflows + + # Below is a request that includes all optional parameters + # Get-Workflows -TriggerId $TriggerId -ConnectorInstanceId $ConnectorInstanceId -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Approve-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) + + # Complete a Work Item + + try { + Complete-WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Complete-WorkItem -Id $Id -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-CountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CountCompletedWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-CountWorkItems + + # Below is a request that includes all optional parameters + # Get-CountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-WorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-WorkItems + + # Below is a request that includes all optional parameters + # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Deny-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-WorkItemForward -Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Send-WorkItemForward -Id $Id -WorkItemForward $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-AccountSelection -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-AccountSelection -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" + Write-Host $_.ErrorDetails + } From ce2588405304ccdafa7ab1f95c845b7dcca69da6 Mon Sep 17 00:00:00 2001 From: con-docs Date: Wed, 30 Apr 2025 14:10:42 -0500 Subject: [PATCH 80/82] Zero Knowledge Encryption --- .../connector-commands/index.md | 2 +- .../connector-customizers/index.md | 2 +- .../img/Solution_Brief_ZKE_Figure1.png | Bin 0 -> 56878 bytes .../img/Solution_Brief_ZKE_Figure2.png | Bin 0 -> 78470 bytes docs/connectivity/saas-connectivity/index.md | 2 +- .../zero-knowledge-encryption.md | 149 ++++++++++++++++++ 6 files changed, 152 insertions(+), 3 deletions(-) create mode 100644 docs/connectivity/saas-connectivity/img/Solution_Brief_ZKE_Figure1.png create mode 100644 docs/connectivity/saas-connectivity/img/Solution_Brief_ZKE_Figure2.png create mode 100644 docs/connectivity/saas-connectivity/zero-knowledge-encryption.md diff --git a/docs/connectivity/saas-connectivity/connector-commands/index.md b/docs/connectivity/saas-connectivity/connector-commands/index.md index 401313dc2..45b310082 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/index.md +++ b/docs/connectivity/saas-connectivity/connector-commands/index.md @@ -3,7 +3,7 @@ id: connector-commands title: Connector Commands pagination_label: Connector Commands sidebar_label: Connector Commands -sidebar_position: 7 +sidebar_position: 8 sidebar_class_name: connectorCommands keywords: ['connectivity', 'connector', 'commands'] description: All commands available to implement in a SaaS Connector. diff --git a/docs/connectivity/saas-connectivity/connector-customizers/index.md b/docs/connectivity/saas-connectivity/connector-customizers/index.md index cbd62d8c7..5f01b2580 100644 --- a/docs/connectivity/saas-connectivity/connector-customizers/index.md +++ b/docs/connectivity/saas-connectivity/connector-customizers/index.md @@ -3,7 +3,7 @@ id: connectivity-customizers title: Connectivity Customizers pagination_label: Connectivity Customizers sidebar_label: Customizers -sidebar_position: 7.1 +sidebar_position: 8.1 sidebar_class_name: saasConnectivity keywords: ['connectivity', 'connectors', customizers] description: Connectivity customizers can customize out of the box SaaS connectors. diff --git a/docs/connectivity/saas-connectivity/img/Solution_Brief_ZKE_Figure1.png b/docs/connectivity/saas-connectivity/img/Solution_Brief_ZKE_Figure1.png new file mode 100644 index 0000000000000000000000000000000000000000..52cc770e49397874e6d2465187889a43d16b88e1 GIT binary patch literal 56878 zcmd43byQVR_cpo#L8QAIK|tw}7Nn&cq`Nx=DW&7kDcy~Pbc>XffOLs;mvnd+zVGFyVM+>8=qMy85CoyiNQMJ0TfyQMGq-dyAgls_JtukDlF(=gW_`nK9Zi;xQ!X@DQ6;qiF4g{_clZubCz5DnD6nTbmg8;UDey)Ljc!^TFkF2Q3U(D^>zHawoMeK>q~=QL-tCmCPZ zCUfmA;(Hs&)x>wf({|Cc$+yWT7;FSl2V#jK=e+v1*$jvL@BJAbnme`_c(2s?)sXPt zCBzs1-!I{K9Z`hmM*Vd?5xK!^6mHr+bF(ujncSIjnE82r_48*e>W0vd^DFWecS3?p zyPMlqk>xBN{<{6sHwL=1_NYD`?1&a9)8&gwD$Y%lr>UGp4L8>Xtd&E2j#c}oo=vmW z)$DdziV89g4eUJt<4`+VYPdJ6G-q*bzPB2kQjT9E=qeb+rEG znlb)a0nFZlmfUXPf>c#ody!{c;{JF4n8|)`vVB-&O2oROKC+x(_fQIu^%vb~>zearrzyIwUlHGLN5H*%p4XRUJd6P7>i3_efp zydZcpze!6=J9mczZm6G6aer&i^VXGLZ+^3y-KUt<7{)Mpl#Xti64Ho^E)Hc3zY-qrDl-yOiBGR%c+ui zNJ<`eXZCiwEXi)`4Pmft0azFeCPSKW-GRyS?z)LkAzkonAubuiw|2BbQL315Z>H}3 zVi{?ZJ))Q{$|ZO{nAN?Rt69*|irc{&chzIwb;;3#sS9CmFdnd;n49ar*n|VG;cI6( z?keB!kdkEj?i}|h3V(NV!Ma8#-KM9btJJR(PKEtN z?`VZMOp&{Aw6Lm*{eC=Uu)yr^#gu^Qk%d%7Uxo|qOa_;km(S|}3(5ej6V<1B_yi3clHlpLZ%<4LRJONoIo~eL7fx<} z;a`j&Wf8d6tN)x~X3AkT?|3eD{8{K&8%$wsH0nq?T}auNazTO3UvU-`hxg}sc{K0; zM#FAPF1|!J9A0n5XSB82AXEQ6n;4ilbhyd?Ql5SrKa6bk(|UQ&bNgH0yoX+!`)d1p zbGO=AuYeDaviCo63fLUnU0lBZR`0dH3mx4~L|<5XoMg8Bwc-sUFE;Y=c%)Nxb6>C6 zA0S2XNyOrOaqT#RSQRfk+w8eMlK-DCKbxDqrbY6z6f)bjoVUT;Kx|I8Gg0=DrKL6) z-ZwrSDJfu5!RDHF^;CD0A8Rs(Lc_xyg;2fIJOTw%xSRx=-n#kpTGwWbh)h^=EeW6T zl!$*_+FnX!4_dg~So4+29fQrT6o6KBvbFoqZ;ptmAKk`Htlgb_h-}Y zhEyYFGHB)n4Q|Vp43&ZcBT3^o=I~dp!#vF87@425GC%K7*1kIW>S-5^bYpxXXQh3W zY7kzzTujDGZ}+DdFI7%fNVPC(%H)jr zH~KQZQk8w1drhcx$+8h6gb1&`AFbtgJ*n)Vt*-+s-`(AC)!XE842fF!phA9kfZEN@NX&cTt3<@WY6#(o&3mpH!lI%AVYW?* z^F77-CZG8!O?{u$2I{K!wQm%l?7%zwW)Ul$@aN@1ak(k0 zq=4{E?xIa8BVjZyhGhsQZy#4P-r-c?QyWz6>v24J4v*@f%%szZL<@J}W(P)-KqQeROQ0KhthkX0gBUXJbmC*9SZ#(kg!Tl9gK6UTL8d znB2`lszj#kB_~SU|zw(O;;>r}Qw3`$h z3_W&=;)^^EXZz0OVvnMHl5J3E+|4JYu3FAo);96Oo%b6+hAHU9cAMC|cpE(o~HwKd;9BuuM3sT#s^4L#1afEj)3 zI9Z{SZYLaxr{DTu6x`!yDkJSapnCvBmY2^<^d0)souuX)4T^ZHG=1U5P+cMH94mD z&0RO@rZU&Cuak^srSuE0m4c2~2fnbsf@we1bu@%6+@~7Ztpa`{1%`ywm7*4E1c3#m znQujOIkf25wN-kTbE)aPTR1^F180=VdEi(^Ob~H4>>+IUm+yrqGUR>od2~kae%C-B z3+2&6uioqFXy~i!P3#nQd@1(^bNv)ufl7Uezeppbwa!Wi5^Qiqd_Vsxs$$9To$WEI z>0!IbEdt+r`^ z0jECBJ!5vmJu#uOxUWt(P4(OLp4fS1zI7d8`VsjTQ-S%#_17WMbzV+VC?n}^@^`U} zd-Ec5-}TcVLjcUY4xY6bn5mo0d)*KkMmJ z%%t&=`_W~lSAk+B;1OfT12H6`G(@#_9KD<%vW$>LM*QezqX9N*vv4XfJ77~5ivovD z1?Bf&>cMAw#*y<5$%aO!ao!w&<#98U?E-E8EXAs0`c{YQ1=h-p!^&07bZ#qlILo;` z6|ghVp}(byAy_B! z0L8O>Zr5rD&-d;|XI%(i5ZKIXs&L)i)~K&JdFkwA>QQ!FoJ%^_%+>PV0FS&TmA@JN zNDg!t0922?(fZCAp8Wf%5#~cX6Uqki`MFXprQRU0#Mq*!QD%TiImOKty%kGgto1< zGWPj=Dd0WktTLq29jzAAeQTQ8liSiAL~kQQh2Yn;;5yR|yR4GOp>z=WiG&kA1S$`->3l~##qmTBG^pcly3BLLM0hm7f25RxJ@MWZ-1mG}o5NgA_ zFR%S#>P>-J+S09E3Rx42caww2)n@vv_L>W&{>xEAwu9NUiplL6w4&X1+vWO1^7fe~ zzS`P;v!8VxNs-^PEkEUB!Ts8b7K!crGYNC3?#tRc1gw~~!wZ%#BvZ%>f(9WC&coIW z^5R9Ncr=L8)-yoP_1?Ab;C;=3_2e($E*D9{t5#qQvwfIDO??5MMGa9q4U?(-vH)k) z2C+@)4hfIQNR*k={*{d;;I8s^KNq#EqU&Bnkmq{kTuvJeyq*zJ zZWwtX4#-TxJbg2Up&N{~C3GL-(D>%9&_pTeQsSibzPF9UX2d*(r z_`W`&{+5GT-|Dn?DZ@i2pOBOo|1Ol=$c%$KmXhvUAG!6wTs7~hXGm0~_F3*OcZ85# z6dAkiU(J?s4IAF+iBul9xW^8D#$&JZ6-_TPeN3fh*wKLTbUY{BD}MHIs0K=2B5v#I zOyV@gl<*ZbDl_C2Vy@dYLET(hPH!7ZcY6GuuFYr14x++CmW(Em@wLgvz-;{U=))U3 zI*n)DB%hay4JipTp4%rgp0#<`dkd{{H6=bwQ_f*Ykc&(Up*VK#dJGa!=^x7 zO2YoH<#X+9IOyDbQ?S)>sT1z5Uj%^D^4yn$!ngJ}dbV#4aTvX@xZSY@tHo?*a)#im9j1?O$QDo}Cfv@@_e5?kBFreu)T!+!8%oO@EZvyXI0Xi4UwMLX z?ZiLQG-e=Q%J-#0X6kLoTOnb~y@Ecs1bE`2`JF^tqVLXSsIoW|z(%7F#qlblzb3aSF9 zZ`N*me?REFGc57bu^I8AEcM(aE zNP`oxv$G>|V@!Dyl)~eN14YVE4!0k#?za$(_;nh2RGqob9xOdr_0}aoY1(zYk<6A? z_nClAC3hUzmdOh>xUL6l-g^PVn5O=lX_R-GzHq369`EDWgK9V==Diu}2}qL`N+=;?||_9w`z*u8U7W(M!=e+CFpfE%&j6F}A=3 z4+ue4F_+vMI9~&IOs?%za7*IpZ}XWpP>a89|4MVM`?#|&$Z5EXCWpig? zWEqF$yA(|tbUS?4QK~hSU0Vn)2Tsq+pH8xc0haTAf>@xGMORjrRu87rc9&P-vjQ)! ztR^qd+-QKto9*QuLWik+GKBk7iB{t6Tzjzm1=!uTRA+z$fPuqy9n+KF-os~U{h@ji z-7hFVEzj(^@#G{?y-aLo>BsFyF^)CeJdKvAsI$&JktK;wQiVU72;@zRO0X#sruV-I zX?w)tBM*>>RK8!)5i0ViveAzbbFQov(tS2m2#B%41)xv2KwQYLT;Wt?p?N}E^E7%l zO0as18gty;cEDb9k4soLA3H}Ms7_Cy*jQ|_oM`wC@!1QChk=_KU%B^p6h&#FOi6^pLIH7qH(*4h{Ki;4O9v)8E5ug-?$_ck3m z@~BZ!;ZKXqrco>V;#KC1NB1jT@@9P>t4oJ^L~OdoZ6hXAFid}W_MUdEp54~3!bVTw zTrw!K`Kh88+uC)!pHHv;*b-n}tm4g(lB(*ib|HJVZ1fYvk9@UFgm)j(!o`Rxcq3;`HWcyDaBfZ?X&)c3%IjK7+Z} zD(mqIJg?3B&1m|Gs7mdr zp938=*R#3lS!cJkyOEp=l$q|h5I~(lG|cUEt7Tb2 zhz!{x3ZE0_s#Cuft3a8(xhmSrFpzrl-eY}e{NP+5Mcp*+nz~Hl|&h#9GM7#CYn3Ge-}&Ri~YsK*mBdQPI=y$M5pQs z{nrE+&OV}2ucP`S7Zu#|69Gw@=I*v{jwZMJTi92X=c$)rTeaUZ=i}5udbouv;DC0+ zxQ}$lk@{ty6=)q!S^pb%AdvES6pYNy&h zeTs*C?t5Rd+iU=_fe>|H^;uKqC!W@mX+OVXd;y;5wJv?nGuXkSmJ8EG5b-xIa_m=5 z{Oru5Ny&H*z`B7yn4CF(VImN|tBLpk zAkfi8|Ju!gee5bgUd+}Inp8D!QErub#iypns2hX?MW#G6U#u7Pqk?~=7{ zFR?6|1O9$N#$vZzUw1<)TD%)5mP2V4jxClBv?=1U1*)v|-js)|LqFl=YRY2gDL@6% z#6+Y3_UA6mgoHd|{k#7w7x6rsAo10|v_wBXQp>+L42DKk5&!ZI@C5(k(vF;jgqgD} zf9h=%`1p#P_oJS3S6OlKTJ!L~FBUuGFqG!zjt9KL(|kyOtXcF=vT$&SF?=f{67!J& zOuIMo1;oJe-D4N_G7^qDFeYmtB{q?rwydx)=^^)V3;mDhJ)}PVk1qV@(uj!!vKu`I z2MsH4+OEb!&V&Lm7LYUP??-;fnd}IO<*@Pa1pn{PdQd4IzKZo*+}1X-1>gM%MK_x+ zFU5cIHxwUmfBq-W^8cR9%_u1@mQ#=cIn>Q&YS3cLGmr`zK>VDW8@J0t`;h6$X%EUR z2FV*tcx7Et^oK!GYqo%nrrbPY(zS=*-wHi&5Oo1pzsuIJm=IVcoZr^Fx5bgYu%)D&U)Vk(}f|RsYfP|7m zqV+yad_eVBWbL|{m~h|^Z|-5t0z~Xr5q~B*;0$t*QQ`)~X|SgSK0HjkEAC74hSBO- zTaB`c5#x^UkMMWx3g}C}i%sZV5*)$Nt2#0mk*w>e#~beh1AZ8@y_`2&ULM<@umL| zf1RhQrDjXU%q1U%i5fq6q#J;>V+Hco5Ed~pHQsOaAp>p3>x9hvl3u5hSe|j1y%|Xc zG^x?tE1OkZD}5DH{6#(rC%*(S#R|<9^eNMf`yp)>|^WnAtMJ* zKd=t_FCEx^5kOb*Gz(fMsCH_UtVGdpZrer9c_qp6F2(APREm{&8)m?we}N4b!DQ-5 z#kjF(;F4VRXv7s8n>3deV`L3?;4xWsxRQLR3cuqYdETw;V*WPjuG|XDq@U7U$&u$a z^xx$;p_&6m8tj^C67;sQP0R(t4hF5YEt!@{hxLqRZsiwx(^Akf= z<3pce7;RkNY-2v92UD*&hY>wP2T1f)j`lYWQVU#hP5pss#Z|t%)8rb}hf4p))HL@$ zu*TR*edWX>`57t&E?UHLsOZ)3aZ9ba-kOxl_i#-1NWM=@Erf{tt;d;{vH#dbDY4)xkY?j`q*@9IO%v@WN&>vYo>;jq z=WWWk>*#vrWy0yq*vERcsGk^mpBUz*aPqfwQRjM|;{_`}8fX$`dT8_mXp|2$DjPrR zEqf?v8#kq6brP8{y36WpTI{Kc`_aqz4^DKSs2eUBOw1*ZagEclaM@KeaOEWrr1?GKQSIK;b(-yr#=h z3dLQ*7Nh8tqdmcH{HWuf&9D>P({!J{Wayyp5RAztEXSd0Mu~&FWYboPw|`rmDf}+) zxTeHRjQ~LwTTp=OoivsKeWIgJI!InYgnTDH^5&QL9-nz9B~& z14<~6-(gX&j7G#`YC`5DH&kG9#NFao0|tAI12W9tL7k6Nu;?>rcrgwMX9sr~J`E?` z4r)e=n&ylsWUj!Wq2b()zS>qw6pxJHrwLTbuGO)#AO+)*uT1SVl3mgx@%q!brElp! zaNPo)bp)3{bB`y0q`t)R$CEl%;jT76eq%0Zrh-XK;s@GDo zPumt#nQ+3y0!(rAg7heK?W}}{QyF^K)_R!Ukvw^DpLqQY;iX@?-gfYi>A_fFVI9F@gxLNKiK!%Vlmy3o4X?a}mQHK3+$m@HIWTNBu<`H#6 zYcEyo>iIs1HzRxuEScJ6yrVVcut!>bjwhOjbe8r?9Ua{s!;TS&Ws6*dmqXLWx=9!$ z(*wPf+F(~-hJJ22*65Yue$7{1FAPL>bBLnELb)_a{3)lbSE{pci-#$Px7RxEI10_;tBy9%*uML0g(duB|GIfE-PDUN4Ag(6b&W^8M6KcX*7)2Ft9;V ztTu{JBGk;M7=~oiX@FgSC~mI250vmN8SAQa8KXrN0KPHBc z$!=yS*H9Uqwt3eDwRZ;UmUoT-UWM`sAXWPS%&;Lhw+1-=+~Ud(#IrA?XU)#qrWJKp ztvD}!%VQDeC2+7#xol$;sNIGr-S-=Q5bs2Qo^_hV=VcdGixzD*TNRgqN~?I)@qslD z;3U4m=9+8WJ?jbzZs7;GdT+!F*=aS1nQ>#@&<=1BOnrjMn^#5?@1WZUivPFV<5xz^ zC@_R+oyE_=8y}>^C?Zwf1P3z)c$;T3M)#q{z9|afSn+O&c?|v7GGt1q?x{nnObZ4$ znD*c`NhFl>S0@*Fuf_jTox$N^EG<(i?q8*%c2JQE9j!#c%}MB)9klLQ zIpaZsc5Fw!(ktg@v|Hzs*t%vU+JBkA>(;XBmE}Y9)(_R9S~*QH_D#?wVm2{0^-k@V z@&Fu7$)&LRE6Q*x7&#}5dtIKOda4T=;F_8)!i-FiEzoViI0G-I-{*-fN5cn0T6!=g)9R30Z8GW>+gKNg;r4I;15xNF(;{Pp9ME>TjyeUd_q6z6h^ zJ%A=SxU6yM8Q`$c!~RAO(DQTCn=kg@!5mdb_LPwgWA)gD_t$0ED*D_+uUun;>_LuT z=<;!RV2ex+T~UQLPOsG2y0}or-NgA_sP2gTl_Y4&KUH$=lx^lr6MwF^mkQmJ?CBa^ zAXB6L*f2U~k{+T_ML`oAEaov2y8+$C^FZ&^m}kE}1digKcqZVMf0^j=Pc$sKa#OPE zt!~1on~gGOOZOOqN(v(qbO||UvT1C;J%#4D+0^*vatT8ihq!QG{4Tq~FfuEV#KU_L z$C!`v!JicyrH3XbAa{r-Bp_EVQr>}`H$|?#>K;i(x+18uVN4#cX?=rR*->M&k)GU= zEds}{O_)h?f>k#lucTFh0k5~W*KrXgFy;{O0do=`vh%%by7&P1(maMX1SrruMq8dq z8+jVm+=LZmEGD9_n>TA(7sMEltIl*BNQB&wc)RTBwK>!dM}d7Wf%h*Mi0at_58P?M_53&-94Z(x*2Exs}q_4Db&GBjcS zgf#Jvi@Ex_XecE3cw8@3)MwW&3-fDIK3h8acRxY%pB%W&b@{2&<2F?|Ph?^Gu5ok( zQ4%@FA8?Q%u4`eig`dbzV1#t9IQ~qtb8q%UDh|a&i4EN?JY$NL=2D{ba<(;=2{)foI7U^*1i5!(+u#`hInQ*3GbDY}`WdA^@r5ndbWwJ!G)K9);=aDr@_bt+p-6&1+=~L zIy-ds(60@Lu$5P44W){!cVBNSl!x_%~9MJ0Sm^Lh|e$F;Aljq96ShHRR0hHQwe959) z@zO3i%YJR!4x?T~ljYYLDo(FV2KM!CfT_{lSFWzRkd=3F8js*bBl+Kb%pM?P6jCyx zUtF0^+j8M>6UpO71ZA4=h)uuN*Ue3;=25|<5rFlficInj?J?%_Tfb(fzqP1X+^}u8 zN;;xeVIun0@H8T_0WDOSE_$OmRTwt9DaEj^no@{TyH-A8?g5YBIA*AbqKU!wR_v%5 z%+^7tT;5~QtPKD|eDm6?g+!Z>jMyu59?R5P;upVrte>uaOm8UVvi8%8?tBBarl?^eGKt9HE+;E8UUqNVLwE$>M^=N(@chCK%#|HnQH64L4SFm4b zmY79<<`eZC8MZ3BM@v5?At|AlSMm`b<$Os5F>osPh<7zQ$N)VbR!g<(&>&WQ zEbhF>0_sn#026qaFXR^=y4px8?k!}G0aNplq+YvIZ2gT%;+xW}sA#iKpQy$q_9GvM z*KgqY@Xyh8bzR=?e*skC5w4rW>IGhhx^u#qupQ*E&R#__)OL{2>NRj#ki33}VsvWv zIyH<53DzU(wD?8%8!S_=b?)qufCN6*iLbSz5*jA-4#E*W%n@Hl4igg3`G%<39MHE4 zqa@Ptp44~nfcNiODOVRK8JfasO4uy~q73U-ITK94Dm42|Ylc!Mgx=9&nEaXD3>oZo;63_h3% z&3&<8teCg0eI$U_xN4BjF0Z8jTZgUN4>aJwJ4p+&`@Y-m7$#c89&8vRtRBpJ&m252 zT#RpVV~LS{dQ3gOi_spI3)i`2=v%=V6@|X;HHsy+_t0Y+YdSw#7aNfpHuWvbf-dV|yv4sy5nTZ;#>58X=*3NC3n= znjtRtN1U*Gi~zk6E*@@t>k9QBw-TCRS0$oDF<7iBi%L*g`EER9+%lh{mlPiQ8$FV~KQ0v`Z5hg9;t8RucuK5jSx3b~gx~es>8=h{06#~Bu5jcl@_4)3_(G#iE3@L zf6^Y{qcdO9+&;??*Ev0ysSt&txAorm(9rkvl_^s8ne|??ww~`c6jh{*_-HB@(hUbI zap9CNoE>`Hy(zwZ7k9aNf_Jh^FvgxboVA$!`~}_>USenml?GO&3jC{#rN+FEQv&Hw z=jO4onb^sa!qWI_Q)A^p7}pQ9QGsoSKrD}bL{=b^1uP!euug=c!e1m9rmC6u%9%KH z8zv)YJf7@~S5bf<;a7oygk?{*!!Y^n6SF4f+ZwxEyrlS-<317f3A;4aoEuIavhV~1 zB-W}y&|hv8-%{R|)@g;M`GL1y$lbRrOMS=6$kg9}{W<`0^^9$1{S_@b#)r^_AB+;- zMt5%7w?~2d9N^iKP;bcg$E%tC?g z99$FL&MR<7Yzts<2vV%R$(eLM^cd#eI~&)GjD2jD&=!(pl>P}%pf2P>f;yRXCmWSY zw?H@7`H)%Yo9G1B#I1TC3G2U30k(GokLJ$zL!6KJ7aSXujdhYhqsv@nky_4ER@>yx zn-$`wk0n-2Y)-;HF+*rrH3;{K`U4B(uhkikeAMux_K$oLeY0nK5ORPXZ%=QpVG!_3 z`2V@N5!-wPar7+_(u`$t9|FZFYEX;vvoG|uGBe(tfY(5ypbL)xci(dZ|1eVJlK5Pj zA3J;#mcU@^{PL9DKjgw)DAI_iqGyc3CKHKjHC8(9{4SVtedRnU^MF4sLw!UVMTr@$x0We#fAZ)(GrApw@Y$9}kM=INl`$s#+;cstp?oB}wyfWzDTbF#dZ}US^Xbu}m%*!%rYpnt~M$zia%g=~)&c zvi$WiXQNL#<9BxYl^~!RUbn&%(-*VE)IbHt5&ios`AKH=F;4ZpkhMHX=G4u6X6D&sT zr&1x#iwuD=gnOd{i&^nDJnx@vE+unYkid1)P4ok(Qgtbeg}Y>)VAyC@_LVG}V1CHe=FhE2dd>oxzpd6rzl<5D zZ+3$Dkxkx?ur_f}(Y(-I_e|RKuB#r{$|i!KR4kg#aRc10GZvb_R)5`nAVID>>uTn{ z1w_$?ZK9tV&Ao|ToEh+q(+``E*i<4}Tz|kMU5qb2E;`fJop8Jqg?kli;m*sH6T7SD z7Cl+F{?Yo>qQR4BPp4vvmKRM@>NJQ=l0LG~TH>o^r3V&up!b_x9sSAvS^;9q0WSI; z!>U~~=G5MeT$5NFQRk=TB=0eiS{9I#!XNXapV7dURv!72n(q{i&jmWFdq~RSZ`pp} zI>YbhPok)v-%n<~<&ZUZ;{ei&d3L%84Se4x+CU{65F`+qlOO<5FP(Te2RC6p}UmaZ=)y!GpXc;1ukz^6d&$!X=xZ$o2I zbKNv^<5ZfK_yAMm1B(n)O@zmwRT-7RudMpzvAqxSuwysM^5i&XFdMwD2klQ!+3u8_ zd#>%eipd}y4)iI6x-)dCq2CuwQtZXw=Q+wPf7EJk`R=HvdG{=?%8T?hr;-{5vB<%+85;76%>6VysNeIFlD1T(zCO!-^Oj-PhPRNa-zFyH;(J*^R*g? zSK&+~Y6J zb`Ry6Vwrx-_80w0enKxUJxiHUT&Lgg1EP8$tY6z3;u{*v>f2X7C3<`>yhb$DQ9b38 z=r_Sh_$rV%MU8Ep`tuY9b{!>{IKYj8+Gd#io*G3$CuMO&tD``ITjLq@67Gc5mR|yo zD=cIzm@R0iHZDZqc}CyvkiP8>;kx{1jE$bYTMhE6@|ttjWFq$|X3STet1$FrsI!EB z9&lJvtHX9nTjN0X$Jr_z#^G!%Ttt z_j$jMUtQhw@FhAEM_U9Z#Uwq(qPDX)4OHtyIDgjB2ByL_Xkz<|R(W%8ug%Ap09aQ6 z(8p#Mat0sApc*-19cD6&RWY=_mqe!K1sNkw*awsVJp=4Qjb(bCvX6%IW+u2jFF!nn zB*U-T=bROoQp8USPsnpPew|+FiA)deKO;gnFPaco$M6(f>g+$#c+($Pmhe{cYu%jJ z38QtvN1=dkj6u6Nq840mP}ZnLa@O`5Gq1#iYe0MT4E0^5&aKVrAxgq2q-K17>3A%} zu2M%PCGLs-FI5O(kwyejW1~3!BPy>z-n-(zG&Tq8^%@2C(_|RIOj5Mc-`bz=D#DC6 z9j3Im?|6s$N{zn6rA`@4ib&7&7<>?8>7cVxQsfoTE!eZf?)f$&?JwQ1G~P7IYIV9> zQ5U&*d~*OtjTsyqdJw4`g@)8b)RDEMrmC98PK#P~NhRikU{2Dqgakr9RNk-f&Rv6p z!@U@p6kk`5O;xsEW!{x^iH2D3i%iabsox;ADFY$urSj-=TaMDS9hI;6tJfhIN{CL2 zYfDK*WDcgU0<@`d5b|Vi~`kiSTvqV z?jfA=;e@@^SW9P`=(FD9jLJ4{%NW{lg-@|$8&k+&_|hJxxSfumrrS_A&E5QG>jb)f z{A7YV?&TY^k1yo%#tlc{a)gcj6j&g+G=6QCJ|;LJV12y6>n{OyHHp~(k!TMINjOV{ zieA=?3%yF2mNvkzvPRe5^$Q*wTpBLWmvwCXnFSA!O8j|Wv5*nagij^XA@+#>iRi9Y zLOx^skJ8d*55mg_dNLLboI?x9CK%EMlFBoQ`n)hJMt##dB|fROm4?)moVK--<%@w4 zH%NC+2yYFOSE=rollXEof&9epRg9y5Cy7}ZX<-yPWx_`@U4XbDK>xr6;Wq8%;E|hk zf$>6BS9jW{%Aeb;JX1D#NKp1vO=Z@GuVgLekpZ_D8_*17_ z%fivsWFhN!`TLm@h~PhNLhQv57tX`r?H{$I=^OO9**qM=U&DP!XMofJEjWbx)!?Dh zLnNNh#mjm}x{idf@I?6`MysMjZhivAH~-~$kj6ZydI6ju7E-rR(M0bC_Lu$FvutTQc@8Ts8raQX5KXU#MBZ37*de z(S&VeI+Bh7aS%_DpOWGhnCsAaa4eNT-J7E2atTDIE%9%R<-WN-(=*EHFDe$lb^5*m zPDLdADPRi&bPW=YCVY+?cj10Quohr!Vp8>$MXWdt?6a3^y$-GuySt6{%+8}f^Jhwg zZn06Cyp>gML{KytlZzMLqk&7xI}La-m-sMm~>Bj0}`=Wd#=v5&Rir$E%e_)dfBS8UX_`ckGkGxj{X@ zZ}mqX3|F(My8J`gDoFsW^qV}GXxFM7P~ngn!m4AT*c;TkwXD3?1t!557Jk=Plk_;U z!GnP&Nc4_V-y;fsAVb+Wr-#I82iLguK?r88Z{v`hro=#|a6T*k{n}PF{$R2-*TZ-~ z5yIJ{|9wz??PJ4QQx8P6cMTLS8o;-}rd-H3e(wp_IgLb-m{vT=GJM)a@NlRe?ZHIB zWJ1TD!`lSTB8y2e6Rv1k%esrRa-4){Q6mPRR*cY*`vp1Rg*C*D)E7 zgLFr~6=Ado7at*X>Ae)gj>~6D4eowO2>r$a1tMGZ$^#8BS#WZgT%~_q(R{JX?YWZX zz&|zef0j=;cf}7>9e@hDP|3WdKiB-=#|f}b-aMq}I$?%{tnVJoYlr{Aluuqx^qUa% z1~gEE6s#WYe@@bqegr=$pmqKGJNWsKi>3IW2r?l0qJSD0(`qf&#H4jXJf!D|G6A?q z&%ODD z;_93Xt?J(<2)+Ls&-Ky>l+o+Yl1NN|%H(%KqH$m`8k$WE*Ct+dL@*h|d`R6kij#RYnpE2!QMK&1fZB}1fNfRkL; z^M}5T;JB7_=m|Ik+BPn&v`+xn?>+qe8+X$ssx;^BBKxr^y(i#P4@d( zC04O076Dxcp!w%7|6hEabyQVR*X}nWT`CRIl1hqnO9|2v5>iTcH%LmCG)N0bBi)F! zbQ~H4q`RBDj=t~x#vS9{I|l!t`*8MNd*z(Z^P6%|$LFFPC+RX1-!TqeDrL$CHgg*O zje%Jk7#%IEgm~l^zj>fA@)vfqiIv0I%9G^bz+MX4Vq2xHq{Be)NOpKv@T#{&JB{nZ z2(VVxL{PLlW-Hd{m60lX@wr}RD>wmNeKU|52QVl60{8)}((4li3<9!?-{6q||r=EAU(tvBtad1Q;1Hos@id z?F+8$vkxnj(7;Ia;t)+$&L=o1xFmfrUD_#=K*H$P{x<(Rp|4))J8srrLR3OPE=jY3 zgeTXsKeEvMR`8$YSkV3Z*>?X#{%wsOh0i$ zbm?;)en_di3wvmv&p_Q){HgXh>NRe2N5HOie3KJ}{H!}YJU z;y?YrrFf@K&c=1H{i>P{d_Eo?WYMNdaCujPVO6zG5su5~>svdI=r7PESr3H6{Y`h| zkDdW*7WFIPX3!#yF4Kdo48Kx`<&}^^J2rPSYCWeGfNSt=1ZL^9=X<|_MVDR}Sf$-hjlK)^f;V!wNeX(qu(l+07)=ieZO5> z_v?Q*t@Q<(h2DF~N4{-Ti*0FHfprB3c5lTSN>~1_)yR^8b8@4)gmK=M%GYnKpIT?V zd#o4IG4N!i25hb+spr&2CCL9e^iKC+e4a|GI?sXYpd>c0=Q)s=(-0EEfZrq7?NCIhm_gYRqA$>*oOky-op0KfHCl+uxfDeyw;7SEp8m3ljT%{(8 z7HWZ`AJ}}lRSQ%TEX$NP_{0?GVk`C}Zu`RZ614Y0$cBCLL=I2R+>tL_bEi1j0A1n% z1RU1fmYYv9MJQum)mYC=?>-G>jfYwfa|dI}R2d%3Iu90s9sxA{-`Ao6$s*E}a!l%R z)0+dYxF`b=nk8WhR+)&+5f|}~A~x1$Vs4i0TI#=(lQg|m%VN|?afyfH&Zt++ft3;o zs!>QAJC!2;6+f|or6APs3`qW2`@X0!_%;J?Q2%8(y2Q}B(q9At80TP85CFadRcTb{ z*X^hu=(z*iMc}Oo>t1gGlSC;DjgMR>`3SFu5xY;xR4g+T9rxbYHQCsc7P<^!N zPkqdfe)p3#(+2#0$~8zv5CL#Wg03RZMMMz*Z~&9J!yCM9y?K4e#d{`i`}zCS_KPLm zDcr6V;o07khhq8Mc)Eq>QdLm~lw!TQ^Xa=3_`4G`V9(Y3%zE0UM{Q)?r9rG#(lX&w zhxT6V;M>b38Azktqd+oy_q0y_WDGOgR#5z_Ixf92{}aXLD2YwD)|` z7p49%6PRlz59h0C2L(QwzVZ$NlNRv{I~Om}-)F${jpZaf-@FB=CzemCD(!NwH4BZw z>)`^Xb#T4B5q>4Vys&*I8CYtvrE(W1>BhQtn3+o1P`bJ=ynzPu(UUV5{%?zm^pB29 zQ}ZIVx#kf%{fQbUsJ(v}kvO{fsY_0P1|EMJUkuO%Qy~cml!DAB(Lt*?vg9L9y(k-@ zw5;}y*DH)%LSK0Fx8;Ow2j}mAVd0hrr{9>~hUP8+KE)p0obBFRk}4}ZJE_sRhv>`3 zFvg+7U_n7a2(594h1<^?&bAFHyi=T4JPt|+1*$%!$^mzt-X3fLFO|2ic~SBMtt%Uy zCnp4Eqfhr6@Z>1?Jc@=*8i8Z9mVtef-@@t2SqU61!)sdrE2YT?c zkZa+Q%%E~&VAqNHRc{j0m2=!a5a@berl_J1UIjng^aN-jumCy$8*lNFQuUL!g`&2W zeo7paZNP&_+0$9{YXdk;yu4@VE&b+f4M(~SQpqC)Df2=39&2a)_526kU{V@fc?=}eQM3xfT={pYcL5sa6?;I zeQJ$x*Zsh?-6`m63MqVO5HQhst|ptD_HT4`FqIcztIj_bQu#r8IrZQ9E7QH1ugWB| zs`z_^iG8k-XZqA7gzq#bPCMB3HxWd|LO%ZJ`=h=0SZufMxgmPeQlriA5^%spDK!EM zA=os=>ncuG3q@+;i?L{}#1VwP;HOWx0R*Db1&S4Q$uq z?m@tpW?imq=&gL4}G2=`D+4RL(-6`-UL-Q0GnpeDJRSF?HeLRV2qDG9{nppekRIk#-m zb|S8(=7_C1@!gF}1FWR#x`=YxO`7 zIn{^Q$TJq|4i!k>!&377XjQ)lo>`y7YqaD0l=bpG)hi3V4%fs#>@@clcC24C=*caF zSwXE}C;EQM_4Ea}!8}X_x=7&fX9W}4ReRUvS*R=UYVmJJ0Mbp)H}Enm07s!qA(e?w z*JCx|yNXo`*bQ(v$#80sgoTajfCB_T^XyL^!~$LhoLvPr;N@TxU}R-cgY|Rw{dLK_ z9_WvCJ4ZSchoNrRJ)Ca)lH6`^1f%1MWEwEw1j+omvk?mlaIDeccwAI@`%1s@E?ykA zrk*x@JH4Jr#Nz6e_^scFG+sO7$CK-`&Ia{T?y}z@Ur;kkz<~zDkdWL|aD6mrH!Y~| z|5-tR5;qaN2)9o$9$inbmksSW2>J&wAUK3$)5EUTv}_K{;NheD03CODkG>reSu3cJ zHYbDd3S+g?izYTBVUrN08nx*a0fH_B$^U8vf|IfPKXuyj z4yoMNuXGSYVbM*?)5`IleT3T#wkl8A*l~1786k4(1{kTl1KNqeAsHj<<+#Am#9PzQ zewNtEmex`xp7U~|qZycMmy8^}%Y!GJq>nM74#abnPwYZ;Ff)Xozm>NWfeZr& zZtB_$`xgONWavqW4w3k+ELt4LQd~sLp6@Nin!?5)g8)0@Vj9@mK@L)3S(L*h9DFl+ zL-T0H(=)gSos#^4|C$+imri+jD>ULV)jes~>$X(F1;*X;9k6>>mwnC1v*(tu}VD0sCJrrZ`aZNS-IYtEDd*4;pfae}2;o)Kr(Pi~d z4OXiQ;gfsxt;PB=4~U)Eudz$kgB2-OY`;FF7o_x$TAMFsipy0`?&3x9a5z%MnvCC7`3inDyrf`c^ZJB5@-X&lT<4U ze>*|VO-=H&`xGkVy-ne;MH%4CecOih^%npzv`1q{qYjRMpaQcC35fOq2-Syy)B(q* z9({3qqd~a@5K#fa0xr$w>8V%tbI#p-g8`Er0Uvk#@ZfU4x_NbQKkk3SGxY7R+E7nu zNy6R!hN=Q^7z>}5FqacC(y21L>3`B@igviYR4&$c4p5=_J-1|0OKbWdec|>sT2s$; z`VkCUg@mR<`h4HU-*Eatn8QQR_uw>6@2B9-2tQAd!V(fm$=Eb$z@HMMCUCyJl&z{i zNq9{6?SixL(Lqpw_(4V-7jc|jQU}O6Z-(DUX>%!aC!5eiP?%ycMMUOR&~i@Yz>~Zj zM3Hw^P8LPnQnEBa{M+T|#12=;q!<#diVId1iyP-8a)z(mVMQ-+jxZODH@WrbXC<;{ z8ps){W>RK#$~YezP~k{^>ma7yNz6pk-YcYN#TR@irV|7Y^UmFGXWP>mqbR9D6w%B- z51>Ln*dr7kb#v zIc8pWxG!MtzySf&A}c~6S!Lh9?d`jq7Pe%YUe4*tb!}QGBUn#S-gav|iv(AB^@K+u z8Mh!a6{{JSYnYjtKYdz=un3^6D;Ki4xwNzi4b5q2%Uxz;W)Kl4gVmzXEyMcfxK5Tkfms5lgDvTo7xy?Xyi-!5x-lh{ugM9=>kEZ-};&V!9cQl zq05c#X>*X3R`nt^65{%|XTO+Rpabzjqwf-VqvdxNW*iCHW^26?_39cLe!Tl8pdXTQ zA^0@NlIeSEEdq0@fQrj$LY94={F*cQbd1E|q}SVA<>>{~jxr&nOa-`Rp_fqiR1QvY$%mu=7ye0#uvhq3?0!n>eQX&>JeM_Sm2(dKJkh zQc@C52Q&;JZdb6cxF>3LK4;2VHX3iXq|YSNcB?q*FP-u2Y2l&DhVzH{SMklYk07;Y zx*>THKB9JED|}*)!sa(4Y?~^hw~{rBJFWP=K~PQ_h$va^g=F>i_A30j^H|>>c5>Hh z|4ZUkkRvNVMKe`{o~s{C&{o;#7844O8D1-(|R#HePRpLSwmwk8i?|M$!M7pgL`{PNundJZ6X=}JtXRqUG zu6os;{)kzdBa0R3-2T{?h!SIWy;pF38HjwCtk!SSq`36p6XXX3<4+muuIJ8zglC$9 zZV>6{!YKGHH&@CxYL2%Ex6G-sC9@|?#!R#I)mFoRLTc2^QDSZ2?tHWdFlGTqR~vBw z44!#+g^6O^PJL%qYOCqGnO@y^LDsG5-uEbG7WAasP#K#jJEzzHm`hg97()289Cm;9 zj4rHtE?Ct7VAMC~AOh3?F)lqh85#eDyvI66;oDG449E@ACQOw(0id%&k^mawLaR?( zNsAeGC%CNf`SL0F+OXHezom$Y!zBeTs)b)S@8CR5VEuro`)KGPGLPK34Xe7VLh!_d;f=QThX|dd1nm3S*xF9U40XO>p z7|Ox22O!u<$$W?N?iKsavsa*XZ%2FX+_%VJ!i~*G>abm2hqmjwvjumY9)-;2PJ?oz z_w%p|bNG=obgmvMb6lvA8q5B=?)BDVFl{?FTyoUjxS#G@TI`BF$qj{apo8r)+&F(i zmX<@jSLlCp?2_wldRXNl0*7XbkC7v|i0-K1=MX!dU{`#5U(eLhl- z6B+exl9Tf<)gXV?aR;t|u^_-^vhp%7+)_>e0P-Wi;a;a{$DdVIw!5I1x!rK9CHLOe zPo3Dq07}$%|ETCIB&$mWIs9xZSdb2yeXv?u139K1W%I>elDFo}UCb;2l`GxbjuR@; zeDx}Hds|K&SQVLWP=e!tepz2G80~$x6(LxC`+IGnngNX%tAjd++Xe#F17fMvY^a&rP}xZ&p`RV4oA3oz`_fa>)aeH(k74CDdQ(|7e)Urvty`8cm3iUs7zCNHe?mjkO3yVpHS zUh&1qZ>HJidld)y>R1QV zTlks>pwhb&+`+`w73swdk_=xI-O~T2 zF`dJy4^KwGAaDgSdsva%LmC}_H=yL%;duiAe%roycFxIfc42B zavV-NVL)ij+B&c8@A1*RN%r+udum3;gDqBJLzF0i@^jb6+OX_0;~JE>&)P=(4$qC{ zh0pti!W=yP6&bYaJT_puUIYZ7hC@y$%%a+6uEZyxsSfo5u;MF@JK~NAS*W9TL6rdE z+kKrdhdPd@_ML6kr{IKw4e_F2&vRIf+@@-mkm4t@P3}Czld$yMYZsp9u4&Gsdd7Kt zQ*3SJ=1DeRevzD$^RwNR7j$eSA6$9`xt6UjVBiBU$l5-FavKW<(*d0QGjQv zxw18w?^&5W$x%uiDX=y7fzK2m$9e#=+vQk;N3@?APa^uGmJi~lhic)%LjrR%b?Y~V zB05SoUu|xGNUX3&+&`fK{b^(E9gpoH-XgQinIfkrpr*pu&cI%35U{{>F~)$f5%3^w z76iY82;IcyE6C+`qpPV_r~|;Z8ToX#FTrkkWL!@`Chh`YfoOf9^6&}t5vhZ!oa$*SQ9>Yw(SgT0W4b0 z==+`1G=C$u7JcqBmG!Il2;ppGK$dwL`>M`LlYd$=imyrkH%(|2-<-R(^|6&tE#QCy z)F4Pue$%|S4&sLhaHx?Vv-RxpxgwkcUkd2$OVMK+ScA+uqE=k9=+QT*#M3;MoA1MB z_`1G~LRY%i;)Sj|y51+mr;QF2^Xx8Cg~cwwxnzggE!EyaKX>Z`LM>pxc8n z7~C#jk4B&G`cbVg#S13*WW@8bpzB{py-^1r1szq6NSFYcXsWl}2z|;JvQ)3s9GbNO zVvq0?4#-SAiT)cu?Yn^Im#-N{a!uSWbahR+N2)Z6+)r=UcCQFtH`8o^)VG5hqN~^M ztPYSW*LKZMS?_PT$XCV|N3-$1q|-4%&Ci0}f2(kSSq+7#+PiHp^o7Z5R|a~kw+ zXIY*1TBTtvz|a9NnecvM8aFh3;c`C6g?1Ag)2RWzwhTqtFD@D?2!+}k&Y*{}C2V(Nu--7YWRzLvXsPPNM!PPoGVcikz%gih zc+wiYh@Gh`3P^+P%nRZHt-Vs^xW1{lr#E!3aMFYvHj*4mySM*38k;~I6d)D{B-`% z?m|zigZY)8fO%NI73;Gmwds{HCTgI$UcEoP(Q_=76qWbrNcGWMXOd-n_@q9tGb4>~ zDm)KfqWoL?v>Os>eU@_9zN?kC`O=o8w74mz3IV5Uz}Lmb!T2DB@e}JYIMC&D69EV^ zP-6gUZpzPWFuzQtqeuWi;l`?NcpO2r)`wythVLXcfaU?nPehh*S>w*1tytbpVc%IfcyY=0>4*ljsb2B+uB0|54+}%ELXs^zb1EP(&7yG;CPZ6MG zi}^|6!mjXxtjgg6u%e!Ixv#}AntSd)%O2g3mWtM(#>!z!7|I{No4o9dJ2Z#qE@nsY zDZKZ&_@P#Vav;{Y*P7~zQ{$$t!5E%MnD+o1{m??akI)pP~n6(OR%5l-fK=|AX5{8hqiKeU&U=m`PZS5its z=y2#7BTYbiX_j z{6e7SP?G2|3p!b>am2MvM|v>ngWimI9&hechh%!E5c zqUV+FBi^c*T)W5Q>ehY@wQkIJwqUUun~sC92S}H7-XC(-J&HbH@?@T`(s-7059p-? zyI+j_DZ5uVuzOujJ3@v_mxN2WQp`+`97-6F44aGMLD-g`beJzYh#yJ`9L^)%UJ(tE zxrQm3S&Pr@a2t&>laLQ;r8uW3GQ1z;0PAGE+m0KQ{$VZXf4a zWTo+?jBYBGe(RA>NY0PxTvZ&GX1^l2uMp(C(WGv^sjizd75N9w&^g6dim{g?63tz_^Iaoi9p$A;7C*<4(QcYrmAmZoq}~{AG^y z-q#>+Y|6>SVY!9&3&HI|x%Yjd(Gb;It9JMTqS%MEElZhNa8e{ zUIEJ^kcrfPCqD$T5(v!T=ljcpn-0ju@>22sAUi&LxLXZ^6{9C|o+-{h9hrlH7A?jb zc~jZUlbCeFuGYvncD%Y+X8k@oWU%6kB=hnz%BA#JW^5DFeNgxA3$`)jRa7O}=YNJB zwcyaFJBE=ef+*tuhRs={`$6yH%+nwB3znqz3nHbC&s}}A-R51-{8AB7K(4aH&{4(3 zq5h{7wGPBH)LL3O1hH|7U)NYUWD}TK?!|GMS;|9HK8lK#^Bj+)8~K^^TXlB^=oKcE zFjMnu`fII72w?i3>W)H!1uLu! zd1M(DY2sorvsC^|^1GMPEu^aoGU1$v>2WD|VzC=fBUBNu#wb+MG4VepqZMTKh3C&oE9z$g!E;o_5qcd|6Ne1M6 z@A?2gs#+l|3e`Kb=}ec~Thr+M9V6lX?Lt|U5=pQz7F~F7)L~7;GK>4MJC5)r-i6Hl z)}qM)j1ch5a7cs?yqtp8raeQl7eKfI(kiHl5x&K9{8h+ZklN$P2s1m68i85QGRhL3 zeLZaIt!ZZH39#nAQjuNy+|prbO}G^~J`GW7{B*YtlYF+xmUC4!d;Djd4*H}X!WE|0 z;Dnf-Uq$j*K3pT}+argHfD{ALqcxX~rklF$S=z~pUQiWn2jifm3ziKDv&^ljM6*Dj zG?B?%)%%tl6q@X_!whs^h9yULTYmFo}cFB#)-nP?ej0|L-`cF9#)lTx(G&97R z1Pzk)5S#ofUG&(osni#0--g=~O^tM-Z_63nJ0B=m1-vpe6C}MGe?EDDsqoBep0Jtd z%ZALH_Fs=IAB_2g7widtu}YvEVJF1Lu>#C;n1fR3K{Qx-?4I_ov{7932u3(OC3Vn+ z9Vv`WP2MKVslWc~cj8>5Cg|v6eW46Mdc$qkHRp#p(J#U4nG^NYGDU{STMdI{V6rR! z3{X?`GCzTDJ}svb>l5lxMwNx(;g&`7gYALd)Q7mZFT8(KZ!hemlA_Rp2pUl9nmH~c zW9?6W<(?uoZGJE$E}dLj;K+sEx)U*?D^vRC4GIE;v#5ZG?|c?pgRcBm$#=B}0jnB2 z2nkkm%~0L{AiyThF8JHUL7_zbz2Y>4bFrsQWUYRbX_jGoHe@YZktf~t%>w?C*-p;$ z=DIcj#?3)6QRRP6Ot9Y>jQt_rWPVD?0>PqId!;=M&w=@Gq<&q9xw7LA>%>#ZndWu% z5q#`ESV-Y=dA}HzL_vfQ{ru6|s9_Wm(ntc(qwP(y0Z;BGLVlNxjS^6&%3;-$ILmg`@v zYO9!yszW^Nrc38Hx;vZin>hU&2lBvUDOMlH5ea_dGpd^5CgiS&F8Mr2ic7aa_~f;U z?2ot>4EYs&LI@c_#IQ@%o>bFd^;WbPF@-00|6(OdH#|bOl8YmI8qH?%iC1?vZ*C6z zJLc~bI;PnwAiieH;dSPRb4Sef{MEE_;W#OG(aB;s(XF!y@ERq3Tv5qQxoBLq#r*Q& zSWdMc$ySPk&u4%M30+er!m&acX$HAkb%%sK|IVQ9Pg7{PypOjod$@{d)UPHN^~E@j zAA&wV8_opFGX4d|P6PTB=s_HgI_Y&tSNO{nUsxVTIG)7C8!(ytR^}RAf2EVrj(?)r z0729_*Fj<=D!9wyKTd-XCBD5BL4h)y9nM8B<9Re_tk&E(fuEU53>~d^PFQ!^5FOd) zrRs#~jW4qFEV<85uFkx&qw#wds}4`?>VAEvK1(g}UTX&jxfsy}5OqcwNswHy+asmg z&o`b_QK9}|s{aTY;!lmkLN3Aa;|7N&Z?E%r8YU*5FWV{h(qxsI-1Hhg{Xb9LYz8lH zO+a=9L=!Ft9+AF3MJ>p?nplN-Pytkhlc4UP8e?HjGJVMF;LpG#G^7Ncmc#al4b8nv z^hEy`xrUKl(sfs8#H_R>(0qXNqN5>059X29*bSpvI$J6n>|j)q37$B)>T) zkS)BxAVg>dQA_yo#nHa8XG*{V?VLMh;j0=`cfw2B&3)MsUAjfYedw~!%FF(l>4kWZ zLZIJV=5W67%!LA!Z*AhT-DB*@1a@xlAVCn8{Xgh z)?T~WemTIg3o%${S&f<231QAxp7%%*{z}Jyz^PKh=4;f}>iL7mokPh}78lD+_6U?9 zaF$jxk6QL|UMAD0D8t3EHA9Qv^MirKih0}ETR%_Vtahypw1*=mNoAcfkr*vKZ|Y`A z<+`?tfSLHyACt@ua(q(KcKL@cmZK>kCG@9WLa$uo?xsVX!m}dwTIF9kDq#N5pM(6b z`#_n*qXUn+sz)&fxE^_$V_!dVnePMQO_mABEa`!3KWjWo)d3Z)Av9WP< ze6Ia+G;^}t-|pT{3$$2h*YZ386|nTzAA*6@!}EiTUl_PJ`t)Uit{)V)1LbPKUIY;I zfq=Lv-P;Ywj)5fMkX6e2JUUHqY05+*eVk*C#3CZ)eLJ$aKbi})qk5~KTR?k{d>>(C zjJs6Dp-{hO;*n_GVSNpLiWKS~Zvf6Zi11E_XnKnJ zkPbik_43rvZH?n)FPO0Vq=CQ5L=|UVHC4IxL(Z&8`A7J zPdiyXXXJ?We{FodAeDY?cNPKlDY@IduD=}t^Qw5#FRHsGd4SYLYI8U(mt) zU6=XGFE27awo}?%OV8+eG{uZ6LXnk^V(p2F1&Tw6f3S(ZN?W&>L_q)oh~mN-qRc3; zG0{Xoh{JbRE9hyuaRid+u}hdJEmLc6?LZMEoYi@61&7b1j<#-AL%#BPG_fy$d?TMb zsXtzdTnm#q)X;V=)v2sNpMLq(nrvhFW6FDwSFHsJCih!(9$-8b=%4I>T^EL^XMBg# zX;`t;W#>veMfg3xZEIY0zm5TrUXb@pDAkxlk?pEpk}Q+$#AF8fXAyvjE{PrSxIpIn zmOIu*tMF7aazq+xZ ziL>brmU$2%Ddr}cC~_-*TG~}!hl)fFV|N6>eURPrY zo+i`e642)%%DtgsdIG^o*EN>Fy8JghFYVHBtY`$spv z*xhltUY$Eat|fOXFA<@aWd(l`s7PGJYBihIrH}}) z0t!{U_LRCWK=kzyzR3=>-=R7xOCzuymN+LYP5bC^K3f9!iA(fh(4)`fQXn_oFe^S` zB!hYyx&Mj*&&th`jK2cZI9UMG`C~Ga64F+77%}9IXAS2A-h{tG`t8a%r}S-)}OFf3$4F^imh_i|V`-_F|xjt1rJ`}ELHBsASm zgwj6+HD3JK>Si=rTHy!EhI$TRpDa)Z=%#5rwj`|qSF1zDzSsC1TMQ-8WwJaAJ4}RwIN7c+vFh^;gx2`C^vPkUw{%Qo2>sZ(~ty*;O z!-8_|&F|P@h)63`j&5m7P3#QzoMbC@gm)lq*;mK(fHfKdiAOQQ4o^?LqM$YuD zYa#uswGyT$z-8lq=}Xq&6q{L3aRW5jkp(mc?Jq{dJDXtr(7vjQv`+c&%=;h8Cfgqt z-~4#dT=x@k$KSc+h=pq!5^42o`I?U$bZ#P93EwDAwKZg`NL@-inrXORv@TeCeDhn1 zW5ji5;coN$bBK>ana0ch%}_J?dC7!{^F8QuQa*=@v%LsiZ)}K>|F8iS_X-{&A!$J< zx!hZu+(!pSKbh#5c9clsxFdB~lRaiA0P$jw*T!ai;oZjj#y5osm?iJD>%MOHsvaiB zvZ?>o6V7i*VP^{EWo6lc%FzgVV2oW1YiG@TjwnUwe!XT`H33xH&wJVo#Tr!KWX}J- zF6iZ;`bkW_SwDegSRb0 z8m`wUy55hS_f~G+8aNdFVw^Q=H*MP5LY~EZggVgxy;Rx@;Fv&j&gkS%| zi!al=)z;M*ZRT%K)c(9TK{|)(g!pTOP<{0=4-o+g3DFU5v6GZ(?DyH%u58WegCezW zqKY0#NjIs;<+jP_vMb>e^sXwMlQI8Uc*GRvZew()3g5vz^Q*MKs;;l0;FK=ep{ zUdUi_sMxwGLZ3yfs1?JhrumF2iOCZre7q7&pRjCgoUD!j4TYvYz1Z>uLs$ zyISrcBcn}(joc5u&RW$70(rt13E%5u>#k*d!7Gz8EwJl|JnKjD0hzL?3uzhuM&G77 zGu0%~zq<2zxrJsR(6(aE4^-3xnz_GJw7X4&o%hbt-s2!wbK`akOy!;n?U6!`ODl}t zuPGg*bTOT#EQY}@=E{N?d#n%0Qka+NL{qMZ_E?DDO;$&1MvW&!4ri z6VLs!@=0_IJ+pgum4;^*Dc`=%mt;H}P&T6rt(w;xBTiwMjwNQK5|7i8A6Wdt-jV=16!D&_N{yURmOs7#|sYyPTi%i0^*tF-qJ z#Jc+`HOYb<)Nen$r9k6XC1Etgqt;+s&oU z57qe2fyFYXY!@uw7(TX2-FpCo7?oT#$l@Ao%LnpiPFp*v4!eLYe#2Xrb4V%H9l9Um zU;E=-nA*(_e#qv5YBKLyXX4!d-t1YQ-huba%vcw8H1Z&5GRdr%4&`rNSAiTh&J8TQ zFygN^E8mEtmCm~p~LJQJ` z-Yj3#9@K#LYc3m7gwEIUfcqRn%!~0~mGd_@X(gN-8InL;Nz}70IzuOE7 z#qIZh5(94v?N&!E#RXbCbhw-ZT6xT~-cl2xGfeNR19LZNSm+p0d!5PG;>F<0+`6Yg=}X_tD;I9f})$S2t2C#Wq? zHN@|XC_LF=rL&R(?{7lgRa%67;Z(X{w-Wc63S)6#t`)~A^3LH=gJU$#VZwmUzZerQ zKDB>68vNfh4`&Tf*9UX}`W2`(tY*v9ich~&H{6{~@cYcwchg@;td;yTdKV#vD4yxp zupG*5li+@wuG^9<;|G!paLl;H=O9RBe8yOZ37x(FU^hqLuW88d3}lOWtVR0ZkP!s_ zka0gyge@MWHJDW;!{OYW5Jl(yK*Js61E%2eD5^ubm1OmWp(uB@$gOJ16>gyAJF@#u zLqk(*^@)@r~+>NKW!E`TBDgg$`9abdqKBHXay3i1n{{rp-jc|W0gq6 z)*uS+9{?(FNLpUb4t~HbRyckv(;~c}tA6Iksz7t_ni8eqs=^+kWMqt?g+7O_4{W-+1AG)Xbve4pRoFv8-ZSsby&wE*;z?IDKUEdsZb?O-F9;9h4XZB7tM zyVfddS0IV%x(Kw9kchIf0eB+7ejAdDYAwiFsbGas+9&+2=JWQMSCr9*!Dkw_m=~cy zqKO89V^5DKi5P=kREXi(0w{75Naihm%1f%bulwGNEAW|DYT^-wnCD{&B_Lcv=6Qj2fuE^Z3sy_i4BtcqqU{)V%$!(EDq-q`zHaG2 z#99Y7F@%pzwq!{h@He;;m^AvF(g)oDS+lG!LZ342J?aIaU2J^H6&Vam6xFp2s2C9; zf?w&O5^T}l#Nb1CKLyh6o&%e=uLy>dEhgfj`L;CjLP1Z4S|PWUMuTm;Cj7OfgO%rJ zkIK-JZ1y$!s~kbv$k`?#4S$dUq~uPx}30^(NV&HYzjz#H(d z55R2hV#n-ODCagM^u7V}3Fp6JP6K_8?ghg>B%S-C!FTsSf1qX&inu1MQw5^qZNfr) z>Yr$KZQ#qe1`I=(r6_7$zeRP_m$HIbdU(6k2h5g{@p*jS z3UrWN1k@1jk2S*#Q1_pToE&k82dMA2s(rxW80fgbaD#u(1(wrkJ<4;_2ZxM?qt*!U z1y%{K!%<5Bz}&%j6XJiFiaALZijkM;BeMFIoYyUEE6}IIpoiDyLDw6~F-M?+LxxXp zb>QLV@F^&y$jkgBZleD)%9=H_68le2w+Q>-^OWzy_E?0)mb^pw#od-U@~3!@+kLLn z6&a4x^cz6koF2vv@B?N&kwEq+3v2Mg2HYh+QhoSo1MlXo7BxZfIDHf=F$x971#QX5>SG47+N{wrRiw6`<5x`tA?F&{A=iO}%?u7J3hn zm~s>5H+ApHq@W`o1th6I%#J70?bCwM(Oe-<1DaNbMF$y*xsYIh$`HjppC^pqe|)fQ zFo24b0}=#_Ye_Wzmy{f($MKcJ+T8c4_M-Yeyw@4*%l)8T)A15qIWaaCgCf){&nIR@ z94~O+CW1ulHt@PXhW9HfQlPEjD8l0Gg+U4FQl^N8_s3Z?|A4?HyGIOB;*#Q!i04a0 z38lwgHREO{U<+6$M1*>Q@_kBqVF-eP(GK7fMrjgt=zMiQxV)`=32ZE}hkR1FZ~%0EL%fDAGxDclRey zpA=`F2-Wot*jJzobTn`msIF6s{{CQdC7B%z|A&<%bp=3afshsX2K>WM9alR$HmnN|5%+ecC8Z$x_C}9c|p;d z^R>|A2UtQ(kIfDzo{4m`SYf-w7_lO&4+<7WdF4zBcI2IWyGk53C} z#$H}~%0ptFSn&oTA4682O7H&IJNGQpQqk&j#C@;{uv>N|DLxN2nVdWsDV}NhD{@DB zASKcMfqz?ZQBh!gfa*hZw(Vp<;@_D#hMsta@u+1|Zc z_WE?~9bhn-Hb%kJW@xb;Bk-8pW}8f-7E)kbIdc7CA@u_#;1dN^0#3E+Yz$}j_s+@f z(;p+|xpMNw)LFp>7V;TsVJI`vXs+;r4AG8x?DGL#Nq;botp9DxpfWi9AH4Z=Nj07y z^@a>(whaT(#Ijo?%Io;UTkoDyiO?OCFwz!{cP-dwB@!q6vITlC){S6FU(> zisxN`xrBgR((tgyKO8v-NDezv;_?%&?&!KAH@>diVioSyZYP$@rt~4eADZ^I~fq2Sswn z4M%^24Cy@vUxYhG&RfBr5mxQd4(@kj{9J_GW;-$v%G%#gS_T9JPH=OcFN2uAcP1?^ zqI*ex=3iaPJ&-v2|LIbk{|{Y?-~Z@RT6p0%&e~X#h$df3V3|7v0&k)dJ=BUCx8Bxmg+)G|lFUSU z3>sTRT%%S74WhwCF7h#-aXd7aJFcSJ?8mrV3uHpNCn}}IqiWrx5BL(ytHRS1+Anhe z!iXS+S(=HAhd*sp6$NjMG|RGUrN6`3}$?w50{L*K?Z(1P-|gEjn?5F z62xxTb}yI8Q@T-oH{RSauxYK-TOsH zwnR4&AUFgKF2RBYcbDKA+=IKjdvFh~!QEX$uwcQ19NgVq-p+S#_vr4|KY9#)00YjJ zs#>+yoU`UaAbo?5ST?3D0Uh2aL5X}<4!PeN=7|Wvyl#3wFW0y6;L?zlrJinA{K6-R zQF(6@EcbtvWJuEv+w+YJ*k=yAJ7?kGDv1uw$6G8jGb`~oJi9S!GiK0S+?~H&stM4` zK)}sI^>{)fd$vs#q-CE%_Exi1etSP{#7i)^U{I(q%W2j_tj4~Qj|_7r@@CG~XyA9n zGlhuPUP%);rO)oBqCT%WL6)CfCL)qO2m`PWk6+z-b6wsm$g?Uct@gaAQ0`E}MhHmq;esGtfeY;yZ753A@%Y?FhO1lEo$4y~WCGfo;ZffUDU5d) zcbDZ7?Lh~|NUN&aL-up-g*3;v+gJ)ST26GM#Rt||c6m-!(WN+7D;Fc~nY{7oJnyv1 z4DN9`9}0(Ns}vZJDJ)xY&*=Sxm1bfbM>w%fFXXT>66HKu7)h))!iW;%zxPZC*YhJ0Qi32PBGxjt)n z@1E(i#^oi!n6myBF_f;dUj><6&?BJ)^yr6uoz4x9lm zY>EzUf*$2-;n_; zctPt9-~re1eZsNuLM2Nyx;~v5UbUS1=5)RO&44MBPR{>bXW&BV%Rad!;bRc@DUZ@f zLhPT)!13!eZ|0+IYCV*m*#W#n8&OzobZPC49vpIPJ=1@s-8XAsuhBeKMMFD|DK=#;L=mg@)h!-pM50)~q1wKr5|@1CldLs#rb+wTlc26ciiXcy zwX^u=-N-eXC4?5e7)v0BFkwMqMPX$*a{UdL^~ERq57GN$@=*UK?0=dCxhviwQa6x*7(tkb$tWis=Vfl(-h%-cTFa>fTMlxTkir zlzcvtBnZ;qeOZh^J)7MmNlmTPH^3FDnTaS<yCe6fgc-Q_TFki~sEOd|??q@r>BBTOu! zl?}OXaiCC+UCmSHPOiv)d&Qhb&kPnI7NY-*#Bf9PZ>yT&wi-dyshTcW?BC_Qg>|0t z=^2kgU$JIWi<9Ni5`}!?gc8c?iZ5^U^FsM|!BtQ?%c!&H&7|Zy>pqP;NE@R0yj2NT z)9eEh-!=bDe7jlxPvYCbJ<}`cf3JktNG8~tWMSZz#w_blzrDpg0~X6A`=nK5-teu# z6qMTO3GONzIW1@v>Ud7$KJtPyX*gPN{C^0`cv)dSFx*0eRCX`#{{xkc_+M1El%Yr@ zWYUSj8kg8i-?Ua^s7>)dE~}tbBr#%Qge2UNwfXB3kB>=6qF(N>D`-F0(&5|lbkU;vH^tjQ z@B;*?ygLMEBmeSMB%T+jkgjN;qC)|KIvgmW8T3j7Rm!f}F9#b|FRJ}?e-;3tUqLCM z<%K8e2)S9Ex+q9sXaF(pQLv2%&@X;(+gV$kNyUdbs~otMFxe;HqJ%$ufl)R;aVXW> zMPQnaT)MC1?Qa$ai-vkz6II?d1r2m+;v&VeiVQLMe43`Qd*5VnQ}S~7H!u8^$B1nj z8K&mg(WtifW{=b&t^)oN(#n}GKgUTuHy9?9zh(Q`05GW206ZIW-o-iz{WNH1{Xh8M z+112kn9pI-YN!}HGYE{FJXfd_ABWq>bScsZPVn|D-ndH0JU6ev0Wg7{r|kiQt(eBx z7s5dso}RJjB3)6(STr_Q1xKRxaYxAoMb!ksf}kTXFnDM!?&%dZx-5FT^ndcYsQ=-0 zhop9qhxI= z01)SStcGj9G{vst`+;#8RxUQlGT~PoRz?rXL=y(X8*qC1OnM<9gZD*t@40gQ6poNY zhV=h`M6CtF|Ba{}h5DaFt$yNv5w&lVuU3pb`Np&U5Ii;JcdWv<<2SZ_ZWh#GKuA0r z&YJeEcQn3j`ks$d?B2HQszCQ&4DGEj!w%a1YWcA6zX;W%sG_}unZ*Q6jI0ul*x(A> zZIta7Vi4;+n%<%*hrfaUIJ%u(IdKy6AL`ZMzo=K_h$E3%C%fLww!-u7X{fX z6xElH2F8s3+cq2g}4h-A9h`#gC)?^#s`kzCozyB20=$PHMQdC zllWt%|2K{`@xM9N;r9Q7W3{g(%Dw%~yWxP!=Sy;wP#XmbRWg#fe}oBqy;#$5DS3X4 zK#@zj)WUSB41ah>+Er(0UPB{!nNjr`r!5Bd02@;a`A*-4?>LQ|IU3QZ{F;O9e0X9pVBl=Y$=l9f z{2!EVWVV)U7 zJ)6f;b(X9)JvifnCkC-|u=EGprX8s%WX#9cM)BB8-1tV%d|M^NZm5RtDhJP+0DuWq z+2{;pIXL{HU<${uL1QSIyuYVk;voOC=)P{LSjYR?h;V7IB#G@Yqg_-m?UiIqxn9ot z050riS|WXzxc4oCmX-G?O=bx}gTby=b$*?F_bSOIBHvi~eqG+*nNSU~V}h;AKJKs3 z7n4`o3?>(`s9ciHYxfmO>4+J)XD(f@s@wy)Up}^7PG*A0;q^8mQ)k?PD(w~;N`N5c z(EnsWt-8AZn*sHBF^P_i`J3x(&BUHHz0}@n^;JOjZ6buEU#x69v-r~)SNl}ca{sU~ z@pm7gx7X<)2n5a&5D2T-Jwba6vErcQBxIKAs{Ev#6%}HtCupV^8EyEkYbbFqjF~6( zBa$4mA`YX6z^^{FWYyW1!e9sJj$5lA5_%_0opHL7Psg*RfwZ_ zcUjRHu|Jgm!k9XdXCf*jxEWJ(q)PMDXZyYp6Btv6M z&(8W59_KeaGIrC8P5Ff^TY~vyj|AgE5aW|Dg|=T;uOu^&ThHrqb26v>#n~u3RGDh? ze6+_OGk0ZRW~oiv+rS{sV2nmCuH-i2Q$xt$0z5*9$OMm`&!Ox(Q^D6sduHU*pIWn> zq+dS1O-7vRrN-aXbYZ|_-FN7)jtP70@{^zJIelGm~v*7ZjHpKA$3 zu|T71_346@G5>qXH=%=Rs!B>y#CMDKb5&=L1}Xe|AXwPt@gO>6l$<;Ze6qFX`3GD> z2&GOz2H5b1U_P1W|C{+dJ$a}90migW<6pm++VFh-G+K;zA7UdBaU;Fy zSio2lQEl?2ZN{{U;LkCUIrp9%*#8v-byJ>|ol$`qu23klZm?0*)`cFv854*Q_p#S@ zF|X>AC4MxX0tr+Q)bnxAWJ&?;??B{o-s==0M-tOnCmrZVJ$l^Mph!I}*Tul_$MAqC$}m)~gT*RXjCd&EvX!m)8Vt__Ss1ksa%|GcsjWxrNU{(YIYF)fav-fWh)@3${y=&FJl9iF{!u|1|qUC9uJ7`eG>&e zhyg_{wJz}F$A^Pwj#IFI;PKwIrHd2ITF@nkJLA#1vxEG}KhPBfh*eZRL!%~&Kn3U1 zum~NzHoKiV$bCPC>8U2-vLw-6uJnpgty_zC(5`moU>@#}{gn z7AAYVrr>#Oel8)B5GG5>N_x%(g#p=Wh~DHFs6W0PWUz8r!Q-1~I(*!}MA)r&U|qP> znQ+m+bx9NhErxKOAK>s_YfD;;pNnSx2EQLsujJ3T{CrrFGO=qY3TNyk>FuIFBiRQ3 zm5KntH7pb*bVoq$?E)amoX>7M`Ymn@-QBa{{w`$sX^Y*i>HT#=C~^v;excXVTg}na zT_&LC%+Syo?U$@tcMv`XmjQ4u!lTEWIPS&-dmDE8e3GLvdi(Ya?d@4H|HMr8-CY>eT5~ajP%H@`AleNwjJGDMT=@6%*+6_VKA>ot8S8{lKAIj|AMt zk{|(TX@h&jARA%QB7ypzFZHCB^q1H|+CHoYcW0v6*ZOwPyr`H6Z?{8jTidDvehyj* zk)cH*K?lTiUZ_8jBijkT%7+ySytZ&K1-$WqFT=(fO_3E@c?RGJP4eRer6@%u4( zMsH@IZtxLQ;VhVBVC%GbQtf)%u86nhZ<}TkpV+cDx)62z9NiBe!I_{2&t*gr@LKMk zbbYLV}uSOUuYervD~Qd7_W43G)bA$or`;Yzp<&l>LM4ci zH?FYrzZG`sJ!z>0`(PQD(^a_dRmz1&@+Z08DK4%z(w6TLBZ-)@EK3-HUSBu`%B6*F zBNs0pXLj>AV=S(1>pkPEIDP;2SyWP;Y z`8fxVenxbqR*1;+B87Yft-i^)&?AwCAAsPB@mhU(py%HmDA&-%OB!urLakZ$!nO?t z##x+vPsRmb+Wo;bXwu!xD36Z#2J93<6-7iOz&E{o+W8+>5gHJQ~2DKZ$eakre#7~KYByX|Uoa}MBl4jU|AqA18EUY0dd?!2>kY>o zP4@@NY#|Y7FxUi<2-eX9;4RO_OBQ@}AOraDU*AHEguj^*RWpFigYaE8%d0z{dVZaQ zKi6Xg6o)C2a=9C*&j;;)J6qq1jD$`3)EZea-kK@sFI8UH-Uk;1`MgQ8(87)V??dke z_+e^7p%%*J=fC&M#~_g4NX&f~kM1G?PDliccuiW0crIplsl;b>7*i_J2BhJPU1%c6 z%L{WnJYAdhqkK8=ju1njkHAO9;I217fvLkxQd{D+8lmrxdOBxSm=H*DBK~)sRt@{` zitofG+j4_%m!6K|FGt29Ubu|zs1r;>AGdb46Iqd_(_`)*z~j6{)BK3W6m4C03;s~g zo_Sn(#h_urckh5?YP+pn&Y$9%uB~s=#)p&P>PILuW&J0-g?puVRGHNGnqnV?XpLD!>L7~_!L{Sw#y-1GU_!mavvQ(na9HmK^KI7qF;p2#@%1STib&}TV91D9*FQ=lCSMU^CAgeT=J7vCn z$0rytxaRxv>@CKBD~CPHeyOMNRYyMVRz2W-FQcaR%_B*xho5dkSfdHfRkbFo+sO(Y z4(`s*w$V1@S1wUZS?vQelMyllZyjsL-#oz3=Es zf!i@SU07mF*IC$q*<*IBm8^yq}UTVg5JvY~}00=y}u}T6#khawMi~LPm<9*@`!CcX>PQt{sVY z2)d;uP|^>L)E3e@EZs{j1}A?0w%+7dgOti|X#94t(p(B%l#N|!^^19oq=#oNAE73i zBUWON&y)Drp^0c{!t3Gn!xW;Xp62nn#BKY>W3OiJP1RW>Xd)e5owiE|lV01!)X4Dh zb7g*8=+@WvmL}`1Z}zVOzTb7{Ox2M`W(1y}&>1O&qZ&b9cK>*p>9*nEQCkgnHUM0N z+Dd3FfX4N~V$=`K)Matxf-hw!1gsdq6zYlD(HI_F`wnfQ`YG+KZmGpa%^C*0rm``5 zcfF)i`Rt3L;)Q5uxiZoV-+1|RBh-$m0&k2nl);S(>&LP(FoNH#!C;04qyB6(`EF9q z&1%eQ?f%kxBWMSn3mWE14;j||C6wdq`xfXBBYzreU@o?m6lfbMydrfrsDA7C_L5*R z+020}lbSr}2c0p=a-cG0<35fVL;26uD;{3xyB}0 zau5ovu8zePk8X*2!@T@}qV2zcBsnVIr7>pl(;5ou#n_|={3RGGQ$?0{NWxDB8Ac5mp(lk}Zd@_|%^Vs|24DgY*gS z=qsoD-1&AF>P#Nd0x}@Ft{AX7Ct*sn{m;~2K+>oaZ9*pMuTuqMm@4(38 zVciD*hhV6iQ0fG{YVZkjfy?IR*L`B7Iy^ZQuvsB>G^&{Vk?QmH^V9RFI|iqE%9cS@ zHEVH6%tJ%O!2@PH-afRybYV89ncAaEjZlnfAarXIj?uZCWr}wLprC&SrbW~O5SD5=c`A87#XAjnk z@r$dxZ}&=u(xx%n1r|9tLxuQJz|RRl_6e|dfeP<@(+*C>QL=bRv_c{{e-yiC`02K$ ztu1|Zt90jps!V2KqHSltF13fL)4JE?Eo)jQ&CKd$&(a6S;Vh2W%#G6Znl)<^BbUy) zO}nved-6~;-B#=MQlot^RdJ;};7@eQKH(fCHgv>gj@HnToNBYHkje9+=kM1G)cquV z@{$@ab*mAl%epK&$Y(DIG1||pt_GVhc!D_-1f~|cnGX(HC^+{Aj**`p(~A1Zhxz3t zaS=3o;kmmVhA_cu+-8Blt1^F9LuB^Jx@!s|jXuSAqMfY%%Q%Cfg)=@kEw~|HL(86! zOGx?J5CI=#!|P`o{v~D!NZHlpyvf4agz}tAom_mTQ zW|t^~Lw{oGg9*HuS++a{BJxq^TVaIs1$NVXXXsX3&}!+1HMuIsf0UL+Un;lw!vo@7 zFmgo5DSZg2h~B;{N3T9!C7mVeO1h%AUZ$~8iS5#b5hv@U?cXy}?E2*JkY(Tg+j7gy zbk(~$f{zUA-BydiaJfJck&hgW{Jz};pG83hQ&m|3swb7K_n63u{#IEk2n>wAUNm-= ziamex$Repw{j>_8{g+U_e800jECz4%4Pa5&#%pB7bkON3CwseOTAb}=T4gB84raGU zxZ+A9>Q!)u7C#McWPcDPGXr4WOu;YrZxczOYkT&5n?}V-m$58bEu|?A4oyh1`nb; z#bzYN%`dUei9b-&#Eep|xL|QKGbA|`Y7IHG+mvRX;YIG$t%0OgI&N~q__y`dI8O=L zsWW2Hq`NL#fZ8&^|Eop67iXhoRyK-#x0TOfF!m1NBXZJS{mtrR4 zs1l}#AFdrZo69&H+VHPjS}FFTAG!e@`F=*q0HlV}nW_y0qNaNk?`nXLvs$V@iaL$> zAQ1hlc_&T#wi4gooa@U8wW_YXZcT++Ap4>O>B8>E{Ma!fH{i~@wBNe86R#yz+j4fM zzWOgFGtoq7JzaG7dh!^!=453Hp+v%<77|e*g`yvDYd3e==|%!kQXi&j&h~1~%-i69 zI*-Sou8b2B2@SSC#t`f^7v)ebPb(FNrBe~*^m+cB*oS;Ni5hBZclvfX3;bE_zfobj z0nay8_%OT&IBeznlPyc!2wx7g-`yXroD+i!juOlhw*t*ra|TKg&cTWt&L3A#C-Cxf z$u6F0q;j)$&Am8qW4)R-f^Er=0t?NV5)+F|^7r%_BQR()ge2Pe-Z*owzc(AqnU0CP zRhdANilu|PSyM`3jFfIxvJNGWm@P9=ogk*lf=iRZ(p)s=S7NGuWUIr<81VeAgeZ(`4qi zS9)34RX^{~CZ!!(x$Ar{rdXN|=PXfj)GrzKxwiPM^kph@7cf}_UlQDdM)^08;6nNGpM(ca$Ce(w&?A~`>|Z8#nUO#1lRNH>)HTEQE;R4 z8uY3?4>t}{;8V&aZnV7C`d4R3d0N6jjF{8J$fKhb-uRcp;>vpF&*o6IiPB(!*h^ey z-3eGugKZz@+LczYLrgbq;G@R_dC$#(C&BjRD{Dnj5kcI<>{82_Bib)7db1@kf-SQK zdFLficcRG=g+Y)GkGU%uD;k5pO)eB*dBnf{V>-om(!)vfETQ`*APzw4x_B+);_*M% zlPBgQh6qyD$06ytnzq>#6b-@UfOr9QaRq^(Z4`}?7iPadmBTwi->c2w*JRHY}3g^f-*Xu|}`^Y+~_VVKUAi5Q_rg0Tni?>KBrMUAJw={VUZd<`b6cy zX%IVdQ|!n#@tynpCTqeth;}^9HanS3$j43#SS*;fuP*EKfn0|g%|zZCM1xXNR2 zgd%0Ny(~9qmmwE2(J*iwBP0a9HMpR;MK_ zq;KCwHWtqlDre%+;Bk)oawlhm+fMgd84+B+JCbfmDbu4u(+4O#YZPbha)6)|z5rdt zJPey+8)2GghZXh2Lq|)tHB>)bD*GQ3PeELq5tcDw(Pg6D$RvVOu6=-w=dWw)4rGtf zBz+&W5i6Uu8pe5N*V!6#vYtzPF78y&UQun^Ax@#2mhZVFryHWhITX#ysnzuihj;UU9d0sGdszB9hf#0!1S#*C{((w^jN#z!Zg!@C2pSHM`y)vs+nKEM5lAUmd)+~K&TfF z-{w*!Li)i&=NWU{ux0ubg%>Zk0O? zzy&I$I};G=rm1U#d=RlZQbG~p0-U)Erkum@wqvkOuJAr=cp?JXw>FOUJ@pMlU_2WD z0W@&V_^tO-QrEFo(9l>Ya-MXL%tFBeFW%!i&FOo+!Z^cjGn{Oh9q!LeDFOG0(WnN8 zCjI3B%NWl*!)}D#<;!kAWx z)6(`Utfso0T0Ozt)e2EFqoBhCH<{AK5BKeOmmPX+AGANO^l^1^I;tM^?r#*wU4iB4 zUM{eN?sIF zd9FkF)?T)zUQt!U?{vBAPqD*HoPo^PQEOX^ED>%ahX^{Y^BW)<)wk^AgLA2R>21WJ zB)j;OPztBS+t0Vxjgp}Ch5&SI$Ss;5)n62#!IMizSzovM=%)OJv{gsgl^vhcwITWY zpmPpFFDMQM0Vd~XTD9QJuR~3iGAZ3ZpT^sN@06AN0qnS7xIwCB|u_p-tq8UUF8!~NS z)08f9ZAf)q^YNMiRig0D<<#L|kWwj?X0rJ--U0OBjS*e+Z(By!^|h^yP`V9K%dHJ% zue_3AG9}NttR{09OD8oSw7VoL?2Y8?Ii1$)51uG%!ZJiz9UQgN#v$x8XLK(jgg}d) zpRD-gFnU-(K`0Kst!FPBweQw*o_6W~rlLk>MC!=mCPqDiVnj7seo?}}IPHHC|NY&{ zIi)v?=BZbOI3nbYjT zEv{$-@$Kj#`{Xp($lxjb190{(9PAGe1lAxUbY*2r&Z3&1dnNPw=z?^!2zgtFASH^{ zZIfRV_Mz5r?XQzYLOprj1T44ajYm(Yuv?z|EK%DApZz9u~OVJeCW ze>>8ub(lS`{8HJ2 zqqV~Pce6IBJg7tfSo`X*Kd>avBw5dK-3% zs;yK@bb#2Y=T{Z6$fP!_gih)FaBJXO9ADKUQhP64-JAGPZk{RNiPtM=%kH zL+A)~3Vjj`fT zyfNM3DrD*ZErU<=^g|=2ADZMxJ{LUv$xmV1$cYhvRHZCapr?Pj_ISafwH%F&4cb5K z3K5yu>`A?9xjRRBQ7D;1(J^|O#p$c=8ZWm*B%xnY$w4a5wEMyQDl)svTzjIw_}X<# zVQanF_OAXYS9+uQa707Ue-i{S^!N&A&5=%$>tn8ZlC9_)SVWZ;MwL*gQ(YCGD4bk z_55k8noqt644_0ls1Dc8_2P6{e*m`~z2p{6qV%@&)$2!T_EhYRqYlQw&Kl{z3QGJW zI%D?5un}K3NbPh8E&y|Id#*oMK%g)1q5U!w>WmW}icNiv|3xf8)p>>eO`OY)E76D& z4<5O$8HZI#k0G#X*wO5iyCmpqX-CXCl&r0z0A?g8NoKs9nPoe4$tAN->ze|k&aRa< zQ(27avmD@hur}GedikP{>$IZRwT0Lt#E(ghFH9cKs8t6Iyes;(AR(vg_UX1y^an%6 z+z57r6Zh`!Xola;46`X5V`yfHhg*_*`6;{8{@|_{3gXe7fvuCV-2Rf>FMNSx`aK#= z0^A;_jh`o0jh_Cir*r8TM~?JUQh%pVeah=k(1!HYAI*$W=gG6H_@zwVAx&!E!F&B2y+{*&)ew_b` zvws+T#|%N5bn*0YtJ0%P+CbWvC(n?}Hu^jcNL41O(H_w7$M)eLtQ*`hiL7z;HSVk$ zR{iBgPGewW``|JH2MmD|)@nik4CaikP8Wrf6-Ohw*py0^Q2v94&xc*YL}G2g+DgZz zJv`DV4W!dxKJU3)n?(OK$$kQ1MIIoX-}4>rv>q7p$eLxD{OPWQKR1JMhtm)}vHN@m zF|Qvk)W>gYALd8??IpwZ7j22XOfJR9>2xec-j?BGGIF(InBwkPxKo zA6{HT3E;qu|6H6li5|CByAW~}TWwNb*}L`x-mW>!eQu(G|GH6tUdISliFU~=E3IBk zm+A?r$I{oGTO%~_iAJY-mbl2yj3sk39Q$;S$c2wKHOO_IzrN!XY6e@R>4uB_e#+MQ zE|Sg)^nf%7Q`c2p^z)j}-R;l0ZsV*|1A+0u`{cZA?H^*B-kD3hrnbQDzCm-PQhuDj zyjr~3ibV@V2+AK#C8gRmD{m6C^!j!T!N7PI&PLD2L(i9f5^x3Do3tNlLH66D#|hOO z(RuT$aUm2Uu9m|xNRkA1;xcL=-vl!ABjpxt>Q8H9hu-OvHA(49zC{CZ7N+&Q2#z}L z*4~jZE)EuUqYgYXc?^u?=-Y^)oMt&Yz7A_ z#ntl(&#o8;30CXu##!cQ=6 zY$S;|^sD@G$yK2q#DxKcw@=RF(_sc5?v_%mW8;V>4?KcX{1ZQd z#vLrFR<4@CZztFU$K_kE-s@k3q-_QcQ@0M62}txRDf_avb_p>tOa~%M*rLq&CCGI} zm9XTo7v6#I@>1eC4Us*kPm5?2<(AXQOJv4r2sW0RdMn#hLrR%4abZO|fh-#wKPT*i z_E~l!62iR!2;uLCPx(KVrIq!^7lGL@3~#%M7><%|hhpnXadFij#J~fG+SD_LbBaTO zReAa6-y?KiH!(qGTh51kC!YtGorT3^By=muB}(hvp}EF$8H>}!wiL;+$NN3tq^$9= z=XP4q@~bzy$S$#F1=xC+ah^@LyuEqOC9`>YqnCK6^NWQ6I*qx&q)~xYA5FxfL+83q za{7c}CF(lrwberMseIvAtJ)@6o2OPMX#X26-~4Q$Dpybt!O^`GA8;<6Fqk9xbtY|4 zQ89NqBheeddHcp~{X2(Zquj%U-JuE}FSkI60yS@I+r@o6SpX4<)294F8#&It+rVxO zF#@~UJST&ZS~gx&>EJAd4JfabL6&&~W^TjSh*V$9F4BV_1TLngJdcm=h4%QX?OLL3 z4T_$3g|f3q6lO4dJBGeEty*P)wnqf>K6v|!pCa;Iza5UNTHFz;Nx$VBt&V<~9=t^S zoe9_MUek@_7AiDdcp4Db8Y}|Ex~VIAUoo{T(0+?RBtt+0+^MYGy(Axa^xBFPXWL+2 zMK6bowbA=;i}Lg7jxA)A>J>uUvu=ieH|da1M>t1-S?8TnHC8qNB^CwQ0XM7E>Wt+i zIZoQ8m6kKl?(K$_f=;gHgtU$iq=Bza{EsOKp$A38t1ttQ0QTV&&Pj3po{6On^`S(S zZgqBOfBzzSe2F%Wiqdd!02n_PIjq+y!*L^@TRf7aOdSBEwIr|mqz_DvLo1(HSJ z7|Ph|Yqpe_IzbG?+JvGoj5RrW_agy(iz5m*k<7GuiHmA94`2W_io+&`Ft(i4{#Ow1 zm&?_*9`I@E7~fk(wx`5BrT=Ru`o_&pza?%&C=w>0AU&&umjtUdcOWo z%Cl(t*E*2c@DgiqA(h4`fL%AP88`Y4gj?>PgUhh80|854#K zBpbxrCZ+}Dv%MsgC_;xD98u2gZ&z`r={+oZL0MAd_X-1%4qn-{t?ge_&BcNrA>?hh zmH}1ELh3s&0y>?P3)+r$?$Do`nu|5P(%gd9GXvwRwZ^yYpE}>5LYDH5^mRoCgv^EMU;h=5~qVzDB-$x|+Atkgj|Ql)YR<+VB$(OTXoL&f+Sa%r8rC zWASJ#t1UiQyC0Vq_RZ!qV-?N4__(lZk|}5${SUpqcQoIdwA$2N=8f`zM=eHjT!%otO(qzdL`lCc)#L;C_5D8#dF z#%vU%h#Gm+i(uC3NTs*9dS){dV6ybw8r$}z$5!di2p4J`(0TtXC+J@if+brWfxWr; z+s<2#lHH?+m)*ob4786gS}eyHeL;;b*CR|H50|u@>UA`H{O$}eyP)c5>PEtKU5v~V z9c*SnXd)yu^bc1mQ^aA+vRXnl^#hk6!O@OwB!hGVkNYLled8h(uvW8Hi4mw6yHZtJ zza*(n9-kmj57HW`S7Mkeq`ZQ~4e0DF7h!g2-DevKAJgbL1mXuOrOAV1PGjxw^`Hko z9cCiPXr zo!4LDi2R$A#~FbM+P8poIo5R&1(@`he_7ugHH_YxTOkRJXUty}oGTxb%y*lvfL~7c z_4iUCE~cBoHI5$nx%@f2O%=IqFwdBCj$&Rs;7M=c?j+fgA0Ws@ z%Q;>*kT=O9zEZW+HMztdOY2MD+vJ=6%yf0siKG%)o=|y0IEi_-0bvlyTN87IyWf_P z*SuBlEu1Y^`-A=NytN|i@r*ixFaqBhJKE2Wsy(IgW? zCcr^trD&v%M;Z-4jF!)X^0!rOtkYOqibjd`&f=yA`2A6Z@@J&lbnOLuLh5~k|Mcgn zN3x|l$rwd{s<(m~m`2o?vw%Sc;bWoG2GRre)CKXm7$wYQu4!{kkocy}c+>GQ4eV5Bv0I5+Dyo<48wOTR>xMuAm7sSQGt#;g-)$fPv&=?`9x%{-p%x>M^4#NS1{k& zW&{0b;t3S_jOu`s3JAUk?gTvU6JxNbL|Q*LRT412ekGm`)IAcIqb*c!biStx^+)hy zuk0_?_tU<8SPCV;rVnHJ)IJ;OGP&>k_{*hRl>;AV4gd&9XCQ`oIYo9Pf^G2M;t;ed zczUiI|2?)F$nN5+zgYk22D~=^j1kz4ZY1n52>E}^)S!sXD6D*EC{1qP>0Nap( zWfCaP@K3{~GtTtO>zv1QQp8f#(}ODF>}%`|ooLu}Yz4vW2T;ZGue71ps{1-yZk24R zN}rca6)#EMPZcN0X(+8Tr?6^N5Q%;%^+7pYOj?P*tF+>J!?AT~WufJ!(HH==d%hy0 zeZ{`d(I>)r<4RbK2eXafwngd{0?I_d^h!}r4}%~_@`8z~*PyvLI5aeKXk0S&9XtSX zm>a}dq15;ic{G-r-)%rvC{%mb=F}Rr0C0{)%KQH1_38Iyx7R{zxYo6JLbL;+ z!%?IavQKFmI$X3I0b84xMZdC!#(P?wBYO;*;o}JoV_iE>Dc`9M8>eoVpgM{$e|gT~ zc0snwIvxWRo(PGUzT*NGPr3PRJGJkfsAc78J~Gy>-Fh1J@nTX@3Vy*$c;V7mBOY}xt_ZxOFxgrzm8>e8~@x2-Y%c>bv%pIa~H%gY8>j2jgTWX$^E7T zD*mqeQ(`At)GeMTt8SY+>oFpo89)nPV%*D~XOP>m&zAOzx&8WrpcA~SqwLWZ9xyc4eg`UcV#iX; zl}mYj@|&CIIrY6+9De>~^!*VsqPOs}{ux?fB6$RdwyYe@`}-Vu(dU~Y@ty7S_fn}I zhFG;N_5&5I#-(V(-D}DuBVgXid3N6czHwRJmYh*a%Hj$yZwXM+HyU;?i1CE)%a?G9BzK4D#c8J#OaNic9ZR- z8xWKkSvk&i^Bp%%-P)EBp2;tg0sV$AS!jGaru_hoy&lnZ0@XPB^FA>yB z8O<$&ML@w;&M5ji0xSkt54(;07UaGYAMFdTMPOa|dlr+|5rBn&_qiuYjn~lerxELp z>o%_=cc%Dd4wS!WST|K{$rnrI<4;aEm&|C?jQWjpiUn3W4(Coc!{BTI^+L>cFA1q( zm~?dIS{;seXEmI29~83LCeI{ihTgWV8vMc%$;)+d$kM6G_0n-sIPI( zqc*5nDsRy_Sxiy|D+iDV4&5mW71j3+r-Sp15hK?H)l(qXllZs;0tMONBz~V?b$NX~ zJT5yi{!bXnUl=6W42s@&j&@_8&Zc{x+fh$eVS&pXCUBhf01dWRO<-t<&y?%#_v|5X zHo9EpYOcn~0qx&2o%rN1(#~5Ko1+D)dci4D=eUr+k~>BO5Zc9!-MbDS`_LudhV|BhX)}Y-H5>2T7WL7Jp{iF=R5Ios*^cJ-=W9 z1q8FJuZ|mRz=vOg%gLwUv|n9qoww&JoJHMRy$vzj9nE~v03RW3nj{kcz0wz*{E{k* zQ*42ScBAdOkV-28tro}YHk~|oK^GXvDce^ZWgRo~nSW@iR4szW>>ng#T&lYJFF%u7 z1pNe~VO{vgg3G%q^^W&M%J7G7FjZMJ9e=k~mM*DNS4YK0_M2B^BuUQ}=a7&S{DKiO zHwO2OqiTP2m{^e=B|uI<0_$4Y!>0P@KvkH66(ax{Dgon*eip2FwPT(G3@fGW8q&+ zP%3|AjK13xSpn7ZO}?eL*;z(I5Z5&@Oj)h|#p2~IqMlnKBM`!8H#Rj%d{+&E7;6i4 zyWl2}mfXqi!aKaPp=}fD5BOa+asJGWkT-q|r!JyQ7(y0ZIkCdn@eCIuSb0FhVaUCC z0}tz4V>5lsn~4;JkS)u_juV&xx`)4%MEXFhvJnnCDkk2iM-oL=w1ryzR1Publa zqhdz}%>a)#Zb8A6(q68?rp^Tzx!b#UpY0mXyAO(L88?v#G}t@wh66+T$}-sDa! zI2~+Xu{oz#rj@ZIhyj<<<)taf9lab4Ix-5ua__CQ=C$KL4g70aNlUO;TWH(*G0DmE zjwFH0l$n7RnmJ5n>lG%b%#h9@&b$-eIG7w`x*Ge&)j=tcf7j`0}Lu;t9_Y|d!E=rgawR^iLD?~%|;Oi=}4{jti{wZB)kzP zZdjUyC7@rUw^xh!(BoayhYmOwj8=}u_d6RgSI)iu{^62C?e@J+X_^a<0{61?j2{xE z|H+?lbNtv|FnH}0K_#sp8(qc~)dvvF?&NyquDJRP>D{((>Uhp6-WeA>(_D=EBfL2n zgO5eX=H$5%FfoPd{T)0xAbC+uFkj7VZ12Ih3yKW8xf6(quou2MWJpOq2kGRI%KiEO z3On;~Dz`n3zsa!4ktwzmZLV(Tpe-ew-{!gZKKI_I=l-?#v)=djzVBM^Z>{xPYkfcOg6)Q&Jzbehu?E5+ ztmax+Z)zWD%hIS<2^qgDI)CgDP~NGdGq!4kH~P4Dqjf)Mf=^*t*7?fBy`WV+Jv~0H zZQ1nLY9o>4(5ye5Y?K)g6Mp#+5Kp70dXw@77i&YS^hIbi8hLER0fcqil(0rstA`A9 zx&t)zYlU+gOADg;XcSS>5N5I3jo+O$HrC{KK#{c z@W&O*eni6Tj&Y=|?{wz9Ri4%)p#vu>49rdV((}B6E2B&oC??h&9Y-b3phtAeVg|_v zM`HUS(edi|AdmsRXnwfo2oO(UjhC~n9yM%eZ!UThZ+3H`uEhm|0K+U3`)r*Ikz4oH zU@F(di{*jG1;f9UyK_Moy;*c=nvDXQOIQ9S5&Qw$FQh$4%G`Y|>DCx|ox|?;JLp2} zuPb@5B@4y?D1o-yk3^n?~i(`n#}HQIP(O2?{GnYh1n64e4qR$UoCh8W;}X8M(>dv zc#gDgu+gqvl^L0-DLLORneU`xPgL9pCXh?3MOGz@Dl3$fhyt-u_%;0KkcA%e{->lk zbCKkk_ZPH+7OIv*1eDuqY>G|yu?LRe-LBU{KMXY;X3+y#%8aVq?X8&+fJOiqs&0L3 zW?dyPm10%u`Laxrg}FBH#&mF4&lY8!2Zg}w4Y5UAImE_h{j*aSJ5T#9{kwbQhR&1T zoN_83kw`oBVSFw;Z=XMTkxLKVE7vL$LyqZrci2qHnJxdeQ~7mRmiILv=XGvxEW0f> zanaX!3=9pS^;=q;(i_C)SQc4I@dkb4-#%Icd(3)B&8i*QLrQba_vB^?=g>WqyHw>VP-;A@F?LEcfiaVXNlZ%k*vktF4Z%0hpC;t?FhEA^ghA0(#ax`7nJRQeE`~-} zw9*wkp0RJC$zkT&LeUuFmC!B9n)3x0knmIa_p&fU zL{KI(2Aj)W6Vz@$kT7s5fe)vrXGlyC;?lksQJ~e&u$vkD0V;mV`;wn+@i7cLKSPS= ze0SI>OI>RltB{Q(G3>VU-FS3LbkKVCNnPEDtI5tN0GwFavsOu@@2Lf6eizqL5qzG; zk75#Sj@{VUcx9s-(d82On4b{L;Xo|rU=5MCZ+N3I<*rl8FV;ReGjovp5F^46(X=Fh z?X7;8tt;JNf$Bb)xi*8&em>;w|K$(#xZ+uF##-u3wYoflNMq+Z{BHO)!N((z@V2Rm z#QnHJ2qfKKvzw&CdP+l3Wp315C6nbJgUiS5Gwa2SJx-@rFmj;7`DJHbIPzl%H|s%` zZ;RNZR_&cy4kIW8A>zG z<&M9VBSmUUb@xZoiuzUIPJfa%q67~QjBx`i41U- zVl3-hH1%~4phuk)Ar92=zIgqEf?24c5Kbtq07XotpkNkSFw4flLHBFMZW;c8=}UC& zQg%+_gHzIA#)Ai1?1YKcC$HsjYdLjw&2^cE^dhjwS@5PSU}B8VoMS;?NI`#n8qxdu zcb;?SP0+aGkq70486S^}5`y=CqXIjWF#wO+!pLio>0bvgqqjH{`TUMW^Yo?=3L|4+ z(GPOCm>D7#vZ}9nHdP*^t9{%&^kJ6ixmD)YTGX)CjxgXoka5UXG+E9$<*&au5o%|n z@mC#ATzzcFbbH&Fm;|8}=Gk_YVk%Q^12=MV)CTg_zpq!RKcH3KI+cdYcH2}ZLaf77 zB7D2^z|pivw5boYubyRlnK+nPqN3(|9NDfX4AyU{#`~Xr=Ha$VXltW5 zNBn|Y(~-0GIQ^Cbfz}Ye;CC*#{#~vl_|M67^3wrV$+)#7vkdNMAMW2M5x%g?rj!W7 zV9I-SMVL?MMiiMm?ilQ)P-LeHVHXP_L%+z1vZFf`R15q9Gd9bv?3fXW+cJOJeNM4C zKPS$8aq~-kk*AGm0|uxgZ0Kml31MMsmzH6LHVQK`wbS{218C`Zq7Hk@?5g%qLjdS{ z09Z7O3%WW#8T}$QI+~G1MOliX#s`wnW5ZZ~x|U)Mo&(I`b)44kjtOja%gBxRoY_8CfQkvmzERYc1t z&o#Bxc1aCIdwCs=fKRfcFr?k77Ii<>*)Xio=H?G3ZkmK?y!)rCVGvVnt12qybWe?3 zyVvHf`J|uxtQE?}N8znNm&@4#Q#5v9sl3uIbJyJo8SKCRpDIB2!2hZhKTX;aK5wgG z5ms4JfFOvtzk!WE-pT)>hKuh-_(2pE6jhEXC?8W&usW`;p`@ar{0|ug1q}rSs}&y6 z|1j|M#$R>~`niF4+2brQkowmh{4aZ6^z(P}^!d4sFDXF>Y><-%XY@;Pj*))@x|kww literal 0 HcmV?d00001 diff --git a/docs/connectivity/saas-connectivity/img/Solution_Brief_ZKE_Figure2.png b/docs/connectivity/saas-connectivity/img/Solution_Brief_ZKE_Figure2.png new file mode 100644 index 0000000000000000000000000000000000000000..afa200abc6a8c409af76388e88e5cc6371895ac3 GIT binary patch literal 78470 zcmce;byQbh_%(O|X;1_tMH*=kkd%-{O1is2LOP_Rq`SMjyGxPoZj?@?n>qM>*E{oD zYu3zK^T(h|;c`Fco_NlF;_Q6`Kgx)qqY$7#5QHuvE-Vj0aN7_BbBhEEt_hF=6Q8@lQr;el)lf zk`R8c=sdr_um65%;y_z`{_ipY0<(?S zzu%kUb#xFt-iVZ`2f;Z#enaZ(5A#27%rnLR z-5kL==!&+7w;J}DYHnwR@ce1aC7D*niD2HkG^k4hb?3t;?(oY}w4;h~PNSPeBirW*_Nj&r%|7#5{L| zRM?Bhk5Nk|cCIKXVoOVkHq$?pj-}C+*QizS(aw&}+K)6PQ2-?ILAO_*`&X4+*guLLxn_ zINx7-9p5jQhw!6Ecxwaq)6$5u#n_awmF^pF%UEJ}CbJc!xs75^{gH-Qe zKdHvLyxRT!{)EY}rSzR}=~QoS)mxf&u`|b1E)+EpgIje40{jiQAHIeU{ zWZ2{3vDajX!l9!75b_#PMOg`S(3b0+1S;0%&mr=u*G9k1#Xhv@Pt6|(p_J)*f7l2+ z&}i_Hm=f=_=f2}_=Sqrg4cDAhS-ZRMce?x8PLg9*Ob`isG0ihH!~o1_x?Bw%%0aO$ zq<6WBs;JlzOrmmY6g(VRa{v1)7Yz1bWJ$|$*M2@M1aw8>2CMJru1#4<$DUJ`I&;QS zX5%%}6>UrV^@^+?+t3uH(SfM^XV&hRn3Pq5QSi+3U-e&osG^%r--4^re9K?u! zZ#`2K5;FJ|<)m+rr9!!K<#n*+Ny19^+HJo=MbqYOm&bI;GfEb3LH|7*FGIQ!ZB@!t)r*Um_@*rozG&WN{fZg~i;P1w z4Chtg^7pot#)1R1nPa7^v(q&sE*EJ!A>PqncF``DU=zg&Nav0&|6|8!ui|z8Mn< zI1zUrpraMH9m{*B(A6ynlTnfru_$wUlALYE!?HOP`tA!!{kF|=4zzK+9+tF5XT0{2g>gtlV<>VOka^=}ePF3poer9tqBy^HT znCo7c@w_911`}UAg zWY6u+D5WPSz@uSf`@wH*6BWsxmw(WvjqiW@lKx4QO!ky-fFI+Bka+R$)nvvLOggqB zY4g!njp^yK9Zw#B5h8lgshBrt0W4Tbx-b?QTz%#(N%2b{x2h%UtA(en1vVj;gt~um zurOH~ArW#b#Rr%U{xEE?vnJ{+qXu#WleA-7Viq4x<!qe25 zAJCyy^|rh`nbIkGsV~{>=?1sCT17+xw%Re@0uAHlTda%9&?pNPIDRB6#Z$Z1RTIONX|xShBQed5{^G zN&D*p`L%C)x$FwBh?PSFJB%0VRQ&HvQM*=SRtuy1a&5Zu0!|$l??vaA++TzlW3R$J zGwYjX4UH233hMYdN%SEXYdv}slg=WIS~`{TVx_4gDcOzj^j=GOYu>jE>qh@}L{0%k zU)tgrsqd&jC-B>BA(16`p>?qudRj|G@Lnyqf|w0hx05Gko$r;4xufI`co3VvUM+I9()h{-8e&WdB}BLEMM3#bDNP~zCK$IjoQ)RVYXeAXn|c% z;k2T%R{D`zTw~5Yw+;aU)6Ofqytt^JP4klI+KSF^B$bI1pm#o$Ez*a()x zeLASDdcb^OC=O>E%TqI*;%hY9X&bUxQn0^78d_f}uNv-8|8!%6q)?oZp|*X}AqG{8U+oEFvmiAp`O`1hx5KRa(8bDR}OVKK)PaXllrAEv(xzhZlZ&5T-;)y6xSFf&rU(uW_cfz_2_6ekU{;oQ z-E?$zWsCgmW7&H1IS@GU>k|wG7RLLn8dfz*QrF_oUsHm(hSINVJYqcVt!e zGbM))UTkW6SXQzS<+9Edqe^@Y5x#}IM|ZiTeitEd2jD}78$%%O0_`*Kt4N@H)RYHq z<-X?X*+q*zxX1g05$FwokGmb3GGD`3La;Sdu?MPrv=DqTnyd}~;#8`BVr@;{k8Kj~ z+ZSN%2J1Q8Hy4Q}XV=`TcX(*ExN0h7fc21K9;#eE6AjmEfr)jZV`uHV;Ir3iX8MV2 zhO%!%d2XCL_5RBSyu7%Te0HK%CJ~vV6OxUvKs8P|s9f zWS9g;YHyb^D#O>!iRHYz4LZHe0lULWMObm)ePe>$_v6E3iX#{vm#9}|cW%aZ(04>n z)wzARzX*qjdU9dHk3NTe+u>d@aNK(Uj8)du)vK@viPT=Up$HA&p1NRC+Dp8OcU&S$ zDh~r(&tJ=?lgi4u6J(v|{{(FqIq)q zn=V}-puywh(v|mOxk~-vqlM!;iiN6R^k2$HfMBD9|9_vo?eb6{z~5HGhO~_D#qB_7|BaH}{^Xxh*UZgT=|8cxDB6Z1G-u z;Y$yLAkrBE$R0u^cqv#j(oq<0lLWh><4*wbO8p zkGtcsNPQ7d5kPFO*SBf<*?OJDY(#AFB9-a0&X#Aw$*H@*N+Gs;Oa0NraA?>QFQ&HJ zqOIn~Aj=DQt7wMT18s0#AizJYmCo^Vn#O+ly8NxKMjwA@%!#Xc{&rd^=lDMmaQ@nYqs)}5}o!<&(0ou9tn1DC~ zV6+f9>V^==?n(iMQqbE1+>7EJ*Kjs5#*;q=4Z}+e^vk5Kg{|-APVDr-fVAIM zq}JRUfErZsd5^sez9EWUTpb51z5y(yj$o=xI{@;@Mc>hHro~!cY!lhu(bs@5V0tl@ zP2PQ{O1)S@J%J?hTVEWn+eKe))w&bTKyDTI{%l(9mhYE(b5+rG>4Qf+c2qNl#1CZT zV9iQ%hQ7Wv$4LJTf-nu)O&M_%Um z+H~ymcs@H}giak8Km+R$zbXbMPM<9CFBw6;fOR+=@WaDPGT%|5uGjfwzWz0}o|men zj}dXu4}I2d0JU%({Vyc7QZ!}K_^@!>sXrDjR=T4?>$unealiKn2Lwo4n48M1G!_G| z;5pE@uK!UV_$g!MFil#GM*SU7*HD{tg3ksW%_&&|$p*+-m!`+!fKLM3qRPpAb8E}M zH~~zfVSGTm+vmPM0J0DU2S<}h<;wMulZDb5NYOz0+D^ll1{?wugY&}1pw(06MsaDr zj`=S-@zEIYv%qYg5f4^!_W>9KZY5aq1Nb)|9#KN8Ni17o+6wZ5KUpbgI&}vf6P;+I zb)kVKCnqTxUBnn;DVcO&A-D6xfx&*YM*YGe%$^=$ocNem^wgR$cq5h+J2Q61e$m9h zJA=-Ebjz2G*V@Vu0K2qwDo7GMxvhY$#D1vNy(fI&l#fY_g@e`w_tfbS`C9c==nRCslDpjR@co{RNLcyhJ2&P&@RYH<6h^3LPVN7@8@5a zXBNuVi%p>^CcnP_<+bada5^L-W_}C-lvqf@&jaa5 zN>0xDldG3)t(T=o<+llmv36}$`m&o_a98E9q^C7qk7067VQmt~8!1T0$>Tv%8z6-a z>jmK6kZ~MDjhNC=81Ddd3MTm@GaL2i02gAhP@~-WQUadzz4qdwDQ2Oa+r|A|geL96 z$&^e~_21onwdZn`gnaiCX@eu>(|1pxlTFd#pahu51kxv8YIlG1jGi^n39JW)djc#( zs^DWBFd`0ukL&RbFXVfy*I|fW>Po!0KP}h}G#M_p{vMwu;Jj4Sl;>vP{H7W6ks5n_ z5F}%JIyhLYbuH6pSt=NB3~I$r$5aAYld7GzDtx z92hr*Lt7Qx!??mrRT^ktN*1&$OJK9H>i}v3+Nr!2pm+gF6~zwxAPL{Lcg4)J%Y1kB zY4B+}3bVYylr#cc2kguU?3jo`rymn3AoGL35qNVQ}*% zSY&Pevn=x zp=FcPPzR{J!9vJ$eU7$+pfCeU6=XSPRo8|ZZa>`}7=dSo5d&ooq4_7;y6z>XPat|( znMxN!U`w7aX=uv}NLZXntzW=;U4b za9S*gH$hl{#vE;bzM9czcm%3^D38f{eO{|TL%btE%9 z)@mM2n`2Ych4MSR<&=V(LWbgrp zk12+D?^vmd1_>rDSGotQXY;z9zw0X=9_(Km|8yy4?mXap^7?IG} zOdyLWe1COQUCgA#r=sn$s;k#O9||V3WSkXRrF_5*lKgPB#?lxhwR^oy5D)_jjHyjV zK2wZ^!IPUB6qs-NE-vqi*8TlO8BUQr7erMyE*~I4)9vm@r2KSiEAs>& z>%j7}Ktn32P*oPlR!aN>`VtD7&SX}HWyt|lMMxUa#ukO2pqg=m$`>dYHI7B1E~^8) zVdb|^8!6s*5s@P?V7z}(c_d}h)p^i@jk@v*i3gf={>L=ecB z`;J+Z>nRPDx4TU~-GEx%)zx=lu`PmMvba2rBss$X2NSpT3K{jp2u+S6Q*g$0K2yGIbb`sxF zua1`>QmuGn)K39%Dqf;XR8s}Bf~aYFbT$W+?t_uLmej_+tm$Qfvge|~*28uEm;2?4 zME-IRVze5HbVXE%ALGeY!IH$w9qjK@I5_}JF)T<9|DFLHDmkK^%G&FZQ!IS9&43Db zlEx!Yoa}`>LBat7qZh@~=am#(eGutDzRk}5sDTT<_MSAkmd!}ltfn`piG@A9qal@! zrm!t8|0w#sj3m3)*74)0SIM8SmL2()l&otv)q8{a&Il8FtU|C8+LVmo zL8><;06^ewVgRjP)~pbI&2gqNelnr?v>k?ms|{4t+8j218Jm_2p+!03|d$ z`wKi^RRI#dJ4h!4M72RlGO3PSC|7<6Emd2^v-DOoSCbYMHQCA`io^5H6_krN`e@eC zYzw6rV?X2fm5U7X>8Mq{RJ^bXlumuUtU4 z0R18~!+r!eA?w+xt(&C`cOaev6M$4ArNE@qc1Ol~SdW0hRslr+U5664BWb8lk8S;q$l<3^j1=oc5bS*s22+RZy zdC-BMaMBKy0tszD9c@ElPmcSf`q0<DYUvv>vpH|#y~9G%BuAR4)=l2 zN@>i8)JwOmR-Cs6>fh>0C*J?Uz&g`8dN?O?s(%iVU?Aydk-Ps4D{c2^%~=-k&9`MwnX#PcnOIt3j0Sg^;>8kjKI+S>-DoS>E+ZQjl>y%TLh_U)2@!BS~E zaqN)1?^K{_XX{)U>(k462$lvenVFq`8Hsd~Bgkm3lM(K}^VRKF%s>BM&rko)RQoX% z|9?1W{r~mGHC=z;ToT$M$An9_IzRC znWG*!IbMQ)JRx>Ht~H%+o0%}NcGR9GSfGc+c|s3WIJqD6SJ6WsArOi%|IW!Od=>Va zXz-9_P8XLL3=4upJQT>mhsoY9n%~v?GgwZ(t#mZ@H&WH5DIz{HfQQJEjx$0s(|*yg z%v<>G>8ik!`ldNP`smTQ!g@FD~`So7#*I4BmSP&hKSN-Uvj=@XM%{6@{ zOmxRu48iRkKTwiG;`O#Nuc71!&1d^$7ysis>Kskni;1t1`s!496g3?p&L;8r1&-v| z>=hhmn~v3f#M`Le4p<81y#+SUZX#KBbXA^$hs*!>aM3B}lLxD$0Up!R$PG+`6cJ`Q zb7D@xZ3$LIjpEc)agq$-)6_&692C6hIb9Z1%|)vOzXz+sqG^KK&BONR*aJ({#A`+W9I!gJ=yUdN^u>NR3Q|If=wzSDDRtt!H-qOcrI>k`HK&B zN25DQ*0tIPU#k%$VyANqdX1+gki4I6iZi+CFkN((QG>xcJRas}zWy1i?C{=wrk%%+ zAlgrOD@`Biug!g8wo6R3_^(wP9g_(Mhb2>vSSMszwmObo7)UkFp)&g`#iprsAGOMr zt_m&~Gh@R`3eX}c8r8&Ks&1Foj}~!WhJFYjzSQ&Lw4|0-JJ99IM<53P~haAKb|XW zOW5R9W~W8r(bGemC~GE%VG1v@5h%=Gi}r4G@@aQkg@p-1P&Ry-!qa?0ZiHsA#ZR#x z4_5#^U{m>EPNRpNTv85HFn??9$DV6xmsNSU2F)O;d8r;T)tacqWfic)rC7XOY01Uk zp9j`D0sFW~2+kR66O+tLSU*A})mSa2X6K(9+u;qb`^0EH#un)T%6j1!Bn$pTHSgA) zc?AZG^KY;f7uKO|#cqWT&dX}sd(`%}QSX9Kxwt=k(Gvcx)r1?pqf5W?cCQ(&r_%}o zQ%tM-Sbpr*$e+u~qHsk;gITlc$JOTYw? zg@2qCQ|IQ~iR9)%dJ!0}YH{YTV~w1AQEQG}bA4vmmdB2mu#kvcs`0>_=z(rM46uk7 z|7>inv~r?XwMnOWVd9)Cb-w99v!D)bliyLcgExHv;8-gKht?8^c_(% zjAS3^>)a+)?4u>z;YHs_!+6cXmI}VEjU?JP765ij4619SY%TbB!5in_nu!=NP+naz zIc9#OK5Tj0?~MQjWew81)oSt24n6js@4wy~;Ne(>H=xoelVrT=79k>fxp>h0@U?=z z;4ChHhZumY+haKE>(7A-*;I0)V!sRP(4xlvu)lo>`*GB)3q*hzuIv9uFsCHc=fl)I z#*av2;Pr?ek0{&?J@)DmuF>HhNAp-tWkdTn-Qe;l^Z(Zy*;?eV9|C?lX-(U1G4&d> z(1Yn}{cmoE(()R5=Xxusf;Zl1PMWgs;`z7asrJiwc}fFdi|p2^eVit)1yuO2haIiK zxr3q;1`P#$rqfAk$Ldgtu>k2?C4cdv&@6u@LR0LGW z>m!uyo42+8)Mx3DJ)`)K@#NpSwT|hujVT8~sm2YXV=iZLn{t{3m8BeqH zMlev2QS0|CW~a<*IL0S|U<#2RZSa)hPYhQ({hQ`Mvns~*SjP$cwceoOP&mwHCkF>5 z&DOuE9Vb7ZvO-V=OC-st8s0ju{{I#Ike}Z#ZX?UYkV{w6OUfx474JNtjVq{lm>+FB zCrmgxI^H**yH?66=e~gjEB+ML{43U3QT?~9f&ea7u#IlMvIYU`Lnf`mYTG3>XRX{? zz{~c74{FMJTl}L8fx#EaKFrZkaP97HxL%c>8_rIY;Wl5!QRycnQb}(i*6l3z?G&^3 zC8duRIOTV3`e;an1zLUGeZgUM-}=00p57Q@Av+ZB##Z?&g_~WTT;1C0&L7YxO{HKb zHuDDk%+f%mI1(O;GcxlEWVA0qZ_bQvWT3!?-Bg~0sdw)j=@^(aMM%&THx zA;R1)PLTG89!GHL{c8;6KX_8uJLPDiCumhOFqR7Wp$`K=nWMVTC!JXMYw#BaZ&yxA zykL{yd0^si});IK6=>yppF=>JH>jppk>bSDz0p4IT6O&4>lN{Izx5Y zv?0-G2+gY$#x~9f9>RuSx}mO6^~ya&tJEN3e1b9VWSOs;L5)L=Q9*)PA>(?$nfQBP zq@jhgYfk%{WE_CIj{ly3?yqO%m>6V{L>J;%D%#&$AsSaZ`?Qvr4lEDKzG?q^NS41>&9TDgZ22Soo}pN%eTL6I zx}L`&i`$nPTJRCHe;+BZINB~SpTb?rD&Li|G)C>vB5nSrzu{O@9bsFA%ZW<;e5u@y zMF4-OWLbZwssaJQS0Ipj`n|B^lhF}YRn?+_PdoaBaf~O@yxm?(WaxBQV_3WgCY)+% z(Ok0&3m1Di0LWbf9swWS3|(3}H?(O2A>W_T!)A~hrSP*%mr3q9idayS%Tk!}fgc%< z8xPD>`93zP#T!=R;JGeUdSn0RA7jA6`3dqwR-~Ii6?j9&)roHs@VxVNv;q#RrZ0&@ zC4NFq7J5uxZ^F84UjH6>mukp3?6Va22;~3JS4gF_?%<)>{`b4R`A-!Q!j3^kM1G1D z$wC>Ls~MIAJG8{4(I|d*gcP2J^f80KSD}D%z(`DGJw@>mtSkSVY zmTibq+LSaHEkZ@>cpQm0sF7am<%c_djvhd04guZNME*xP^!-%OKIUAdZ8uEzF}e2- z3SBK$3)vgQx#DzUE>VgYbVnG=Y_n^%qcH$I>2+awgP5QNOkCViE3Ga>@$P>s}-X2+R%E0X4A*+{I?PVvO}dW z5Pr@(VqM8AGU7bpBFJ;&?#u1AR*HL*Ms5;Tb74|DEQkXQ;uIAvIp@8fm>zpGDHnB~d+)o`PKr|@+-v&o1Eh`@L5U%bKnAVl!M2?Z? zaf>vq7Mg4reI;rh>N3 zy1_yENEZg=G>$PGOJ|D(az0uG-eUz;69m*fu-Nd>sF^<of8<{$ zg8i@HR1U+R>oFcwoMdC?aC);|8?Sm9BEs<`J@i_)tk!(WIF3xu?HRVnj+%1rj}j2Z z?V^S~hHeoZ%!6l74Vr!7GoaZ>eP_p<8(rL@_NJyLZf*yeFib>5#AL*Z62Dse_B>T( zaUUWPIS2t&a(VHhXUW}s=H4;)_$GU@5$S3U1c%-_Ix zi9_Vn)$x1GNQ-K5mQyu%rgi0JSfK`MTz1XD(F)e&d%nWLq0b3kkRkXw@+Taa&nLDq zWllIunKpZ{%{P8~(ssa*y`(83E4<7Pa%rZ2ASZ6Rv%Sma^ty+03|1~X=oSCuOthX_ zU2bh{$pl}$vH=VRL~+g4u5T4Rpeep@#h#3gAQZ1%K20cHFSaNq;ak1Wop*C{r>e5D zydwbXg!=J7^kit$xU#j?#|I8Ki4e`-lf+r&&WH#JV4+qZ7?(2>w{Oq9PzxPse- zKJAx)1Ry@TdnzjFlorS`uovWp$DG9jzLlcVmg zHPLEcAEJ)?iY4tD+>E7Z;o7;d7nlfvfd0<+9|9wbvUaOBA?E%Nw88#{*erZ8IzE4G zneUull)6FLQ-K|;H8Fh6&4r(EWJPd4VLZ+%3PIa^{zhuvUYQcBPh-5YRO{TvX;HuK zAq<@DX+5+oznzW@`-43{QBm$~IjzyKNEnyZpM);JH8w+#PWXGuN#-dC&h-8TXQZ8` zb#o$1BZ0wJ&AFht_u zh@!u+abLyCaD7ypN9E(kla|%AB3q?L9p`T5t7U*YG5O;o_K%AF9Su=d@>|M<%Pzc- zrRRdOsQ;OnuDAPT^g9GgqSV;bt}XCIkLi7DZh7Mexv_V0_P1F3q> z#~98}G_?MWd!m)%l=+XtP*+qDIZ^*sGi=S)+#g^o zpT_*J9@sd>gczE39(=dw?bhDM{!%^-&;9t-)>YGtL}Y#z6A#Bb?`%;M>?8bZY=kC9 zFmrUSuMhkkGIZ5ieyc>)I4%P^c?3hji}#27Y;C1)CI<>@GJ|ueaWeceZLKS?7v7nLGzSM)%TI31%w z`jpO6V+M+bAKM=69`9`1+hXv15Jh_Ob%6ivt2VQ;>0l`|wH|+WZQ2y`l|#xig8%Ux z?>sZ&XZ53d(yNpVmfNsFEE==vP4tbSr%3tdZ&+Rj`uKeBTw7!M&MzC?R9cW&I3CPB zL@xp=8*L;n{N^m+L_=$;3C9PHz!3@b5Bo;%Kw*{mA_P&>y2`oXi`#@ioJ-*mi_X|Y zHeTM5Nz!g;k4CD0Tv*vKV|JhZXPn@ir~1!u1EYQ1iI0jVws%$K0t(&UU*P6sB|0W` zn22)oaG^UIfaZVuJns3-8)IwhBT75`DMnakd+RDM#Yqc&w1KLkxapv#o^+|Mr(*Ro z)uV$b^z=sgaBlNtjngbyt#Vw`thyz*mUPWMecBXHa5CIl#T&nQ^!(_AuU-K5j{j)y zNW4hWVmHr{4q>ce;M>9`RWsA_Ea{2t?lw#N*@bGy%F>AD%#A|`s;6LJGjbi59SAy& zcBip<92W~Bl@UWCgIde)Cn;i_Sb#dnbwbHt&(1&;-H{M<-QZt+5pEAnC20@#7&kyt8R+8^O`K`GxhOe%PX2~e?lug7bp_vV*Zb;#CA)~nb|p= zXScL=`=MW{Nwwrzu_}1BAx)h3ZqRQKZDMgzP-gb$@-Ks2+#)8x&MF-0MhH^RmcC&l zXQyJ({rbR5m|xGrkLO|VRJ@zaH$u9ptjt(Cps6~wwgQ@b#U_nw$%2j)T< z9}JFdZH_1Rv|RRjS~%ykZ<}_C!eBBc5e8n6yB*#T!!OA?VTyluOee8uR|9>Kr4X|e@oeCQ4pr0q^DDDMh~!1yrO?FtCQ8c4%F6#RdYwq8&VCF-EapPe>i^;qnQ8x^bvi75|cc1@sYHX}aVgF`zoTQ`dT>RX!(RaxAxQS$kEt!pqx_ zVCxMPFFGs=^aT6c5NvzcbOG)gPSp`_;M?#_t8Wj3_`6Q`D?GDwF`g$PVuElNn zwDRiR{7~+N(ToV$80WJYab4ze0{Eoua=t9(&((= ziK6>HnRajrIs_QfZf$a3HVpRn`$WcsNH2*!>!f~3#S$Ea?}8yNseMNwHv zBQ{Q_yh_2OWVg3HZfIb~{u=xMlv2DF(!-+~8j=0#2erFY$wn3Prp5`&d<;33mdY5U zlb#%JE$av4(&Tsss?KXxb0eqM8aj0woF!NEsv-=i8s}wgYV8_lx}!{!lpDB4&TTO& z=m)Bxk5lHOyCLgu*I4Bb&0nutuVvDAzydgJM6k4_?L&R-GYSYGAw*`Ffq2mWmTSqD zPDN+|&C87OVMBU)czG8OQ~T-x5QJS|QoMYv$J_WFa5Dj8Xx#y*XMpkuLIR{8m2jX= zvUP62T`auR0Gd8wMf!H=k$}8q+M1{b7?h_<&WKWfo+;9n_DdZH1J<0f`Z<$4yGN-+ zCE!7CZs1120$~uN#%*4Fe!!GcZ=?~W-+B<>2j-v$0#S@opXAkRt?4PzTzlfWWt^*LJSp zq+uC>!A92O=mM;O(?+voaCmIqLGR@jhZxYGz;!I&A%ZOlBpHL@$%qhulD2nTx%C(> zowpo7Gu1Pq06-WJmB6wt+sc7y*8~K{hR+@pEx*Z@+^&D0+e5R7X#~uj?Rj}t-9J4) ztTfWme`<=TAGfhCV$xE!c#Dd)0(o7vyOy?O{ra-u2N*H820(6s^$N%JQs8i|dJ8by z>)vts5tlN`$^ZhW4Y=C*wQH~>#SMpt$0S|7SgqaI0nm{)H{(XyZ|8TdG8=LfbLCsx zkF}1*vL#A1-FH~bq92KG>Pqgwf<_}$*uUK715(+sU92HvXOvO#q`LHO+*#-QXh6oR zS^Lco2*f}NwqVzE0GItv;jp2hzI}E?g7FxARHb5t;6l4XIV1$ zJP+Vau5+mTt&|@RaraaQq&UEN%#gpzAM&iI##Pd3YI(=C;Y93F1J>L72Alk}AVF<3 zX>f*s0I`{5X_Bhvi(AA(p9}^G`^{Y96IdGzl%I`UZv7?cx~{FI1HIr-1zIJ|BjP3$ z5ghT*9*`5hY5K-!9)g2H9b`V5oc2Pkp<`+2htagDbLNmub@qV19!$m*eL^Bl8*n2z^(fg+G|y$-OvX3hodX7??|WN$Yxr;mcj zx#sW%x2k;}$l2|$Myr<7@}jtH=FJO2EH0iFo`s(yBU`lvT!4Gmpj&UPb2tp|rD8Gy z>jj8f(4QaiI%@ETi=%vn1Av)9KtRyA5Dr9#QTowweS`gS7B%iAGOS$8x-~P@wzN#L z;d5)Ofb&#p{3{O#N7vD;@2}6mGX08*2Fxr%f@H7{7dP5~_Hu&%1{2^%Yo{p*2VBlN zpu-XJU1|Y^fz-2+AB9gt6OZ%%+|%dakY=;=S@oI(d#vzvPs+0HY8Y&EW6wA6jcWrF7tZ<7AVjX1GQ*g-BXBBQ3t^*&wsN`C5ki_ zQ1Tw}@wwp$3)aNfqwjwWajc~eQn^aB)0_~BMcqPSy{;{0u8|hus4k1eR%i|Yk4hO4 z$Qv8$!_V;Hpd@w%2+-~WJ-JAw?XDQs^R|JKt;}hjdmhRtyH_89y}dq50HmK|ksC>C3fHQfV}3u!<7@PEjb4KM^f~T3d7t=#Zq+#c$PtN_CsI_R0)7 zVfCo^4;3x3J03#PB-tsr~g#kX)jrd0I3T|zWna!IL)dM zYK+jNV)i5x^6hf-WbNDPNcPCBSMBZP{`raBY3HnGA>3qlGY~lPAEoyGK;`h~U$eI!J*9p^4E|+UG=udUe&FaQZWRua|ayxPVU_UT@K=}fc->B=T zj;5`u%v2)oCWX0X$dr@ehNNi?lfA=tD4-f=$*~eRNd!W*)!`#* zf4yBRGY>WiD+1G~=`y3G@;(1wM4*O&-jI3BOTWhJ%C^WG{5S1C>M7z=94e}o&+Ddd z7A>S&AMCKMiu2e2eYPNVy#cNRXiL3;OGLn2nrNJe`XMH^?2x2 zLBDrM;=Gb}9=&unBW%osjYLmxkx56};x4xmknQXB#MK>40n+$mJtLOp=3B zPCEyg*VkA5#|BXD3HTksv@Xyp6udud(6r+qt3RkGe?0r@E_VdTTi! zd&EfTecX8bp^Rc(t%8>@W`K$Yjg%4svB-*Cav3R(lBfXbPK1G2v5-*oEoI$6yxV?ubZZ2sn)EC z$zSkzMZR3fsK!e>VZ{qQ=VdW>)mN)aeKB2=%pf2K0gA>`*ud^oC5xgxYqkWj`H*?F zxLgF+P;mZ7An&id`V?Xn$_Kj`@XJ$)Ib;{|DED5dmyVnI8P-_;doRH!K>T~KxN;6h z@Yv0ot2&@{Vw#RT-y|MYEP!PN@AldIth6B1wf8dEfB zd2A|dYGw+6E)LK=0fSNA;w}5nRS-;ktgmwiDsn^nTfj;F@0|bK4du}xU z{&EMT{(CLAU)yHP(f)B+w>XZ<;l2JOX5L-ZL`(%K1Cclu5lzm{<|a-RYPKVr;Z;b? z4Rl&1c=h`af4$Ck8qE^NTGNGn)0;fPrZhiRb$VLM_$krE+2zvWoxF~vj<4{mpQ<}s zt4VcJR(J;hC;piZ>zhv(QGc^jeSg&@3(oNLxfS7@F(9fWALUYG=q`e{c4VP9cBGc< zIj!oF#!CWNEz>yB)^TXyC8LY)7grZ~D348yt$xP^4}lkKYz?CD1F0d9RDriH05T?c zYeGoUj5{F!&G(q^dOK|k_y2fnR>`<%d#nMj`uscozD5w&yCKXirbr%EzSrQpCIS3# zLysHUmijNJFb|Uc>l>0ld?R!oMLBy@fa_!{uMTm3A&D=!Y5?(9+JKIgdc18#Ml+GP zQRBeD^_LqE!nXrO5~C0=&}@zrfXHFT^U7edt7NwOoI(si0;ZISQFlXCUyvecvoc;wT(=DSDD3qDj^mS;J14*kn7}uRp*4?+|uK)s4uR0v?V1QF|PpLH$y;;o4M-p;6Zu($Se`z zZ5ktrVj{%}F6~lg4DenM{Hk(~!`iK=)3i9YJU8+~;JPhN=}>qC?o#FTGe$~M<9~8V zAnF1#^y8B=((GOeIbnJbTl0KQB)yG}hI6&5pO<{qA)JOe1>QkYo$E)8QofMV&npz9 zQNTClEH4RVh;f?Okd>{0*m0J71Qi ztw@v+8_>z5-SyVKrqQz|es=Ge96I+iU!-*G9_Sf>H!LnD@pVN(4))cCb%H8X>8Yao zKCwp=kLa{TS>olgSJDq~qw4+O%ohl6eic&0n#gzc-hD0Z$Dlm@Kob&t^*i4+a#JUj zh4%3?SE1PHn&!N{yhuQg$jTuzzoXb;Jtylt@IKv5w>q@WW2yrMXWN{$*x@8!GnhsE zC$QeBsYIaD3T9KAe zq+983kVZii0V$CNk&;%rM--G2q&tKGq?@7V+rxR+|DWYq=PVp%o_XTF_r7Z1{oeE< ze!YuF*)(_apXP3!N5)U9np9+09?X}xDCZeE{Eni0DI&t#HB({KBFBB=i8>DAw)ickQ1^H57^=&x#cGS+jyt%! zEwqUEnfSJiNCvUkSQ>C6|rne(?&y-@u5O8(-x89u!a+ zTQO9UXxLf!3Xtv#3`sWPe#}H3{Aajm9&nMth&6sqT*Qr}q<2;=@;7!62o842?|8F! zCS91DCT!~jgs1YY7Fqc3V*XeNeDzapFxM6KX|f|ey7$!~Jf2y~#?fkE<@CP3dAV>I zIf7;G`^ZdXxXtN(C5^FOU^$E{Syp7DCBmbvw628;l&kd?{>5ZGFt) z;q3Oc%5#18t!c_lf2P`jH99Pr_L(9mJKW`E$UCaQuh50CZtbV>d6xgXs~h5bRZu|a z7N;m^i|p4Rg-BA*t$tydUjJ8P0eGt-rM0!ScYjyLaOI8?g~+TDN!$Fq^q1QpyjYzQ zVWnPma-=jdkfW8^GrYYD#wXw|e*W+qAMWWs3g4ufTU=u+tEwVd6V4m!GI)H_KW@X9 zn3BR+@?7-TVEiv@4vr2Yza~s1+mo$sB-?)d`hNrkYBQo5`fN_HgDyM~qRqv6?XUIO zOA4`YBfnH ziKS>c)C>73a$1OsBGh1mN+^BuR5{ z=;M4}TbbRVS}X_)yx?LY?X8qzYq6{@RkXW5JkvQePp6GMmXrZfI5GZcqM&=Q)@vR% zb#q017#ycqgX2*{=D)m*udDzPId;3-*jRCKv8Gboyg-IPbP{ZPOULLHT-IRIE>7qh zoCFh<41m56j?;_Tl3#n84er*C*e9*a_p;S9?N!EL1q5#q#hstT9vxsx#+AK%q2I70 z`YVAghyx622AyO$#WO4aamu~@WV0econ&27yY81oG|3>}nsW2#-E>{}&-5fc|LVzp z(eLZGmmg1k*I~hLDb>@q+*T8g%bcJx;Y3iJwy<7(6uDl2t=0@8d7Ln(?U4(r3n^k2&gxg!(HwGk!QgqASwYUv`mgEnV* zN!)kz;h4d-0#?SmI*$}yx{y|YYw=a6W4)*kMNNuoE@t92Er8+SkchA$Onp*#1JsT& zVv4>MRX;@(i`}l{u#lbC4*$epbAP(1V@^79y&pI8V(W!Irl9P+nvQ`k`|$e$wYqc% zfAO^2?+%(~#V2e|NnQKIt)6km^^b_slIXAsR>0VndE@h?%VC`moy9!}$x)TbRP$g${{Oyc zWHw-8U}uFifR|b3aJ3k}tS!PTqQ103nF)9Y{8q%9w-c$U9dll>4X{IN{o1bT&o3?p zyS2b=Q6{cUzzC8l^{PbTIINWcH~=R%c(TFo4k;FY^hfqP3Cf-gjDq2aYqd0TPjA=56)yz1K0=Ya;C}@Ze0Ri}LpJ1}TtQ%KG6x3%N=1nM zQCU`pbf#OWj1BJQj;XSeY>!>ZC>S~Qt3=%4+e6FYnWdU5rRU~*zn5(`cuH+1TeB+vp)E_z{iA|l@Jx@5P-n1+iaCm zO(WoXY<1VnuLU5i-Ov!5H#Zo797ETEk1cb)1tLhez!u6Cm%ZAmQ{z1$ksItVdKka; z_AM4T6WCl`q=JXKzi1T9&fNs5s%)S87O^pB*l4DD_6)1_DPo*&S%LBU)Xb_kX=x~~ zU|U7N#Xr=#1<-Fe+jv8q39u_9)MTlNaoYgU#jXMf4LN2Jm4faahw!epl;(}qY3yJJ@j7=@a zie~D;Sn^??+-vG2BE+LAcMbiU$eQ9KqmFUDFBH{eg<`!Mg=HIF%%iFx%sux=%AL>N z;)Bd8LyOxRKc9arxt4M>F?^RYa$7T%;u5d%&Y~9iVbkz`DFdeF|FB*J54fEHn05se zam)0~f}U7uPo}s>=TjpPo(AzJ5L4FLx(4|mkb)U|BUY`CG~&gc_7uI3J_RmL%=zX;NcI~yvU4)3!dAN zI?T6E&HG-i3}C6mrUbny8MFde1QyAnx2U;AUa)>=rRisO-T~P_s z_5$aaH5UxUSOSD-no+|ges^z1_zo$ravXBNkxX{em-Sx8N z#V6F>Ic>3wqaxbe=MtveExoDQZi} z_kOi1bn@DNPlvQT_tU#2oV?!3G3L*?59YcbZn07X-*tQCE%K}%;D9RO|>_{+FHhe$U|y0xk$4rVuu=50P4EGyk=Y|?g)PPv zJgRL>05jjk!+Rb7YgB@v?_{`lZ(L#Vdfx0r?32377sy*Y94$FM5dG}^Gu)rgpX6mL z)_ZTHzB$ZPT>frVUO6tMPm`5pVp!&^iS`YsTz^IBobI)3cE?h}dZmTg-J^&xeeiGB zyE;|(K2%38C2%i1+co0*rsn4H?~p6mfGO^wd4BDom}5yEgYD?BIK)(pgR}y697rcw zO!re1QcdK$j2Imi^DdxE{8Woxf31+#33RQ5S?pOzh%{`+z(|>0Sq$Lv!gf{=uMnxgjNlA~yeyU>e~@88RL&VC#*lTuYhXD$^9cN=Q=;HAz zsxr8_4{uCdS`{7$K-{H-4PJ zw&ZkF7q;=m8u7@t@O|MmP)1bIS&zKcv~|Zu4U_4X#@gz{oJ#f*B6Z}g9(_H>l{J(! z>{79qjC;~%;g>nt+YtBZb6xr}sH9rk8I zqHR6dUFHQ!9-H@*@yHGs-SsE-dhw)!+-azPvC;0mZjDzQx$4>=coYggAX%U&p@@I) zVt)~d*_@!D`DmWX$9~C;IR<2{X5Gsq->64ap)zwWI*4Ee`OQid#(a`XJ#beUi(q zVLadM8C+-iam%>FyjLPI9RemP<5N<|KN1ip54u)tr3nIS`9CO`!$t(sZh-%mWK(dU zfhF$u^{TomEAJn8$fLuO00t@V=QSW6iOJs#Q>kQRs^2`WwuG=HF4yQT%z!QE2qJLF zsJ`MNfYOGleT)CyerqD+=+=~8yVWHIF`m@7h>7uGUoU5~Y3-*g-oyzkAHag6Od%F4 z3JkfcBf7AkgZwF-y+mBgTbjw;FkxSAzw?oU$j4h_RZvL>U3}%fJA@6&6e&feKx!OO z8sFm1$Tr+wEaYz?`l(2(8N^loQa&ClVFdrE9y;RvIj6*SCd)jO{<^|*WK((uEA)Ww zs%Vgpb`2^@$O+t_gg~5(U!me$wS`$58Qt)7{ENO$TF@>&XJfO}Wn3Kv*P1KtcVx2g zaLfHOgX04d+_fNX2n0d3{5@Y&J%0Dh09k6ie}^1GPqBBD+OZek3dAbA-7P81`jQ@& zinT-jdpu3kdh(C!tAlI)0Gs_k-r;~R*xX^6?}eV(a~jYi3W^nXRL* z7F=w_hL7*uU3BvS9IaHez@q^sH z?T)GL$^PYCxC>PXe-j&%V54FIDSu)QX+#j_W7dQvfGY9}01#qk$6p_AG&d>Pecz4Y z5_1=|m;bq8Xp9139rQ%A?U;QZ*Zqk9{G5d3{6FB?g!CzQ+ev)jwC5H{_ynyW@U}L+ z&c)N^m0l*a*FS9-jUWqp@*toRusvi(8FH&ps1~7H}AEJ z$YTkgU?1)7@A`(HEf22@C1)K%==kw$+sh$?1N%J-$WlD^9FZyRP0xL=*F=K;dq1}i z0;<$07r!Xv^YSaZx^@J{YZdh@?RrD*WHSCST6{~fJr{ef-&`kT+WG`ufMh#4n(N=C z3L#;wW1j0?pxyzw)SPWj8au;DUq!ZL(IIr z4Fwgfb*P@#79nk2Bk_rG4~XzJ*o2E7(y!m{X8Y>_g<<2t^3ch#ubo!LN`E3qu4-uK z)JK>DCcob*9JHdWuP^|O80`VR4TQ}>4)oixxLR{Rcy!di#Ke$cV^g}--=9(H5F8=D zL`{jjv_@k$??`{m03LrV&E^W(!u%dtkRI!D-BY=HK`M#L0y3t?P5VtvKgCYza$xzf z4{)F;kr)Iv{#xdCabZ5B#4xG_UkLm!w_I^KIs`H?qs0I4dmWIv7kmha19sOB@I`~w zn0W3)iY-2*FfncG9d3n#CslSETRZ=B{rzP@1k_(&r?oRb+L!+>x$^WCyO0P*8*{WM zVM={Ye*E=o2$64T;TDBR8xzVb<5sCJINbK5xm1vI3b~YrUMLe`2#d&gdJi&~jmz{P z_4v817v!k@#?h;gtAp^z?EH?&U0q$pr(0WhpfdhYtkWiC0b&tA`yezNyCT6RxuR<3 zfz7h1Z`kK7=!0w=E&wEim>@vhfOL)fxvdE6w_24vcpM<#jPh33SbClQM81l_*1O*$ z5f&jMNrw;+BnJ81<)7(*#fLm*iGr_?+}fnyfnx&QJoJ7zCZJmdR0-!}P7W8BfAsi( zxuv%a=&BG=5JIOo&BZEm-$5FV2r|bRx}RZY_jde+tbtR7%T2-kmRmF>zMLlm;#H;3 zaSd{_vzAj;Aa|$MVQ+)lX&8=&D-Lv7_3$GXyePLEKq~6$>Ojv3a0^7)DMmtcIV6xj zg%sFcZ(vcO!9W#rjnqj(tkE7;vLSpP@yKt{1@>9KJa+4^03h0db_)vPW^UyzA7nbk zO*fF1{Z|yqzoUqK7Q66kj3WT9L{B1b#8czqia8lxqOQs^}#=($j!HUjV5E z&5r;5fF};Pd``@+7I+)M5AgCv1J&f#kfCJ1q@LO??vMpgc-SeUV8PAis@?Yyppg>LhcO$qMR;O z*H+5#^ArAle5Vs&rDLy8d~@I3+%O20U0ef$*3) z$3Mh$(83Y{0+qs-E0D8>hywV<`fGJf4=gSataHq>4x&-OAL!#1O+UfM=`4me;yYR- zfT~Qrs*t(cnHVDL_}yyt3KqReWQ&O)s*9p`2R;yxOQfiemeiOB-4pXu*To|couyUL zsbPguu(!l>`jeSBeUgLSJeOw^b`-$qRPl*kUWS1mWXEmzu$x&SE?av;=VKGGCl%j_ z$=QGItY{6F1PE;?0Dk_C2pM}pcX=uliXp_G{y&{3Pp=Sqy%N(uQ#QZQ%Y=CojQ1iV zLMxSM?X9dX1jZj5PfxZ;h^ET;fO@^|Zq3G&OJnJGi@$&p&@GOdO^`-ZUPF}I>xIfF zyOcK6i?=noB)$*pQ{ZWrrG$f0{Bs$>=oMl-4R6H4#cFS5w`3{62PLGZEMl7YIeLDk z98SfMK(=p)+ZVxxQ#wkf&#`v;>rp^!)1vwZ!o?q)!oJ)ob8;W&XHy@qsq z#ZY&S;-Tdlp2)fm(q4fBK2#cQ2Had`G3Qy;yVWl7N;w!=Xc4s?K#$GSHMHJ%t{w+} z98JqXCmat6pp6jCbMW!}Jr$LSjPH(Sdv^$>jUe6uQ8cdd zMoC^Cw&Y5NguU$BB(VEsAxi|u6_lR`?XWBQ>j7f|d5gxj)%WoilST_VD3ER3KOuV- zq5-jN%75yA$3q_3+`jdRfWUH&nhV+$up!J9t0#LhL7Avs++TgS=B}us?={mR8>OW? zu_CSus3Ckru|b}*Q&h^S=fTPb)v+6ky0MG0kw3ll1qW>vdqaJBYJ^jf3Lw=mqM`gW zHw0Rd@y!MZRm~}T;92xn4#L9>ByTP@19}9MhRw3oY?ou%Z3A~uD4x3qLMe$7>8-X# zR!K?DyDS`bqG;mCWriAMJ&&bMh>$fkz5UJ%p#x_(Tn(>W8<<^$3 zyPrEBZ#QrTPkDmh=BhM;E?yCm++HaYj_y2FGS}RN?CAeu9$~(PGj$uyVnlP#3!hsw zLY&;lkNY~-&~##FOW1uCO$+wa$`H9fvkuRG!F>m=9aP`q4)SP&L0vkgHN(Mvb}wIp zty=8D`jH(fcs%cJRtlD)S(tiM5Dqs6T4GAw9pdn>FU}8+;bb<*IhV9aC}Ss7m|_JO zeEW0iQ~`C;8Fae?i#w>wEKA2N+h2~nHMU4xdl;v2=j7U%)+oLHSC zVNUqQAVu9%9={4n0P_dTUUWlyu_)%*W@rdFH|&bz7l;b-M^@O1(_1Me7>A4CuKayu zJD{fmi|#@Dm6){MBh5C0hW`>l5&I`TNa%Yt^E8gXojm$045cSl%L;+>r^DOO_o9A4 zL>P#UA&AsW6kmAu1-XTn%UfvOVFBAsp~k6arOTT5Pj($OmIfEby|O4|J#k2pN%XbGq?^zFd&X`X|VDKp6i-d+-X5x9z&1C zUU9d=$2tj#%qo2b2z3KS0>;{G#f>HbAC(ku%mX?4C*jJt9KR$S9NeZ+2*erMs;k)F z$S>gzOScc7l-fio%z9BH&G%lS(Lb?SfHX{qP;7+F6ZEbwu}Vmf3e1tLxCZT*(_k!{P>N@L>>beE_YPxkVd`w{%fa7{gv~c1(s!^liF+H8SgMnP- z3N3z^@lrJhJ0c8K@q>?tdq4J}Im#itU=)wFP2%;Kq9|UdpyFSE;URvqjc^&`TluhP z00L6))IlDwAxK5#c0vK-hl@i4(&Ua-U2KhQOgUn1ftBY1-#t)-%~41F%z>FIQ!adM zQsR7fUM6qeyW+Zkj|%}Xgw;0fKu%ErYsqIFq{S{|(L#;Wo?Qyq{nEpUZW5M~&k5uo z$J6VQH4XwK$1Wm{foGtMdJ8Z)6k<_a!(aV6io2_}ksbW}1fipf3-jyUM9Bx+0D$`s zVxx+Md^hT#(_UEbW*Pu89`+^3@jZ{A=nOFJd(Ena;oHW)GNAVxDk4R%*5Kr{zNhwk zU63&-@z&A?t9f|`iPUm3EqlIfk51Gegx{qxK!o|610GGVUgoL~Cla_2AV8oog=h3w zA!v4Pkv_h?`WHHZ%EHrQ4bUX$gHC6S5r~+%@2jh;Ud1Q^Xz&ANV3J50Eq6@x>7c$% z@i1&k4r<-gY%QrUjR4D$@;SPL#vMxBl4)opL9rR!|3c}`I88#8&4<_bOP}1hL0!WJ zgtQJ&lNMrXLcCtoO7sTxN`(Bxa)* zHX#%q^ADCvC#?v;x-6;SLf6IgG<^l}d0E{(D z0WLAxw}KxSGY}?Lp9hnZie8Y08Jy1KYxIU2a5z~M0NNh&#Rha^FU88W-W`~P^P;@YSjP-C1&B)av!hIKAm_Ttm0eQl9h!^cz3S`9x=p51Qf>!v4z#YwFm_@&lI z6R?_&t1p8QBi1pdO}P&^DV%R1krS{iu9+OF`k#n}{gUysqoK2!6pT3VXFn(zE<;T{e6@^L{?;lnY+IJteG$Mf!^F;vo3A zM!?*_IT!;Yy);#%Fk8#;HU@tbm{f=BE6Nrh7tN~Du!*tWYny`j|3GEe%BAz9*|$V} zgE7N8F&Dm{w3d)cVe%~H-Vf{x)MPNu%gIB0IeB~vLBcc?)ldwck5f8*#Dx+2czHIx zyW=$!%ibL+YYz95RE-+Vu!A0^rQE!o0JhqqAmsv+$$ci4;X>`_IxLhjF=~H7!QHA& z!C1a3(zEX?E4X113+cvTxr&Sp*2~7#L2aH7Bo^eNB1sOIGU`nD@-$UyKCGz8wxYd* z<8ztON#nQtYQ%=vWR?3o7F?D6gRU}$6D6;cd4 z5Q)hZKv#N_d;_-G;%aNd_NJH8{?Q8aHr=rxLD7QwA{AN>C`dq(N=&OL1M&&f*`O z7=;n&#rip^tM81hvqHNCxI{zIY+9}P4-l$$59o2lMLV~pfz)!TWjz`@r|ci;O@Ty? zL)CWJl&b}&aZKQbRJkEhM7OF}rty6c$Jj5Oq$zw%|zZiQ)v&2*jd z61 zqNbr}|D74YgLTLuzrmhYd$&ee{m>OdSF|%IM(pa2T@qr>n$>wHd_zRw>-aiNEz!g( zrFWa4X`P)h8*2BA$GZI>L%6UVEESJShV+Y`)k}E_Qc644gva>SYAQg&2U8m06Ie53q<#h+IN!5}Y*w1m{&66uXvGm? z5QgRwIAah*Lq0fiaMzoXay;}OANQ{)}Y(E}05G$O>h8kSv!PQCI5 ztF5B6K}q4d&>wGBRy{dX;S{J1uQwuKcy? z*qpz_f6fIeWzUdi?YG7Yn&I?Msw#Z?kp?mI*mkiYdtUO5kfn(e;4;Q(2F{0_HGP)d zKUVKMbb+a(__-NPNXaw1fTiWR#jh;9{*Rye!WReo6;$9@QC8bv68Xn+z3$J%5c>{A zQ;LL7TJUI?{e*VZWvXKvmy))_CuUo=Q7PhLcdnFoM0@4J~#i7%W3uvAw;$xSCk#SE%wUfD+>(QSz)}E-iv1`c09A z%@ym~D$h3a-pL$yz0_RGVAHZ0iR3PuhqQ4OHfAxs8OO5`!igQF~LC^X&oQ? zqSQyAFp3tZDmc3G5@q2`#;1@o0U9mDRmgDOAZYhM^99J?`rQ*GQkhzEP-C;o;+r+eW2i)RQl))GLcJz@; z22thV;@#oK72x2kwKP~3l{Nz1&_zd1ZZY=|WlMTn$(T17uo>DEh1dqeY6vjrVe!!S zW??91>?XCZGFC&q9j#2j%9$WwNO8|%$ zu`*J(4!XP3_ax9})>^>!A4ze`II6r5rg@m%&w!x3;O#oH{zyweyS`j^Et@A0u!ljXxJe+`<5qix*yJ&Xt=e=wfnEFt{+f> z#lBTy*^CYjI}oWpvn2a=$g|c;4>kp-LG(o7R8x(ff6`MLBpz1ES{T7Nr+65r{ zP}XsXEofcFD)SC|&5J|fbyJOHSyCBgGPjvJ{yB`-{${gufXITjlzyyG?DeZ0jCr0> z35b$Fn9wsm-rGHSMl9WsWBFiCyDJDb&(wy`>8vei_b+jcWn&^JuX}(|Z*Tu>HT7=2 z@RZN&2w`qzW#{7QS$6RAb)NRr?*V;LA1VD=|Bk_5O@3x=Q;yMx#wVxo^^x$-IQL+P z#dw1%xY9G|=X#3S9_(0prQ(SVD+Rp#4nV_BY8@EM+StBMun^xE+l{`8;n`h!K%2W7 z@J9U6E%1M5WR>JlZ(N8wVmk=>eeV9hJolW#*Rj7t3P`&tBuq=c5DCmJvg|k%C2qfr zT(>$Nf{iI?+WErT187?AJWM(F4b1G3EHQH6QG6pMg8H-Ap1Jb*Czqv^jBnl@iZ{f}7WV73&x^=6JiNbovGRetC$^q>ayIae}yNW28kzW-JO+5a^qScRJoC zQ{g^gg}*(D0F8QU9r!M)$w`{H%pY&7@_Rfr$ z{8oHuK{n#5q@ae}hZWA9T_aeJUw!X#sn zv$3Ps+jH0$oQCL*tUgQG6>HbfK-)Gc>eUrg|F5Q!aJ2rieI?~3$tMq~^&AL2z>ncvmFcNfo}<&s@ZP|lIKQG-;da+`mDdJ|KK{`Z@EbgWNfF!G0E|J4l14O;46 z+6IY@O`Lc2QxBzvW!2IoU6I=B0k_tx>>5&QA`Q_TtA25q7bROf4F^1{p;*N~{ax=< zDPh8S+3q&)wfy`d%;DJE6|!rZ71{@5@(PB}?i4N5-t^yJ{0Rxx8Ly!$hdlyT6j_-T zn6iZJIB8rb{|v*tDMgwrg*0--N?@d+j=%9A4*-j^q$;SGJS`VOE-!#17mAPy)whF^F>KX6)FkkE05Nc)qr>b@zEFPp*D$!%RG%?T!r-C*}ro{ z2-N*)KFUQXshL?%fX)V$$`_GVICJDA*OC+C$f(IA00?U<)%4k$^zyA%&5eZp0P;g% zNd-*Bukn*8OacTaaH)1tPh(otdw`Aj-9)_zyp#<->17&XM~`BsaEhq`{iautC|o6m zCzq|>(tOA0b7MWgM8F%s=ESHBPp6;=mKHmk)B`6t^x@>=fdQcJ4q+1m)$q^eJ26gu zojfJXjG*&<#Nuldmb49{MRE!!Ov-j&<|?0=v|A%VMs@yPQGS~3Rld%35Zi8HH8Nnb zS21do$=FaFi{9*Zd>69{mkSh|#5XyVjT#wYt}%ELVZhLFpgzPP0AH3S?q>mG`mjT{ zD!~%zv)l*W8|>U;qhcUq&UdhX2%BeE*};S`up^pi_&yM|@Ob|@mTsKCZ3sIloi$Zx z8E6V&@Stl0l^}N`rojvLN+|h&9|75OQBOHE%^%VW>etoS!hqe+i+}#s^aU{ z1Fi9|)Qh?PbW&^kYf1)f5z8vSk4-D%Pc~j}L5iWIH1RSq?a3ni+hztXFO2{6A9jA@ zlTG<+9i_rIZWt#Xu%Q_`N>ft}OFDgbxzl}{8ctA1RV3f`fa5!wWv}_p5?7 zwyn%IJ0{Dzo*IMSktf+HfKB2%+zs<>7)ly8(}yq`PcWGHtdv7iIS1<$CCl^wNCYE}GP zDo6dewnlEi9~;3yH<@>9nX zy48S!;y&{F#dSr0U)%32K1rh6eTHR^C3Fl;oR+VAOeeiVwD3@%$D;1?)cRgpWZ+~NvPsa-s|>Jy=_&(Z%-Vt&-T+L zcWaY|5P_v1Ay@aI)(^5?>_QLpCy;f3|3EMbl$KP|Lj1sm+=t&Z7G6J7;sLdYofT?U z2;d-)hoJibyQzzNXy$puP4G7(2qPj8JR&@S>|UUWO)iq>x<3gkA~ecC&OwO)bRLQg zfyIZ$H=$>6DgoFNKFG_^WkvthcX=4(_+3D_Dyrc){5=FqpkCG0Q4iH?wc5l1I;UUR ztIbPs7J`7_Q<#F2ZPdHf9qIF74BC^+*o+;Vdwn@`=o}bvj-JO3=rhSmrbbUHDg{)Z zOuW%605kr0e)Kq+7(K_Thn>a{r9xO$j<`KU6LwYKibUlx(ahTFyLY6#6B&I|aRk%z zE1&HJi9HCfdh5WthV%+30!DE)@LL0ljkxZ>}yQd{=<^XS_I zfe1yJ`x>b-y^K+}7Cjc63BhpOpt=2D>;`1tJb1uxHWlR0ViT0py6>;674yM#nzd>0 zW3IjLtEf{zaY-9K?kN-8@s3b<>-L_NZzJw(8M$odPD}3^eeNEJ6wIR19*D;8XggZMoGhE7pB9dizF#k6r9v6G zsgbXfQxP{*1|NuYKYz~gepz)QYw}q8;c;j(#zcJPrd}HL5dkJ4T~E;A8NqnZhMc-F z+|$j$!T=iIh>{BB;TLPXmO~Hxy#->=%S>OUG6 z_0VvNc5%9t!eBg`B0v{K0bH?u`chM%Q;qvE&`FFDV&?cT>Q^Aiqo5#`fGmdbNkMH{ zipD_px{obcjJz8N)qzz4?w<$&5Uj!&R@pbOa=xwVao&WG z5wq>ue;m)Ock2=NwpUK3Gjgn0D} zhRIgze;93vWr264I3@qv8%x2v4IeSEQmsaL6*XR{G~ZUy3sChDYrj81H6@wh32!ysInH-!tw%0K|8ovMD{pE zM9>t7>&yI1XD*|KZ%xv#zQ49p)4Q7*{!Z=6b5{5<$k?#3VhDhmVrDj1y-H+m6A|Nc zabTez=iuxaLt z^1X-|Ck6c9#lJY|g;KWWD6#Rzdqqa`^khmgD4N>R7MLr}2PQtXBl-mM5+&XC6+n3d zFlcqEO*i3-^8h~Gh@xSRxC*k=DL)X=M&-m(FhPk2gNb97VjEBn_Uhjr!s~mDg?#uQ z<&`hN(>)(G=?lgQpivZ8fz@>?X{Jv8M@TI+K17Xsv7?kYfOO{@i?WIAzstLZ_I^2X zYu0KQi}H~PO@E{#M&Eowt?>DXtIOAhlaofu40`jffRpd0S;_ZUQpkCn=foWG>QS`f z=35WRj^)FhQvYF|J#p;-JCD;Q3j#)p)gNHyk^A3Whp4H~pFcOL$0M~^bRoIvvjSrZ zTCcyGiCxg%{_R&u_7BV#Rg*poU(ZEul?Lf>T)kv*DvlaLzBSkR`TvFqrMz)kYv2!{ z*@A&c<>S5e``@=6ITMhmB4OE2VwuHEL3ukUNsE+IzQ4)i*i0Nawt9eQ^&)7dHG7-##pP_A*CV-LMFKV=nP7W*6;$ zL=>;_pty^N<4$1nK?w%AU!61mf%VDzGzRPq;G zN!obkDRfYzUv)Dz zk$;>#=e_%w1y?RaJ7`Yx@1beE((Bccv$g*OkCHc^oL@sXT*|=tN@uNGl#k6@lM0Yv zRA!G|k9jv6I=4JNw(++=tj9FoK!CA8AW_2_OdExWl8zuA>j*VSbv(bfs0Ec??g zMso*@Jd ztdxO@;};m-acuu**avqGk^_SbjUe{c*2)gdxb7|a6##=0d*~t%px~UDp-hEP&oB6V z$Ku~f(33w$iz>&&+f8_=2;>?j%>?-5GDqx$lC8_Al$n%My}~abV4Q>5iVR(O8L%Sf zzUrW+O)MR`XBsURJTJ*kERLtmF8i&(8NbcZF@Lh~^VFhFJ0+s+#pF1$k=%|%~W6MC>GIpa>DW71?L zu)J##^3;qEFSOa{b`zczv7x=ap`oE19-f$w4?QP20&$UiC>I?*&FdlmZ*$n#5L2Z; zvylDWESniKHBm{uSEVzxM(d{hChM9>vk4^y{m$q2=>-HDY|uMM9p`Zw)x(6^w=a%N zsMreHb#(B5z_>QCvcwD)~~*9$1OEvpv; z6E4Z2iT9_rzFOg!1ozLyDemt)2~Jan*4OLcl}!<@hCARO;QNo+odARbSXS?hLl-;c zEC`GWu0kqI{TB~ARiXqrJ%&&&Y2V?VOShkx?+0%gss)z$C`+k<{{Dgf!BlZSx%u0K z#K}TkLy;W@!u-l$YOQ=HM9EA^%#8-EcteqdTJh0*i7|S68*~jmXxi(mf>#j0+8D^U z&cXaIVbmkujTb&sKUN3NuOe1&8R7;#E?D1iaU~0rMSN;A<^O$aCW($0!`ow6W#K_IkV_^3hK2j~OzI4@$)E4}ke zjyIk@OM(>{p(cy}JZJ;WKutmUu|c+8LEGeRB2?Q0ilDmy%pR)tjqPm+fC6j*hfbV> z909N$Q+)fLZv~mD=QFzVX#bEEMx!d8!by|*fnw+P3gYs$-Y=I;gfDtu?XIqgrgV>p zsO1u?>DRr7&vK>uQrZOqp*~X{OWX|kg@1GDzH-lz5{n{Rvqf4eO)Yw5*+-PT4ZL&K3KAMn>%>f9W5YmEX{WpcqZ{8VG{g4-ASG*kT=tyjCxG4oP6s`( zZmK;j?r*_y!mV8Pnj%{|#?_bo=S~I(A1=cG#G63T3TC6~0LE0I1=LUTtul~*K+8bC{(`t+1h~bX zzv5gt^9Rn|=e_|Mh;wh|9|8eZ>3l&w#MR!Nzd<5ek9{B`7pg3{DZn}!%?WKHVq?|8_>^h%db-E=#ed_#e?5={EgAB-&B_)X$o_@n%V=fSpiohe0;Bu)Z)=xj`pOH!!V-C>Gzubc`Oz0U z4AU>@8+Q?SG=ViFBlo2NTiNIgYWfnky&-n01m*`Q2C(ddm=BvMOxh=sEU654xh@!u zlr-aEgeO??pIvA4VVWpBwx{t@F!&pEbs>>xs{&I1Y_#rhOZf6&9rB0`aAVdO z!fgr8a$p64^a8C@^{R9dQNlEG@yGk#PcK2|jc@`pw~6rBqs@H^BY}kQD$&twBBCHe z^PRiHp)w$*&Ko4~xPR4KsbTuB$Ne4Um9My4Q&QI>d+cDs#T9yi{qH|=aK6Qj-f+NI zbOUE}4u+ZD83Q~oBB~BV-(omW#KR<6L}32Isq^GgB`54CY~N#BKH*fwrA&Y5F(r}Uw1pNo8L(s<93KFvl$x`BgCZ) zm6=}=AJ&wM3~B&`BK8Ev%YW9YtEmPdi0}1Q*Cg-aJ3;s|w*|hC=Hl(gY3GlLwM7!$ z?kQJ9OQeLr0J8Ay-SdG!&A}P^${P)Sw{k5_h&&kW7T>S=0HWx0T$&?!}C9M&TurFE0M{$z?LX}=Eh{TK&vTuCsZ5t~<+MJUSkbXtQx@ybGUcIrEQZ**WdsQZ{+S-? zl`q&PV^KKFxsxYO*>w~F7bbsr))L_2`S?&89Bk$>dph$b|3+;;t@utbelkEa$g!4ecr8nQ=|62=DUvQCSSZ#XmhGi_gW1sOTvz7mBg} zaJ@yR5}-K=X^XdDJ|fI)?fdbrdMXa}&8Le9ah(vi#z1oTn#_Y&aP06;n-!{ZLyGfy zA=cM+Y1ba1ZeEC|Qnx*!8`~x@T=C$+yB;eu-NB^?K_pn(2sk&1n46xNJyv{)PSv+| zQ7bFs*+WvtUf53xP7^{?R_o94>&&$|l@NMM$UY{*KFneQsJo(~HwbapbeGIO3sXYBpbk3fmQ&<8lJW_-R` zL`%QlkTBrZT{=4jKf3+GtI;27P2yHfc&^Lbj(&7^qw2!HHWN!rJj8KL$8k3?EtlZg zd2FVFP;-~$Rt)uXs?JLzW?ywWE%*Z?$f?5nv9`QmyBqtO=71WZ-IyWP9eZ>q+mBxO zbn|+CxEO?!oBhehDNl)4Sy(<>Kh@j||i!_O34e_e#xB=Dj_0^fIaBjHaeYK09J zv2$Xj|1}cmOm{`R%=&+br z51uPT6w>y$lm-&7OaI%1$e#LzpQSP1o4CNXp5bsloh^u}?Oz(paSENl1yCtUp>W{M zXmaJRR-3NzfwLX&@6$e-EeIKtj_mtUH2ZEDoq_Wzoh6ut8PajZ|M%(_v@kFmhDBYn zu8lNHIE%z3_Mn0oLG{Mw^QAK^bc=gyT1vRsu7lI~Y~hRd7K+++O4naWZirYBt4KrXXKQJOT> zp{lhH#8VURRunNt~LpD@CY`t`iNeuTi0~=4@eoyUFP~f024v%zP)#IyPM}V zjH!F>sdG+M-#YcKr=IgX3#+QoPX<8{WUMh7;UI??8y-2QpcL0vAjp{D`fpw{z(NE; z5G1>dhRB|~|Hj|WN z)tL>VUYf9{Wk?W$26O}&8!VVVZ-9jef*?qC8JuuG2i+A^N)?4h<7zCf`aR0@Ou0U$&WNV7NgMN3F033{Di&7msnz#@I$r>vzU-slv&#;Ybj|D-Hff9*E-GOjZN0&lDJ@+Drj0gfDB7u^; z9GBH(G#IiyoPI#z4ge5}$ZekJ$A>!q_p_G2{=Ll|jBD4M_A10-D8ij>Q-Bs^w)2LvJyl*E@nBS-|CVRFs#pjcktvL689viAL*NyACSWCM8z}l>olI z9}1LG34{`#FelhmUYIk+wL1!T0DzXR$h&*mo_VwW;7MOR;m)4y9z%M3U3wsy7N_=n zr>&ORkwygwMAcXKb{=gDxBBAWyfANCfhpT313{2;lxx2J)oc#|L6AY<4ulUX)-8=e zg#rdp9uAaJkpPrhoq=#M3imP2-@kCb^LfjkKWwUN3C4Te*@Yyld5?#TrVvurp{9qL zNv@y49uEMZQfTOmZQkAKi>P0lL=a^3h{feVIOGe40-gYNx=P2kPGZH8iPKT7HSXXhbGuvb7i*tHL z4o2jrj>!Lg-ul0vwN%%70s7S3(5G-GLlf?aYW|3Ns5vYO1PEA7()0qO6@6w91Q}5x z(Wu8C=4r>O*PV|`p55Y3d;aM$SoJ=m*pBI5idmqL57Q}s&22h)9vk0gl1h%UCenhptQC5 z=m2i^gi@EmS!U5q59y0KTMBfL>vA|94pBtQ0)k{8l~S!=yGu_B459;5#0(g3OlgZM z?pQ*t6Ch)Mf$zC1+}k~o-N(9~d$+N+CDbFtIZ2Tp)51aW>tqnF@Vz&p`P9%A+jhWP z;?!R;6J{2naSK6^p`)s*KM)9jVQ)~s$7`<-#zRUl@!h~obd->;7<9$rd);w^XfCq| zOZ57=B<9gS_ABaYt#2eVtND2oMSYKmaJw7?~)ci9(>76>m`mj``GMzJNm#E-o~E%}8Bx zRIk_LYkCA3BRKS8nE)4`UzzQJj2{lyo>4^r6z*f2sH`@&h2GuM_V(v(;kXLWlj5|m zNRE9t((n?Yzeb>cN1BL2ch&}q9s23{h6_r~CL-W{5kZha(cbC)%uoKWE#4WCSG1OWi33Q<+-O(6;194f((>sJbtt@@V|BLW2z-2Qxymy30+Mn%{7TLZTj<_x+!|a z81(4$l3vnFI!O=&0x|$lAe7R$IVQ_;)EZZ8u9H!6#4R5U#M&c@LKAJpRVv5T9i8-x zsBf7=Sm4y!@nR1ISzY{!yX8QbAtZ!N^?K&ik$Gp zV-yG>UKwh9QLileRqw@xCYRNk?el>k2r@A_hlIPVsHZz32O9i`PX%JKn!F%2Wu52% zqRJ$Dwq&rH52TSaqdoy3ln4LYG|V=u~z`%w181 zsdJM+&a>$+avB%psZMh_TX;GmSk0!n6;mo>al89efx~$yEOfiLpg<^<$~dqADQ-fI1{$rY?M`IkI@Fb2QX5A;en+;gHS1VjKx z)9Ag$aTiFhGJWJ4A(RL}nTL!(`34Yxy0*xXGvRBhoIIHq1)vlt1@?a_um}>GA)wwz zkckPU)EfwX8r1D{M}2XY_MEyTvC0%#o~N5xS~A)Ln3A89Ym4NxhCdRZHV}`floHYv zqgzi!bY<2H!CT;Rj-at0K@bEvSA;tN#8rCqOz=!sBsG#FhiFadY2h8U|C)#$YxYSCks;qW9f!;22oLDy4)3 z75Y*`z*uRk@&|J5=re;L2r^=vE5bb-Ra)H9Go2A{Na;1?3+clLrq8^pLv4f=36v5_ zMGD=nGTo}3QUM?mRT|qP?;Y~$MTo>zw_o-KWq(Ksgq2`eQB@Vx9-*%zU@?j|lV~?f zcC+ZR>Rfi6(9&)7&`;UH7oW0+niX|6H^Xj510m5w|=XqNr3(a->Odt-mMRL>3^UllS zsHRVutkyL~a&vZfCbavhQ2f1ykgE60F3-;61cD&Q1mj#0?tzHh*cpk+6a--?NtAk` zKn^UbjF7nz_Mtm&3?&J_cB;|eRO9TPFuj8cVMXn>%2Sds%xeto-BDsaOnztzC61<+ougd5M9)y}Om@3Y6bY^#Ly+-;#~-MdjYs@({%Y^CB2xuKZ04M74-ND> zU6~U7R;l&BzwmitDkUVK(1THZ!HF|hEJWdsAP6#C&J|zhm`pt(Sy9<1ty0&fMAe8_ z(#t<>jf{Rh7kZnn%H3fL|)D|C*+VPp5DE?GZ>UrHQRq41VIMOiKf=$swKeEQBYc75UOZbp2Ipu9>0wS{dpF+ zyg+A8rc&ep6+e1ST1R3|7D;D>dta?MTtkUF!sQ|!(toLb37X}tpCX*u# z)9pO7Qj)P8(p+U|nyXBAco|lQ6(-r#LE|bzq3`dLt5z)rZyEa3VvhPJl}ajOBR-gTavPp(P-MSWU)Dtp39!R7XrPN}?*9 zGPMXBH)QP1Y}QJM3q$~u2xL98BC&t0cQ|o4AbQH zwdwQR-Y5VeRCNgQ5_8mIc4m8AsZ1%#U+R}VokDX&C4{s@l*4NLB9AxE>B#obkh8(w zFY5kIa=-A%p12ZKz@Z~~CUJVS?JLuY3Ui#<9vy;=Vr<4K!`+o`$m(@^2@r2{D z3dt7tOpzQj8rL)CN$sN%LLecgxxCJ>>Qw8Vo`@<#lRV(HuJEEpbCZk~`b=H$Y6L(` zv(~FI>S>Se`ddq9bJ%))SwV?Ow4lE`f{a}bpKd-0#msNdAd(q2acaIx9FvLG78Tm| zb#}M~W0XQvB^}nH6aKi>9P!u2nQA;|lD|@->gn3RUpCi&`Ku+Bvm7>uKHGml1VJ(oi^WcP zqb+(B04Sway|}d4DhOlrEm^MJI?L43A_z@k3ILs9`k7Axz1$krd!v#&W(=tiSJk*e z;{XC7<|r{pU{b_fDcZb;P!TFpAu<*?h#CY?@~?E^yk=f%H&u{B_)M9wpc%k|!w zPW|NkJiR1z1_FobPaiOsf8H7S<4MITpI$b7a<&JHAmfq=CER62?eN7LJHoXs;V+tk z4ejAmosl!{Xp1-Ii>Rs!-I_YxYTkWWO<&pyy>*cmxCT@jbjMEwyiTWHpfGbmj-(R=5$)~>GPY0?-1JZkkn^C5cnQJ|`#+ zhs|ul928@h-!%ny1RX%=|0}UxUji0Ok6GPnHcc(a{~Ex7=Jxd`l>cs)N=!}DCzoV< z$Otn2ma^R(UE?aFac%Fjiym1oX7Zm&WNT7YS%Cu|w+jj_m}GM0 z8}&w9tBN3Fi{q_bolz^>wn$`>>N85k*&bA1Om*6=p@7L94JiOX=wN0P6-Y~1Z3)Ld zYLD3@I@f8uNJnNHRD&$*bUK`!#v1Q`ae8}`BnfbPv2yuzOK;WY7U%!Nse^wG=fBcr zcmQqg2r_skf^Y|b7EkoU!|vBUZT+Gp)aH%(!b)5lvYkUx6nV;b+G?46VA88=++&j5 zT6#2hX2%u&t=4fR)d!}>c|Fy?MPpOX(87?rki$yjQQt>zoWAs$DfyF31dZ+pGL|^w z_W4Lc64~_R{G4$R8NH&p@w6fTWN27HXMJ(_q%HD!XQaR+UQ=RRXp1`Rwrn36(u2<* z{9~Jr5V+nEynK2^-<7YPUH--%f3-V)roC%Ye)f|OAjtS)d<%Cq?XSSRmO|ruWD&nl3bJSfS5g zk%Q?1RO;`D)*tXpskBKF$t^Kw`!9?jNDpT^eO_k)yI75aQ05v3SLpny#SLwwF&LqQ zP)hXzl$dnICLz}-+4Mvr#4HhmKw>HcWhJaoUrcQYDa}#E9Z{5SlL;Y&5{Rm5b6DO~ zAJ{=dSCz$P+a;F+W7K4aKp^n(k-9Uk@-yMMqS9bo4Jc4#5?0LY-->RrSgLYjyE|il z|Dq0sJAw?B@haRYr4*pe8?9;ZzrDBPtv&5^Z4s4H0O(btXYh~#P5oYcVES>SAw(0f zrLT}LncdU-h$_?L+TP?93 zDfv^QVE_VzQkx(Z+s1)#FSc8jhq}tFReKq!S+ zTvk;@*2^JXG!l)5i(RL|blexO^~K$B3IGBTR0;tF>WJk}P3ny1&daALGxHrf3_f!f zIoa0!W~Y8vdpJ%D)j&YIHo7IO-u7wNl00Kotf{;>zpVGL{dxW-fIN?G9K13@kg>-2 z748sM=(f+>{`^Vn?i0RHR8awX@qtN;8A)jxW@ zetMy+AP|bhVo3$=uZf z3w&*h@{A?9u52IZ#79-t&7U9t--tto2ms8qiRXt~O00UXV0@v=Y!RW%sypn7ecTcK z7;;sQY^!aZ?atGZ?g%ny#-(sqRJGY1eS2@mw$IzE>;1lv z44@6c-dhqSNUPS1GYo+YZZ^p+6H5Bejs!_|@j+!r>MsEk6*N9DyxDfoL70!RC;WV)vmhK5CDiG#7P5l(x*3vvQ8coi zYkIA$&+G#;+%A%2eQFmOTx&p}lqldn6>Qk+E}iSr8ATD(sZLPd_^jp~TGA4>RoYxL zz4eoG?2;S{Qt3=UK4>X_@3{J<)Aiq-?#xGX<`}>oibWye6QU!;K6oiSPB9t`Q;PCS z@^iZU0cU$teQwGAAazGog%SnGnXnp^4W4+|z3h3+Jw7cdo-Ij{VUm4dk}D?5^xktY zXy4_vmmk$J_I-e4dDIvrwLyck#=xx@H$Q*}c zGGGe1k%UtEt6g7wDm!M_4c{*(B{`{&@udZMYKz(si1U(ZlZw_Ur=K{ZuMf!oSZ*l| zxBcZzcz0)BZBSWbJM9lgJ0tlEbM)s;!54Z6GHAw`a1TY5&rW!^ALu&J7>FrsDXP$G zfc6xtc|VRcBw62Q$gD)5+tA*#By`lXBPDgw6Bxc{O=?mX&`aQ&Ub{$htT9jTv6vZ|3r%pRk`)sG>{x6if+P_$E{(0FR z^*KZ^6lv~gKhxpq%qg#p<(wc^PlP7c-vfvQbkaDRy+?}4`L3cIWzxykkE78qBuhs` zrG&&N`NAK6`J}2;+GfjPn+5YUjToOFt=+A<3XJ6bSw^cl!+PioXH?{QI_iSTO&_)9 z=*5-J=w;_knpQgb0h9aRkJ6VNIVLIxG^kNW!h9Xb(b=p)j7V zoM>Ea^~T=b*RlJAx5FQ&RI9m1_n$!7KPpfV6C#+3l!_F@?ro-n*+=ekA|^IK?B3?P z@cLq+S#6ssAJe;lKD(d;?t*RbBLZy~N?2(===HZnC}mN6kO{)>BVWAWvtI$H*Iqc; zX0`TF^Ws^R50uIVLHMoP(cICQ?SY>YghJsnUEZ32us!T}DPHualfm7cu`U_Z?({{J zQiDVs=5yDsEQ#XcijwQf?8_WViCGkZ0)RqELr{77g#U|>5D0{_J;sT{$Bi8T@C{cq zqiP2LRaK1w06hXFHGdCP@NZP>cci5oCyrC*fXmGVuI+P0gN! zk4%sEInjEtYkb&AvI{#&c39U&cuZ-8^weNJ-=fCCf@bIl**~LG`8& zs}I(l)RyNu?5oXPd%~tKPBmqF_!AaYRl6ebx4MMq+VwlzqW(AlOISfEp;Q1W0?n7` zLWj7f-1My}rjqfHHg&YInoSoM+O97*Pcli+ZCyC#m;Wx69B(|6?a@sHD5a-@^1@t$ z)Vpg|r#A=y=R0-NZ4%4-;f*IAI4x%LqFg;8hCkvZmnnQpl_&rs;JWqZ71 z1-(u>-zMEM-7(43vs(9)_V9ky-qPjH_UOhv&0U_TO7mKd^ik(a=T8%W9`?j-A~6d9 z0Q2*V{M-Dd!vJtvNMuO8@VxRo1KFcs!c+tqBI9Fuld94aEuq6_f~VavfbMLjpfQk> z-q)n^4IxuudLux(mxT7L;LI2{F(qgt-_~S5)vO#%PI{VQYJX&rbX$RP>d$ zj*@~zFd0I~dDPP)XGiL`#{&>LpzKJQyWoKxwZ`>9bpaVo@0voO1V9eNW8N5yPgfaPQ2;;^ z@nu1R=1wnwF2`(4DOW|ENQlXpD7RS5MlleIM6`ACY!+{qJiv~SfzaI2y0fwKLp850 zst|#tfv3}~x;azL3&nVu(QYzfSi=E92yt317s{SJhS;&FKBj^U06TPT6uAXKr!w>5Wr!Rdj13!gAM?^82Kj|SyAv-g$#so;Nu>SDQDb~ z+O}|eKpripb|5Jc71P4DXu~hkp2ew}Ade}*BD+6o!?tMSxAfH4cG2BtYPc9pQ@wQo z8M{ahF4+?-GE>kS&>kB1fLB9u+#erbvRzh`nuCX)*znAuHG`@J~AS$4(ByY6{l*C)F}p~&!CLnbiez~b%=DhEylyCq!;g(6yKGBbdloR(pML~Cp{H14WO@_tbKN&1{K9W zKJ2WaP-I`t{+Isz#@_1cY>#D(QdXF!KhfS2PrdLb6&BvqTKk7K^Ji@x3I!DkuQPR= zH+8PI&Z#a>o*5&Vj0`@%e}9{IH_2^^D6B*$&_yoeQgd)tK~dkq^^rc9=hA#+O}{orULZjF->xJN%w(C@u=xpc$!*B00c@% z^4d_Ih&0tzM!N%DERg0Z(|Z@m$ys}r#*Rc6sf8e`G_H=W!f)dLRcHdunvLRr!NU(Tj1uu*h&(izjlk;+i(BL@&DtM$1#)EK= zDz&YVa9l|aAOisXIj{FA+zIK{>j`ws*7;qYMy;(@sZ0TPRkF!hNU|nZ*5``0>*%(G|9IoIi%1f{L`d3$6zHE%&WstMLIJj~G5v8_0 z5{j#uD3E+zY40+fmuRCsLQ=p-Az7MhS7auIS)?E)o6>n`MQ+kg#AE5zFi%s&aguHZ zA`p;(hyv5rL?qn`8$h4{DhL2XRY3)!P(lHEd4%Y-3(ZmVy0A565p8!DA`l@%;GV3( z^!gibzFk+}IFS0S?d_vIq);&YgMWMA+21_@Fm|WZPwN{06rVK7AgrAfAA(KyFGrhA zlH=0J1%urYNg)=CeRAS-4dgQ)8A*VAiCkZ-t8iI#gO85)Nn7N}Bi^z2U_De`t`EGt zY*=q~@@&>gN^O(D*ck;vh%c^w(e5jC;WOtTXlQ8k_Kw`nhM+c93W6pU>Gk|Nb4W7%?)i*x*)H6>$^$aR_WE=?hNL+34 z#-mDlct=Q$1ew9dJ^kzcyu+zRdH3ey&aLK}@|17W!!o9K!AcAgxE%UPCFX(xgVU+E zSR}JaG@3-cUI2htSc!&}XjlmaWPfM0t2x|pIu!QBRfP_`i&P)?UXC&2QHTV@F|dX? z9FF|&U*8?LUgzBTgMU9eBfRd0o3n6U`ormPgu{^spZxj8cH10X=$-|W41-tgA02Oe z<&y)}Lmzytwl>=bG(jkNcq0G-pbi~bkw@kfIfvHHsjxDUR678uBhko=0#|K7*BO-o zAP}by|MP7RXZyIu7Z)vA?DPAkt^V$3kUtXw|30(GYBmq5g)N^S{&T?P(32k&MROd9 zC$Tf_9WRD*Ev?6Y@st1jMYfM|oRXs83o9x?^Ss|0Rt_31okuan^+0J>EUl4o_QrA? z2zOb9P+V2%Kz(3(^_d~0+mD4ig!I_dGo&tpBzt`3>`0Ko;GGhUv9~T9RxvkMUyyIi zap`k&^!Wuwms4-GNd}{6FbH~sC`keU#A9kKs>GsdG^~Vtac^hT(-!e{MExC6Pir{X z5se1qlwgrbt}>80SY*oUh0JDq3Isr>7jz~u>n3-dUN?Pu<%0QDgB9-QI999WraS)m z_ieVhy3oCgN{8@z`lU|~ys+=2XWJhts^*@~_Tfw*2mlxaGR-A^y>bMyNM2TG%r}jL z`MeL_Zw|FbM?|;7v_e;IOg;_(0DgI7+B~NyD$I*qb<^j>SZWgfeP)r}K8Q@ctzQ4j zP0G%ItH>nYH&vZnJcX5eeg0oGs2vg7^gsWZ?c6>L`e8+1El)QWR~fWr0IcV2$ZhTuYIi7B#`DRqxE8k zG*_7nc~yG^u_S;&63j+%YN=`F4BPqVyNXMUHoIQv*2XmHe?X7~gSqF=L@A{z_}$Ug zlfj1lo->ENU5&wbSfO#1sJ$NrB)iI_Eo|+12uXfQ5daJ(QE!p5?kppT;`}+Y=g*nF z_Rd=m9XYyv$49Sj-8PUNx4igVanb0mr~LZ0H~#vUkDD!HF?ipx7SI299dmWzbxWp- znSum2oNmr_+A@YQX>RX$p)RmHoOeliY}rpADJd){D=W?R0gZ23yusDiev5xBF^MZ| zf+UQ#wvTUE9CAlTO1Kx;EKt8o=a?R+M4_7cykn9h4FSmD7?Z)dC6mtym$T_UCmEbl`shLv z`O#sON~f3?Uzl4_VJRpu8I7W(Bc%I>(#Koxp05P3IQ6Awsj$r2wJ`V05pV4$9qv=X zm_Oc^=ga_)BJEq9Su)thP-5y71;1x+&1U#JMkGv`eOcE%IM7>w;__$^_w) z#*V6=KHnNv0Kg{E;y}~Poaw`E6-h-9ggmR>t`|C^ln@eARGAXYZ8H#ZX>yL?*T@>~mX$DqI{ z{BWu|2_^gBNzv;ZtI1%C5&%lO^DZMpgHlQe*mT4?=Hq&e58)03dLleRpHXEC_qct8JRd zOv=@HMg>nPI~O2`L}wCoCP`-yO?JsyXlOdxQknG8m;!)GR z0N3cy8S@Q97;`fMSMWElxuLeUVdt)ov!&q2rfPrtMDwN=q1++5NT1th>G_b*8)I~!%US^`r$06APA@0I{)=>+$@m?OO;6lIaVW!HEs!nLQftK9r4O> znhzkGMfj@8`^|ZkqKL0O`p4yPe&gD!mo2@xva+n-$~iXMg{r^EVLI-U;}n37trZ$Q5N|0MB}fU^%t6B z|GJ<+d#C)9*LG4c6qZ$hm1cI0x*~aQf3taz@Zm!nIf=x<4kjtKnl)x z=x3BBdDMJ*_(ZioUl2%zRk(n7ubN)yu;Gilei)Qq=MX|%Hj5z~E;I+nV8WF^Br2G# zEg>PSssLaVh4aj0k>s%&$DBKgK)`CSm`#?k?{PF9gu6j3%QH5*T&C zDQi!Lqonxd{bwXiiE$2uQZd;`pPu1Jgv?=EBm#OJ`O=cyg$r{kDs2|4P7sBRPsIGj z(wh~YCRa;AkOXs%zVLj9s!TrhQG3&;9W2fk;3!il!oy zp~y7$f66Iv1)uGKoNaa;YkaCjx5OCz!3Cv4@+zA+RZA`UpI?~QU642U=8>Uu%pHs> ziI{rD2B}0hD!1A9zBuzi*sP9_QWXeHGU=|LENY_x2122iPAg}^GV8^u6aIgb#C)d> z0NOqN|L=_AiK_r05HiUmv3>j4Wt1@KB)yP02`Uvv>V!;GHXms{9kKQ1*A4(>R`JmV zsa`IpBO(A)#ye7ivNuecE*$kfv&5BSGyvph`{2e0Z@#{HXgi9cXtP=~1{laXUZ2m{ zt_TA6!=y%$6y-P__Ob4cGL{(!!rf{R%W{pMp9}$!`w0ixlUa%OCe2e4mkL^M^|Yj? znpLO0N2Jk&WJ!(22w*cy<>i(OF36cR+i9`tK={C?flDVM5Zb=nk1?*dZ*ul zD1fLJE&0aD7v>U~#yv65F`pV%i8l6ShM<;7ha;vub?60iiOE=G)Y)|7#o~UB^U)V4 zpK3N-Y>lqHVCuMg)|%MFWw|j7F@du1?S&?xG=Bu5K&G=RVm|1JjbMWZJ@E^LaMiRj zUUH(T?XS&AuKCmLwy!$@06z1JA9sW_`^MP5ee5zy=tNQKz62VV#Bo}(OX>3TnG zDM(iBfl%m~`j|JSM5(#AC?&P+U0}C=XmPn(1sBgq+iR#gO<0E`3SZZU}E zc?Od~1R?-4Ad(E>APFTJ&+=Zwlc%_+r$#`BBw4TBw~vLbJ=Gvd{fh(&3yfd=+N81y ztJ$KD)0TGq#kSbmg{54zA8$Byv>_4sK4hBi)Zw2p zJA_mrq%*5B0DyrIryR(&m5fG5ON}ALIl>nAX(dUf@o6OmSE)(n^Ch-~uv=nNj^`P) z7I(I9AG?eastPLYjxR=GOr?JwQ#7}>KT%IbLhdaEt*!mYspd~RtN@^@svrmseFpb* z|D+kVuzKE<#9|nqKd`A;dA|t=p;uS}0O%frAS2H>5biFsIDd-8ZjvA+xMsJ5J9l)? zm=ZNL!eesMQ=!jqGkAyh-351~0T2MDPq$sTC}&EU#bnV0V(;@{wcmy#N_|tH=Hq5D zr2NB*Qhkw$Sabu~SMSidW;n{OC~n@>=KI3mTT0Z7{{33le90`i7UddCFzUrPV9TM# zS2~R|9MamVBCW0c7fpsvT9Nn=QkIGaU7VyMmm8t*&066u6*m*`2CXYr(m!CK3 z@=-n(tJ!?(d6~b;ciQfD4sMrGBCg6ZO=!(-CrTs(FLp}qSnO(Bq^!71TTWF908`D< zx2$d=kXchQ_%)plDRW&0KH)suD1X`!)d_H|#rw^L80Qp0Mul-8+^q(&EY~nKSN}za z>uOt-?VBMUuha(PW%v7Yj{b6q751wlV%mFbK|>_FzLGRPXm4^a7=s z)4ui`h1Q`T2!N@`?3nK~6q>|wo=1Jc^WK4D|J`Z7+!4EdUQx!ItMiv;dzj}s zan03k5{X$fW_v^v9B(KTR1!Ycf`IOR{n5RU{h9h0^N?YPy=Rd;)DZ?S%(C~aTE4ET zvbv`0xKG*CtbBj0htxxm@yhtnWFmnJOD%`nqSZ|it$R!&_(^im!zACBL{ypHbEfv5 z^t8usgr>I8Zx>dJc)^m~;>l+1Q4G*Yh62Rn>W6ztUXXA^ z=O$q9`gi6;q)vAD9fwPg651r7YY`_JPsnRqd?{t(l({+U(MlDdw_iR=ZQLjjNiX ztuwjK00js~JLbeZo$>G5ie`9}K;yS365 zX$Yvkc+aZ|NQz~d5+p~|36>c)+gzt{s#VaTz8D7xos9qq;r`B%lmADHi@TRqETX|n zW>sc;fCzu-MgTyd1PESPqf19180dbhA&r+?T~;8Vs%n!z3=NF{5T#~SRlj9*_vRtP z2!zAc?$~r8$V*<@fATLLLqsetH3{>=r}CWWm4_gs!uXiY2!Y8?{oG>H{1VgNQ^7z) zB^sfb>c^5vnhSl(`jot?eMOZ?>muDzJ}=i$d7eEt-=H^&>CWrWyOalja8y3k8hZ1C zQ=jf{bNdo8-4v08?UGpQ*E{v`C3#YjiI~Jb9OZi)W-O9%lG$11@_1trZ@kZklf;H7 z61`1wUX*W{E(XgC}Ljmt-h2S|Ek7%{~sBvWLV z^rWX+f099UQBYv4oaxXTlAY1}JUagE$>zYjA2)sQ_m)%5J@;T)1h0|kV@j;n7u?=# zxq6b$WFBD4l3kaxC@*r@6Ke>HX~&rE9i+EOmT5NEmkZ6)F+T!=j4TN;q^O{dP?AHT zdjfdBH8Q-GCKT=daL{CzLvcbtPrw>>3m8nP7cMnMz-d%y&%MN<7c<6?(bDKBhj6&m z-V?fD)%laR*92?*%AR9&7tE*t1VKiJ@gdyVlDh({birivmn*Fwss2-)F>TECp=3wW zqzmnd@}7C&W*=Q7MRpee^g6+nqc12i2_oq&+IoicNfaoh%^jgnYTDk|ak9BREGs>= zVgyL$ASb=Ce8!~ZgWv0bCkgWDq!qP%?P=yNG_Exg0f$59%+*`%IuMd_ zqoxOK)D|lWjmDL~AMAMl^Ok)_JJsa-aG26FiaeQ8)u+V1@I`9eg3F*gFIl+L)Ly#( z!h+<~8wyMYr(SM}q&#)-HK_stK_Zs(?2d~I9G4ad773#;j2C7W=5137SHIWXT~K%- z_2aARu}0#Oq5uHinCgj-j9W{YP5Reaj#FXf{pL`6R0V*`3XS>WDiYKocl59~&PHBr zmKM53Al+tNo7*cT+OdeFJjXJ;_K+mnz24@qViZZ)q#{=GX+!ICO~f6i5}|WNKY%ma zV?>Y%%XpgK0l;DqzBb3v;fpu6MNYIt6pa zo`a5mBgyAS>j){CWtRj&0Du!`T7Pwt0>E^;cw4brUNj}!13ZTa218xJV5cXbz{q&t zjVw`F?EshDy?RAfpd+dtI^AiIIDiIAG0QVVc?U=_y(cGN(o{%GU8EC*{9=dHi6+e9 znXfBZQIFMoUVN+W&5*`3_ zMJ7YBDXP+xR}G25>jm?9w%nDIt&8(?IR<>EJnp#Uf~sr}0qF;uL`6km%VB~tjZZl* z8dnUuad49ucbpEy!?}~=ei;Dt1ag$fB!?^8gPKsB&Z&T=NLjp{rC}~|*<8ASJ5J}R z?(!l`n0odIhr`F)y>(z~Qgn(+$6%}~nbPL499GyAzQZm_V_g`J_3@=Z2oVXC=NSY-+yVLhgPvn&!jT9ac*qy6^6pL6CmHE!CO4a2 zx)2H2U3!y6qRA0tdUbH8006b8{JZwH{_T^dwyubxWKiH?g`Nz?!bAj-fI?|Njvw_! zKI<^&8w8!eLqk%Ux-b7MI&_jtpPFO}C=rNck<8~i>`U_<%Zqe52Em9*0zpO|i(Y4m z`~8wr0ic8giqpe7Xls0skSl7wa5YBqmw zlJ{5jw4`to z(%s$f@O-|%Kj6JU#B+J>Gc#w;-fOR!S$hoLPZleG6W{8_?$_xVkx`RdjTmL@_&E7X zVX(y~8;Lv*7JTWGn^EE<3#roHQ9Jd2!<~!77LyjofdgM+DrGILEpKsX0Y<y7T+@b{V*@l zQm?LRG3@~Jvk*<*v|B25e)WNeKX(b-+VAl9swpoZ=iRR#nW7RC)suLw6vG@KF0(AMQ^+vv|U|BR$L+r!5-M=|z zVhSnUE9mp#LrA#-Yn;_yAqv=^^amA^=*sG;ZX$8S`|L`-iFY``;cJbK)e%SbiGowc z_LN==lU^sKn87K|tDj1sB#6IdFHa1Uy8g^tknE9u3*r;7TM4_J04h3Le} z#EQNc(TMSQJ;}YUa{@gfeG8$qxRMJb4gHT!wI>s2`K>e3PW7-|#2%1~d{8L@IU(WpN^eG2u1kM&tlQ@=w1x@F;(k;^wb!o149;E9kaO76GUrlU9JS z$W^(ehBZ$tcgMEISDSo-(wPhvFWfH|7o7MMx`nMWKwT<>$`NxfZJ=Lf#0ywpkc)lX zHpeNXCVpuA{L>KYU2=#NoYT%_YhBN!&nteY7%GE}X zD{#&yxXE?q$^6Vw!bl{TS^`QGr?JpZK3h5Sne%!BLDmOJ1(KZ5x?kgK&HXvulYBlV zj4>;*ozG$AQQN;CH!&%mmKE9caT0##-h$*G+&c8-u`7aS(3^HI8p@Jvn$A=5z1>z9 zD_OnzASWha;pv5DdsNCX(zkgmxogVO^WeymQivif*p^_As^2b!HISqxy%#bbnM4@x zE`dxDuV+zz2MC(nIyPENcg4%kMq&_Qc+>Acc}q^&oFv3 z;2pUv(ju~k`$A6~ZUIvKE=qRc>%Tez8%GriXG#jDqKdk+?K92-0&B?U74tBpnH0h} z*QgQS6Rw4wEg}_p#+ZJnCl$DxMR|xaBLTh}iz+OanMGr?fw%pOe!AZ520p?BhaYJ- zwJI}qe>0C`WF`t-^t@gm>vVk7H===xN6YB1j{6 zL|@hxvLA{Y;tNIQ4|mj6>&jX2rEU~xkS<=X9eK{5Z#C@sWx*6VL5?98u-K+yhQYHA z;&!N;zm3K-46+R482)pVjA!;Ela_wsSmy?-gFq_+E={&MbKEIk262!MQX81y&th5y zRpmxG7(L>S8`0N%873A^5&LUJLv$G0{hVLaN1SLpq_r@9w>O1j7wcIWc@)+w5i zw0x3b1eWYyzO^p=%TQHkzn_U-iL;I$P0UrtF`6U(hz>|LX!*9d?`LH<1sYbwurp+$ zOBT#54!gp3Sr!-+rSB1#;BX0b0G@-G3580W?o?P_U>{Y@KJ{3DMoTtPT9vFb!&?QV zrX#pdo;RHsNcz>OpRHdd!Qrf8ibocSVL@Wyc$bxwcTf74=I5?g(tqS%MziYLtEZAX z(-k!s=CNRdQsRm0ui}Ptp>q6;%_tZ!pKxY=rqZD*GTe&9t@m7rBF4Tn{&11;)5;3> zGzXg;iNCDIYX;}8*&nH!Gj>t;j49Oqe~FSFJC4imd*qfq>WP6cj6#M7T_SBAm@3zb9h{;Ih80%je$tWGx=yWuo3mbAr)HC3#FHq zspe+~Vgi`PtBB5#LY>BMOjPHMmDOlpD(6|I{gHKEAPEi>ktQV#@?#a!KcHR4z=A4i ze8eJ<3LIzLbM-9W7Z2gqgfBZ_cxXHN!!!1yW9Hzg>)^6i_x(?#-jr2H^xH>q%P6r& zJ86cR;5f$U%O89!5ZLXl5K;r*;?;%QW~K&1)Il+LyLl4m3Un?KGpbD_ttG_7f}F6(c_CIlb6Cg<`wQnQBI}!^_>7v$p|yxzG?!H* zDn02-guvCxorxdyzhAoY5WyQ0!4X#+=_*1^%$7_JFi8Wzg5IZw-5-CaLt9rZqR_x; z+Vy0gE`FjMVfMG9-)Uv?*cm2+MRLsC{FE|m%J|*w6Z>aP7hcajPAhhDqBVkPL z!1*iSs=ys+2l$A=`6HSYJM-p+l)r>sv*~^7_vsT8O~$JEX?=i{OaN?jA(C}El8mB7 zSgM9h7}B|$rr(5Maj}zA(^Z<;lM(~pUz{wk^X3e7HKEC@sMn{08OSz7|9su`P$~?e z^hKl_!9a_JB@^kzZkg6g;o-M-HuxrIKr{X(LL58UFMGll4n5*8CCixZX`jPl6(tR1 z8naSnmk^hcrGUMQ@em7UQ4I+*kaUX`zU{D!&{ID0DNh-#hn6e=)`B1K|J96^7Ae|a zSqTr84o|$dUrW%nCqvG=2n~`MFJ%AxOT22%DNUq(carUw-dUYdD=r&|1BpgtaKOKQ zrn1$t{}eJ8x0AeYCmFH~>%ppb%6t>!VIFIhE?TW#Mqz&s&b%6+U>{P1e zOzQm*H>_xfN^krZ`fwT&IS?~5P&Kn1av5AIwCoI}fr)~^mu0l1kBd;G9eoK4S7JVY z)31dU9MA<6Q&3!;?qY4+HEUa)SfgD=sn-|tKgLaZm1U$K$vaG7p!TJvPH7!vVG{0U z5cmnE$hIZghEsGiHTj$hf~B3k%grIk4S+!IUb21%_1KjMl5!h?nV3} zDV2!WxvgY$m6)yesJJDOys=jqS*{cF=!exv$L|SY_Ib=((NayLWbEb%65N6>$aL9K zYpFPELZYLclI49_PLdRKu|tfT*X}N>hB`xf_3Iw5H5}6eFV5+1N#U6CU z6$rkg>LeD0Kac}4tq59vZFXVlF`8PxiGZL_k=n^ts`+!Br1GR89F-{oG(I1Nn0-D% zP{Em~d<=2hFJ6Zek+KF&mP5aV;=e$$u_oRqFIg(1H%KOOzmSo!*HW3xOlk9~ZiI*c z75i7pugDaU&(6}MVhqpH>I*i74Kxt;dW~xAypvc{&#&2S?p{Dh5k*XeiJ=WqTJV0e zM}oT{9yZl$x$#>Gs0x7-hZmP`FgJNGRB?jyj4_pgn8j;iU~W-jousj9DU)s_R_|e9 z{3C}MI1@JB{>U(~4@y`oi}4?cd12Cps>LFwrZ;_$#NHE+OzRU_=nB8lMVL1Z$K%@| zH+f4AF(&$>7YX)RyMK&Tip?mnci*2ZgUSYe?Fxkzd%3Eb`D2$~V5O5~jQyMD7j3@Z zdiej$WB_;n%XK4%|J0*^QGCQc|1%vN4dE1%=UL)I9RjZi(T{Ajfmhc;R>FTsqdlz`o2mlfQtsROe8VvrI3YlhhNr~(T4k;G?)DlE2yKq73!wr83YuGtv zD{Vq=!nwTqURygz%C#7ra6gde22f_lC#{>R)D0A-h<$8L&Sx(}h7n@Ms-emB2M4V` zizzS+kFW%FZ5G|i@g%&JA23NJ z!gLQ>dK*I7CQ9=j5!vp1t0>*{T^2VrLiZv$qFtmt3R)FF@m$d{S~~wX9I&& ztZc#S0KK;0g806*6BoWE=Q?@HVtL;%5^3QqGa7OkeL?@J9S5E?D{l1l7ax3WrG?_& zNanF;514Ghp&?)&=D@IltHxg@7PUVWx66w(s9=wEx!4}CEL zAOEEdas!_=RZ4#{#q98jsVvEg6?OEEM7R%gr2V6o{2|g1-Hv11pp@BB_?3q{9VNl1 z$lJ|!KWV7|?Bw&je6<*J8ZUD~IZ~H*bW?5=q0+wRyNC?*>n=%R&Hk2R*lv76!6KA8 zNB+5D*dO!!Ke6^`)@SuQTAl>S!C^aRP*-Z#x#{x{w*RWw9;u&yl+~@8lQ#=}!*kI6 z!M7VG@UD;)WBgSQX^abBOgL?CJDMrEhGKek4>lakIqV-_8l)bxcogz15pq}aSbDV2 zNSnHEelfg)XRoIixF%cP8Fm(F5|p3XSUkFPY?f|WEv7C$tz>JnB`>V?XzjORNkv^_ z_Et<3{5G{GVkg{ZZAreK+9ML2K$jL4O8r@&11XN4>~-qoVQ0o$*w3~s`DUMYi+YSW zatrx?Lh)1li9o)rl`i=$2J9iK-P!z1j?iaq9BD0+7F?ebP`aI;xR4eFj@uz$HjMM)!yK_letA3pIVu4rM8 z#Losjkm7=+h?CBt7v2{36`3ARR~1Y+Dt3-xv@+{NmNNnp=v)se5(Gnex>Ce6in&Fi z!8zNC<|g zNDZ(BZ*>t736H)kg@1_s{Xyp4R<5^Wkrscl$#Kv0cOSwpG>~|8%CpAiYbb@ZyOI$_ z!)}1oyH(%H)C49>jLx#zRD~sH&HSSR*vx~cYLDXgnOVARV70Q87@el>(ZvFL$~Z)UYlLq7 zA{}{-M74#S6|#;;rEz3x#6vz9;^W3j*&VF^CuWCJD=!d{Qgl{N{h}{EvvmEfgHsyK z`KlISe8QS=-YE6eQ84>002NwlOv+$83t}M)6~ona3$=K{j$FQI3h(E^s36ETT&1)~ zy8^omtXn+=0D}WA{p7DEQBI70Gzw?vEjA%3h0xO}Qz~FnPH1=}Iz=VU+r1UFvj|XT zfe2NJC*?T(JQ~<5^UJ2IE`{}>{GB~s(k@82i}>|a7Oj^zpSd(!z9>x7YBEg!drc0k z@@lcPvXs&-w{ICSbKPb-3XSc{YBZ#)8W@=O(v*q80>T&l)AFYz>1drS@VE8}RUiM2 zhkbxopw7$!>T&?YAInBZt7Mu@;{*PeoOodyqDrHsTc`) zg#@*a0(^voC_}Jim|n1i!b*6F{dZe(XQquHG#G9eizQTF?Hx?ut-hHUjAOKd5hWxH z&MEENUIAfP zHg3UmOGGj_AyVB~IH^qIm>%WeBKG1!7MxW&Wtu|l^}~$NHF=w06aK-3}I%B zHX#)9Kd+MXUkQ(D37CfQx%QNJ7JGMa#2yHvVsf5>!%oc1^uw2Gpv`?WGz&G~DKVr- z-$4>YH1jY6#gyNw(%PphH1q!xhlPdl^`Z1h$MFC7i5&AKd8CRl47dliplk528WV>; z3at$rFrOw^q^o^V$T{qGP`oQ17(Ph5<&_*q#8J?VD(vX@e>89H_IDAQ(40FL4p zP$uHbPZ@9-(>^zLR0Ydf;KGbBJu{Fsef|!AA>a6HmCuIB4FMVs|L?NIQom<-Zh&|n z_ca?>a3sY*BH~>vE~a>$7Kp)G_g-+>REF02>Y4z`qsGjX>Nua94vC~5t!;jQfndO8 z)sjXXLHn7WKNW)Sy22DZC-Ba2Sd<1MJlmf%r&FdNp@TD3vQoH;<9v#5-0aFJ>Z$yJ zEbyHh=GT=ir(~ngX2(P5KOs1!A)Xpo0OA7`R!@usQ+sTI3V!~dc;jB`mI>jz+jzqZ z3VBQ-IYH(@bECe>$Gx3Iab1$0W$?fV3}3fT0^7`R#dA*ZWw; zJ|WYSetkNk2n;7i1@&p(w^J+Hqh8U_Yzh(#&fLzE%6}Z2sMP94;WUiD8c}lWU=fD? z$+DBdL1+&4vP8wizn=$@VoWUGBKhIxV;CMYaD2xuP|u?dw>tLt*k4Wf?6Gv4 zqvcgu#H<%Cdvp*5aAepYZShTv7Y3y;mN+RX%CHv7B2Z!l=|TV&tyh@~T_&7ljx9N& zt6y7>+J|)l^YrP)f!UN7CWWl5e@a-pqC&nq&Iw|EbMS!CI0n3n(?3JJF?#)3KgXFWP`QB~T=5f+x5tXg_>D^@MV6}R} zGpA@QrZ5a5zK(-lJp$`jlshfSlug#%i#Y)r!%|T=;fhHrT+FGX|IIDW_or5j619yK z4`i=k6UOt9geAh!;}@P5k5t@4*!IVf;~1NTIX`r{=u6wH{pJ?&6{=DTyOuJM;d143~f26ea!!+lmrJ6h7TO)e*rc;9Tb?kd*f6O z3d`|9MW2&igz)=nUFE!$Z%SD?b%rqbM{pFF;`l}HClT#r?e!vU{Q^(AxT`=bJ>SzE zBE4%CHT~k(Y)xy`63B(5R!KsXg|M|rT}Ry z9dE?rspc4s)4Q!6gNIPPJ2_SJzoZxFvW7lvys4@sW!CTq4jcatMWL}kELN{_+>0*D ztqnV($8*U>JDnej5FE}pKi_Ix6Y1Jx82&PZUJ27s{!^+FqWrb7Bko-z>1^Y-O^e3^ zdTReqZ?;l%#TDsmI0tj;{=I;@`_#bxs!W6E;GAdk|I%_Cw0m-&L?@`rLsgP7F& zWRw-eTL$u?9>d;D^?RSH{|h+q1K-3i#C0_%{W?af$5N{S4}qV@Oc{NFp1jB(VsMt68IEW$D}L4OKo_Z)>L zCnBgc7Ns&sFyW*mx7$Af#-Hbl3NwZ9$JRwuTChsK69rqgp zMY7t{XFyFDBlx!=oQRK)&_`)P1r)dt((V+c2XViG+esn^F_fJbBR*0umfQYcVG~{^xhaWHuAt)k^SNVk>s|hLK z;7I2&7FBB0e4Z`Vo7&(tZiAHKfkO@RV40UyTg z|N1aI{+RV%ar2n9wtx;}dw-WTb;LMFp`!o%)9W|h@A1%r#1(2&7z3gYub&`ar_uO- z8ImgU;VT{dugPB}=^WYff`#UuI+S&dz;P*8*y7i$qmQA)k@#}s;PUdZd@p8aW!GENDZ5lHqv zzlOH=nk#6((+|fF-iy|1v%@LPm+h)!!iX#5h}+(IIHiu5)*0XNk#^_h<%p8@Sk)C5 z(;+S1)Hi$T)fT7mjzzC`#ltK7Uy%QXUslLkJBuEI<%^LGFZ(_l_PuR2-Pw|EQ@8cettET9nk@mU5c zlLiSLRSZ$;o`a)UYnyhR@$z+DTLadApNs)F>cl<3&g$ABs`+E>q_LFdPZIf%t$03C z0&QL~3LQ=S7o6U^Z3+xnQfYF`UlK2*tY z7;Wqj6i%C*>Df59Acqh<=$^ca-y0vYbVF{zWWnI%rVD z|7M#6ez{E$49{@oXsl6Nig7U&Z5ieOHy@58c)DTi_yRqAtsDOdKI!Lb^Sw;-|3S3@ z8@w``X#5>j>&ah-K0l4V^^N!{{TH=BYkCJX7RVF>@bNOCD3qrBu*r;v*e_SMyHVGF z=Sj7*ehsK4EM!;Y-KGR$p}^Ew*(HP;*>0nc#$|%9&aI~%#M4#AQ&S`*ekjQ$iJ6)S z!#g{Dy!a+}^X8dl1a}NzaF>*`Qox#B*1SkJ`ELZGS$c!j7qYk-eh8cv=X=ELf6cih zBT`UGf9b~Jhn%dbGa-21hOJzKF#rEvY|lp|=RU{=Z!XO>N;+p7D*pS(J9VLL@g@`b z`Q&rAL9YL20^ffRAUki%wK#iES(w;Zj`7hc?VH54J2*CH@I;5}WE=jk+xVD$8BzZa z$NuyW5A978cCSmhGII-R7v;}x)ukwqt^I!=i8HPYic0*~!9JKAD_fKEMVSnhn;LJ~XziWuZ%YlrL?i#_5W3eH zUOA6KS_n1^wfcJ^a^LiGJ)@%^s^({+WK*wc zG_PCi+_<*EUh(x0dfY%Ln!l>!T5{kaB=EXW6L-BCM-!$DdD%{msrK9b$UCW8uy67yLOzH7d8LE9-5JXd zOk3U$t0#k@)iJx<*1S%amnY5Us@hK@$}ci1z7K=@7q0J(9~pc}2h_U{PRbuvqIP!) zTz_94O6fkVp)!zGCVGJuY1$${qVyQRP1QJEzvo- zxhFZiwXk-q>)+F|-_xqFSW;uHyqlDSE>C$WO>*Aq4((YVmMwMcT*;x^46Ax(Cs05+rbg{`iAD_p#ydMy)+GN4=W$H6#V(1 zz8|v<2PJdhgF1+GALu*m=Emc%_N?!Z2GaS#$ooOp9!9SYZQS|ybB0zJn3gnG~$5Gj#T?>rvYytRj_*32FS08{#5SwXj z1?^jFXK(Mz(&ShgU`wWFLj)PiC=he+>m0%RF>6W%kFCY4Ii`g##7N=-^B1%b>^Ics zuYf^$J>InYOGYxP*Z#X#XS?2i?sIw@M`=rx02CE;`BHP=qGEF7b6l7VgUXrT%~@@E z@B9)_#%ND@_$Bo1Pxi}FTNNN85wcftClM;j8mCq^a!_j29#%iswR%5SV+<5MrlvDW zX)<^&w=!6$7ue=)gRH-!U;A6+l((nv8B1YjxbBA7u&3nQh;r7|dhPXTT=z$eSv&C% zMhUtJK50F!7jzgBJRmtoQijTvdItznS}dRZ;_5g-huCD7Kk7Uk2*0cT0L;?sp5&^U zjELJMz|r}}D6taecxh`ixwrpjZ&^SQ4A8KmT+*jL#)_vv-mTWFN6DkMr$62cSJvIw zhu<_MqibGeRP64#JJe8yj`3X>vcH*La!JwnTG6s%{Ajy&mTIqA-cQn$v11I;mEC#| zSs9HHJ5d$%KHr4S&dhK?IxnvT8V~2aAwKiX-@V(eo*RYBRC;^jzo)r)hI3_W^5S3H zSQ=Yc)YLbkp2g=!L67Iwv{HtN43G~g-__|mznDl z4Uo2SL!I{*+6}h4uNE~lm1yV(zb`+gE6-#*7Ob?Xs>GKy9mr~%03U*jgMAzeM!fy5 z99q%hM0K})=|bY>!0+wbIj-_=M8IRY%_0?*7V4esg-7x#X`m7upF>txB(At>;aYBb z8eg&DmPTYr{oKSns3Hg1Q9vLpdQxJ-N(?$Gnwsy2YZ4DS1pR($FsOULK!IObzF8vTKtK-^!Gyd| zRm`co-%so?CiuWK>$rT40NJ){@jh8sY^(cJlv4fYEMeY&Do4;Vv3L)xzUg2TpZ!140~ zT@1+aM8>k3+n?3FaxK$_`MH`k=kh1c@+YBa+y2fi`k=|8vC@txId6HtizO3^vCDEcI2OToT0uX=2B+hCP33{yt~P7)g?*CP?>KLti)a z4=M9r&A0tU-K?MO&NO^EPoVFAyp}s;9vC9H+jQb~2KthvO(#&cd^z`> zG3#UMO7NnaZ%2S9ZUwL3eP#&_(kmVqCD4eb264=2Xrk(Jt|%j@wV7@2+5}-*U+~+b zLEGkT$=}yypyJm1j?jmxuc=Ty+3%cMA41$OFP2-s-`IH`6w}XHvut=`fZdI_KLK>a zSLSQ)(Wu**q?gS7Rp-3$V|-(|#o&ObVI++=j5qJRZ{;v3C{S5hlbvnt9R!G%42EWN z+$_7Dp<29CclqV9>0&>bVqNoLH>JWmVT2Lv1hTX;Y0+%o{{s1DWvcbwI(=xx!JQv? z6A$(e+6Ta*M!wMzrT!G{(!%P^!)4S4@u{KT{d%CvpkJ=_@>XLQ=@B5Cr|UAYsT!?} z{YPNJ_IuX@c0-@J%E94x!gd3IYk1;Vv`Op!OBo zs48HE>15qko7~2hQeXyE4*O$c=qnocbH<#km#ZcZF5bU9vg7WsJ(%7xm-sNk$Y^08 ztULy(Me_x~?kl~Eu(q}|axW;A+ig{6K6G;z06d(rHFI5n2AmvgFc|A(n!c~P7I8mZgSmF4IFnlH=5qz6sFF;X1L zKSq#j6YekR&9?o`7aUH9==YQNpGP3+z_(74)@A5T7N;~$PE%f8Sq_Ex_*tGC1Ow^& zB-CTOo#aP?te3S(*WBX4g$0;?qH8;nk~9>l-RW;rV+me@Io2w7 z&n1}lx;0}&Aba=g%~*I;A#1mo^>`aF17I+vCD!*>2;N=ZudB1~ADeLJF6VhcjPm4| zo+nDx_}X-{>tH`Q5E&X2bF-GAtrwOFE?ylL=>=NUUA)I1)gly*F7-LX@dGPriIY|O zH>~xZi>O?J=YMbK=i${A%+QEIMZciGLv5$0toidzaliZBaL=NafMtE< z#t`#MAMf@H_tN^+GfE}g6{pvr(aW02F80_ zg>>#Jt48H04y7o?^{b}qmYWG>-*mlXuNmpv;;OmeoUaUr z=+>xTDU-}=XtjCvkKzm^j->LRMQ|+}qp>{$g3bGI+`C<6`niSb&3ay373Jw!uHz=F zhc!Xs(=26`A7vocs0)=}-8ITa=p};u(5}56nblrL_jbI9xKFIAEZ&{% z@c79;&6p$@_4H;=>o`!5&-1zSv1Gha#yuMj7H*df_Yx&-$dB9Ub={_*g1cG&@T>~h zfymT(g9MgKeda7YjL!PPFZZWQRN9Y&3Yv5V0f@W~?@_u#_ICNIp@Y?%A$Un*5&9P( zl{h*6Zl#u?m374caNj-kRgI-rRYlvGiX|}t=WG+<=tYzu-|)Y1!DbUiL3RO>CA-N8 z8Roak<(`JuQd0f6BaCHPx=BWGpX5r03d<}D%go1_#>}itjdXBuaq=l2Ey1tqC@!bk z+AFbnI=i#@GAi+Ls0G(9wKu+X5ohsT05()DH`kw>Yxc~u@b069ulta$VLm(A56IsN zQUJ1EdShN~-df51Kd4=8o~(0(($EiexjjEws{`(aRuRrR!15cj(;ESLJVfF7RhI$w zxZK2CIjeaV6AR8YP4>$VTLJ%%7zmdf#Zd+9`hQ71{%oer|8XYKwvgu%fd9LU@c-}f zM~aEi|FT;P_oU?V+unl{335!xz}VO%{DdGbVj#J825xm?PQX)EgoJ^cN+9Nz=A#D1 z8k*&N&OVy%CoN{$0;;_@JU`Mc#Mh4XJAyEZBfmr|tUQq+nAW zvO&VJ2c5q@J+FN6bk&~1%iqDh6}k)sm{8%;c4pui!b45=G{ z15snhkVFP`iz-mLvRzk<__RshFg`&xT~ia*R7!b_^|^z~t4s3>qdl)7=VS|#A@lR! zIT{w{8a|-}lB;@na-iIKxz6&V13xkIqwz zWED64=b%W6VHXCH_~YG`w};~%rzKfO$J6zrH%YtW7kX?(fP)_zS~{ZGh7nm=%UN^! zN3}=_;`zW3U}JVv7(X5J7JqOFE^s^ihBcbSK4P#Q2iuuzI{vWeX^b8=^z}fAcECvt?AA& z+30>ble^%)1ic}Hs#V=%;Z?4HtU8`|du}U7E5l6CYWd`kdP`Zpoc?pbZdi8YYDr}S zK-hLpUUj(F(w&(=Dvf)1m>i&*qKSQh~3M^JyV zrz0@xrLC%MI~Tf<_@3e%q#*J%T~|nf3 zth9MN4;>_X;>I-0z1~frPqOhoxM;A_wtvCw?B2Ssy=})mSJ$^m0?}5$_5O3jG z^tGw1YkF|7e_hg7t}YNId};)Ratsa1ad9zfxK%kx5Mg_aY643JQL3%kQDaa>-0}#m zWz9v4v4yU#1}P(db2Kd>Bf}XGd29XVVPT;lFf>M$2ia)OzaGj@0VvPoVh{)ah_|i| z6=X!<4GuP<6+~%Z`F;AhgeNMYCEI@&6b z*%Q}m9N;S}O4Q2I&d*-+I(urWtM@^f8Adbs&5hmNCAA)YzdYNj>Z=pc?>jebC5$ym zUCkD8O2&P&C09{s==fJ&@m!6hW~5wBz@RPn`UTsy7)w)QZgsZB{9^q!f!|6S`54geC9$ms|3N0`l*#aakQfeM$ypsyfErtcGT`DtqAwl7@O z(?IAJzM?N6#y4NmiYGG`n9k`(rR{B z=;=iBtwh7Dq6V~+I_ThtY6;nUZ9V{Gd+%<(h1jJ&aGrUl2iod;MLa9G}Qq_e;9=HKKu@a>Avu-f{ya zz^4{2x9at_;Jw-JrBa4IPfaj)+X2XeWR|zbj6m+QwcE_{CQT;?@eU4O7(V`-Ygll| znK{my=7c(X^t>a6?j7Ln{l-Mw8DpNJrn) z;q;M3_c)KiP-wPgL=0=3VOmyz|3dRYnWWb(vXhr8gU+TMx1up1B7l3v1sH78t*W8< zHcN80V5-&NpcxFM3JhdHd+aE~9TS2ScGl!z|KTTqU#VQ~#)It=IWbZiePBF+8C}+u zlpB&H*QNhjG_`8l=?gdU2I*N<1V~A|^t;*SKO)ZG0_btlf+$!Ha>hErdrbOx9HVJR z^S{h>*{xF>Hr4*pg2%p<&T^lvy$tTxYYsp@2OdSwz@SSV5rT4w<6N+k{|oz4nM9vJ zwG8-q`ozhTuD<2P*3IurR^4Et-UomRyr+Ww0D^MeUtYZsoRFun17Nzw-^ly0ZF-tw z^<@BQ_d4&acdF$+ba^e|sxQ^LCZa;SDf?)V3^&9MR|7$8$aRn&59K zsOb7U*Hs$9L^l%0pIT{cKPWr=rOE29qW{IH#)=1sWQIfcRuo5ocippU{E#Q=G#-VTeWgtYqw+M_i_hF$ z!_nU&=}2IX>jIMjI3T2KSPJ4TmiFIk zUSn53tB!c!43;~r80kTZeGfoQ;$!WW9Z&7!;qb$vg>0c~naji8<<(qYbsnw>Um?gH zHlRQ((Fwc}W-YG^kaJW#lPm@s#2nA_Ylbm3-E~*Wt3tou5xC{UJPZ1#W5EtrqcaJs z$obRTOd^d%?Xj-n;?HA`mjJ_mYKVVsY#{Ei3G}K$<8B+Ukh1+{T-4gE#~U#BS%InW zivMn}0p$zN+ePxUHFiUC8yL~ye*Vkx{^%NH?^aRHJ_m#qB}N3`twWoQ;_8XuelrcH zzGT-=BPat*+}#DLqdWg|+kW6?xP!b_;PxNSBVK34oNu`AVjHmfdf;%M6Na-C0^;@~ z?HO*|iWdPI?00Vp%OW1NohIaq|Khsx@@(1j zZ2FnJzUEyz;1$p(@Mw0wZgR$FKU!Gz*^f%OvzLQSIv6|7VWt$@<`vU^Nj&}45?*WfHh9<%iB960_e zUL6n%pA@UcQ$>w0ihJY&MmDRnk6%u;-Ox#8Hv(eAX^s~oNo-JEJhb*XC z?1;;N9SN-h%ugSx*H*b=fdFNU*dGf{ftxT%ptZRG-iU_n4J#gB!;*)nkIA{N9&00`;~BgD72EC1sYJdzpRj=#d1;!rn0I63ln3t*kd?qBpjTQpvojQ6&Uy z)qKZGKSN|IR7$c)wsnd98qbfuiJbYoNRPwA2TD(FN#aRHV4X38RoAO zTGV=|E0aWQzp!y}+N)hDQeB9g5WeMGImw*fw)%Va2}PgCh`XBh-I&NW)Q!fyYyO*O z$VqU+&|i9L71hv`m+&Ox`tLc*Py?%imvVcesa9-lK+oF7vRibLNximn?~Jpd_OV;F zLYIofv!2&Ta+7d?3ITGz)}SJlJusaH-TQsbZUu0ivX1KVb({C?BcOo*4qU3ayaZI{ z@A>sXdp%`kKrGpV(;0%z5rbK>x3QOilYsDhk>u3J>PUa-2WkPLZP=9H~Lk zo_MRLJ74&=>xrQgHz&Qa^WLna9q+Bjc`|Fw>BkK5e1D zVMicSROk*XxsB-ZCDxF;w#&|j!}H<^(+U*SVFJ9|%*@m+{hRfTst7>Zyda$Dj0$5` zlS@`uBxZIdUoDuo;5^0Q@LZ0)#uthXk=F9e;p~JD8d{D2ZK9`)(-9BCVx12EO{z)l z)rME%+_%|lQ}y>9{fPh2%p?x2 zw3?1IsFt;U#ps7;1(Dyc>aE!r^>E z2*hb#H|5D=@5-%Y%wO~X+99ab2xuecKBHOBe<#;$KZ5-9+S{DvMiA3!0Oxvrb~cJG zcsH-CTD@nar#vl0&Nz%;iI8&HC8ZEIe~nV2TK1F8yblZ^@xDPBC)WSaHph;}r9f5` zJ^w%SYSaSH9u<4E-9|TFsON$Y-h3e3Tr(Bfz?>vK`_=TmT*!4#8YaYNLuR$n&aK?` zkzD`-c-6kLsy8J~=qH(NKa=xtAkT0jJ|;Jl=r2aJm~D53*JaRW<|^G~2uT0ZJ$CUk z1Z{w^mA*qRdA6EI&bn-mU7KcNVR*)cn`W~VAv1B0n;cxN4QJhlHk;ISg17O(L4-_x1acY1 zI4*b;+g`ohVEq&CX@EH$(>2%r1Ca$@Mcd<#Ht3!BokJ=tSM<^SG27+B?~dX!OI^7< zoQ*u-JGBNQZ*KT!Yc79`MF34kb&ZaCCd_z$je&`N8-Uim;Kvst!!aop3|BBORaDQ0 zk}Ih3X=_!?tfowC_PV=@>E7Iiw8W$Q^wLt&S^j~28jI>L7s3Ex%HZeP}XLzK)>BPS11a1+X%z?+dMZn;;wtek48cE`$?btjNaK^l0q`w1Jf#`1C zW}kH`WB#G272y!fzo6B%Q5|KEdUte4fJlskiCBAz@8Y_lxGS(nK%G1`eP%|}qXOg0 zi%`uV1Z8!W@dWwZ--`OE7K=_2KnK(VYz9EoFz`iZ?a%3B)-#tO1D zh7VDx_&V3$W;PPByeU(ls@1Rw+Vfom6YwshEk`x)(Z<7mX=8~$1}!~muUhxWy>+N? z+W2MmczW4l6~%=edapMrL;G2)@_p6dB_QU{oUR)@R)wN1etELHy43w@uF5;USU})&7@j1U0m{m6o~|~{L+mUmnLvF6 zv-+<7gOk&`CfWuwh;E!34fcv2%MV8Yso9Bq@l&fiG1}J$qfIo0p|%T{rtdE zEQVog<>LuSO~e7OQ+c!1bGT=wmj)CT7;Wvl>XIl`OWNw^%z>c_^Nx#riDE%vt7hz~ zYUuu%qyjvzoQ2Cf&zRe2Q!7(X0M4KJtr1hE0)Gvv1#LNow_{^tYxH|+X(0b|nghAz z(vPDI&+n^r-4Qu^#4d&)KzMqJHhT|rEIxQ%rn-Q52W@lLKN%f&9_$fc+q$}bsOVn!a`X4Lafk`5W;Vpzzxe<9I`eQS*Z+?{ z5|u+Ll_QB3m4tAPeThPgC8th|WsoIhtl78Gst{Ua=Sb<4-B<<=H%ZW9Wys&Y)%mU!Jx`|O5;HwWKB&UUahCIRl~EG;5MpNPK<)GF0F(XA_{_T zwrnVjbMeF63TIfiBR<7$g~@eiHsye`>X``G^F~MlZti>5=ev3yuF{R%1^uVuZz&Gl zr!PO)ionA;Hq2GcnFHUq0z`Y?5EF$?s#hE5MuvBn1I93(m!Vqr(sVfj`os8d$_c@l z!3*zi(tH=4HQMfvh0P=`4SOgjkwi>D9&kNn16sC&{30rdbIId$E%O6~RFig>Li8l2 z6aS7jl5xomRd2a1Nj%sJihMcet=n6JM*bkO%3M){>a_6&RCR8nJ*7w1XbF>gA7YtI zwXwql2<{8yN(+^@aTo=T!J+jT`??k|)aqK>68dKJ+e_~A*=qU&k5~ay9PQ+(x|0xP zY0(FGd|*ILisIv(7tJj}2~6kD7XGJyMvtB~DzZGLlz)4)Q!S;ec&GX6rsDMq@}<|S zfRE(jnKsx|wxg+|O~ux1_|_)2lftIS(ANt&fh>L#Pv4qbl}7t4V!0j*hGkq@o6FES>^ zp7|gzKuU9n>FuZ>TqIFunj~?kK~DC#VG8Yhd6uaQG{$jmp=CHiL1k2+yxn_0jqWvrvo+=b8Unr4o8Du4BkKE zqd&CV73*V}66?}gAIwbutQ}`S!Rrj#2uDuXMa`Ugya)TQ$nZ}N4i$n{58UW<0r|EI z{V;c_Xf!Qa&?QSL_7lCx85}B6e1WB{*0PCDEtDW)OIM}P@`AT6reA!$S}mI5VEM7k zOW2%y2LgFSO>A{xG}fcEdPxcaJJlb0lE|<5{2ba6)8)FZDfgPa5@j?lT%@;5LSN(T z>|$h<9xc1i8A8L9LWb8l(5?fgjopoH>Qo>w)z7yl*j2!RXn9su88`8&(Y_K{$z^LV znm_lMf9TVQ3_mQ{)cEM?X-6|%S6__rP7&o^P?0MPl!bc>t9tLG%)e<2t4=Rhn%Ws` z=$mlXnVV8!V~}6d=Icn}i%8w|JxCoy`sR|bQQ6j2pOMPDAdG#+#HQp|TX$2BHV}0K@Y_P*wn-M< zXI^Bg`fI=hXp^j?z4@r+E~#lRmeE$%nu&zi`?Dh1lF4ZnTu3xnk;yX=89_#3b&FwSlAe$ zn@)icp|24p2JT!{?R!q`>n~?FI_Q{}jnIsCceT$05r9~O=h1Ch{@etN$N%^s`B|O| z(Bsoz1r(K*zAerff;_odNH_^(J<@(ASy6ESvDi5d4gOrlW3h%Wpf-V}Fo_HEZ*K@&_-=%+EyjDcnYknaF1d_L&+_!Rv}G*xka=ZLz2SHHivobAg-PYQ z4)5VYlDzAaF!F;IPpcITwZhj!dh&VG$W9s<=;PlccjQ#g2>1F;K_s*vaPeKEfY70{4m&pnt%#~59Jz+= z?G%yqyjOpcdSEs_TYJoeFq*%p0blRs+UV4o!D#&5q4}cq6CW zuLWfP9N@EZdO?tY=#}qW(tW3|l6q8<2eH8SE1C{HdY5W14vg^q8*rXeeC-fux2L5~ zeT23!Z$Xh3sQPvcD%&1F^mpIL+ z>*Iv}fVkF*(G1~$fM-jaR#X-Q@mE<(&|$3CyJnZoJWAw%s=9r8zAR}c;3ime&MH&` z%q>e0m)`O4h-Scz8i?4S)ud}~bV9RtE*-qUnvr*t_!fn@!`6-8e(9-)_6MqqoAMZA zFmRqa^(F)DodyLVaX zEf4pLHtrS0&m#P&Uw^?|H$aFBVPt^e`czbS78d@fb1lNaPdVw*_nR)OHD^QIwaBM) zgU@U)@0U`-cSXpuS~(sDu$f-#z+$2_LbhR0kb0kzH*>4N406Td8Y*uThGY0emFpBB zQvoj}GSCkShUWnP1A9CE z;D8Aswe4DHM^3&VgYc?8C(3RV*{YyXNf~uR&nH=o37Gx3&N`~Op>xTJ8o1*?`kUf= z4aJmG6|tWk0lHPT!U6zwAh zQr=2PU4T>vN-kl=JA3A)Fy!fWb8f9@Eq9p3#j>s|`dHtVPLuqnaHbfy%!srsHI^F* zW>dp)wg6|6UtybzJFL>J3hdl3`9L^U)lS>qUGetC3Bq&LuAJepSB#}HQVOccZ{0yZ z0+AcE&{>oiG{*8EAk8|#AYNHR8IFDbKu&I8hQintaq4!D|9rvf$lni(coTF~BTgu& z-2vGZH-bLwhejHm>7NQe1i>@HAy8a48>~XuXs|pL_d*^4CzS?eGmdTG&m}dpQN?C5 z6`ws550`OMPMT_CgY?Kun_hFp671%=n6)hx3Ac;gKUFh0Cz3G)$}=EVA6B%$8buWjade)9H)9Z|;M*6SU)Ce25;)T7d=Dq{AUC>U@-DfJOPjZRjaS_r)qF zDc#8rVG&>yX2_Jc%8$rNXuH;;~uoj!aNmeW}m z#}$gYnk`O)>&0DW^*9x$RNDlBztMmKRVy{QXc2mEa0qONL zUX?W;Kdt&NswP>hAj_>aq;Vx_C3wFiF)0!NBviZTITZ>la*Nd$=Bg&11v7!83JTHV zqmw_3c7DF60TZCB0hxr=!%Hn;83C_z?%fJmkJlN8B7m_*_T~ z?u=~4WzGGkQii@>ZWrIdLVPaC0ip~RTQQzX^(qj_j z2(Ufqeo^9(Nrk(y$$K`u_3u`bM72N7S^Gf!jwT`qt7vY>evRs@4j&c@{y0uWr#{_& z{GTp`IH}{=XUAondPo9L&%_avb{6wYLry|vGEf@05FkYR+ChrLD>l$noooW;%geP~ zt%VP{niNOzYDM2IV9ke0Hoe<&)^g+G@fL7F;!_g%HZ>#gnT3SmOHg3|u~*-j5Ss?f zEraTNZ#y?6a8w@+M9!M)>A80H#BBr7bpilR?@NdA4^|nr?0F#3h~*F9KU<{5{Z1PG z_D}GjYdpg#-4lisdW@qbU2P69hr&^K3uCgqPLl`DF6N=0LfVz{<`h`N0LBbhK@8Or z<}d6p%{&jiKcI56sTQ$bt))Pgzhf8(^p`~2nj*xj*}S* z_};$!af{4H>mlYQ(;%9A9fMf`i^IF3+_{5LIeKq=+Nb!w!|2+l8DD?o3zb@3B5pkL z10%fO0bs(r2dlx@$DK?3#T$x(0YCbN4=qS@Zy12M1nqZ6Pi*WWYC$TZfpw;6HNb>< zOA9jj=JgHI>AS~;`J6oT-D10TR+M@5K{pJ{b>DKM3#;A**do|Cf@n7pi-hP{+zsbLD@*2?f=vyW92;&7o>GxtYNG5C+265KU2&=d{nParVMfnf^kDF z8kS1g}Gr-HR{^}2z$MA0ELsR4Hf<>e+|7ZYTsH{zj^1H8Cs zTO60A{n}wo&HOOW^~mJjKLyRk+TvSkD)USXsj71M@!muQSe5JV4$d)W3UjCYp!ko;E4?%MTNBt~!eM}tW65DH+R)bWhkj}>2rh-Wh^1W?|@xs%bFm+E-81tUhucA`mJq2gjLF6uQJ-e#J%E zWYyfcKaVp%?ZSKP!~|E!m6P9={h(OvF&q223MAv^fPG#eDQgV;{I4bt-q6FLu{v8Q z#DSW8OQCp{VUkeK+Q|{3I;~A}U|auHSTRD*G2Ht#+~sAc6X4-hoPqC6)M?`1yxz zPwz8&7qM?xJ#fVI%&t>FoM4UP-5pfn*E^RlyBoJN2o7&1^JTes=&T7kOVLIJM%oeC zUVgSYcA$>tj>Woc~hLN8_FTH+%?bW!3tYj`bwVY9oV zqJis*yX~XQVo&$W^4vd*oNrgxmbN2oD``}Ikfi;``3w1C+F}>Jd>;&miOGu*6`H^9 zzHt4)Q?`p&8Ege?~L-Zz`o%&p2T_I7#X zjn00nYQuK?L#KO_rW5S3HQl{Cd_vf}W)Ngo)irJe*#aB&BiqHO9Eezm+cqQwsTTQv z|2W58!oN3~dtVM2K@f3I9aB#`8&7)`TMv8qfykYa`(5hHZ&LDSuE{E?$SbSJDNCL? zqjKiV Date: Wed, 30 Apr 2025 15:15:03 -0400 Subject: [PATCH 81/82] fixing link styles for sdk setup section --- src/css/custom.css | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/css/custom.css b/src/css/custom.css index a2649e0f2..2f10cf383 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -241,6 +241,7 @@ --ifm-color-secondary: #cc27b0; --ifm-color-secondary-dark: rgb(181, 13, 152); --ifm-link-color: #0071cE; + --link-color: #0071cE; --terminal-key: rgb(47, 162, 160); --terminal-value: rgb(226, 52, 120); @@ -297,6 +298,7 @@ --ifm-color-primary-lighter: #aee1f4; --ifm-color-primary-lightest: #bee7f6; --ifm-link-color: #7ecfee; + --link-color: #7ecfee; --ifm-color-secondary: #cc27b0; --ifm-color-secondary-dark: rgb(181, 13, 152); @@ -628,3 +630,9 @@ li.tabs__item.openapi-tabs__code-item.openapi-tabs__code-item--typescript::after } +details ol li a:link, details p a:link { + text-decoration: underline !important; + text-decoration-color: var(--link-color) !important; + color: var(--link-color) !important; +} + From 3fb03422b581b98492614a89d8e6acf74a23548f Mon Sep 17 00:00:00 2001 From: con-docs Date: Wed, 30 Apr 2025 15:01:46 -0500 Subject: [PATCH 82/82] Fixed link --- docs/connectivity/saas-connectivity/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/connectivity/saas-connectivity/index.md b/docs/connectivity/saas-connectivity/index.md index 01e4d3a63..c1e46c3d7 100644 --- a/docs/connectivity/saas-connectivity/index.md +++ b/docs/connectivity/saas-connectivity/index.md @@ -45,6 +45,6 @@ With both SaaS connectivity and traditional VA connectivity in place, you can ha ## Connectivity Encryption -Any direct connectors that specify a virtual appliance (VA) use [Zero Knowledge Encryption](https://community.sailpoint.com/t5/Lighthouse/Protecting-Sensitive-Data-with-Zero-Knowledge-Encryption/ta-p/79657?attachment-id=452) schemes with an RSA 2048-bit asymmetric key pair: there is a private key on the VA for decryption and a public key in the cloud (as part of the VA cluster) for encryption. You can read more about SailPoint's *Zero Knowledge Encryption* [here](./zero-knowledge-encryption). +Any direct connectors that specify a virtual appliance (VA) use [Zero Knowledge Encryption](https://community.sailpoint.com/t5/Lighthouse/Protecting-Sensitive-Data-with-Zero-Knowledge-Encryption/ta-p/79657?attachment-id=452) schemes with an RSA 2048-bit asymmetric key pair: there is a private key on the VA for decryption and a public key in the cloud (as part of the VA cluster) for encryption. You can read more about SailPoint's *Zero Knowledge Encryption* [here](../saas-connectivity/zero-knowledge-encryption.md). SaaS connectors cannot operate the same way because they do not communicate through VA clusters. Despite this, SaaS connectors can still leverage the asymmetric key pair scheme — the key pair simply resides in the cloud instead of on the VA. The key pair is only accessible to the Connectivity service and is managed to SailPoint standards for credential storage. Whenever you are storing secret data, use the `secret` or `secrettextarea` field types.

zi+iHL^3*SiU3kzMp&RCUdAFeJ>>4Y{<4~Lb9StK#BI+&=z$__yyF8G5*Se z*1cSwmLMg9a2(>MFQ@fgS6nzW1DUAy&9j~R!pW=#sKGUF)3w7BDwZV(tMqYHZ(SQL zt1HJgO-a<3pXjY4(Q(rQ@;^{(Jpd~>#9FV$asd2}?+@^nkw|$!5a^BZ-V6^Je(x-q zz=LX&%YqfQiE-3Yu8xX<75ELTzKQMX1SNfDKxrZ3dmGz7A3N%a>xiTsAiHLtZ4UQ?S0vmk&xE4FFmf)nlEHtRi7iAO#0`o-9e#im ztMF4uQ(KNp)g1#~>eXziDbkPxlEC~JF8mgbf>k9j zUfvYaSBa(0o@ev*0<;V@=ldN3mB}@o-$BAM_EH8#sDE?oP|#h4}VHb)4QND?_GQacTB<%bj^#*_Htqmwg>qkW+5@&W_7I+ z;ZFhK?>eVOf>B`CV|bp15dHi<4+^Uni%9Yw;+(~gL0F3a-iARDogkYH?|>NXYyoap z`X_?|4A15|s^Mi|snXfbApZbq!yu#{ZXr_=3n$(VkN+9+72v}Mj>6eikE~hqQb38* zI(6n|>6`oUNrjL78BoikBj;R6kD)x>zD(iLPl(`Tfi3L-14Yzm{dO`rS(_oy1C1|) zz8^_lPngcpBFhnD4HSKv!@5j6MzLA#)>h^;2%t@BZ&>Zas&%LOB`gj#Gp&g0)@b;r zL%E6r`>9U{$Kf2OY{?A2l{gy#wHe!jT@a{UoND1FJpn5AA^6o)QVH-toU(d^WqJW* zxS|n|zI5TCO|d^8$+Zm;1cNO2Mz7-TaKWV$aw|-ZTv4dhT-*h0Rfbm-#|aY|>VPh`gO$+Bj+}B|f-- z!mgO$Nuh2UJU5^t4mzzQ#zq+!jn7klQE`7EmLji~kV5QUO?HOYbZ_H#1fI95@ws@?}7!PbN zg5Oo$ZbYFjS(`)5H;P|ZSp03M{jfJMSbJ^e87_fXsDVYgnq80in1A#(iA;5?!d6}U zRG~a7#b^v;4&wNP0E?lN2zpjVJijnf1QIU9db1Mt#wXL%44TNDsYS^-10>Lm_%RS7 zTOn<3QX|zbG3`l#iqeKX|^l-9_$NwT}$rImA{biHa~BB_b^{BRN47ZkxgL?8tlTi zCjH7ZEfdYH$z)Q8t1Px>3_YbsNzO2I`-9anS{cu>w740U0rNzeq>$WB#dbVQrAcj2 z)f6sw(+W;N|83jxd_l}5*CRE7QT*1#d|8^<7-rS0RS>;Uc)-b!cMn%6fQRp1A}$DD ze#`WLZ56n%{qw@L`SN=Sd*_$C$N!92`OiPId}W{al1H31?DdVr-vPr@&4wy`x(SJB ztd|hZD!lwR9T5*Jh|H*iM_cwTOd=d2*!v-YT=T6MQS_R}TTN~^5nbjj4uQQ8F!N()pq8Ktnt z@Ita_YnekEDQGw#I=Q`-!3UW;xG?m8dWeB2DQayoeVmuy@U=yV4cbp=g1L}dNI6v^ zb8&{G7)951YNfC*6v}O(BVa1*0ccNkJqD@re0N#hD3~658)D?{EZeHcgQuxX0Bn4^ zQhCQ)g5eY3Q5NB93NVq^?H8Z`+a}=gXNiUN95hZ3Wo4(^O1-o|LZDF)4E|vrJ)RQU z&bJx6CS1f{2SC==-teQBA|oAc?x7^g#@UNmBoCbW1_4+6ljV?evYcnEe-*t#(`%lxVAlXutU2^_RMcCT27QV(#4^+-ztk7n9+^kKG8&y~v7xL*Y(gHH zYg}Kr7H$D4z9KYM354xh$CZF6djGboe+>#GKL`Vbyt0bPT^7@R%B zCYR@12m4@KgIaiqZ38li3Q)L-Gk_`iI7dkz$0@_mlP%D*^`Q%pE6)!1fZJMx&cq;t zSZn7kg;YQ-%eU?677~$~Jf@hb%8 zUVbUf?X~+oJ12jQvaqfWqLme?wa%jgmLIHgIy5+42u4o2U@hVw%d9ox!xxNl|0VIwT~rMA?@TLX1q7?6M5TK7+>k zyY5Nn)A{}dzvuNj=e$nybU*iV-PiKI-q-cqcf>MwSi#$r7JYIrtSAJTeSxLLAU#=K^KOz@m=NpFZQ!yyx@Zk1`@KHkFv!U4v!UB5 z;N;W^*`(B#mSX1oU7m@Sn_> zvdoq)8Ost(p_}G20eFN zlDz8}2Wj6o54{UucuRe=ChCBD9kf==9(ku=d-gKfERl4_*vqSAQgo?nZ=HIEf0{gg z2O-5Pq@RSQcmYk(n6=)aprEQ4~eA9@GEURukon;ONEO=gHjR9NDF+lOf$Hh$hc@eCe^vG}VL(rYV(%W{)Y zWRpe4>hC&0ud0ye7(PE}iWzon8xCd^K1sz^4d)8IICJSoFy;K-9qCi=jcoHBStG1T zFfZGBUTN!fpo^3#PHeNd-L5+7F>nT{sXISugA+r}JEKtPn8vgh6uyS0GN146b^;6U zsI6rbqWA#Lf+2^(o&$>+#)l$TH6%noKr%n2FF)+$)L?G)=cg}el!^64T>;yy-T=|j znrHvdq8z1I@BI6eT%BXl$+EPk((*@@!cMrtyY(Dt&siJnIdgb?OY)F7DnxiS)3N;B zvj&Pm(UG0;ubdkC+H%sNaW#lC@po*ou}uM)Rzh_l&H=Qr;6!fo$43p{Wg$Q{q{zcr z&@vn9DxWILatYVi7`)al-8H%W+I5!WOX$cDKRPf>g;x?9rjvX1=NG+aMx>Xz!lRQz zy)AEe7K>=N9a(hg*rf~mC7T4x{VLEBTq%hXhk)XtWzKst56yK0ynJVUwg(}EQnp- zUr{D{Pm^dKws2o-aJJkP>_%M*MVQn@;X@`WPX_+*57k z$Ro1G;7l~!fk~jtrR!DM#CSk4-@_y|oibs0OvSp5eAm+@YR`};kYz!bUK9M19lS2`gLRo{fh z$O%-h@+cpzm2H0c0{a+K7qLDAba|z6gcwhip4#B8ZI-ly;^}G(EBkM%C=@8)!V-{I8`(*=xeR^LNQ%QrNYzH zHh7sc(PPIhdPEq7Q9L^#8sB1^7}`JBZ_W4M%$VIUYRY*4&YK$%&L zagt8!!gXyWJz}l4o7jy|9b;T6R&&TdSMyT1Cw89cjvQ%2ZVh{?+P&7b>d{k|k|*kz z8V91HD_q_QzB&>_3>v0tHz_P-EFFXMM`Lm3dO8)3ZPYQo(jfUq!_hL>t3D<)3I<@S=&1O)i~x43z&GN~TW6bbw#M@W`W7j&~;V4zFJQi!DbP!ylB1L6$fP$}%*HYd|{w^_F(@44# z14g@7-`Gs;TH3vjq4v~(iLYlj#FUwiCB^H_98<(#>`-YrP7O^D2spPV{oy0x7@#%V zPJZxB^8TmdRBFzCnT}4GYWpTZjvi6l@(@X%IjZ`gfwJrpei0n&?jBr;iGp0Uv+Spg z)U^)RoxVn|$c?pq?v-B1uE*CwJL|SQH%Ct4HyNDzqI@g=m3W498aBd^xp>~B1ykm& zr1SbHC}*4s^2RYJ!LApl$h;Aa_3ca*l1x=|?(rUc!#frJ)Kxab^s|NT^)DXUfsqeT zWWDI!TN*WD6Plev=1sB+X5Ogp=GX1>yvbAej2!%p&!2H!TP2y38@H}4-y_8J@fglA zaKBgBTMlK=gJCfAG8lrqTwHS29~1Ge z`?B+QY|$2s3Ph82C+Y>Pug$srW&8eFT}l9a;_O3QSkeE=&p8+D`L*a}C3(NcxA!8alr6q{z_cJ@^v6OPwK` zs0pOR9$Yqq&))e=*f8aXkVN+)iEgt&<}Rnvj(MZg-f%eiTcx*&O+m0l)eXB{#%{Z& z%qpcBg`Q8Cp`VB{JEos0{Fdwb1SgQ@NO!V3zvJ7j^lwT>&QBaEeKZn8QEne}Rg%6N z9)V@k?|s}=M0U=Q_nVXxNRBU5S$s>$xn7jde{yzT2Iax`Ovysr5Vzy~Z!LVura{Yl z>0Y`s2h-25bmEehqKB0EUOTB2-ZAtQt9QK00q&_6F@y~pfGZ>Xa~M%9m!8}HR(N_r zaY3Gbz_z2xrOi)k*N|VX#(~!QI=hh+wJjwRa<)!OuwlT=hywk9)vQHLl(3=f@mjZa3m=_I$p=>09(1oO?r5_9y$Xm5%fmN1JFF-o}ai(ciTO z-BiBsYl)bP-@@12mvehYVJzZs9j>iFx{CJMUOuS&P>D?-d!YOks@K78NlZ-s9crYjPTGTlGczm%)G zIF=Mkp6Y4(@NNgj;dfY&>uAnNXctb4<1puTod+?r^@f-vs*r$4%!+-RUuQm-oWN!H z7+$pgbKzXXoN$gv){{A>+MGJKQfzG0#GeMb$)nyxLxg~gl8$-PU5o_@xWd!Z*In)( zS4l1o)axs-pc*NMc@K`X)DNPTOCu3Y5O7Q5Sc54WLx@+q z%s+)1^=a-44oX~4-WplOy!}ce9U5MY4&D9)5w=ptJcbq=}kw#%kVonhT}^jr6liPz-w#`0{QbBD*a3P(n% zGtT3POUHBhL1( zMn^Yd3m+8))JU=CoL*R3)@xIcaZAo(vmdEH+&MGqnB;+JcS$l`q;|h*TsEPO()Y|i zld2UwNYUKjr1IDX8+zg5EqQmY>nqgQ=SmY_lS;|AvADTgD^ar^RFCHHF%D6>QCaI^ zh-c*Uws@azXT z!xL}ab}~8~7j<(vRHoOY7q1dRrhzX=9v?5ad-g?m$*vOW&S=QAPv z@pP!)INiluBt%+UKZUP_m+}w9`Z6xHz4`Ogz2P|XIZ*+XO)?R7U!5XcOXh!)qa9Mqen;7Jd~l9Vo@Ap;`;A7K#Ki-)eeDxCkv|q5wt;baa%(_u0_+7;=RQHv z#EK;1pgI(^&3t(`txZR!XQtxsHU5xFl$jN2qsF92tbS0ZkD5gI; zB9`?2kRkREKf}v)?mh^5aY((=i{u{d8kDVjiMH}&7O%xdb2Y1Qk)TXVj~S6m8=L9p zD?N(m#RatDSF|sM^G$ooa-1nDJ>PajH8RS7bhP=={_wbf%z_&~djVWql%sOGgK4pP zF_m-n7%5@&k`G&bQKwH&0*kMTat{HmdhfXG-8Z43Y!_+N-&c8zq|_IWSKghB^X2Li zASq}bh*=8h7qi{gZj^M$+QaQ*rPu@O?&&?Y^dsJ_Nwy!~hK+Sw<9+6Cgw9e^w@#;= z0{G;kTPPu?<@NUHy}9>?Uoq(7%O<7Pp%jVh}k?21la^W*E7VN5ZFy97Q?K;GYKM%q-1~{Ixgd zlB|#3v4`X00-V=(XZPWYs=Vi8O5N&FBFlF=fyFCK3vl0m=uDdcW z)9r#TWW|5qy37|W=;cO~iFiD*ON}|{B)dtaHm{`cQR#=u#f-04<}0%3@Dkl`!H1;r za)NT&7azcvtW1(}Ilp7aYoZHFC6pH<=e?Y?(ANC%9E2Y(#ek)AYN8W+DkWOj7a_=pa zcLiDwl_v2^Y?<_hO1Heuw3Z9Uc)wWnh(Aq07E#uyP$)VFjJabQccE^4tnfPL!D|u9 zC3pP}f8qMDc#66(7-^yVl*ND=M{P+;c|m0m*;%Qd==Er(3kEE$t}Yt%d2{(?(@C z+B`P6G&UZ7=ivCb9&Z(!hgA-G%Z)>2rTVI*9CK*DnaWZ44O7;!goT`dAdlK_jEtEk z(7!vVGwjqM(U_zn7S-9=hwmtIrw1%`4i@$I4Hl7Yr)Q3TvV(wHQl76HMYQD~p)BO2 zSO^=BkyG7QK2_A_kOe1_3%!Vv;p^?WykyLo-Dc01I!doFdou!B2`aEnB5h5ayw-uk zt!YIn?U0HWpR3Ts4hDPHx#Q6yXm7Xkwh&3d^wb-=4^4&yxx~|LnaMPn?|99 z9OIy=hivl94Lo{-1g&lkXV5gP^DR5XXP;iXG@-ADK@1dqt(W`8IGgLWITz4~$w5}n5CimM; zjOXhpKObZC0A1Dt${-W$@uLa(KD=CYu2`=<^ZAXFoZ7w-BmmU9kfEL#+*6%BvQ=s; zj10Tly;>UIFkENNr+YF1U&FJ+HP_|;`hg3#^(D))-Zrr_!I`V*Hi6 z^4od7$BtJe8cW>4K~LiUr$ z?M5zydZ5pxHqu1nkC+xV3OdMgJ36fOKBG+4GW+n`mCD}3HPjtl$=)*X`+47gu&x*> zZUAlpBY$BqtmB$^S^@b;2Ez$-2_uRa)qI-J3jeMF&zyf=^HQ=8kfN61OV_8(@*y-) z2K}=_bw-n5PavP>T23dfxx3m?)AHS~HE){n-!{rV*#ukVzBJqCVZ^@%Bln_8Ljqh) zmIzd*IFabrJ6nw~$rbt-f}@;XlxKQ$GwfN&@iYvpuUtiKJX3#puOdm|k;W5k|7rQn zR{St{@MV$QDe;=*FL@7+UfUef5D{sJV}AimkrV8m2+DH<$%uzVX<@XLpf|LqC8y4) zy^V*jOkpFtb~!2d#!EG+jY*g-<>V)lM(P`4rrJZv{F-aaFIFiDQl8=KZTFMT_9~1` zuD$+6?jrlsjRQ`YzcgY$Ahv~dB9`J~ka-yv_S8OPyGEFv75JX5Zd49>WOMn0?Tzr-4LQmlsB@o0L#f4{LyblTd7F|gseLom{mwTQsU6EPrb5KEPq z(6YJ~lQ4bh#^b1L5Co6NfK$l_#<>3!z0V6al|IYAMmeEj?ZO+~!r2mudN%Xy1K9l} zC&QX#zT4NE9J4v3F2KGfcrrA;TC?Q90w_w5G+^+9hpS1%qWd~UPPw|%Rib=S94)x( zlma>SKH$Tp9I>b$FWgaXOJ97$TK_CvuZ(<=D>r-|-Q?l~EmzLJ5VM|!u}Z+hNI_`c zoJhkRK*OENp{)RD+ZG`a$D1+&rYCv{o`sJJquO{Lwz4X>+Fxj>5kk9CL38L!AsEAP zPQC|T$14ZP8oH@!4fjl$j3PO9?|f~ql5t~~ovt(jR`cA#L3ojldgz=@$c*wUc?pL^Mya~Tkis_AqnSvv(k+6vtyvHhi&*Gihhc?6D)(mY~McUIVf&1!!E&NMh1z3QH` zeTT;idb}Muo<>2sE6}m+?6AVv&MT(TcS=TUk~1DSHTZYF8F?$S-i@JLoqdu01)VA+ z2@U*GTU1O|@*ZL7($ItG>%|xx1=gc)L<)m3K#fWcn-EU}=Ry&yD)f26bx_}q$v);p zD^Jy&t(Dkzf9(7HZjM}0cH<)oW7PF-Z=(EC?|&35elRV6?yz8prtrpW`&3cVv=r6x zm4ZvEkZ%gdyEK#JP;yI!JmzUEjCXPXM;wFNA^9b=nrNdBdCO!`bCi|~*GU|7krVC| z=uTg68#JvrVpn@klw;WCM#sQ7;9y}J=mXY(gWC9Y%LNz1F8uCjih1L@?YM6$$NRKV zj=#P_9drE!oVse>0rq_}eb#NaiaF%2bOSPY|Mp6%xp_Q!mxO3nGk#NBw%=W`)TFnnqL;H%clkG`e ztigX%Z}T#c4}gY<^=aR_9+w-PVulnlkJ`pO6M(!SKfFSIsKpwN2YKg%aS&L)dGaVi zo_K%s!dQ527>tXNyH6ML)o$OKdr;>%XEQD%IrSSKL%sT;f5H7N?{i&vcbW3m2Z)YH z6{SA?o!#nf;7zUtCtecU7k%XcnRLqdE!_a8OaX2jt&9eL59_9yQ|^Mv%SBb$q_HJ} zB#LQ0yO2||lbVS>hCV~F$bgNT_XElHj90DTbi26q-rZ_vq%1^H$J<@fHZ_AUmZzz> zmWXk4iw@U;G(&icTKlQZ0iHF<_}X#auje3?U)nY*B&T z($7;Z7|0`he+V*_@&d&zK7HV6glE02i3l`su$A>}C#P8K-949efG6#l1+-9CZLgp3 z*fAkLOZ7H(94&>_>@-O<)r;k#V#cvC{X*j#@<}aF|33X^Uyj#cV#ho4Mvi?BDoQFG zm-tbZb#ktnZx&V zEA8e!)xH^1G)>|^KKWYV_e59!S4;b077MN|a+2S6!nc~t-ubHRoQX@lGQ0ONtH7Wn zbwCz_=oo>giGW`uiHa%p@1L72k5vnRPr^)EwBRb}E1FS%6{T!mD-c~N?OZahV0-z? z;a72M796-J!zF`a8;AJn7jlkA;D+#Z=Z$ZbC*g-`acxTRIt}<*`$IF)xUZ(|%kt^A z)DMiy%DEZ~i-)(wWO(qm$YJ>Ev-4DX?R)~kk(NC~OhfkN5qVCBm|4tD!f=7+0SAf3 z2h{fW;*elx9ey>`hpZm2C!>JoU=vKvo5 z>(?G!0mB9_4aM2i937p2oHfZh;txA<#FYm+`A%*zZ<%(y>^2T^917oGL$Sr?dhQ?N zup#e}L9MB+g9Fxl$B)B)dh%_(dl?o{vk%Lq8Orja|FpL~H>ED_y#B6Zta%IjEDPi49tueQrAesiKa{{GvH3@+-m&W9KhEl0)8diPTS|HqTp+q`=VWY%xCgayB_SFuge2$qJT{`3+x@wJGZX`1+lU;WPzstP9QTK4B-`cV3`#jO8sz^ zk@nq)VAvOXN7Td%NYJGY1I~0Px7#yrUm-8|(2(hFz82uyt7rh2s5d9ElRLK3TX5;- z$4Umgz2J>tMXgJl`0lrsrsiC4vu@kH8?veLnV?kBcqd=v;Ih%-tLn2fA+$GZ+ zn_pXN2V7R{s-lk68-=LwX4tm5WbW})ab<5DjkR5aw{z3WyT8X%Z#y}D$DiC;Zy$Af z@P&Nvc|~bnqs~z75RWB=3A3RiCa@TlQULl>kj-egY{d}bks);EL4VW)SkFSC?lhnu z!smR==}X3fYQxd_?Sodmqq(h5kEw^_cJ1fR3Ol3=3$oYJn9U&b(VqD)V-Kjca*x;N z@xyaOW6P86(rwePR}Bo#jJ%cJ;FJaX6Nh-4DY{v#!vs&p-(9AT@M*X839aBEu;(cJ zjwyQ#&YvIw)}WdmERO6U3h;2hLNz1?8to5(e%!N>*MTB4=ACuF@!h#mnbFu2@4_A1 zKdkRg72*a2%<-0)bAPXa57F13b|Gtk)hrU6r$+N^TSm zvfFgz-S$yU_9~qDee9%DEH*AaH@p8xjh#R__Pn5ETl!NZ-+u+*`q%T zyteK}^~JbdD--4`^M)?#;n-^EM#sb7*gbyu6@I+-OkS}y(f6FcMWd^Mx~%N-#?9D> zw;FTFZ9Lhop{}LVhh;hs=>!O^81O%9@Krx_-$zkvdJl9#{B^`N!d1tCt7Tnr>y`P5 z6nf6W`uUvG2QW$j6K7tUB)?ja>??bce=#WtJLp>@M{3%gtVHvC(ywnDA~DvSM#(de-ibBe(aiX!kStQmaO9_7Z^QDI-SK{ER{RfDOtHh7*aV)gz-|pj7@dLhG#WHJ zkn(^}FCd}8-%!I$lvEybkWv-iz*p&_d@#!VgRqQTNatV&oFmgd+6{?xA-3sn3k)`b zT0BR~dCkSJ`6G(K38;~GP(h}D?kXHinFRHz0-Mm`Qk&#&E^RIhK+^s|sgOTa8LO7! za?|Ukd|a*?;?^~~fci@-Elk$_o#x-`@Wuz8>jF_&>IIa~xNsz|5-j%j(q)IGKAg+% z7(yY+2ZRT}Cs?=-jHx4fy&R8?QC_bH)gX?2tO3%XqJ&?W~ z68}dKRZ_IkVXjge(6>0k%zU|x-g&yO=i7r-T7Ta>2a+&9?xX_zElyTonJ)ZbQ0k}% zF3KtN^MoFlvOCEm)F6W*bFe&mRAyMRub@ZSbzQ8E3HPUJI9F4bJs=kAriTqDNW zo4?k{TNtk_54Mz#&S8CJ_m%h4<$Dg3$m|$t>fl0Ic}B_Xl2SZYB~d$p(8cY~oW`0^ z=E)NY(Iqc^iUmd@Jy7{cXcGiU{qGNCuwJn2`_S5D@gAo7W!6WCU-1?jGO zE{)}ge(zpUMtQAJ3+?mt`Qg9di%}!cpV|5m`7PPNm7q&igK`o63=?OwCC1MPwERIP zfVI)kCa0ZmA2d0w4hX;R`#I4+xIht$Gd*?7-)eACgYQrpfkH81Y-mVb^d_#COWLA8jL6qzt-cMq*O_?K*|o=Ji?=a2#Rfez z*2y}dXJWIz!dHXehnQt7?pfK-YSB!($d; zI#=%kzuBXo7E6)(IV0z$A2V{_12ZBVg`Yp8F*t2tjAFgR=YJ8L-$?V$`IV%dv$v98 zLx@t0M1yq=rq*Q(aqBB4%iGtBum>~>{&;53hNLW5RE+AKk)w=kA<0dr;#JZBmvdeQ zhn5%4yhazRhNIDNl?y^E=YDy}_p`-*%VNz9xO$pUIH=GI=dFO0(3IR>8j{K1wm{z& zF!HR+`|u-}0tVyy0p4%YrYPp1rauPLhPF8Tp6)rbC|>=-Vf%cqH?fai{SN6O>uQMm zq2H}pGgpVrBy~JV{q99E`7N6;c=Q>;B=-gKSGJ$xVKhl2W(+fW3l_KxmVwnaTE_jW z2pOHL_dGf3ywe86{CyKl>#u*BoLt}koT?gFCfEz`!2~m(W zV$R%O9pyCoSn$q;j95uxkp$npWp^)SdAa>S^|G$nt2X;=fI6>5?TJ?b2psrkmw#}xE7)7MuL z8U$N2U~z7Mk|z~l;_Dg20Acgp&14 zG=JtVcGqwSH03F1Ee{5)qd|?{G$>jPKpW@x(~W#D`C%gsf54rsV%4cruCrN4r;K1u zaahpaJ=MPd*X|g1VGU$7ZWix8XdVjmsB|q%hH;|U(VQ;!7oC?wPssg5@{tLURCzL&>y#*+dWc z>D1!XR&A&1)u~$e;7p4eCkwWtS_S@x5cnE=RM$TFUyX(*cFOhb>1pyswPap2gFZBa zs*At4iXPnRkU?;dCA#Mhy2t<5d(bq$-(J-|g^%#c&Sm&F^4f1amG?*8jr~{dbrC<- zM#&o7_fl*>SRW>b1UhgvpLxxR*bjWXboozBK!eVK8}nO=?!TsFtg8i7)wm6;w{guc z5dl+p=!Yq<2OHbs6?MfD%&4szrjYX(qJqsYG9-v(`RSIMRiTH5p@;tQtKyAz{cvYI zJlBV$KcRb&a$W@oEPW%i|1|S|Ye7hAx;~_`k9kIJ;}Y_X#^|NCBe!Q8EDoM5Iq?pf zJ8bKss*Us$P98T73L_K6&+fP%zX3^b9g^VRpmOJ71*4;yoS>TV@8xQ@8f9R%PIk== zp_lh)VlY3>2nf<-XCnwgw<}={@}3~HC;iP<(Rv(75aMW!mj4b0MVBd8 z*NA@6CeNdaO~9HM1%)APv3RjOJ4{J#=!Pi5?+7YzKGWz ziy}`PIv6Almc(YK{Xl~Jgu$y=uLA;T77%({e*DeJzYs8a>D7_|NWuU7%cBe$NHR{6 zg>M+|@NYb1%x!fIOvTQC^`ek=inX2nk3leuI`?CRr*A&(H$^B%sJh8BM{z$S6!Y&v zdlaAis;dRoJK==^np|BKz*PdMqPtKkb(HX{l-F0Ry1^~T#RXaX61)lHt8P&G{pvkI zS3nhamyO6Dv-rg(FkoPn0Hg?~Uc(S`SAHGB=jjh?m9AeMg3|(q7`H5G69=3ycoE?4 z&x>#jIS1M6Lm5axCD3%-o@U7SYe*1_MEUOd{ObXhj{LCJ*8N~*qjN$cphs2^V;U}i zn)Dn4rIxNfkAi!7jcW<9&$?`XV~{oQ%P)VQzL%-`I`F{&1o8_l`p)+#2c42?IHxz*qNzXusEhx6+!v zG|b0%-!60thN%7NQPB`_oR#fgam0j+YSiJA8p{`h!m7Z;RofTGD9L(>M=+`fJ{d+~ z;a#;gvGH_eA^8i6KSV?L`>8N9!TJ9B#gP8j&cDM@?)PV|dJwNXd3k!X-jr)mObpUb zTT77ZG?uvt1z^RPUst$wEr@Ao22|w$gzq+_DtFvc@ypK~wind>bd;MZKRj2Q9NgSL z2lj3P%@iTvDhYoZC?^a48ad`hA@cbgn}-0N*Oj&z~6MZsVx8fq5|4qdiC1; z6%=;2J(eO=D)f~rP|aeOMK2CoN_ZCmNQTij zMjs{1R8KMcd!E5sv#vOoq~R)T1E?E({aHM7H6I!nhxwdqWUAwLz*CUQt2vt}U}A1& zd!|ES_1}wM2GW!)zxwir&+cH#Fu;pSi6VDHBtewj_Euwg4u5lU1b?#!wnX~(YFG;j z4rv4bJ`V$hO)-uzFuV?W2K^+epB8)>d6(yEGFT$-% zzxuV>TI{e(4W!o=SCbOgHW>f9#1@3KcqdLuBOAtow5*Sw_m$qrb~VQKf9@R(#*+?; z654-N$ykE8Xe`Gu=5!9-8w{deZ&lK!t%Z$q`PCa^d;u@I6^TMTV@*xa-G*+S$^Rq;g$Lg9&Om@;LAbk(wSUdxgAK*LrcEu-c<5jTt$ zxXccoTMIT8a^*?CORpT@=BYUl1!mUbzd;=1{sQovBUqpibAPpeqX#4d2>uUc+Y-&e zcT)iPyZq;k+#bQmLZ>vkxB}N;G7SLStD671GMJs#00wx_{>pLo|B>7=^uy2*^n>1i ze(*wIW#|C<0V3p&!$_|R-*IkZ9+fJg!|=>;!u(CKbIv0-y zJWId<2QU5s4lphOd@w;`*FL6gNt;PM5C*@3K0+^KycsC@TZidEyGat1QRevXwcQdR zz|bzFcakWz{`c~-Mn9mC2rB&R564(Puv9qczdvN{J{W{Dl_7KrRvZ}sYY;-}|6T?5 zEDr+^k&Uo>;nXnva7;#X8l{RqJb=}(>c2N*RCB+iQn4Cl+mVeqfs-c0yGQgFNId&x zk{z|LScutTE5K+ep_at8XF5cyOR1@Kg~)9Fy~Y6$W#sunvp2v?i__^^>~Tl`Gxu&t z3Nyf}QxOa{|2bF#a0vgKKSA;$bXX{dfbQL4oW8(ju!_I z{O^?q$U#y2CKnX6sJ;kh>;WXaxeHnVnNe^M!7Fqou0cmBp68=>h76_H*1;r2~D2zGE+!ogf7W=hWJS zalS=|?LHMB0u-P0fsh@F01U(%sjDnQcG>9$5jl5?*8YVUlzbbVuwD9bU4nOC_5pizOk^o;lAalA8QaS3j>% zqh0k90ZF$49ZDQZFc^zDP$EYnC6BY70^P5wC~#hbxekrNLOo{zT@0qD3U10ir=E!; z8V(!kGxontQ9f3vebbW3Qv$xPD?}qXg95Hf;Z?+ID++PH|y>*;SJ!kO%yg2Bd!2l8zBd;N_k)@kuY8<(`4P9J>?4LczPyC z#E_nQ`drk%UcYdTyxH1Wp^kZ(8ZGIm$;LkpeSHpku#ByeVCy*`VOHLfR}OiL?sP_@ z{Lq%wHO*w7**UE7^5|J^{W)sVMNa^&%3SqpI9+L9Er;FPnE zapf@}UmwT|x3mjKcnIaB_C`(8o==c*gCI5jep5G)kjXtdrgs((-Q z`}c=T&q(qLRAncGL?!kakT=gR#oc3ywk%mvHRAOTV)NrRAq8O@OnsC~{VcR9hRNR^SjIrRE4+TaCc9-TsG{XdY9-k^ zcyg`4S<~ND4)EXYbu1a$P7MguSM@&zbHi7F47^C!W;%*(fo6wj<{k&hg|viF1K-b4 zF)-?^V3Rr-@Vi)^%9>lhGvbsX7fwgK>Zu>RYRBZe zy*fVwu}U0I^MTZJiH$JSkZc9L>&yu(7DQLUd^WH;6q8=$fH*3v&=KqNE#Pxh(I@|9 z+rC^M!cO@qMgAWcYzs;rM2r@W2&q5b2RxtSh7e$?a3UH$2V?G?G?Gs`RL@;Ji2r;tWZwy21Z*slSu0F7-hSF24jI39eE-~e^NT7PfWXAJ$D7n} z%A0Sc23$DvW2x_~);S3LfT0P%su=f1a}WjnY2&h)J305XKYkCvK$mD93441?iuQRD$eDqiA+ zIhPiSa?U5crx@a9%h@eaRd=u6fKdeSHAWjo9(oWST2yr`3g-m#nUY_v;N`5SJ_d!krC0PJc z$GwbHcF9pUjlW|)!>n`8gHlDqB~+>Co?BbC8#%&QFv>omWZ)Z*031ow>AQ^4n^SHw zp08`M{wxjCF6#ma5G+)RqV^4ggF8(_IF1{!$S`igLPw~8QKDG5k2wF`rJE%^Y|)al z(87m27J~?(6wGCA9>AXkCyOWBT)~Rv`Y$>2dsF@gb0>e3BrZme{Mjm?p`0idPZIVB z?aw@i5=x6)6h;7ka1BU}+lTabgTV9^ejk8$hP~ZjQ=PdZ8aGWPEstR8xfO4NvoGU- zV|rHrBu7rkR6l{RHyQ-$BN`{MMe^I_-|E~^T{3FnmUm=j)bQ6J&J@jIS@V{GXYeSD z4!CskS#Qz`;#X+EPF;B9pWtI>@?30txz%E~`>|sO_-}VQmc+5ub9({JFb;@t=+V5o z1=bPDngT?=AV?9xC0SfW1TPyZHv%sv4={{u7-a|sT*jfO_lCHfA+(}%GnBjufnn9E zFX4I_ebf8(=uX7if*YsFP2@+lq9nTX%FFP%AwlY>UO$Z2I%yKn`qDD2ID$8k|^oR_@8 zwTyY$UmP?T#)v`OHBvJ!MBLq5WmI`0!!>+rsV@Rv?<4eAy95@GS%QMneu1!-0d>ip{gy54{Otp-8OoQUcqq@EEdqR0+jApRp5h& zQ8xxqgz7(KkCpVM6`I;Z?ZZBEYORN?mLPbR!%FXD3fH59p|b?)davm{VGYM>oo*|k zx#dCmW#_CHq}r-9L^+3nUk(r|1u$<9u_#jJkt~IxGcoPKivo44;DFS|%yVsyvAecg zY$&!;6cH_BKKq*s+&ovqEnQYgIpqRb61+TSxdvip&KG9C#gl$git?l%tIio3o+6Rt ztvzG;v}q$6kPQaRI@e|i176-xtOf&qV6K5$Hb}o%>*fm}o5ldgViZs%1Kv*Ba;JS# zvdV>&njx&U6%3%NBI^Hn4XBxs^f(83i*ebXp0ysj4QuMT5drK53~o-?Dvzvys6uC` z%CgFeCDPT@^9*%jInfe^iK`u{eUY5#B;`)F`kZ$pL=(3`Yv|x0{%dkoeG3Njr#AL`Q^Q|M)h*oE4EJuyJs)G+U(HvX83}n`x z>$XzENuFJL=+9*!mS}AzEc%!MPkbP#jFe@60evlH?UT|M%59}JDUq?r;D776|! zyHW6koO#1p0Mx1zO{r9rgk?8u0_Vd@m*eh0RWXyQv5Z1+x3tFesqLS^efFG^Fjy+$ zZ5u>1s|5dT$)?1{Y|+q0U6mH=O*MrN>FdV&!2lVJhN;vNEHwpbPZh*rRsT+7wUwVm zpc1`5kkXVSm_6{;S77hx%`t0FQj++V|99ciTUIgf(3N^_X975=h64!5iB$vVj~S8y zBN@tLrECd8_FC9@Zg9b6oj+z4=EUqPk^=tzqQZv;SO!OxmQ=!M*B%gF zFcKc`Y8i;dHw>XN0xH%mwt^m}JQ$)p(|}@5=BC^+&(gI$D$=LPF?O=RDh9C?U?6x7>S1f<%&|kxGL~@B?*{vQNTgQ z zTd*-#`2fu9)snWN2b}ge*cGt~)*`j>Z$fcYlCk^xaVqpHoV$nm8it-jx$Y5Z!_i)~ zmlY|`=Z)S~u`f>O(#%PTo|fWz^aTiI68z7|BUjf7{#H@84B}w$E#L_Eb zq9y0wF~7kVE+}~@OF*4lMebWzANitQ7KrRar8tw#1OVfvpXO0D1WK7?@SgW;Q_a1? z`)?G*02-S%)RVybf>2Vl}ja~V@< z-xmea3dJ+l2bX*lkL?Co>(z5FQF*6e&vFEX9qd>A3G1wHf<0)oKd@~BYUYu^x6NC_ zBrLcuq%=2}o`BF3C#T*hR6Q|Vy=OS+%K$~4NU9ayUsFTb_QkrKmbd5=4ry=zU@d)x zPo^W-_o?R&RC0|?41S#gaH; z9+Xd>3l=h*3D|-m*n7qHA8vY$YB1aNGlDs04%4FG{p7yXhR^tpC!C|5Qll3wV@d2U zH`UZo&F3HY>kwCDyXpfAjg|F?aHkR!d}wP1^inp?;AJ#t&bs-OG2b)6?Za1%5I{-b ztSRRt9eGDQB9WZ-yg?9{;F=98(-HMUWeRK~?Mfqd7ksmQc^)~R*3?_+!FIt#H>akv z3&dR_Exl!~Br^U0MPe20uKvTR!3D4*&H1tEOLK+H`=t}POF=srh4SV=9BqyPKkm-6 z3T7w&0&11uwVHvI1r_Up9F17S>Sicz;X`{(ubJ-S9Tgj%`?9VL_p&xcZK`M)4zPO} z@KN*Q`D(_>$i2SoMoZUMX6h=s(<)i_efrXz2{KM4J$@)>3HsTx$%*PDiXS0Kn#bRi zg0KHyYHgp~o*+~TL~bqgd!Q0+&X-!DaQ)*za9a5K!QRx}5cdH=L+RoF5%t}HRJZT{ zZ%OJTDYG0(AtNC&PC~Sfkv*c!tn84@DVd29A$wPLS;@*s5yvPbdvxejb~eB3eLSDv z*B?*kd7hkmUGsIluKUh>43Luec$U`+U9TYy6)4O zX>@AhN22fw>Qn2MzYXi%%sMJW$boaofx{R>Pdg286~a}NGeZeUj561p=1@`{f~@7& zjNtf_%p$nH6$k!!zUFb|fu7!N;t+><`C|*iW5a{FF0+rA!Z=PG zw%vUx>slrT%g%X!@=zT54<-&lKIw}F6MKQE%fgJiW4e20|Czohov6!72))za?egc( zjaPL_%Xto0aL?4xA{|-vIQht-CaL_DtP`h0nS0;`CsU5Pj+~Nqt2QQM@h;pj$8FBm z(lM^=RJnp8`i_%5th6S+;ISFtaw?%*o=xkXDILtnscyBr2esVf|Y<1zqXJ66hr)th_u3f*~i|Jt%Zd^OTsrt_0 zONv-wH;$O6h#(u*Js0;kt@iI5T;Y9{ik8*;0epix{I9mPb%n00WUQ09(5s5XWA^z0 z$V!6B_z>G{hr#F!Q-;j~4<0VA>`gwmEyJ9(l;)M=grJ8DiQ~(tyJ=EG<2l%WN~-Zr zC;3Gqx=M$;aJ6sfMYVM_&+t^2ws*cQRai|_9q@h~HLo)2t1{F3D0nNWXSD~{$WT;M zSEFy-NO|Jc{dHy{zVh(;-Hr%@G!M={28=MbnH03XKoEw#3d}U-zQum^{y`Uf0&JvJ z&qbuJIKTcaVmW$Oeo#`o(JNqkaLBI!%4r zsSmU*riH!H0_GkwvO%@ukHi`K%>+~YRmn0LK7MhQKpzk`oUC$ z5PN2&U&?`xUE=??OusiE|7~5M zL6@UVQi`()Cq#6VcY8aIWT$0Va+D@;UZVv8JW(&MI&pxJPZ!o0=(v46ysi zx9V4l>gcSq-0=)S94v2)eCwjG=~%H^4Pg5i1ZR5HdRRHkP>rpE`!@{ASSX7DoEsK1bhABD z0+X<>h7IHm-9hK~ntd;EI#QWIXT8q*>FGPdufc1Jdx42b6D`(MY_laex$t*DFwHyJp-M}iR-|!lS7H4c#0KF{q5rQm5 zl&UKej}02NN4E293Mg4xqYt*2Y)GsXhi~aP+sXWHiOGzI4kP%flhVdZYj~u5%V1wk zPLvi;&M{j!(#S!SBPA8uB(e5zRXuw7P_{7Y?j4SF$2{SV6U1eX9`KG*&|pzwCuGxu z?Er|eLlBZQq^@yt!#Ybn-0Uc>AHDy3);vSxkmZT#r21e!DU}m8Jpb+LrpK8YCY9a4 z)Id&GeT7fKT?M;U)4nd8Q^Y*GcOjO8mM4EA#u>VildBW@v3O`=P)L?$0OxoclIUI!#LWv=mL@C@ukhLj;f~nHVr@t zKjF1%A_n8@*RLCWi)!b4{!cJ}L2y;Bq^gMCgs?=@UjpX$5M_aI({2fRVLD>MfSx1b zqM~@U6}-NmWRFM^pj%|(t#OZaWOl-;1ncmhZXmf_Qi$+i?2ND3ieI>v3yHXr`hK14P z{XNYbHib1>s49ES|$LIR?1&`!w<)zV~XSSwX=4i|pTqh?!>Sz5kQv+bAB!Q{>Q zQMA(4fXCu=ik@W;6|Qcro()xQ5$?9H3o)6*dC!%@YalT2U-ZGf!_WiJxSZgVayN3T z3T<_)%Z-T(sfmolFg~OVSRwqDzT^I*l6J>@#X1Z840rncl(~$WjsW^5Goc3FnY=THM?iwC8EQPe4_5a1>)SE)5^S4puPsNRqxl z9=mJ^wO#UEE*r}olDY_;j^=fqBz=ueMPb+qAuMg$uTbgmLU^}8X2|{%cE=YaX}IP ze0<(+)p)(#YUdwAM!EwP4sAYij^I*alCW|NhnZl1zPLyx66%A(U(!fjV!7w?P?(=H)-6j)<@%~je z{I{K?<;BEP<(a(H73vo8TqvJ<KL(%zeEI^T_@Vm5RP+CJDQhS4M%=35@s{$l!@ zvU5GR5osY|Y5Du)#!K|5roQN=Re2St*IeP7BrbZqqM7P0h(6~#%j5R`Lq*RZ7v1{@ zy?=Xkg8k3HshX}e#xlVr;Z??-8Sfk1blVE^tcrvkwOC*qm!%GL2MDeTguGH}Ii0@{ z;}*f01bSPiYCuvZGxW78bfxrg;heJ7E$4!kXx1q1!!?^frEtQonu@VEDy*da2o#W! zD`*2a!dB|t-BCC(v*^7@{*$oej>kFD1F>zzHEs6dsHTs;N8YUOY(*$rLy6!Et4cxZ z8wI1!y#2S#rSH)!1%tOeenxDN8`JeFq3R}23$b0x zsHvpL9JmP=G8#M!0j<}y=XJ$3(z51#o>95<#5IzYI6`eNGN{_HJwJnK`D{GD0c!PUK@ zT}eebGNycAmNFUfxT(ci8qrw>Q|7cl&ClY(+>KAeOpD!M25geN*JYxXXuLk4rrkA7 z`k_6~zmzdI2PU{KonjP9DDkP&_+3BOIm^vWrO^Nr$DEN2xl>WP(O?Iw4e^2X!NIi& zyv60(eQXt_kEv+yS>zAK_8$D{&Qq}5CO6D?Q@P-U@r42|D@?ahb;UQ2?C)w5jtl?H zKQ4-WDDv=)m`$7_s*K8K=dIRO7Z`K)t6rD;c8lLP|NYsumJ>`~r0F%!XFbxrZKewn z)qULyBx$gu^r!QvM?_RR7Y)Ycuv2L&Tl9ODTzzl*iuzFY+!lgW9%F7HET;r;^G=`? zL8RiYv|N9f&6LLlaO(__S%0&)nkpTxG1VN5x2FsL8vj?x&^*Cu=(#!GF+mt#sq1k) zeN7<}%v#i-G`UU>CR*F$jQ?50oEnF+@~{=8S0MS568 ziVjnhaaRk;8odr1AsB9#ptY%vz}D5y!1{fiw&c@n`M35Z9rU8At9`6+XtG}_IO`ps zw5c3p;Ix$<=5nVTQ&?}ZL~Kn@XeKdgD?`1fzgmLIXiV4H&f_|h#1M6`02r%@dK^Ja zEU@(Nl`dmUQvValq1Ng^;-;!f zfKS>iuX0FQ zunNm;-qJS?rx>QjoBgU(J-so@$FcR}TLd~ zRcv9w0k6^AyH-TDHF|q!_{TaGY8jHU?bh0GS6k1L5g|wh_M@s(_W{fm(4dU6cXEQ; zl$_wDcz1_bljsHdKQC%;_#2}+Ar9o~q{EH`_bnq?mNYRWLMdG703x_@If zgYVwZ6RL~(-EX4vd2cEZ&pt$NhbyJ;IMKseR7a7x#uyK|Bf;yuHZAMmy^c$u!I``( zI4eMXI#s$(ftn;mf}a%wGfNmc&1|)AQ=bVjKdZyH&z?D~gR|Agd`>q_zC5b-@s>xm z;p&gu+i~Wr{Y4RfDZUa8_HbZ*|Kveu>-G-rs3G!Sr=(XFY#Y(B2g=+GNbKO163SC_ zAhs}%cOyJ+n)MRE*dz&0{w9i;A^wo{3wtJ z1LeZ$;|4n^J>1KN4YIk7FvMn!olf&-vN$x8jftG8Wl~Zwk_hnT z);xs3zLb=r*5qS`Qp+o;@MFQ>RWB_6!$Gyi1nuWRUAGz(N z1__yJ)OK%LD9^^vV#B69tTUwO)dlmYO=d9={G`FlQVLAOW;?x0#(dc0R3$bbW3=C4 z3Vt9#pL;L5^+H&fub8ScB(Y@$8W9lVhG1{of_x+4EebV8GwJ6kDTFm8tY_%%a4v%M z7iyC2%-NbBZ=aEn^E#`c-(YuX&d2WF<;AQx&M+y=>(ER%TecDiGieK&qN|&4r+fVU zd^IrT6l2hDaBl{UrHs$BLCqiou>RhKL;Am|B*rsPcGuoKi+F&YjeU7N4w@EUx9fpdZSzg52LuE)f(gB37ZLo)Vn{FO{O zkbrZ~T+KMrsYS78oI_sKfBhhLd2S%#QkPYrrkW)?&2_tcY7>8(q{2M061zJbsfwH} zMa%hl)TxZgVF-j_L&@&uWu^3l&0;jLqt!=Gn3C&{96}ET;WRml`=_lB8Bd&)-c8$w z=FUX+w<>7^3pbdE7gk@+x>zWzS|s@Yto%#DOD~2WH{%G~W%8Y1N^+0H>9@UiOB* zBYj+ezjh>3O#RQjGZo7wRst!@@7U;{d9=LC+~&hdQ2kEi z%d?8R_Rv=(jcMu%=*wkW*qQ;zD_d`JAflS+rXW7JGT2%4(pJE9DLR8CfVZj}|LKm@ znYQ!XG7O&Dr_~W`m9DN}@k{#NVSKH!K^Q65y&MB9G`{0zIRIGPXI~Zk@_T%1jmAUe z#PmTt%!{q&u^UpyuSV0yW+Zl5D1YIx4@dj+8?+SA4RJ)lB{35Qij$mGpeP7EdaWfg zTNm$R@9KkrA$gva#JJvJr>0)gP5V0aN{UeXX!Q1$xrV}3bpTT2>4>AjmYC&JJ;Hs> zR|Ch62mdO0sif2sj3iTV2>J@c8?^Gms7#8ttcz1*5}|IU7ze$blUGnt4CV%W(@Kj5 zF%eA3df6;O;K2hjX?Q+x=6enOSZj$rhO9 zEXE&fZ1Gxw%?AoE_K#0{e}1T$>RTW?W1Vf@P#XiL>G6{EC)CX$iV|S3cQn$PigLVq z9wG-W1bxm~Ij@!=fFQ!|JktqoA)MUlU+&nX7rpwI;Y=TX^~AJ$leC2-i|B?Ov5{QR z=PC1WM5!wu{vPw#EVgPORN;_yUf^k0?)-(gf(&_MnOnBKJyabD=-3>3_|IfxMami9 zd|^OK2(_hHqf}CZ*SIye3SX~*l z-OzD(_4ILbIYvB~e%IsK2h>QI;54MrIj`vXoObwb0#^&zAZu_Ho7TL8-d?x9c%fpA z7?HFLNEAR2DG5N+IeFz5Hd9tne$NUYgVLGEm4{^{`ku~CUCvkUlk&A=r#>mE=YdtV zH&3-F$MCq$fJ+hqpmD0sU{pPx?KF>X89kNcVGV_5jv;^A%F*eg?;*M{@-#38yLW;T zz9MYpw)p>#Ka8MHD_y|_My*Z;wug{h%`Xj6_l8#Fp$oplF+ziS=Fv(p z?MQg9!!K#F7djpV@|i*aQ$j)vxVD$K8CSpSOWjrmXj`$4Bg}Bij_La1^4~8w#7k03 z-^D{yFk;u5W;C&rqvtHraX_v2TLJ}jO4Uoo?9n2ldx?mgpcwP1zS=yn1&GHz0F(g7 zk=5z*@V=7(3DM$&uIZg6t8wft!3o>SjwdQiHRVG}?ragaoXIzxnYhfI0LCCQaGck} zb`LpIG?tCCL0Log>he9?_*eC0;oq;mhrAPsxL@HZAnh$srLD#=q&Y*->>tXW0(NeRwOkVr+s%r5ZdQA;VVVp;go)}3_D;-w$Nf0TP+%bjB2hf+N@HSO*(Pvs`oQ6lZS)v)ACCGS3JQ|eC$eucdY4S1& z8B)T%1p(IpnJ z*68sM#r|j9(q}8T-)73?W^U99@asW6wZeTDVZSkV8?@5EUhQW@gXBFya1|y}Q4%x5 zKXnSjUR_oudSzT`e0YL-`#KYE8f%&8>@N1e1G&kCVy7@XM_PDlR3;qrOP&*(r!}jL z15FJDs$@;Qj*Fa5?#US{5N3qALYzf-_4u!<5{I-JQ8^XLaR?q_RwjD$^ICCtIlI>- z7Jib=#dtOo>Z#uAK@|4K4DNYHuVF_BROYDbs*@i~2x`ao0{B=2!H#G)-CrwyId;?0 zVM7i1V}g;4vBw}7Om*YzJ**5KMCzIA9XPowCsK%VCMDSGCl~M4g(vKriVjaFy{el2 z>ABApQ0(J6_#4`IPoC*oj8?lEGrSEYnuB5N+I}5%_lL>@QVj-aSW=~!{r}7oHCX+A zsHj;+$=*OaDhtbW;vP)vn8GttEc24znYT6zL@qLo-{pB#M&BtKX))QCWJqg$L&%?| zFLX?5WS4BBfQm1*2;C6o7-|a^G&RTMtx#VUvTv$xLEreel8$Ek>&%;gH|M_ZlI8@+ zq&jnZKrln?u^1KdV5caX<@R@4L=*%H=xK0j;dKBHaZR%pd%~TJ#fIRnJ3{$hZK-fg zXSnSh35)>cH$lBQG2-&R!DsRH2K9`Qm;bmptJPJUhOlRG=mq}fm zIs^L|wJdfuIo2w915z?4b#iioyq>;sT{Wewa^|n<`Q>|rj2Oni8B$q1uiUwIYNU84 zUfxS__H0m{rba}(lK0<-0jOT^sc=~yrXkeWPi(u58y52qKSIq-4ZhzX*!p`t+=!$= z8Z)AbyOWLa5@`9_E`j$JnDJbDH!^t#j%ChuaJND8+O8oTymUVB5oWi#uFf6N(mNcu z9EZw=4v&RpA}u0=K7EPQUE3)~AoT7a8`oYyC~F)ttp(@OrkPeZ?)>&sXua!~eEaZ= z?=<78_9852n0ViL+~f6smTm6B>rX!6NK3EEEHOUjRQfl&&)%&MCvEGuq?wH~?E z?KzhRdVqcEJ5CO*W1NSNyhk_Afjd7>vBVCQ^Bzp#{Xf;lx_{cQ`~DovKj)szz@h@_mjP?~u>MP5{?Zsu1)hspxbe8zAI+H!ZlV`U$(!{fzqAwtLM5 z^9-347-niART)9p$_9^ffIOWfk|^dbzU^_3>e=a}9HT)7vYjUnbL zM0XzZ%ANHX>i>w0X+k}BYiNB|mmxu))>_$sWJsoyZ?!ZNI6EtuCyY99vA|`A)kM?2 zpYRfQ)O*1QgOrf&`ju$*h0iugL05ps(33Dh`vqOz z^ItVpUR!sUW~xQ`0pTTZY*}Gcy5x^^YuTy`t7?S5_`4duiQPfgC$}SspgTst2S6kW zm@prVR3^5ON2ENSYONI`rlVU&{c?*ueR-!@@y5(83wx_>xe!EW|82?taiT7brB<#O zHf`1l?QWwwgqCtlz5=8L)|YEqF5O3#Hz#TfR7-=0XW1HAdB4MD=#hX)*X(ThPY68$ z1jp&|)eq>CVB6IIj_62(@@SfiC{4`)5Fn#%T|RXo@qth^K>!L=xMpZqh1bn|WQJWb zMV9VBftR**!qE)WU%nNh$)Fz0Ouog@8SVAQ^+c!FPH_jDs%AG$o=J5Sq6!B&>nyig zmU&e~IdvMcaSKv+3y349)MBFJ>nkU#otdfzuHqAZTJ1yj_C#4i(Pvu**zL!aD5+f{ z&>sL;D32MAf`RKkX>WyD`Bv)kIc^)8hP7#Ks!93h=l{))0Kvdw0=X)pw#T@%?3>Z7 z;7#dA_hGN=;l$kariB=rsDA?jc^WzCA<3VHOKI8iECo`_srzAe{n|V{!BSKWA6=L{ zfVA*2FWze_XM^JtTZTE_9~{UBP@tz26D7Z!VgRJz)^hOfjyAwNI2GoiK-5h8`k=ul zX7N#dcK`lW{uz7bEm^I=r4_wak&vN$g?)o>#mI=%r%PLYmf%x`68H-abe3ki&+Ewe zPx&3X@Y4++PAiD$Rt=JQ{FnEt%?zUG99tL8_=XkI!QaEmmL$M$rK5RvX&`4A_JiO- zNq&zXrtHv(oyXyAEda#>2r)TH`GsLH+fxJ6U8HTTIE8njs@>Hw^}`Fp7~A={Q<3!% z%Lk6Dlybz1t>Q{1uWVtaL}OfgFwgzp_Vo@&mr+eHpy6c?BbFh{B{(SaytY2p;oLy`{@ zm0suv*S*c2mt3-e6SjyS)BjP$7`%5-04p*30e6i!6t+&&aW0ZJ9^#FW97qF1_-r8_ z#X(M#q0TdzsnjBfpUHol>V7IpLMP7WATs2$GnK@hsl1F2^5dPB6m>g~{R) zG5)laFa_2Q=E!b*^|7(t9*WYtW`mb#_T)p2zR~K+N~a-S5NfSgLMZ-d#Mw-A8(99^hK^GG+CL|= z5972t?ms`*goz~PLs4PlCh)SzbZpW8%USba7di$7Q@nAmhyF-wz?JpZ0)(9y4DqAz zK9Oxo*D7F%^Q9#k9`vw5w`OH&ssTp6s>;Mm@2$~FDtQB% z7A(WUQu#&$YvIeuD8G(b^@cn5-Tuxc3$OYO@0m3NpnwhTnH3gM2jRH9iX~<|q&K0X zz?Ouol<==^SOmpEhU_O6W@9hOO5(2rQIuZvcrV7HG|Qf@oCO>k(RTOmo1d4>1rBA^ zb3v|9@>@yv;H|mJL;s#-0#5PtM$7g^DZr}hxFUn~JkA7bMDIevsmS~3G-IL}15OaUi%umA z^4}jV%SVBBgm|d)Sn#F0qSjRMe+5cv31HoJ~x@Z(gnQ46p)eW z*)wnmt`8|^@ejr1pyow|OtqlIEin8B(Vs~{<%(Z1!@)83;ZwKxR8nb;TGyFe9kWQq zFFy5}B9ill*6nB+!9X_W+wva;zk@=dzP<-bEMVOyllPlN8&DyN<)F2Ph~!85+&xqy z^#u>xE3xt^_q2$5D2)sefxZf`15ONR4${FNnH6CU?h=TGBKPv0*g8Mr_HqZ#j|-cr zM)bamnrZF`_2GDUR@Z92RMg!D%6m5qXq_4t(l|l(Ouk^%PUUywa*jhTM+E@fiHrL< zFurg-*l``1i ziuEIqLg-FTjD8d0?@-M`B#_uq#4odOS71F#80+B2}IKryUnK(l?M`Bf=(g=Skjrev}aM=MF2R6Ki+&NTffg51D(BE)(d@?@1SYf|;C3Q&YNm4|YA9brIq zl0&n4lSW;bHn>`kEZD)5rFQ-GfBYWXk_C&%EpL`t(0+3nF(oA5k3-26W8O3YK=K`v?A7A^4B+d=QGbeMAKyO^qlG+q(~1c2RFrj=FUBSEtE4VNr$8!gDCAXO;icRlWIBnhgI8m0 zLtj51MvK3Skgdx9E_j`ZT_C+ie)~KVS0yK&LyG_g6js##vC1hsd%7`3|tvxJye!%v41L`Re5=(6o*$~!Y9 zXqenI2c~mWz4!O3gZoAp;7J;*JV_X@gN7n6Q*@{rdOU?(Fe1FPLj!bS_Ifn2`L9Bk z9+a9n3K_HS#XT4*49(OcGYA1Qb8y#Q8Hb0Uh=_To%D5pg4m;{$KL_-9CcomSJI;YF z%m#SIMDGU@!j+v;<`fq7yND~$j}Qd=#r7R=I7evOxjCR(_FXSS=fxUG#aStNOz>pf0JO_Y~ zitbDPMs;&@wu8yRHl`sLGL~b$hO-7}t%z&*;XNXU0R|hv0}K~2x1fUzQlc%yYv;hK zDO&CgrT?i#xVc3r@slptO?%$pOifW5ccri%zdw|+Mq6wiQ3Too# zV(#sq>sz?PgAx|PKcaa+F5}}F`DoF3@zUQ{m^zxn6`aefVm4(s;Fk7ur52T%gLeRS zs(VyC$BA4)dkJL7zApK@8OnEvp$Obh0_M?V43bZcz7;jNuAfl5;BieEj!Qnd#f7*k zFdV4$uz8^r9S?Po5Tl$JnFa<25SoVO1`6L7F_|=`+#tnJ2u>+Ka{)R#^f1TH9Q(n$3;Msy#%io>vOQ|HCBt&< zj=fdr^3PK=VUob`XcsoMDcoGH)V`(!NQX5<&{mw1MM zVw-a8mM`o<8J6V~x4|GuQ56xujSSER54^!OFGnogna4F-!4Kj(g1}yIGS9DiGz{Bw z`$jEx;`Uw{Rp^?5h#@LO;Z7_hu|jJCyfWTTLP>Dv{VLAYj5nppYeWa-iY${u3{;qQ zBdL0M!i1rGX4#W{*ZO62PY>&9Jsgl-`SZeVEuJ0O{;m$XrgFlFQ)Qb}de0`0UX|pT;aNm#qd8gUOO@5{A zVa$bjbt|r=cTZQA8$!)_FpHll`&Sw}`>NLvwMXLe0iwz&8YI;pCgpHT&}Yjfrf0Q9 z;L?JO{`3bcjW#Z(@72PEGm7Q>8Ws0G&L81r5TqDs6DLX%Vxo?c(*ar&FL<+|{B8bR z7R&m1VDz}{rGtd^;(ET@lL$zJK3RS5(FBuuSu$+l2}@+~aUM)$8yW|;GZ*9-Re9{f zjsSa^H1FH7yBiN@d4#+_Rjd~?fombP$nky4DwZxim_hP8&)qAmXx|Y#W*%^ zj&2(AW^4~CnBI{=7mlJAi$4cp^B( zkS{Uw;KmnS)9y!lq#mloIq{^I&s{Az>OY|o($6sS$FzvOVT=1{06G&hGq`WR6G#aJ z2>^9~;rs%!E-f3;`~~0-Lq`!Ker96*!mrpkJ+z4dxnlXrTUa*JE!nd&0+8sson(Zq z1T^mt5SyPYChXCVvQe6c{}mj+5l!;51TM?ZGP9H1|K36|GL7-^xJh*JtoGkqcly}7 zDkoNFe7VBTBSqx`{6uE@+1YTI6S5exMAH#gnrWQyW~>XR(hK-Pwp%iOO{Yt8TuSjx z5tOpNe8knAq~wUwDZNnZH<{g$7AEkvdYDN9m+wpQ3I!RY?lG6&-lG8!m>%qzzs1+I zb*9mag=pBaJpPb>>QCG?FI$fE%c71e^HqB;uq3!pnFs?M&+S{*-YJ^>Y!_TW(8F4n zJ17h+-iAeBQ|K6wtfIDrc+-`;L?L+!p!?$#r)HBx1Qzy&pA7g4EQK3M=(NsGORcxI0`Q)W)MD9FteX1P62C2@A;zN{uQ|1^is%4_L}!XAhKvw z!&wNw2LGE=BuN~5VmI9W33-MWu=j3NJY77~Gq$P-C6gJ|OUoOaJ+csU5sKN=JG~{B zP?H1GkfPMUknnawcAD{#?NwBPo=8fnaVLR~=ribQ!R_8-kydp7z{(LKEi+cRB~MWb zkPGXlq~`USpf^Vf1zC@7rCmczvXxr)uln2jG*~*~xBT1Tc5!G>tm+q%rVS<0e$mIz(ak zmcX$jh6kHM5F$^hbT#4{L%{W*?o@;U5RMC}JHrFeQFx?R`$S;Ar(7mafX%1f$Hb3Lk&=43;EH5lfMm6I0x!6 zO$G&`JMO34XqmZ46S{Fsp$qL1eN@4+r`RqC-s<$+qLz2caxt+VmVbc%2va#);B`fechg9`GHUJEjBlrIik-pvz@PMF4Z; zr7rfFLbuU#QG!8%6$?2-1GJ%{!X z>_reWkT$7Lk23+y&vJWGY@1C-WNJw%216hX70K|6F2t>_xnm2LM_+KZUMz&UgrL`2 zKpC-1MUlwut1ij7HgxW?JIt}-3$BilvIAk79DWYD>NUIlJ}$UUX$3Z1b7E6#+Jvdy zM}6*htH1^?UT~GEj;b1?Z=sXns~HZm-D(gz?1VvAc)FQ4bcRApPIiUt!idvl6HvaC z+yrvN<4kCRlv5)o5+}iljbL_W;)<4CrM_3R*-XuVVQ6L9UIxP?;*ml(@=iSLALL0U zvt@Udm%ep)2xu*vzE&St9x<3>E=XY<|KOd2>6I>^LDDs#HDqppS{TmWAeb%g4E-z( zaw%eo#_35RM(ZxWz`f)73kq}59mE%8VZsGhC*PHHr?^kAo3>S9GfYG%cBw8O3}jiB z%@ptuvf%0+f+1J~`dfn0uLz_(rk?6LBAT;>@QVgRGfYWHfWekSuGGvv=mllMtZ4n< zLpmM_2HK{$O9D+6x&s-sB&d*EuqnSuwgx1c$pweY+6rnD72n0`j@Jzn9kl>iMW*5CZjLK4dWDH-n4EBaty-_(r=O}cB26+?qy$RTtR znYxMHHOs{%^d?i(sfiD_!qP+H)wAlBc8W$Z-t#u^+H25F?5|T};Rnj_O%+PVZG+ z@HXb>Y#J`1XMu0Axn=P;4#wms1Et7vc3?fE{7T$jPVtO#d$ED~+Ao9tX>~XC$Lu zd?k=Co!SXdO|d}Rn{+kBN3aOtFC?7*uB;BobMq`h+9_?qETwKh`tkGV+%|W$R)ucf z(zxlD-nJQtwUo7FjQ?So;m|}Dgehfv`C-(Xq=y6E_yEPMYC<(R=-=w}U2+C4O~XB| z>1wx-2&Sm^e8q5iH1=Rcu}Hzc`=X-xqWRjHIfYrxd}&M?Unsz=ud3ZyH7JMgzJ~4- zKzl#%V9v5hsj*w|>&eY1 znO3s@1vXBadLX6b!H9Zk(THEDuU1&PIVgK)Qa@53` zNp7I#Y^|e-gC4`clU#mcF8DN$RN>&(b4ax zyiA3DIu0aqSkdbSTfitynEtn3e0ki?(1enH?PSB=Mue}&kf9_$xX@u?y+UB+l zg1s2}08Hs1aQc7$0mhObnPEi(x^w}+lSVNP^!q#D4OsL~IH+&HsS4&x9Y5!>VR9@v z=L9MZuhE>E7&%;K&*KZ|b zg;Icu^bv8;+l%%XGzVOZ%*{-^5lk6vWyd$e=i>Rw8xGc&{lgg}PyV(=i(}2{4{OA9 z;)Z^IfSBaa`xxSZcRkm+t0B**U-o$AG!oDo5QQuPe=Dorl(qQfB&jG-*7L=ucy#M# zpbOP|yjbik@TIu(^IcqzL$;6p%u;&3;6t5AQ%QVlJt`l%D4Ga#xGN1VX|cP!Mkd$Q z1yyVtT7@QE6#uG&aw)Cd>hf=Lbwz}sMDnh_l$#gYVat2Cu7oHy!~OEm8G)U6(A>^P zp?ytWxP=Zx*eRgHrx3Iy=4wGcbse)(P+zmI-!VZeGfeS>)vqPZ8eU)M;cwZP8fuuH z(!&gIzq-YZDC+W9a7}}!P4-nL4=mijh8VSXk0xW;sKmfp1PpvyHcfIk7re&@E@3#U zX3Iqx4sMJ@|NP%@eNVz9<~-_aQ00mW!HdRcnghaPO6_#MEQ;mh5i_t?I&l$OvGv4J z1#C1`DmYY?(W8f+8OWYu-c@%Hc;Ux|;!qE7_u-uPSNN8Gn3QD_#bk*1{m(Xa#OAvZ zyaC|Fy#dTZk1y5SSa~%msZ3bylIbS?aObV1RSWOD*=2>_e(IX*qGhCJwyaGYSukKh8#KeOy%r!D9-^)@HnD)jo>+i{Zc; zL$Ln(ov4Y+QN!K#SN&7|9{0&z5DxFLe1lV7=IpIsUox*s`1@1u8y8&2_;bI<;U7eH z(ZROD?hDFxP0R2gJ8YEfj%l)PF2f;hHq%AS&84dI1-QniRj=vQGh^hI-{9mMhE93j z;CN8zl{^u<;dy?|;-(i(K$&oGez))A$j@g!r{gZ2MBjIxVqKt-`L5%J(BHYiG4e#> zS($%e3MCRO!imG^lv^acru;(R9>6-%^X$Gqc zHTc?}k-F7N%kFKn8*vlI@LR@}%Nx1jGxZ1965DQ! zl*^o{`9D_80d11haTlnsBEyu64FD%G5K48q39lN9|kxO>wx_%H7nE9uh9{rwE*EQxTT zpM~pG%%RwZdq;@adrD`3=juZ>{PT~Wp~Rne1@unx#9TlE5D~kbLke&6bR(Snu1lMW zSK24jBe7ZOI`M?%8`bsO8UX$oRMVx+oH1kcvfVPcQmgcSL42_%q}3FE7R0PZSh{H1 z;qMz!wjg-bq~D@O#CW#NK!AVY>1NZewwrG%;`43_fG*WN+f>_$Tx92bVXQt~TDJS} z8!sk~^QslAB+OXI@k%TIFlM!y-bz#~S6=qK_PA+lxtQgM!N1d=h1ZQGr_Xp*T>nw{ zNZmo~hS1re-mkG?T{3l^ZirMmI`VB8nF($=EX6gJzxeyJ^%ouX8}5(Y!P;wMZV(U< zPVHEU5vH;gc(H&PuJfY-WJCwOzX~_EX zKJOn81U(Yp{FPV1v|hR#gdyoddc@ZfhSUDx7+WI{L1pZcG?DX*f%dKu8eR}a*Jggf zpK$Ze=R929)4nhdpC9laj@>}T;xeq=TL<0L8g7$oaLu)D@CdgN_o`l{=b}#3+b;2r zkf*T?4%zQl({YV^f4`=#dzz?6OQ<<(94AZ&j{p0U{ELoOJQo#=Iw!br4*pzJ&b4?f zYp+oQ(#B00$)*(9koi*+c{B6zpQn!F7mC$Dw?ZEL(1*92Be}PYD(D+5?&rSh?F#!AX; zmR+nsI<6Uf_p8aHuRGNnLH6k+ELpxJ8J7^Q%V?W;W~hDI)F}JGdQi8ob_0)mtyz^Y!e*X zH}j=vbC!Lh{Il1w`q8}isnqFPTS5L-snj}uEr=)otb)h%LRag3sARrZ;_A}ucykwi z(ZM?C(DxT1$gC}?D7MjqBJ|r4qeXC>lpwA5sv)f?qMy`SSVV^v1^I=>FT-~+8D|E}qdFR|s;nGSNVk&k9 z{>DXRT5-f9(E^U!CZB*F4QdEvKDkvY7CJt1QCB>~@iz_oToROD$89gv*h=FaP0`&S zwgfxZ-OdyC-_G#FwZYP%>aa(=kqMwklze!l&Eu*IY9PG*}-4`Tl6gE|q zgMFUB-D2vKtDEwQN`|r-SQWw84g&-;rRtsu9uqOBFcEat zU{phu521z2*Fh>@{wI}JbAP-*{R3ZV9?0b*uxDKgPq%pgVE1rj9GpI*u)_7nNdH4G zSjEB(XMQSiHE9)Tx)DL2$cBt~;V-OpA4=!F{?n-c?QG;Tem!gN;IJ;+AXniY z@321G@!fAI$gR?I#UkoQ7q|AB=&kR+UQ5wpV?g|FgY%0Kl#X5i9sKr%6%SuMnoqHQ z@;v|Tt+gBV8hAov^7%Ka2-M`U3%#bs)}8s|=lA&A*}hzK_NlrrxVZ&U;|l5JOBK>CAEcLQ~LzGbxjBg2C*k(tUPg`{^!Zm+5G!Plz*1@L21GEU9=!9 z+^cSt3BtLG2wfe_w!x(4npq7Jal101wy@plxX>2eQLsLYJNepFu&!gWCAjll=}o(nu_IUL-M*oOX$LYIFeMBWj66!vrOFGQ^b#1e5d?_t}2*){pps(aA-i`Gy4 z!94gOaGsal_R1EcUnzmRo0HYL7sO#oa^dpf1sbQLsyFj0SOXio;%L}_krNcrMS+;=1V!0eUQ0cp)OYL(WQ$k8dj-W;mFJ9_7WMQ@^V1x2suSIP@#W#F1*2Oqy zZ<+I@@;;=l?9ipUf@?+vGEaWGFvvTM_Mb}x>C_+)vxW7n)Eds+Hf$9RzV~(0-?ERQ zNSOR&c3V_3gpgc3b)NZpd{o___Uqv{5)DqTi@Y9Q{?p>9c3vQisCU?RW3huIR?Ac> zM%xkfH;67I>KedZEk~c9Jh0ItJj8?_23K1Q;WQHoHO{sd#=ir;qhvp&$rNsuRi|@| zF_1uY3v0FOqiKvmTzJ^CZ-m!()xxT7IEIX*rISi7&UP3Z#hDmN>EI)5b-8`qn9qMM z>jy=B!we?c{{2Bm0jtHz6$>bI>>skR&i%w68yf%=v8jjwz4sci(fQgxeCZUa=UMSW zPcKjofx)*nP^u^3PA(+HnR0<^|1OT51IE3bibb3m>IyTad21i##PI|$&7(vW08$EY zC|IXu&zS;?dbMx8M#v~OVLjT853Do%t{?K9ZWNzQHn-PAZ{>GTGdZfQe_DDdz>ceT z>Yi$8Vq72{u*I>G(;Kh_E}v6O({$7!dPPwReA>D)Z^z=+55$LL`hJrKn>;Iq@osOY zy%;Y^deFA&CR&pZK zs$In#?yu_lksZOHajb~O1tHQQ(cm9zQ0}z`uf0or5sPpMPuj$$kyP&~9C?7MYjKw6 zk+ELg=Ubpt6$gEZu16ueN>GHb7k_#b;*U5T*M`|78C1M!{>)a`JQFSov-3&eafsv? z$jLv{ZlkXQpvFZr$5)Q+Z6wYgE7%RSxlwZCa?w_2>B8lz#s^3K!Z^D^HFM3i7>VE? zyyfz*&>;@JDS)Z$*L8u9fL(7>+tI}JgqpLZ9%BdkHXtMQZ)O6{u4KUaZ_5)4VJBQ7 z18uKTRKp3xS&E$Z(@yJ^xm99)8%hUdh>i0~LF6FVZ(X1~Nqif9Oh_cP12xr~(w=Bf zxodY-k%1G%D-d>8LZ-0F4a@CQe}tin$e?bFO=eIX6p^~;dvzSP>bf016k~r5r0ieH zG$il!n?Ma&NAYly=_d)|U<)s?VYq;wDqT)UJIz-fIMCR;m#xwyP3H`vi&w*SvbQDt zAX$3oE7yF^{INo6<3vd`gp6{>!9nZ=4Si%j+e6C!PNa67#=57}ECeYdKD3=)2L zrvd%RH3))1uIG(lIUU+RMOn-{>%w=)OLkQII^cwa>hh+&a6KeG>)@fUmp%;BDBZU= zxj_yU8J8p0Rn~RTGZx*Dzwbm1^#y4EGZzEMP4v!x7n>+KuxKjwOjC(>gtX}WU%55LYW>j<{f_to z?8inZQK)ON-;ArAdH<}q^cteY9`eV*rUpX-S=?dXUvgt z0sj@Y!r)wSNND}GRU!Z2oHNhYG&o;b_kip3q;u2yLAZg;R}+>30}BS7Tfrsp5_=DP zy~f>}@-%d$PgsApJNwH_hQmN1=%O!}=w0ect{0jnk0FVK>pru()8UYW*pKD?tXKy# zSDsgCqvv)rM-75dc~$u9q_qZ<IVOwq^f&+FdL#x_@b20A8;qj2?PyF0OsmMoX zs!cCEwrk?b1HC;+OExWi6&L7SQ6qS^++%Fr1dG^dQ?UGNNM+;qI4IsWDpOKSUyIe{ zwk6E+g$Ao(ZT0p2TO9#n17f-^J<$#_Wudnzy6MB&<|8shrLCrzg^->s2i&PK8!ZU3 z0-=I&Zk)_et=;kPj8*WAj@K{)b~A8M#lIA56*IQ8*#)-+SODs+(`h?+W0g$%ClbeV z9U*RdXuWl_e#A_>GaG=t*j{pQ?)hmQd#y8BJLd-tKJRcCkG5+f|B!Y&Ep3sjd5HLYh_-YxFYBL7Cx|9 z?YDIyM`vc27cg~~ZRE%#$vZe##qRQpH_-;K1qY9Un*OxFvhSXa6ZWOpLC~GRell{v zDnF?jswsfbu8wQfu4{ry>v*Y2ukZ774-@q{Nl?+uMBdpHTRgb3%rR<;BSIKl^_>t7 zCy|6zV&~E`QmgJ<(-mlj$P~_=P;I8Xm5)~jNBDppQqGKN|e(p@?1f<;zW}= zjO{bIi|pNU!rKj_hqJcSCxx^X=+YLPw^edZi(^sm&5c*h0&c)n496G2|7_5HeC=Ak zQfUB3tF$48cu6uR*|3#0))iT{q%hQK|3bRx(K$sjM6HDnh}*x32IangeCZSVdkVu! zYuM znO(VN>yZ?b8FotLCLXif+qt1FPB1>h5JI~zBKEmy`-jc0*^65;T%pl6bWQzpf-m3- zY9`nbFN`hNPLkqhp_D?>#>k{75A3)&e$KeKmTr2iv}epGe$ecA|`HIyKO%9BtY&y`v2Q7TcM1NFZtSz_t9;;vc# zEy4!JP{P`8!a1#O8lj2l8R2pxPsc)zzEa0J}( z5j~1+t?*dkUj)Lx1<48wE2hV^Az%CFw&+ti2>?`#;k7O1x+d-$=*4*gE}ymelANQB zZ=~)66GP?y^u*gusX9K{9}XfNKtzhK`EkSpyKq4ge)F2S;R^31GtUTk%l^q`NFJ-> zmNzZ?`ow!r6?pgz6F&;CX4qkfNL>W9eNvuLr~_nt+JpPK=|GBdIDaaHTw7h9Px(#B zwz&rJBq|na3DsMEiP}bzdR>7|x|=UmDG@5$kL2J?{%JQ zr!K&VaDzGNgI8MEyB!QPyL(3)DzPcB`Y~df{}D&M&DyM@nVw-^)CiCZ^?w^3+J(?)!@>RNTJM zIBu~*7%vzLHMWyOfgjR{7FQMn-Abr}K%uTE=6!v`oM+gWY|hOVBw{&^+s{}2{*sY= znCOUce#a3Ve1_|8`_EiefHSpA>}g+Q&!~(gx5r$Bev8OM2=pTgfd;o;Sx~x7qYA?L zbRqW9nvaz!8)C9{meE8r`hZD-)wXOkb^0Sk3W!la_IF;|UlGYhQg|eTpEpiRfOgv$ zLd@&&m4SDGllg!QF!%+;+bB4RWphfH=2{}o_xNinwQmnJy-4c zJs(9^X=0VHm-NQ@G^k4$=F6>tXjNapRWq`?u+(N>-(CR33Xh`TA<^_^4U*K8a+5T> zi_H&)Oan9-Oc+&VDn(SEkiPlfmm<2a=(KxznX>uHMVB>*>YXkW6Rxi=`fs9yBR+3Kj83kU@iqiN zTHHfYlh}QzT}LZ9(O&`aR(!Z}u5VCh)&;x^h+%0#CvaM3nA>G8DAht<9lx^5((%Do zmmR)IWhw)~`)-a+Odn$1B^s>4&fRmjtz?SZ40AKNiW3C<9l|PDi?~0(;B1z|m+pz- z3NS`c(yNs-Y-bb_I*En&iMdxW6w&v4U3#=BZG)g$t4Z3fS^LJoVMd;a^fDGtE#k!* zlc&hq$N`6N2@V&pa>vrKBMbaQflfnP)QXYIApjqlSl^XfbLP$c}(`{<&L!{9uOjx^9j8 z^6G(KkyTLL@N>aQn=+HwkC-sRFsY0NIouBO3GMaX4Rw{kKOnGhlv&r3g)%~WqGCi7 zxRjMfG9DjQ#09Gh2O^9ku=N?HVVUduYw9csp8c_{>1;WxGyGP%VKXR>4kX_7{Tezs zp9f?`{yv-~iq2OXe<`C})B2jAG8-$i_EidK?rKqxm>^d1&iLVB{Y^$R*Ub|preUH| z9|2~FDw@LjnoikZc^;7&H|cx6)zOL<1B>ZJELqdV+byV^S243tiP1Wi4LZWxein06 zCB&RuDAApvqIKP>yz3mDAm=ue>FmNrws+JKya*{eSI&G9-LXYx&U@|GYZ2caB-`Iq znes*5WBa@?A5#+82wKAx#xS8H08!{#zG82YG8|IpYFeZqo)OxNI&uzpos-WzRRO#? z1zzTW!*-VNBLH8L0>xN}VbM)po9TpDoG2*uOyG`+8yN9K=wJcd$uI(o<%45BTpdHA zkot(|v*Lq{Xeb%cV#l?6UY87$Fz&c%N)!WA&;+3B*2ej4G`69x%vq9H1wj>v$#7;7 z;4R+uPDq-Q4Qq`6Mj~qY*z+<+gt})VOwc-nmnSgJ7e6=Z@wqzn2$fMJAiP~o|MquL z$4eOqxS$e01A__?r(Y_16&$}0OD-N4xo>~_dn~MouRGtxcGIpluLaHK=?utH0N=L( z(y+-x*SN2-mjDM4hc2R9-)wuygx8>R{;)#LaG8IK!$4__eiUzZ~rYM zIHB=Bk`Tt9ANO=zD-{GEtfCz$Z{}Q}rOR3Q0#w&#+3ms!Hvq3&s+3b&H z<`FCF+J-z~Dcy$#RS7>nsE42*uAF_y1lxZQO$in5f6Va4)ArjYV3R8pE2D85HTsWs zsjghX!{Lq2N%d_e0m<3bxQalw3L#?2%Gv~DM#ik`(OHmFnPM6YAmV}4ug(b!hy<@( zgQSWu9^$3bDU}S=qnt}*2_Z`c|9B$m`gb#E)7fz+e7N^p_HQx_1A2?Nh1FV6EqDtL zV|6-CtjdCB2k6&e?4E`yj1~@>6D$^S@$`c)xtW0X`Yd2RA=bnd8Be^8@<6iO!X4^! zG`-v)S1Uk|k+PyRIom2lfVN8%B4EO4hp$$TkKcoYCCKo0jL^Y{s zCfBv?s5_o7DkILM=6l!8_Vjt$_En}dcq1I;5ylMAd0-_mPv&%N`%8~Gt@l>Cvq2>D z!p3Edpu+jGRIBwBhm^B5keXs)-s71lwaAF_!A_ZeNL~^@kXCtjX3tg-@v1D(8N);SugwZn{_bt z0HmY{0jv`xMdt>aq9G~lD?w5srGag)NjkdKRV~`)MdN*yUzH9bO z93rF!r1TKRm;H|Y$SGm&Txavr&BKzF@9Uq-QHxdaRj&y@_m1uq<}~$gDUi5m9p)tZ zJ*N#PCcToum43e+qz9Om9JKuv&@>V&a6@L40HGhbONl>sRb`|#HXOqw=`*sb- zfc<8ZH#Y)r0LOu-!qBR^?Jso>pO-DM9>^@VDVR35&KXgh-@{MY=eoVuzSKPIh8B01 zPgHNsy@?7o_d5hAIAOorl~2(eCgkE_0oZ2&B$iz78CVpZ2dnfOdd1ef>^)VH9;#mf zVVz%w_R1W4P*jldAtQ!u=cN^V>3btn_7tHhNqopODLVZf;+YhX(P91gVNyoLPt<#;2|cCW&Sx~Qm|_gH zd^B zBXyF#lhq+oLh^|h*l7%ZpP#5Ww$`)}w7I{8iOGXgFRk_vk|^OZ|j>TeUrXr01tBh6^Sc(M?=9-oG$46b!b zC*)Gw4^PXLPe5*%t~@RY(tG!zB6=jfwcx((4cf+r_wtFJOq|iV#uQ(cx3Gt9WcLGu zaGo`thllfh!7l+dwalePL$>OA;_QMu{uHPFH#0WY`yA$BJ(&Opm>_TC8RIV@LN7ho zc_3MnN>RE$|AHn!EJ0D)!3RD)q3rxIv^!fxx80O@h1IOcB<)39XQe#K|fw~E$ki64rU)pv!T^KxkeO}pzE*hKr?i!FG zyo%FFK3>3=dT+=D5Q=>WmRe&$!TcO>S|1#a6zyx}lh#@vvl%#hAm+5wY1;H7Z}4lk z2m@Af_g!iIOtLNjl8IZMD4->pn$uqvoNTd<$7+(KcyY*!NjBRU#;A~JGVq8*f1qgY z{g>aRlFP#N3n9tAGbh;7uSi2*kktK+*G9L&Fnk!R?v&vtx#|Sp0#>fu3+=dT8NX_{-#x6UC>~Uj;L}sL^h{pJDB zXGi5ps-?Cmq^5>cmig+yfdx7AC%JrWy!e$0-`5?RGRJo5SCvLy+f`9Eq!a`#fxE<& z-3c{YIh{_lc!jshsh~iT=PKk#C5P-r-X!IiR zStr^@_-t|G7?NMpu0@g(m#4wnR)-mrIk7o{QP#n8K{qb#d{bui(!%~6;(L2s@x?KI zEnKQO=f{&>Jn#4dx^QI=@}1vNY#%wc?aRVu`-*)Lal}Sl7RuQs+>!P&CCs$zKjDK${j zKuPUlEPolk-B!b6g|j*yE8f)kuHN!l{83C+(cfVsH-n3%)Tgtjlr7n~B8*EfzaD;t z$f_CSuns|cYbcCCo_7{$w0i=;t&Mm6P*QWxdXkw77OwM;lXWr;>Y1*(@mHq&bnvj> z=RrRC9cQIKNYXYI$Ocin;2^tWM)>gL;8xJLr<}010YU!UP|w{nm*mt-B?A#XXRdV? z*1~oy0prv$J*A?tWP{fPwPS+S-)>hpc;ni&Sa01zc=eC-fXT7@kPdZxepVZ8_0);O z77{(S60cRG1zqmr1ugv4a62xeRMDn@vD^94pkg!tQ3LMRNJTo)f&AX6^}449C?CW8 zVl+S~YW+$>UD4q$hXxPlTL zlAYyukbHJn)LVAayf=xDL_=gbRaLoWxVRyD}JSFF_R zvu~zK4fQ)llMag zs6J=JeYI!P9a!F2;!k~<_#~t_DRAB}KJ6`gtx>Q;cy1#G{dpl5%5*tc@#-o=8zBI( z{owQqPwK@JQY0nhy{W?eNgRPDZ`2O5`p+7-J zA(b3F=MG(vfL8}e4?z_H?g;+QgH&!p4NsBB7_|MKxpo)kGvYZ8n(BC>A-l5{_%1|b zkusWf9fzV6T&2u+2m1Z|90-(5%);}L+U8IWK`%eai;v)4fM*){eKct0(^8WaRjm_E zcZim!pUHfw_tEn(dCIj-m9} zHmD^*G*oKUqgyLK#ar$Knc?HO3z_hGW_NRGBv_v!cvRjA79)EN?wBuu1AX@^e(qJw z411SUSGCV*HY{zJ1jI&Ede67h=dq4R-f`bFWP~;Qy$dJ*ox|yTI2xAy;2uzv$LS8Z z1O5X(6(EJM2q^4VkUMPrZ~`O@WX@M%_8guhFksgh=bx@Y|gVOy?y|qm06~ z?)gOfv?@$A{|jmJtBkOBnLDRz*0l?0e{|{UoFemA_)qW#;}{+-;?YJ%lzAvJ{&?s| z6|KG*E&QdXP>$#5I@MlbSMB>@M!^eJwIkR%*|h(Rr*CUrzlF$+gs5 zOAE32L;AO@Ds{i?7?9&E6;IFg8>b$a>iy(>R(eQIUeLEFdRV!kk1Vf}=Dm;__O5}} z_#Ih&B0+>Ona?-lUV8L^>}Qc~Vh8OY)4!Pb{X~_FWX57OSO;=INiyl~v(Ba3as?OV zAlL19W`R__I}Vwou88!NR-blupH}`h=VDbi&rJxp06haI_w6C+? zKhYwA4*ekAiHRvqcP7UM{5x9|=dX)fhbHsF{XbdZD=3%ma*y-->Hmk0m zr;s%M+3 z>bPs=>HYG@{jVxgbG=1^=h9_Pud=GQWYIN|GNx1ndS%~@Daa)U*89%jW!J=2WoBO` zd6Db5-3%H_r9!pw8_9r#Zz%#qWBylJqTB{$u?w`Jpvu`xo9^XP;jV&Z^ng$Op3jOqo=zFZhD7mb zxo6SmJr`UA(yEG0o;07OQ$6T|LIz}x5`j8VF(hPJIg;v4bm3`FY%|4;?EE|!f;~PJ zy$UxFg`vvM6elxV?t$6ejOFjb%awHvD?Wugu#$BtwqbM0Bj)y{mwzF-A!e>MGYJ?bo$JtfE>EVbj}8umX~G{27@zha(r0j?#_X)U_ML6V;QlMNJGFl%h~RE`DjJlg~dx{<37 zAv3b4>?eAaZ7{HQ5=zvKXIvxZjaQ{R)I{ld&A7_54I4o-lEQIDXz20?wx5dqYK<|_ z@a-ttf$>UaUorQvZpcNr>o4jPgExekN~w3B+mddAzfyYp@7g-x_AyH(6XRbNM6%lGNtUF^}x8-9S$8@OSt!BbF}EP60I zN2rEn6~_b=ji8ARIA)mp8zHw}Hi`)c=e`9Zd{@qX^n7q9(N}D?u5T@1bMDX}Da8r; zM&vWAcy#Mcr|0MqN=0)Q&dksMfRN?i`e94s5g%`uoDlTYhu47u%HdEM~Ul@R3AvA+3)I`h`gmbt1%uhQThh zY?U@%@x-H3wH)jFyQgHz)ge$Hy&07Fb5lfXA|D-SWwi?)LCqaRDrI^>EC-H++-|}( z8J@r61!f4nXOzd(m1?Fc6X34Kg~%>e6J;zegMkZV0{n*+r}fK6lfAQ#ky94rh*k3z zkTv^UqC+z(Tt1>LamPQ~ez#nW{^84qOZ{tG3nL&{W0KpH&-fh(-o}>;@vIDZ=M6%%6_rt++p=zmQ9`wAi-6CzyaU zZM#D9S#=dzi2AY5?Tg0>bjiYB&YNp^xi~r7fbQDe49|+1rwEiQ;fI?uASA@WV!~4c zrEkxsAQxwAg`_nubAa8e_zBduQU2c(KX&+Eqq*Y4a}I9n_&k-Imz-c<_;9G}({6a4 z+tQmn24@bv)TrPq(De0TofUrcCc}JZ2`(OA{xNG!eYV>4o)wCen|evG_=bI%{jPe2 zItA3MAc=j2m?qQEDhjhnNtM0T5K6dahn5-EgeBK!8>sy}gs6@HamaLY*VqRhy zdbVF6v+i3yRDxEt#1T9;I-3m0i5eb+^c^i>`lug8K#7SVMDQ5${hA=YvEPHB+1~E8#cJH9tjQG`pfYYNj~v=xKt~;YEXCk`d6^ z&p6)&<+H0G?zq{_JJlZ##nvCdjlKB%QSSh>svp@z?y_4iXC2mK?6`KuUw_+HlpAJU zWRyFkHToH=YcB&6xq*qr*S-H?Oq*$Yh2}&7>OSI|b6L&72V?6wL>a9%NCEv;%6vq! zwg41HSB}{3ZS@Lo+pW3si{3v#AIu%H0N{cNztHO8>3;cTaB5K@YB3H7A*k$$56+eFIa z#-$5W4#pl;ux6MY7jqj0pYCRU>R;uq7H!?vM$Y$>AK8nseF_Chmpu{dT zTaErYV(iTTV_XmUBL3d-MvPUWBISFy16g_Ws$Zz_Tif6sD5;>-(?z>O_ep)o8Al4) zDA`DucMR;Q0NdCxi__=^%OIY*?GLizFkE;gG`?@tX}};l$~aV>7&#t!@_5^(nosjeeQz@p$&}DWObTJoo}l0_|2dRzQH=aj2oMMX`&hNV2m^I*L*3DyX+F3q-Ufk8aQ?n-*`AqXa+yXmj#G=eP{A+bkv=8^b2Jt)EPr;3sqO| zM)9>=RV_J5dDyIeVbUvPgmzZyc}|5@!;g~)Cv+D{j_8v9A;*`kGH&m<$;}$q4Nq1!&3}Ast2&AjRrmkiot&5%ZGX7JfvhbNHhv+;!T6T3Ej#MbkYuRA8(JIZo-PUE zjyhvF-}&dTXvUcRc6Lk9ct#k>pnb6`3*t0rX?6|Ly4dx)ox!8&roA#wSs1T#b{Y|@ zbYKbeLcc`0qvP5$#^EC!SzC5uCq#(TW@JBmXi2Bp)o_dn-4%5Y@41eZSnb2-jj!!9 zuH530<2=x}vE~XmRWl}pDM046h3ty2ism_AU)Ze|FK7)Nrl%gZ*Llu0mPp5JZyb2k zWRw9Zx|x0)!NPL4%rt<3Q2yCf9s7YRkt5Pk8{f?R5Ge;p_kwPVDh^cZO;{S}CLQ(& z$HwPSEs$oLJBXsDGVRkSQ(3EZPDDSpXqdv*4DI)+@435evnJ;>wxxB{g6tpVCb1X3 z%?q^bpKDgd`>jiQ1XH@qV<|Q-9d)lZn{W#Mj(w#99a{H>9VDYmgo?Ub`KSQ>kkldA zT*d@H|8E2beqy>qNtLDfE~qr%HyT?1Z3JrvQN^~P0^3}+;Mwg5jk3Y zeP{RBzH(lo(@=QJL3C4&L%4$F3E%D(6AxB39K7zgpTLJSp4#cYxO+J#+!2|Tm>A5; zbLVcAvOcRp>L9=wTO&lvVz9~${A(p!wS8pHDW2IPm@yXPHYljY~1 z$hN`LCUVTeAoI`@IocDe-BYeXl5rTR5Ny4t2kyfWlv#<_oqOI9`WvMy#z<=pa{tN z6CuLzLUp{I!nNp?#JLzv=uSGF9iS|sIub^M((%~n|epbC#+ZF-xtrU&yp>Xu-wBt?|y$w zW_93S%91sDr6n>NR^w;KBKBO|bf^B(rrq};d5jv7{=#eGdtP$jydjkOWCI{~sqpxw zPV=*b_o2TFbP87PMvc9_+Kp6%qGB>E=3eIqy`gNvs@H+AX;`Cf&kxCp~Oq;lLez-tBDrc>y#Q`(-$+kl}zw!9aYt9aM#+IMI~T#kn_{x1EX z$g@uqcCi^8*C}^4MLJh9Cpy7*##@3sFAWTr|AZ-G-@Y^WcG{%s z=ib7`DI<#GZ0@GH^bv8dw*vz6_pT!R)*GZyTWKQQtOmEnTumZr z(fh(SGnjqV8|KzDFLZ;LFG@AtCqI5@7@7VL)!}V#dZ;U-a3nwK%_Fli-RY;*<=vB0 zs@jytPm_Qoo2x64O(CMXgvymB*Lr>RQehYSFxjR>=6TVgztHMw`SXp+2yeGH%{`TF zw|(a6ARqnmiR&xr+v(`S>38FkN2@N~q3GLq5%OvF#s`217u~!SAw4iO;paw`o1%LO zp2E`S+F3}F7^~HW6`f34@-uLRchmV^!VyO~qw5UT4)G)QBqqFq(NHV)+>zGe$>mdXI7x(^-89Zc z@TUi`yh)#}&=U8O@-TgbBM*H_d42ENaI$sFG$9YmiV8Tl;cNByWP0%knZN$tPk9e7 z8~tsl0Ii&7`F?d;(rvf}uZj`r8}we6a2P-Q6SA3Gp(MldQ9jbmf%V>}Em&ls?TL;> z%75r|0m*m;4147>V7_2-^K0ggd0mc&ioLj!jZjrznEL(Le~UecEX;e zzo9C9H!v6tyEv-C8xfng&hVFeP9ni6<1*Z%r@%lS)VYR%qjKJyV@R_S;~HJdFb@ES zo;0_@(@6=;?;(GiuoGufoJ5vf;IHQs`LGFRRXQ$18w#@d3F9iv{kTYz5YZUs^wA4h zo@QLKFBT~(tg{S?&*t3*G-jA$VFt4a{O9X*=uGpHL^c#;F%f;A!AQ=H%Q3UN$!Or-SK)I~mm+ z6e@*p8l#qY7TqLKuKi2$F&xWx+J-T-<~NQ|iW&JLL^+47g61^ADnx@U63#Bt47-Zi zEHUG@A7y8BLEsE5#WF9cy-XxSrL4A2U{&c!_$9qsT<|rn1O)EjQW^NA%r`VnEL%#y z-=cabkVWdT9#Ow(j!NMoRWZ)te54=y*)77yW~rWI%c>P~bZJf}bmI$VWHDa95fA%YM$X?;fwv>nEL!XM30!{mZ118BYs3G| z=g`ol>HJ4;DCFO!<7*ev69{_qQ8_JP&yv=mC^bv0Jb?SLN}y}@m)Q#~A%a^P#?Anl z&d%iMc24p#Q9G8!z?qClh_B!*QnF!QvRfC$U+Y)#FLf3w`%Rq}k~D%uf9w|+JyMSU zrOqknWdXWe26b-yu?&(v#!Cj+U*s87|8p~IrmCIhFTJ_CV~Lg7IV#>`u0aqbEfIwZ zDO=L#5v$-io&V@_Mb{#q#Y{O7807f{gBKJQ?X&VfY9mzt+k}uXf(IsKgZo{ZuL>+v zWjDWUBOQfHJns8DxF^>Q-Wfk?AYUNbwk#i^XGkAl9r&X^4q^PS%~l( zNqdZ*_b4M_gGyS`FVPEyFFm@I;x<3`8@l=|{UIWPznM>3xXsp#;9sz4uKXJC-1Q}B=|Shko}f19d=?` zREv%#{Wt%{3n}rX>6VQMlv^XZ%KN)Rc(sJDHkF#7Gjy(B0PCg219% zhqFtX-of?0-qd43qzgHhgK>2{V1(cxNFxWtSNvvNsD7M^rPD2L57|TZJ z-<%fPx)`K%T+MyIN9^g~?^F%`#%a@?$#MOwR~qx%fA)c#U;(_dcei`TJ z)dR(1SAL0;IatTqxmUmRdXa*%rKoZ7cL=7pEMo8SC#c7Zwzd3;58oogmOnx5`p;dM zMfLslon!yGD`+X)UH+2Uf9~R2Ofr_gf~x(`UFUcg1JLC!#r)^4C#M%Vy8Io5{r|pe z@5BF0bx97t?)t-^WnRD!K7SbWJ3Ibp(C^$p{V}osVaFc~`X6@u0qOr?$N$M*tdW1s zAZ%GTjX8Z1S!?|L`s4C{=LYKki*t$kRWZVKU;6&M^7l^T(Q)jQE2y zOg{WU;6=muEuZbIa(g1@Z_B7lkYc91Y-tF&gXedSFzvDV=bi0N|Mku@$bYLlN`9>W`Ao&3|IvH) z{*P?*KLelL_TNI1{C^L8<@6Pn|D4Kr&wmg6;eYmU;C}`V{hvLY{O^Gi4*&NaejDeP z>3{7$Q1rudCHzfAEPkbjxtceVOuir=ODmnk5>dCo6e{3e0FOmXx# zLuT6I*6;R#X^Q{vy%qd^qcQU?0DY9-DaN!V2>(WMq798ErTq;7#;S4 zJ(95QQuM(i+rXNaFnM{)6XP3Y(6BD2M#gJ2Z3IDI zEq(31HKdxXNw~DfOp~%4PVUFeEhBQjW~c^kyrdRdo3)ocX{knp=0)F!_v`0dp1XXM zu|T`ibsm(@9*fB|+wef0@J1U4=$40A)fw7GX*1YtYFz0=y@aCNz8~r?X%o%SQG5S= z(64G^AGUev5-BZ9T8%#5PBTM-%E7K_6J_$ao&P>r(XgSq*nUoza9xp=l`F4Z$_fkA z!Cd0jv0#Dj|MyA1o+tzJDYDo ze`}5Y_`~^t(M2iTI=Q!Ied!@>{F1?Xs+upYEdZA(w^e15z{)XJvYrd}mWC@a_d?DG zCkFbKn~W8Dco00dtftU?BNWZzb@*2dr%8z<*Pa|&G~v+-R+hTuGLxMnW7Su*>O35^ z;qBBo4Da35RUXC01@EmAlf*_)0-MHb$MXziVpfUOBE9y+HJdzduYX*(Ol+rHH#9V4 zje}IUjuXmk49R7D%N803dD|__Z?berNBB8?GrjU>SS^mn_? z4=1;G=2?pn^Sf8WUCayjXo?$O?7W&=b98Ef#dz;RJ4^n1=g0av9i7X4idto9sXlUk zBU!0b?=xB%`c@k!DTTUrt&h#QF3lutdrHfdhVnDx36=)y&8>qU^`uuOV4kHMK>eo((<@4 zC10v0L8*dTTgQ%G6uYI9qh=~%G4Z*H<>=0eep zK~HKCtYDI=IkI)$vPPahu>o29l2NLMw>+6C&$yVTUH1^xpl3UqlG@OV#vlg;*c$T# zO2qbWjr`Cv^mway@nLlMGPb95Vdc?8^;G6k$YA8oEw=2dWoOuO*Bxia*ThO0>grNw zE)_ghmOIg3DU`EiZo5nS=+bI7F}1iu^>6ZkQF_^8>%lk|uY7oSgvZe>Pi9_ctTIej zOX4^}4V{kjoHFWmUz<2CV-3ePg(Ply)J|bz&~7!fRapBXC66TGJ?anUZe{FJJc}v90J#P{`|9JCiqtqELxh1%~ERAn0t*{=MaCH^GfiveP1r^DPxR1xYN? z{hpj%Kf~U-<+(ndjUD|>&mq%0QZ-$xUK1Ujn!4r`Fy_Ul&Rd>!+rKfURU&LGNxrm! zzVS;*Nvyd100T|^t*G2~i;l{EyR=#w5U5zZWX}+nYn-pAk}^Fj@%mfFEPcjE4xxlp z8&*`eNbKNQ5b?4NLz8jzyevAg<mZV2OCi%rSblM-Mne1CJ&OWNyjhD~b#!an_x|dXNvb&C^}4>W;0VM_x$V zmORpR-!T6PV17i7rc{lp*QbR615Km@96R%WJ_%tuDtfs(med*6S&PVCp2x;{4eYWr=YH7&6eRQtdT|bTw}+= zwB7Ep?f(v$4r6#}q(B2Tk3X5*&)9ksUXdQm$1)E7`(XBMhU*hjm^=E+aJ`tm2iVce zR{Dk9&6lnKWA8uY>0no6Bvo_Ko4$83!?iVlVZP7Cwxm<~&W-6K0otLx45ey5(*_zT zwm7%_np=-IY!D2)doW#O-cR3m&pkSPULI3r&J6wxi)2K|+=hp8r#G;!(JeX=_~_e9 z>Xt`!^*7deM2ipu>kx>&A6BmKIa6}X_EQ}3!8gw>PYPwET6f`(fp?6Dw45Cyh#*SL zC#u$`qSwbTax33_W2>}#J=b$fNRI6Rr$HFopk7V#N}$Hehx*k~hCXGn1%s7nJ+pr| z?x*LG#qgP~Ge|j$U9}{{Y;|X#ZNtN~LD-68XCOTpwE3!M!;Ow37Lq@^pu8f9r_c_| z3VhXbO&41Ov|7B)%NrG>p@#J$dn;x~C*R~FDe-Zi2mhA;RmQaa_R^vE)-9dM%j!AE z%e983>#Jp}a=tV{3LuK zN5xr$1|R9S=WBa>B|zAm84yY6?#%H|uWzic zU{+`3@>&W=p9#S|>*JICF$?ebQ;Unjv0sU4D%0c9BIp>?+cz+0j_(@I5_IIXC=ST= ziXggaR~zqgLe7}+nayeNHNWM+lVc}e#|^4bE#4?1Si3RIDTP=zrc6kUu7dG~HfnrX zUkP7d#pEN?X>F1=OJ!8K63f&%6v$UWG=9lsS(?0B{46rWTrtVNLIzaW7-HqiFy9!& z1&7gimVG0oRf8(5oRV7gNo>WItq;u|F>@EOz#1|2#@5U^haY5Ygx96Jpzk5F4 z?jl+=wel`CngU?AnB08cm2hdgxqi~;AskynD5K{ECd673*NMlMdOS}cgW#!g}e$* z=3qKPJ;rMdPs?0o9tu}H)?gs9@qORgbm~f^VRNt&i;24vOG^xAko~ybu1#b6RVOma zmRM`(xa?W(M4h!;dA|7(eNx6#`@tBU)RkTHbUX-%CJ4tr z10)Pv{K3LY5Gg+_?~+TLPR=GJ;CuOVy;h@pd-~&QBoOOq-{T-=_ z)6u}>p9d=uvK8Ye%Uom%&m4cc%PGQ##_bRRxX8}Bl+@__z6IX=!Agxv+UBN= z%~cpa=#UKBK4D4on5dT6Z-a?kQ}HKq+-sTKyrdMd()cO^(Mn-I9Wo zR;!^Ln-h!v_Q!8S+83loXW&mV_fz;MBcCJw2HAiHBqTA59xy!p47W<{G}38lxQbG5 z&UzRd_yCT@6&tCKM0+OfDE)>6#5PI3!XTZ0>8EpS+9<2gNS6sOLQd{iU2r?NF?3Gm z^o&OT(K0G2m3F^!qD?IFmb$uAQgN^{NmrCtP!KP_0tWp1HY~7jFx93TW5+@Nd!-MV zxkiZLD@Gku(a@4GK&XLV+v)qE6T=>4M+L!Wba{t{Z2Twit1ij`elT+KORD`TTa;UT z_8BN}@NKD`Wd%l3701WJnV}4+XxV5CLY%6Ln^lr6DXelulyN=s0fd?oi>`AmNvt5w z^!*bx^|>YIc9Io{T&0mxd84d{V+5QEb5(OO8;io(1Dbb|vpTCa&Ns#B8H_=+@F%sk zbY92`$KKzS&M&F8_>LuCiN$UI6dPv)E!8GSDIlR>+3SS1QQZu4xJ}}wd8?(t1htan zD1bUE(s?fl#?3O##vyHG4}1aSVp6K=F*HXj6+W4^MJj<3kKtR*=; zQ&zbe4^nFZEhEHzza=(=wW3x^gs1NuG?W!mkPT%y#hesNA2Sf6jRo@1rOh5DvP4k&q9ihsA}nDkklyVCOE%ZY}!E1El;_0!AZYcW(+U*O@hJdZ=?3Z48Uj)J{u z(gDwDkB14!_2VyGC+Hqu-NXHiA-HQxeHrVP>w->#(Vhe;vGmCm+TIr4 z1%AoxRSG=5k+tnp8&BBRN7CoO(w3u`jfS7jMgVirTNlKV7ih+kX6flgK9FUyZ<*cs zGzo;zv_9Bcw!^ZUx7I(V9dk3@-?;MzD-}>RNsgrh52c}nJxuN_w1<(Zg~e!?bdtPK zwA`HuBP9#BSDPMCCVp^&^n7P`8cr2dkUbka$WdD?6x{$I0|atm`Q0v%Hosgjy0OW9 zfLbd#6gUN$&C#oMXyf#51`h|R5=$oS?@w@oXg6w*A>lHQYWykqlg7Kj_7l=wWG*9S z&B)xbDP*IQOsUPUV56yW1?3cp0*EY>W|RS6S0f*=&4vzTJkh&8siV^Ri7oe z$b3N3lxE8&G3)2C!6+Hwu*G4{dFnsAT7p;-VO4lZDdf74pym(6vg0dhn;QSXEpS*& zWo*Sy77!Q-ECTp^eADL!GMBrcai!}Wcbn~PClj3f1U;gN7qP&OG01sDI3Is7a;*fg z4OI77`J~!~!Sr+;XU8e2UI~>-6BJE_b>+;Ed^2t(MY=mt0tA3kPBeCG9*Jr|xo48k zOy1Yg2Low4i>Y+1ys4RRv%6#G%QUG?#ZEf^ar4i-?t#h~Dok>9A?cC#OgR`zRlFPJ z%UYn(C}t?O&KcuG9yZowjW1wN{9p)t5DOLMC4okas@s-KzT^Q3_=wEc4`qLua0nX; z3J_r2F`&Qzx@C2G35inQS5uq{yt<$ayy_oP!sh-b^_Qlxf1_*Z8HZuj02uY*v{q{H z$9nG3`|n#)Umq9iNL3ifG`x2!2Uh0K?R+mN3^fylyIxN7PB#97FE7`$cn7bnQ1<+w zO0r&69tcEtz=iVE-B(YW=@C;$DFXOAFa~%^-WFeC;&ZXKcdl^HNQ>7D3;+o&{ z@^?(_i?q8RXm@w2drB6qXL5J1mmI}A!{E<;v3QhpK^a z>JN5&TDu63UrP%I2PV9O<1gQzK`bS;r1~#OV;)AzBl|{ROEs3x5?H$%1~N)HT_C`Z zWw34Tr6Pub5?26~c%@QH8he_U9W7=!ni)+hAuULm(R(~?S(cKqN4PI?b^e|qU^vg=4qvkL2Shb>4UfefbH zedQ`+gVXACK_@_0!NN5zG{{a1s88~m*L&XzUZ9f8E{<0bDLT$(U7+_weln7Rq-6-+ zfS&HCegBV7vjg!wmRcf8TnZVeG?*`Xf^2!U!d0Hk!=~0XV=RbeiR5mzKN2h^5NA6_ zPT*zw%|@N!HxwxO?9C?wmmOQyJ~=%Tl#=a&MjfWPfVCUWUc_D{AF>5$QB&kjw&Yx% z^Q_tDsds&<_Dyfy`6R3v6(-K|pv_UY(5#!F~SAaXM?0 zhK}k#eRkLrtr%$-=o>*SnQ+Tab7L}$?3hiKs5HiRO;#xOehcmGqxISN&e5(U zN5e|M#^-VkTe$$wF?8rweLs;~1(Orxd6(#?Hs$mbsadag6r^uA!DuqH(E$sH(3}D2 zjbW1Ha^`Mz?fK}+T{fOxN>BKhl5HOBFC;$HQwAG|?_8|`T zZOIAId^7-y;h^#uN&Vt_*+&_uuWOc~kw5-wGsxOL)0-t7sq5z-o%cx1((OuyV z$fXLw9+aQU#=n%V!owTWD}mG`>-_PLGNTKL?cWUrid=zGK%bo3ZK;Zb^onj=+&R-H zgAE7G0U&nF$swHn3{EJRNLSxd5Ut7<{qvguV)Om&ZXq-czYP*r4@?o;0Djth`Bf*- zyPt})lCK6-vuJaTxe7E|ktYB*5uV4@tstj?ToduUoc)Ip^!u;XPHRsAt^r;YKpE{( zWq3)qlHT;PGd%s`YA7p?#)`+5HU6niyCKPGJZv|#2q8f;cpDVJFy^#ZFp-RD@oA&O zC$RqD_X}`sap6IB$2TeLVgLawvJdcuUw(!dhB9`joIzJ20gRTIR%=IhmHXV4Eb?{l$aZ?FT=-@cK0> z0Mle_G0mFihO`v%7Mxuq$=ks(hMsE!7&t~#>YH^p955#gXt^}VCw9SAhmd{F_5NxqJea+luO5DjV@1;#buX8h&CG#^*e4!X+Ob$-sR&mSoGwS zA|kF3*{nk-`))(c3-v9xaHY(zi~%&rH}Y7La#d$iC6%We1_0z59FYJ6c*~VhtSG*# zwBt$lyIT>QpZhMICXs7aYys@j0DgqBUR!tCl|@_4B|4+q#@pgFTU1dpjYRl)B~d_q z0;5xQhJ6Ry4g{J6O(nB#C9+$6qT2ym*ESkJfMSUr-ft$OCVc)r%&?pYx^2a0n)3QI z^DaQ9k6))p`C6wB0gg>vrObPK)P30WaK#Ho%Wg~tnE0A_mCW5;Z`+Ct2|9m}?%*n* z)Rd$)7sQvYoOE z00fGiUf9%*!dRQ)B_F=FVRxu8W!A%60$Zj0l%RoXHj6w#;3;&tb^gnpT3V8vnCOuF zzG6?5zY5YfH>b@T4yyP=KI&g7r|U*Ql7@DA-dM1hgG;h+2ASW$29%t=`?r~vGDexM zjwb!3Qr86JULp-Qx$yBNT!a*99XTu|o>nXgxK0)R>X}5rbRN^&R)!*nOvKRg8c-)d zJ5_2&xC(R~E^6$1*0Y%$KiN~Oow`>eQ) z`R!5<(2bl&543%-f*GrU;5;*Nduic38awDs9o=@SCNiW+XU6U%y`KX{l=oiLbB3>% z@-D%!Z`;84Loi;`sdauzq_!LVza2yQIpQ?#(EKt7;JCmf}W z_9F$fAKz+#>%&+p=kA`3^L>MO^XSd^=_NhzO9UrlW6Aj;n)ijQSI8o9ITg9O0ttIL zEZ2*XQdQ7(5^x{llh*@;(=9{~(z@R=Zyr=AGf0O}sZHt(K(dIq_#XFG(#PtyJjZ;v zVKtueflk|iuBEBaJM<&8L@g(xnxX^$Zn~XZhQI0;sT+CQ0_?fg!7#e_#vie5qe|V0 zLOr+-(vjRRa$m@mY+4zT#b`u~-#Ysi`VR4_hycVr*9@71VL^1-wd}*CfcjcZII}EV zn#t|_X6UR$CjXMX#03srVb7!;_42Oge=6`D!Rb`fV5Ga`IF2@gQ4oIpBgvMc;ab6@ zZP{No5Ju~M#@6jB!o;>T zh9>E!;1Xq;>$JywklGU18`gN|v# zyg;@f4_AxmvMSS-Zqp?UO8WN@s%txzSU&K<>CkYRV7xE*#gHPd&9djmk<6$**HXdZ ztdg+u#6~fwuSiwBYV>}}RRsNfgbM@-UEY;Cw0@_h;f91B)r2hMn12M!v)fxBL4Dph zVzSdKikK)=^Of|_L-L?^n$sb3TSOg6WCC_9l$BXw>*E=iy+37T#~Paw$vA&AD8;e? zL6HF+M35R<<{ZyJl(?9Hq;C^PO;BpFUL$W0kTajn>a)XcL8m$01wlk5h4sm!KtLFw)M zXTdf>iyeV#fU%*x^jjK0KC7u*jLopY52uC{XAb!2Ebrt52eAf-NpQl5U9#pXyg1?B z!nV68Gg##{Qkbyf`G!ru_<3;gj{eQ*{5Uq4%c)}u9cE@;3=_JSVMw^V|n3OP&F=I<_!_DS`(R7T`G@FYCojc%P zlr!-dtcSL3=UJimHcEE!nP%!G@+LO#OSpW`=Uq%w-s`;=l*I_sET^Dr;%I z5iDhN<#So9&qS?U-*R1Bs_MW5(2&@a0wMx3rx!rqGEB5t)4Rb7j?f<5n{RPSqG@o8 z&k9RxtUgw-12j?ahJ^P$iKXtc#kn(YMY1Q$CqLM|#6ycQ%v}vJ?pj>Qa&G=hPB_+I zlo^vQPQZMjhz>wV!dNd@cp_w#W)(ov){aa$9Uh{j>5K3{+;V}v@R+fV5kB=%*2kht zUdtgrxY{(lSovwvrcAaLv2mxuV+?=MQ2VF)luVaUtjRa=+*9b6T{C?M6adP7o!GXz z5dg;H;je!3-rYN8L*|AQv~c8u-goBD#4*{oD@g90m!zpBRr_=g5z4w~UoI@)!<7kb z27r(RBi@#+*qev6J8fITydfSaVm|=GG^c;u0atIP>n$F}{OE@{@!HN5`bkx)&15L6 z79iO*8pGSeuF(77AZ3!23J>^0#|-a~N!*5>AcE#)}<1J%R5_oC55jevhUoFqtqpNZYkmtSm2Jwua`dFT|& zq64G?;zimjGOTIltoMRQHVu$C`MG)^XB+&hXy(49W78GTj9qWGL!egaB^`fk*cgZ% zg@=!1Gpy$c{L_e+7pWVO0|Xk7x2nvYg&`_!yTTM)r=*m8_jjd8xUCKgJ)YJdL#Tx< ziTNTxNcMm|ZN4h37`@jI!Mi7C2Jw<3!C9@Hn9#=a{PfEgp=Y3Ui3GGPk{&ipS?bp9PrR2#U+BX9TTL5;x{$F%q#8~C)Q;$gK*Y&5rF)> z2CiQ5gtCf?0NKMKYP<@s$5{`~CFC><7xiLkTD1{4e%$R)Mp5(HLa>rWB1Q zCC^I`!k~r$s|l)>#pa>`tJMD9qy+_~P#eV}rus#79F*ik~_{_zS}m;B?7t7R)WOG51k0Vl-l} zcZyTouFrAAM1T-xfZn~ci-Q4~j0H&cq{62)h&bXzK=L?W$3NtTEAB=>xWsbsdS0yJ z?rub&GQJ$^O9lNvheul(Nr+YJ!>DW`~J<2o5zurK{ups47pGbOPX9aEkXVcg8O9JlaL{NZ=H>lg*K0C^) z(T*e1(q6OHclB#Qf2zu12(U_^OPgOAEV zisXLa*aJ$wuv|ikQD*~jzBn2S|N5@X#`V4f^BSJe#;MtGX7rPi4`y8Z78^PP@qZ{W zWw< zb?N4)Wffg=o|f8eKGAfE6)G8J_FBL*iuifu&occU?^jJjz9Y2@E0G}{Q)+TO_1tEt z=xQ+)2Zt8weQFf+?y^n*VQk?*Q5x#$Y%U9;g41V!Y} z?82pD9yVdHmow-cKC<;hN&-%MS=R1v88wD{8gXN3HD?mJcm}<9FgUqrA;fw^v7s+i zW#ek3qy0y(9@4x0@P&QR>?}`Mz;!pB7Y*m#9$315KXDSAyN{5L<{(8HLo))RR z_K8+*8>~qZEv>!^rf#JJ@U44;lRnA8=pPdQs&&bXQ%k?dQNBK(JC}DW_eof$$v|kl zDp!501r_FaZ#<`_n(JT70yocSQf@@ErBdBbGuFk1C1eZoA0q|oHg?(HDi1hxf9vMI zi9xu+d(_u6YdpcVf>74VHW^_pS>KP*Pu4z|K5J_~`|BEX1SVJUa@ygDZvj2ogo^khYlR$kG8PL#1CiM{F-Pr8VW%`+sQ1}MH z`LSaxvJ~SM09Xqh$domkX_&2wQgx}pnnC09eb-o9RMDVS>rDJ{I3vvo`(_IDtEOc0_gor z-}ACuhc`S{p-gtXJu%k2oIb3r=HXG;065(i(bA8+Arhn(-~Ouj^nUjH zwTUu|b$u!M;JHV$1E<`RUao;-dGp&N2F@vWC1>&%QnJ5U(>?%^Hc7r4ufdIicoD4m z;`wQXvi#Vq>ibKxT6p$}3dJS@!5vao#v=D>g{hbuzhFoO5m9u-bIE_|{E>AeP=Md6 zFM!L?;7Wi{@dkuxfHMoeB^MN%Xk^fuS%;}Yx`k9T5cI&rUf}x3wz5x|G48rjEI*FN z6J3TVu#Q;m2!o?8PbU=|U;Bi3u1tFt)4aHOOme)wt?Y9-SLsR|Qzp?p zvEku5``U0;y=@qz=i8S{>djHQ4VJ)h^utB4U~ui`4#MX(QBiO0+H}*oID_J&)CX7j z$I9tGyK+Gt?SxY&pm89Sim5poh{d6%tJ_5ec~f4k&nl;KIzGx(&oI0DK?Z z#{(7b;Cik{|GI@2!9RDxgnX@oUYP+KzdW9t=qrI`K|G6O-x-eWIhUN!JLlf)aNBMD z<5+TnNSEaSw*nJX25^q*{ZE;nOJ!f>+4O&yUTX%Ou}Fy3>sa}?!eJDk=s)j{iAExZSu^>4n6 zB^e!x-F*=I3IairD+SaznkD%FoPMxF*G)n}EdqfHs=2WQnmi&`KfoS}BqeM9kN^N7 z6}Ciq5Q&j69(c&d5;+d|notkLKunh+rM7QMj)U+PQuXD6l22=9P9T0;=7T5}9p=1( zjJtP!$HBGqztGpZJ;*}oVZK>Fx&EO;za97VJ#-{Fkr#9O#(Iujdi3SOO2>s{o`FBr z_D#Yy#m**fr%hkP@+0z#{Z-7hpoFNVVx2sdwomxpz`Y}8G2yIs3gCj*=3IV58{&d0 z4}XUM&*K&fJ$xl})g5%f(G8-o*m17%L zTo8+VAuGg9N}aqr|2LrcIN@*7ufUc>z-s+I9_3pC^k3XuW@c6Ebc%T}_y=dgRL9`s zKiGfN>4x~*gpsqE2T=(p7`U66BzTlw*#swjwMACtUP(v`@c0#sCBN&fGd<;j-QJ~T zSmcLne;4w_<~~QcqOLYLg;b$mpD1htarBf@-zAE~DEX*M@1i2j_G^p-sol&A!?fHk zaI!}?VjvJ(GGIW|t*Gv#*sdDkXtu8;+NHaoJ@iY&J!x<-SR$+hZ2z>ou6V<70=UZZ z0wh&^Yok$6Rd zkzyn}N~E|-VfjJg&u_|7Z`_Yz_?cn1DPCueGRoC!*antP0d&%;xr@fVDtvO+uw6j&A}-w@zWbxf{`e6OqlXRN#rb9~)L48$tc z+^k76>$$G$<@UYqJ~c*0dSeF1OO%T`@BPj3YR6-1@qrVXh88wl@Bex59&riE(YAAs zihx4YPH6Z;b26slr;`p(=&6?eFs05JRPC-n_T4Hy86uV9{KDG{+c_`-!^)27q1SIm z^^>H+p^hl(qhEWP9>4 z&I%jyw!$dB_dP=J8b@&@CRBr`E9M!WLYuy=<@))LZGz|KsVyI~EDgu~>5IsnJ7lN| zpX31t5p&#{t*Mg_%I1C@Q$iqyY`q^2f+2tg(3GJvK*{@(Sh1gn;I`lbru<5uve={h zI80I)UK28p-%*;r>o4jHYYqw!L{VTf}FWnQ2kEN|$Z{azJ>OKc& zDXm@qsHPm8eKQ}k*pWDom$x(XOk#=1@p-<&-QfOANAGE&ec2oYlJzig4&s>oa-G>5 zL#EF$K3~|Y;jCzYkQIQl7!v7j$ud3%xYEhOD35N?o@tOJIlrEL;y0GW0&!EVa|=R> zxQ!1!uK5Kn3XCsKTGVdgv4(Yk^%%CwbzkP_GwdNS?b=~N-u7qsbC&oI+j$4=gL)pr8J%8_20wuuW4!!07~g|)0&&|}u|V`Wu5DlN_V5L|tE>$h=!VY8 z-#JnsTr3Zt42_xhe_T^83<3qh*{M-^-!}l9juNUf-QKr_%lSvaCGAq8mF$NHAXGI!} z<_=%uu;S|ZR#wZZX(KqUjVilV6IX!$^jG$x5=M9dZN(L5q8)=~hKsHT!^yYT3&3X! z(5rQ$m6aJPk6%o*f3DrWh>=Jwo%b(L3jTC64*W1RPg-0Y6X4=i?^0R%VWY)y@JHI@ zh&FukTxaWI-684iwxb`WXIB15z}5Qn4>E~F_I8^P`rS6ag%1I-Df8L625i#D5k2Y- za#-}2`<2SHh0nt9FQ?p5rj!)_c#-=tE2SW=)3XyF*C3Ub&e#ou41r?_ct=QJ29z4K zFF2dN(Jx}9pN26e8Pi7;4F(E|8?Z zJ+;vxG$l+Q5Yq$^hMH5xZ4-Kh=h|Cz*I9ADr^YMum8FR<_e0jWnc`gbDKCF@c{@ZpQL~^N7{H@^YR2<>~nindh0Odp#jLcHy}85G(4&%U5?m@_{YL5lL8=N zH;xYsRi27VjE-bUBHi>9USK+*0>$`D?sVsSqkaR)HFb%VGpEd|a{#g~z z>eGW6UMxLm(iQoXki8t!fZuU3b5^D^zU@%>=P=WP=>xXu05efucRW~)KaPh(PXu}f zLEo<~P~P92%A*G={iS=45m4p>LO0ZBktk0DG&J@ft(mT7{E^T2jY%f`TL+QR;u*al z>>Kd%rO)Zu>X~n3blR;ex{E#BwO}-ebK%s^hGd|eIzsA_fZM_GP~2bpv*l^t%)0c$lRK1yh2qY!{#J-+PFO9!Fy1SG;g+=k574}h!+=Z<3 zh184KM7*QQLxN;+(#(=Qd@^t1lpJ$1p$m*!prBekQb51PYVvi&u&HOGl*myKn zayj83X@u{IoJz?6Xz0#u*_i_4aKjRK2MHgai#|$2cIL&t;ar(`NZ$M6p_Z4d8St>k zv_=chL>P2HOTToR=lUhNOzWm~eH1Qj@f!>-DTwv_Bhm5i-niBz#WQa+X58`R z4XGBgU{qTE*P3R1?s#4agNdy4r9$zz5;-*oU1!DU(*X~Hz->DltfXIPOKaOGI6BI7 zJnjK@euvQH)9HEPbxqca{x7nUrOeoBT1!=9^T(q!8jOmT5s=|L=j5ahEZF~No}{cg zd~zZwHd+f!^#6Q9R#q%;Tgj^#_u1jU?{(!T#23X9b-QlBSY{o$B-3sFY4N1*6n+4IpL{N%y*65H9z`ND#D;*1JkWH7kf?96j= z`Oe6qRwqr8Mf*ywMo9ySWD0KGaK4)YJO36fYwXw`?vp#Snx=we=^QVFQeBkUn3k^? zEz^qjyaq6@S0J>)lrpmbi|~SG>#1PX-CD zhKdD5#Dj;$`U~Z1r*FAbW=&buF`32_XzO0<1r1bi>g0$$UlXlID2}aR7i+$#`>RJ3 zm%GN74&v7+j-u{mtCz7gTCPqprkEn0OI%X!ABSa1-VuXh_nvu;< zbpXsG^3hg0Y^>sr(8Meb?m){03Ey9R~&+=9`_&?)}NCQIhII=J`7SYHw-Lo1PAAAf{$ zTbUhx7ucjzVH?+yq!^L%^aUNXK;T_ZRQ-=HPCl z)BRuUJ6)IoP0FA`#+m0}U0u)Km{NR@>r^hA;alL7sQth2 z`cpMOxsKKMUns~e?CRSV)^Vcl(=PAG1OIjd6^}|Z7@jXwo6n|v-arE}>4er0I@%SK|x*r3w@NtXKFWh0^Y`7UP5Rm*m~yC-|YJEJe%pr}}JLl7*gqeCuG33HhX-D5w;ISaZ}X zSOKaVOB_%I7j^kMvTDl8?(Nv*J=wPzRdhPWqg}Gzl+x!i-)Ag{KIAQk)o-dS{K1Gh zH%(=(cy+SHVb#U;4`o5<@%oh$pkxD>q@q_HdTO@!%|`A2CIdc%F()KAihxgoMrWI0 zR;qMy=K5hF_Ld&(-q0<#qs>;d}QFWq_wJcPAb&z0xwc;Li5xv6|>o z35zzpJefMY$y9fM#`9XtItQqy*sw+SsykxTQQYFZOv37D!uUTC8QzAEkDu;H19?XB z5-dLW<{V}IA+2Qoc*_Ld(XgouP_uFakAK|LYRX~(SE@Dj{I~fJDoqmD$fe5+9XO2ZO4k8iwIB z9;o^7?)49VM>hI2#U#d?=UnwZht5L$!~Cdvgurpe*J9k*l1>OZ%L3g)o`Vl9-6w1A zK=@~enWaec+}<+0fXjNi0Js)IvA^ItM6XQeT?mvekDg!GZW}r#|Mlc*sP05b~ z@i}_BAPdwEpg80=LQ_DsLVI->t9L4Grz`!kCEJVuQodm(AFg4#m*&WsgL!B#`T~6O2UE4<#T z?e=a&&^{a_{m>uFDzVk105IQ+2-dGg&KEw=fb?;(U;<{K>FYu&T2Yg096sL2B>%mP zuRp$WQkAY_mZ>~ezOek#Yeq;y88^LsfD-=T)ErI;_i4KtIKOFKTz$ER777J%*;wtm zBjOyGO6K_@w>H6?GKd~7UH%3HqBEr9cx(DcQ0XsY^UlSFcJM>?Z4e?4Q3O~Cy*441 z8zz<-%nk8$%tdHT?XOMr&wj)R(QM zpj6iAz;EfJ3fGXtT-fn^_8lU2F33W=9Ufq%r;n-7T0zyMAs+Os_QVc{uh@z+KkOI7 zXv-_MrvbJDI6IQBUjR|=78d=K^_*<{TVOC8>__%N+PxZt4+t0o&{}<-J5R~J_I9vi z_X+{*$?)3?B#h{8kyX`Iw=8v_^iwXxI|Ja1aIqt(55(2d;xJR{F4t%uZZ78MX^hP` zwhIFpSpb?nRB1Tkf@Wb7tHj}A{5ldHxigBI`?%|jF96u7C^iAv_*}r(Kp|^@VZJ*&tI=^rVfm)# z&7}vF+$Wdp4BcY%E|5Tm+c#?C|8f7XAJt+SHVYo zqHBxbm8l47fZ1%rn-&u>ApkRKdrq|6c!`-MA5`9Of#HEo70E9$m+`SP?OXqrDT^G136n5O zF*6hqoDsV^%05{v-4%7Pokk}Q@kB(&b8~RQU=eAhM_`XP0;#zGsDl`Se?q1pmbmKJ z$rZmNEurI|azK8^^h&95Y-lfC@FPgEL+;ycQ{C0q^(b}H2-dX855AGX)&ujjm>Lol zjA8rjuTA>scaZ))6WOD{gK}tFV|505%os6{Tz|IkbiO*b+c3U&i29Xuu6d`4G{Oa# z0gfiw%b`Eqf5Xk+QD@qA?|8&s}CQ&xBI*f$Vu6tvX_fkj*MiyxNG9YbM3b!=jfai)LZid}`Qcc-05e`zXkw zHk00U*Sa5YDj2_$H3bAc!uzQCsyJB3GP#emlIvq^p3-p^&XZ`XMzG=fbIeRl^tsA{ z*j_@A5^L_usEpU1*n&@k=8n;%>b=9q&fD-8U8<@PG?P$$QryQX)-hsO+w>A@p%WeG}bOi;^f4HK& zUSlzuvNkqZvzHOQ7^XrVk&>D@hG%@Q;yH1SL|cnWam0Fc!&%??NrPOk?`T-G9M7uP zo9*mz%{$4*8?1AeW~BZqsQTDdZudThPQ9mO*;*;fq$2*MNm7gZ_P&D`v)aZYV-nj^ zY_dF0MuI48%Iz{i$!AqvIew9=e}pu|h44UO6^^=;F~29UPl}Nve#(Fy17?^=&4pZ8 z4o)Rb`M5c1gZwnQr+IR=BNz)?yG;3i?0t1qR9hSOAR>r5Fp3fqG75r$NJ)p3fV8M6 zrF4pPgNlMmDJ9*Yk`f{yp&&>PASsQ~rF4JKnZft1QtIR;tsVkm+iXpZuKLf2i7D|7_TylfB_~%Nnvcq`ntT>M3>IS(-OYJYN zk1&0-|LBqA5*$%A_TMWj>Ii2Wa%+h2ch#Me8j#Pu?i77+zU3W!>J}ZYuIIVP6nYl}aLJOk(1ko*=VZ#3BDP6ekdKlhP*-~As zb7E_+FM5p9BzdkSMIrU}*kQ+`{}>Zrp`-FIgQK0qmuWMaqRRu@gPGYon=(tm2WDCS zF?1|`Xp`A?q4{4K1HA$Xo{%7d=_uf9*b$5OO4v2u@oWuWZ-*?-I*PI!BV zLN=&iE&SfVD#gyk#-;7Ne@y!mKP{r!Kc7=_gyoe#|3-d#IsEHwCP9Qy_t#b8gkvKA z{^l@VP=9@cI`pq^VFdYhd5CGv!Q>=<9}ZEPkHgcc6-PeE*>6Jgltz^>vH%68Tl9E>?y3yD94}O zFb+R;i~c-x_eZtyOnd*d?Eie_OGfnHJ(Pqm5C7{M?B)N=vU{JG)W5#*rTo+F{WJCn z%)h?D{)>Ps|N7?tKS|p$B?u2s;8+f7%>9=oXhx&bNDkZ1Ka9c83QoL>%u}7l{JJrV zb%JBdXV*uXF~97mR_cX3+zWIRvmMl^{<@>|6y6C(?A)eSE);rfIV?P<(kTz{tzVR_ z&kWSuQyQcr6SXqla1J%hp!;hHs0zb1S;jVs5l3De2DUiT`zRF~Q@7JB=dO z3)v@ce_Bj8NlUwMa@eLc(xcDT@~=yUAL8*M=WNZy(itn(RL=muAP-s$VpS2@!hc<8 zbp)@xWz!?_o(vdx6wW@sttFf}=&wpTClkyc&l&67bM?|^Naqkr}s!f>22 zc-#<=vmk99(6C=%!Ez+V1bDnC;QH@eUKoPutWR@d`=zR)co?>@R7_s=fqOk+o-^neXWmM{%l-;;RJtY6I@2PCEeGF33EfE?;Jdz*r@%VC2G(c z4u6sj>R?}CEu1Oh_SE6b`kD)GY2B@(|0SpbMYt&B2cDoEcyL>@z44swe>cXUP>%?h z8Zya`?Z08aP=G%rHo%7ZPs<-h!#NUopFj^Aomqzmvx7hW{O=^F#c;g%I9ao?!`W}G zvfdU){N(scbn*8H9A6al^IeHL0nb%k_~-DX_~9#FG00SH_^49K}h`1_6>4Q5WA(*0%8vHue8RZ8&d z4+D3kHsL(oT;xdMFaP~JYC00nSVeQGpKm#wIFUU$Dm{DmuL~Tc@#rx)1lop&aPxW} z|Mkadf`wL$&`VWqytN90r+I(;Lo5me+LRZ#u-jRaMzJM-sn;uu5V?e#zr)kQijsd; zw_tqv6L|ldcdNNW_g4^ALE#uuC?I3DO96b>d3FwJ31LrM$IoPGHZ3VjI1-j!MDyIS%#>YvPS`VmCu@e!V21gCrc z57G3>;wRSg)RCqo4Z*i&EX ziOvhyVW$i2^EBCD5l?+QLJcol946+W&N52rUT#WD2BH@X>C4PrYIk0QM$J^PWkW2 zyMzc3-QAkJDD7goXCkfTNsI2!H*d)<|CP5@=8kJs!$V)png5FEdYuFqIj2Umr{J8|dmxAD_?_k%p0iEEvf9j$G ze}Q}*A=WMS8)04YB^JegUvE1LhVfPVFOyb5<29qlsYbbV4!eB>6KB)eb|f2OLH$22 z+ef&}x+8s}9Y~X^+QAMB+6uVOgSE^3gR&t)G~8znh9*^|Dz*8dC`9xFoYM3Ur|`P7 z;W&%uJystgufJ~|fDraB2IJ#=wr=zU7Jh$OgkJT56FCwsk6|#suvn$pRrAvm<$Yu3 zQd<4L#_BV5byInXP~&glF}>_H+5362U3_b`I}I8xeeZiW??M_fw>pP1xZd7qFjeT- zN6Pr6uk(pzz0meFSI;=WvQzN3eXcC7g)R7!Ql z_koRIq3s@3VM|ZjqnDhjh5LHRR+(b5znbkwOExk=q202GBZs8i%I+*Ohu`${ zTA94?wOW?1-^Dy%q0{!DMrVzihh)+J&$D6pA@4(8U&>!cEs&?R&l3!|xx_ zp}vgrV(1ZEb+MZYwbh+x=^@^T+Nu~$@}f`%Hn<>Z%^Hai6>wAP^sr{&f97_GSS%$l z%DjSW?*}he3trV|sWM}&sI93{d)k@ef?oYY;<@comM^zW7Ji-Tsjd)k3-Ih8xpg{T zd}UfOV0iz^jj8th$t)zlsK&#Cm+TSov^j{b(pAnsgf@e}dom;&QMcYH`JT<}5$7I2 zbtRC`?S$7pRA9*LflEF*J|8cvQeFBKt3bN!4B0W;sNlT7`z)ds9nvhDV|%BY8Jdfp zSX&P06ow5&9J6D6EL_;>o%FTy%8US?;<>Opp2UxG+i~VEbz=JU@%}VVh4&O;2q}_5 zXiAQ|uSmUPr);IJ(u@8OXnjy3cW{bw*4FK5RAq^RB0Xxb`Z~YyOVO~hntq;iO_`Dl zAL?!$Dn04d)YV%o7A@7?`Cw{wn=Yr})*)QPqOE_UxvwJkto|H%VE$B)F@<|!`ToYU z@o;RcfPYkhN!p4gVe-d#FAQY$YEns-lzQj~HQzkM@1)wt-n9{>A2BvGAr%FJAb z1g+3N_9w5v3t`4u7}4iz5sR~-me_$OZUY@GIcg&c3d+?6-Ex=Ctex1Fv{)vgX8tBg z7O!5Gxl!3>veK(xF1ATOA$TIF$-Q+Otb~Dq%_uImBUkaY`PF8h@~XzNC9LB`9QDRQ zXLOa3r+#L9visG!xa_nz?YPuVot4uBa=(<@;*WIAIcxf`(v;k?v{9?6tn|%f^(PY# zlPO%EDH&C-1Le$6+zkvyqfblL)ydJ;tJC|{W?A+8Bi%wvy0i*QW7X@ZRR#8hFty~$ z?BEak$GfQA=9bIEUz4&0Y*aD{DrH~N=#!Fi^NSK+*C@*!kDykq7MXnBOCl^wj%&Qz zYuf_V7&Wz_Ko#&eKX#6v)&C*n>*L!(4j=vAh4b&Xv7!-xf2`f2{tZl>+vI4e# zKoU64_b6u0wlmilk^?3Ba|Zh6xt~wDpJQ+MU=Cqcur%@QaUaKp+fvSr(g6?;ZN3Iu zvLC$O<5K!n8|8eOxO}l_jr(Kj^pi58F|(WUx)auKHp+WEJdGN2-{m3x<@Su@|KA6+QP+b;#>Tr0S27SIPV{#PI zo54 z2ww4eJ9YRJP8>ZEKX(c%YRqA%J30}6j0B#neEGR?hkAxcb!cI``>OO#`CF@F>{M3@ zD4H67mD7&au;+#pmKNjr71&sEgM_u*AqLVo#qb zaa~KgP;I!*k-@73N<%E~Y|%4cN9J##mG!=>a86D-Py5kj2*pX61%vK453JX@d>V(l zU(S|pA2df6pdS;WvdmeMc%v4jk#l`eh+bwBCy%|5bm&#+F{N|eQzjH6=Sf;h@^loT z99EbW6m)pSdV|Y~g%8X2?v9iLyOYP!nFpKU5%oiNtS-G4sMDh0)VtmJK&;YUj}4t@ zd1Y7-b=!)hdEkl6b9ZZ`7|O}7a=qrlM$$~(!lzwu>|o8Z%f))_gVUcobbiiR&yhfh zd1cqM!X7>krjaGv@|SF^bU5oYYh7<`nfjS5(J`$`W$K(Gk-?3gq3sK%1JbfEgW_#E z4hg$KIW5v>LxQN5EK|&V+Rv%(_B0qzm#{A!edMv_O)4obCT9@wS-2k`pY9W*o zGWQIa7o}(SI0=7RxNAw;5@ywEL>2^_v?&6Y&-4_SS!E6jw7NHINPVom zyzRh6n02+Dy;`${ z`=k96XsbCOOU@zA>m>o6is!#8?m!~$S6-v+^^c=HR!9D<0-BE3sc`tJd}m=kg(B}Vc{)| zxVSNnytcQ@3Wo`8>4bW#zUEEFp8`;x9~%RWDO~y?9wtnlFQRv*Nzg zW@a~?dk~$-`O0SG9G^j<-8mt#xuL3qntty*yQkXftkyh-_kj-sMm;g6<6_XG0xYlv zEMWB##ZJWQn6V znl!(z>i=kUuOGO>Fj&KL`(*lJfg^1P;v%c01lx3lis-rT>PbfiAp>$3na?D`pN!~= zA32F#zty!=aZBV3Sf$;xt=VLya#I-qYCe6}$D(kaih4R?qr0VMZn-k5ldE>9Yhr{QM<92)Etg z_g&$J%BhR!NM*HtSczA_e!5L5at6VWW_8QYK3PXNRo=7&RT~JmFY_!?gHij=UDkqB z{<7ysxnO@lkk1~;qipq@a<9^y&F@u~ks;eMDw+ue;$|POjJlXT2f6cm0BZ zuVdhn**Y&)^hZ{be)h-Cp9-D6t*N@I9`0WQP0@B84P!Dh|s=a)GLhy7X(9b_>m%a zxC8(U+avh_R{)J0AzuCyn%SuUtSkVmN5n7an$G>gIuf~uuzuEt#H6=CB^k>5DpMt5 zk(7(HuJO$KT|<`(A@7bVIks;^dp$CN($q80Z`osSF%se)mmbo_ARBbNY6#6Wrw^L5 zdmKzaafdA*H|UIIJsvK-G%?F0AN6p%PNLo>H(=GMKOCc{LY8^A#FLUNO+5jMsME7M8kOpzc za@8`@UYWl_fQi5y9mR5)DoxOE@;A>;os^(%U1kFrQPwMcko(5#*YtP(POj}@(dHIS z*+(fQ6)Cd4^NGxgSrC+)$(R$dQUL+vrzR1lTchhw;_GY>_uA|r=Z29L{p@_EBt`K@<~8uX*@Ec>G|^)geMkG8^|!dI?-P2>pRse zZ8y#1NMx6lzhVdcmR$)B?f;QQj2$-2Phk8c*%fSeZ`GL0q?IZAbAgxfVNqirZyf1~ zQn7GmHzl!;D+}isv6 zB;PD9zp(~0pr%6!EFD4YQOd1Oy9WIcf+w3JMl$%a(Vl&aFDgrZD(Z{AR|ik`5d_2eo(F&>;4 z1xR}VuJJ_bs~-`~(oo+w&L8-+F02G4sNM=KHebNNA4a+rC^8uP!#>UvNoBG>?!RaC zA&ARc+<{0YSbLdXq{IeGd9k3feXBdJ)lWh+rv#mdWcm1wyv+WR|?<1&B|2H(fHN z$or~|h(AP}K)N$R`U6Ry4G#_mBbT@mw3Bz^P#^Sg4RVkWoY7{;mieOMbz0m3MlSKo z<2XzwYTwn0;J6}Rhh~((%_J^Ra=bUL`=<92;y8kYKG^(05@iW7aGJRNaol>OnEMys z=X3*=&wK+R&*%c26uu3G6a-cqjIcpPfPU3L367)_MSfxs9?@Q3<^p@}mykMFy-a_$ zaB)rN$vkW2DQ{65NQ`8v(tD8?n~JmV%I97zK3G%1>6=!p%x+CN{`SKYFtVUg3}epX z){Rz)uYusN=CfFvD?X7V6tuZF*!A`aznm8!!CW2_TK=%ua5GNd5cJO6G-EC^B`p;_ zhF`CgC#3^K{=i zEE+BYj#vm7J6T9LD5)C+aItp-3vJ-kq`E!|Z@`q0B zwPmaQPW76^<1+DKa-%v<3}()T8nuGsF|C0kpuOh>e!|MsfsM$PUkk{C=i{&NE+I}z z9-VQV*=yS$q~OY(o1IEga155F)W;@mQoCt>nblt8l#%$|b&x(y1gc2)unk1}Ok4;t=ed&y zc_uAJ*9L|sCe0>&lfROYUyT+EiEP#KPUQ)y_2yrFkZ*jf!SJ9?D*FeN`#gy@?$2I; ze42XO40pNau>PM}#121TbtcKh0g4(FF2!>U-WE>8k_P0&+Hh^9sK>R| z{OpK3zq8i4eJ6KmD%jTvgOSDD?~+jL^=?#x61ubZ%k(Gb5c}85JbM$KKquJ??XCkk zTG8_^Zbj4L`wSR}?7Z%Nx68|#pPQ`gIlfHNC*-$Wj0CYod9#KbvO`yB0uh|ex}pBy zeEdCh;-Lg(ncwv0$a`6z{id55{VmY5(UZRT3>iYzMcU1?c_X)^Rb~#t6s&Ge(jqBZ z#YsW}V+Zwv4kTIZb%Hc@bSKgAX{LfKBpNF}ZS#q8?`0b^l4a;kmTV)M%hKbG{z2^L1_}VR_-|W z;8(t*&@%_I9OwP1V*T}RtwyKX?O?TP`~?g^*MA!NIme^+u{a7mi}JcIrP-{zKCVrk zaKV;(53O6z`jSR3(}_MFsb`BV1$V^)l1iCk472ocYL8-`>21Zem1ed~PN{85^#^FfYq>GGoay}(tMN>4s7g`vvYspmE z#I^afc8+RTl-{^ay1+W2(Yo@3qZDvEV{yMD;>a48m`)CB%-#~T0sDKiU-XgctxB&J zx4sm;g^gbOgH>Z!HXgc@c7T3aQS&qA+%pGQZ(m4=_i>J5tvU~U6v4tN<1Blu`4KMN zYQ><1x9P@*CIm}0=Ps>0>d&*%A~RRbQ6&D7Zqk{SZ7Q~Aq0x7B*hr+uTXsgWWJz%5 z2IQ}_IScdlYm`wHYonqoX1Y5y69OB*m*dh(n+>K?o>nw7NNq62Zcbl73La}oJkrMB zrfy;EJu^|!Z0cw6*)-QTx4$OKJz&|^uBGtNIB*(<86as^YOCLHDR-Qhw>nLl+#L-q9|lWfu>oy6qx z7uC4^v@dmcuMh0ZiegFHE?w~Fik%Y{sVT10{)$T$X`1S_U+hX9nv`aWva#gV6$)H^ zKi1tlW_HH99L{oY>P$D4YesrSC!X8xSEb}vV81Po=Sa*4Dh-_V7$(B4%m@ITQKJ z&=!*FbrqPELhcSR$LoQdy1;gwmJGFrBimE$HEoPH6sA3E z>M4?C3zS^F*B4jZ1-;fBp-5f458XeN?{Ki5mb3u#L)GadbYGwr`|~KT^nM8N4Ziqsg#s!St|tQ(<89E2{=t!mEPMs#Mjo}FP|xpt1Y8y8wtE{K zizVIko%%#UwbtS(QxhdxG+>ZaRkK3IKClDn|I#WLe?Wi&R8nj#$}c^soqrQgOEU2 zBc4A(C=g0i8y?gcye#q3Rv4-%ESmZ{t)AcZQ09nm`FV!wC|TEvmB5ef297i{*H&M~ zj6oPiD=v3J&c(3K^Tb?A&|7$UqLV2x#zs&#J5|?~I=J%sBRYvi-*EhX3!;)Ry7dqT zu^syF{#Rt~$GwUSYWUpa88`CnBZbZSVN0*vRaUtPfp+X;8R)s@3C$Y0uNQ%ra+L(U zAZebfV5gB%*8tKPx{H`15k;Z>MuB#MjkuP0SzlyhD5Td z9WuXVg~;SBWAGcBQXR$T6miEsa0q|1mx?ZtT`%Iy7yqni zspJ@j*z1j*s*9Q~6VT#q)|TC;n<(N|*r5HDGP$`8UYEK6O@hM6Qh*wy@gFv5MGcVtvgdA40OHwT|6W934J;0ZH zV8Bsu=umD6l0<5#crp-;<=C&}`TAgD-l-sgybU&6Qb?2=;h|xmJ-v_otp`ZDWOIVBPckcOF_sham;2 z&0KJNl6;SIBI$xpmz|k17u4ePMXr-m1!kId7;U`*;hD7R%)=^%0f*s$4!krIb^v@? zqnZ(^^n^$XyYx;&QU>U8VH(*bM?={A=*1w%9Q*RJ|7qar797iev5Y;fJf*S(T$tq-f6X;jP4V6FI+LrA9!9We2bcHV!>G$IB(~ zY+3KuO?shdWjQs@DaBDPn>BjO5u(hR@8oU)nF8IGpi`A(vCAV>vd~q!andTlF1*qt z?K5}TsA}Bj^4)O*} zp!)6egLSJH@AXGyK5{Crc0v!AvRfbOVw>5x3x#so#VxlJt;{2dJN|_hdwf`U2fwmH z?$)C8p6+>3zg_|7FFl0$-;uQ{uUN69TRbM#7Tf^4+E zd%56eR&&qfinOI9VpEZbDyPU9dhhC^!j0i3bEMnBkzyAzBtfhpgx#Wgg@~Elyr_}pjPM_NavIOsy=-A0#`IF)nq4T)D}P`K7SskrAA|n^oWI?+oZPd zG^ClVknHhcP-wHRX^pPFCie^}jQq~NI(q-eJQS13R1>yq3V!-q<>7D+y~rC*sC#Qd|V0%b|`~InAKZe25j<4a2^{wGMRGg`0H7Ch<&co^g}_ zx^oWvCEA*2`{Qez(1Vtr$1WQQy%a5!y%=E139&We2ghC6W55{>UYNv^*(qsH_j7Ng zSeS4T>>o{{Q4U&u^whe9H+Pf=J;rS^G36Lr5+Jfck2$?3wof6hEr~7tUAv^I{Ab%O ztH7R8@JB|>jz8atOV_j8w)$!OQ)+us-!)+!nN#Ey&l_QW$6 z2%Y8xI)y?6`@^Y3fuMLe0J9-cXeA=X#!0`)(MYcstt!+GfM9FW^HF_~%$#XnDYIx z&_U+h-FR36cqi@y+a+-?phLebzUl_&91NbSqd5NY+EPH!QL zS4B`Rvbf)KJI!#$BL)OWDLRlxH4h{++o|Jdlk>OBYhgBbK#8$kqOw&_2gf~9%s<_OoWcM`bEmCcv>jUT zlgX`lmv(1F5WAfgfoy=#-`%(8S`UrSH(s?hKKrdncKqB%v!K^f;3$ zg^7PQ@8zEHFG|aVu^MC!U%o^VBO#~gBCor1$wNCkb=ey_r5zVq_T8w4g%^}dvu(Ox z>yM7sM@f#f>aX$_C&oUHiEzH8TnBv`6q>%WeSzP(_?589TyI5Q=pb*`)8dn_JZ35H zl{X|#=X8S|2_Z{JpeqRq8NqMch_2Q?BHMte-$^3WcAXwt@VMfd*T#0q%YD0-*r?DJ+U86by;GlBN}!dKV-C{xV0G)KFg?F^9@bIp-nR6- zc85loO(=n)UFFoYCe*!TokXwUU~LgrBp5K*|*rrJp8gh{ky1a_fFX-IiIl8s#d6Xi}42@U-{Gp%fMYe6raboUOco3hPA~O z7$Ca+hzg4mB)>h~R3g|MOiw9?9}ckYg|I<81@^`nmr9kPp4uSULq%Rq3n}qBeP%5O2ivslB1*_+uRC>3^C)6C z6y*|b6D^9!w|xtM^yvk~V^S&ke(LB{Bf3Q#6pFsS17Kq(Sv+-Bz3gHzj8uPG8z=pN3g*LG$vZQb#)IK2g6TrpxqyK94;A-7A4F zRrSQ=$>S-ko;g8Gg{=>u*xxOS;oAy#^2BU9-w~6l>gAkZsNgU(+X4Yx9^X)J9diNj z*Jj_;+n$STT^xWqLN?;aaDd{+lrf~8`mR~ELnrylgicbGYvp&Hv{VYe@8Oi9bETL} z1!L{#Cms7QVt2eA_$8Z%bRkbsOLM8XN;Vf(6_# zkSo8^p#b*I(?hm{aMH6_t)*6NnOB}wuRuQW-JX+^GI|_-uGq3e;^RkeW*(yHui!4- zBiZHk=4tAoMhvq}@({_5`G%u|hg9-SBM$GxlWW>fZeXcqt-rT6@3o%1He|pGC4wb6 z{^5^+cu_a?m-ijKYTmM@Q>$A2N_q5gOa1P(;mLh@YBN+d3?oR1-~8FTDY^Di0)h3Qwn29 z?$Ip|b;;wDZYR6kZN>`793Sl_ioDJga>2CEAt=jzVH$PlmJz9m>KmUY)Ty7Bl(ny_ z4)5)Cc0hed=kPjjzZKXuaQsZuWQ36a6?t=&<${-Du5RDUMe-)&T(r-;yFcuXjHfnd z+ix&t@_^NRi#PCh#|v&n`)4V&+(44BIR1g{ieDBWhS$nImh!^WZVZOUE>c_;*`J#K zR4s+^^I22!;ysJYp})DeubDC1mMVq*7VKMkQ}!OGyudbRy)7(+a!dJ^YJkDqC~3^7 za_yIR9iBD{iEhQAeMy;eT?8M5HFtnAD_JOVvc|XpfgYm7%CIU9o59 z#(l(ng{bh`hUt~%NNKCPi5Qb2Ghk)T)FI&5M|)KEiu_qFwk67bE+O$pI@ER_ift#S z8s!`Uo}2^8zy7wT3S<(S-QRXT*Oq5GUxzy3to(P^0p4bG#T`%w7o@{uCM|NjnxRhF zU$?Rz#=W9ujHl2++wM6LKsz+;Lp@Q!`u8@mF zi#4NB80kwa&%1Pq<<0Ca87%mIs71FV0?7f@Rl}F3`SJ=?`?nX(OUuR1WzhC#MzIYR zFk|an8FX(1xAP0_^=F^iLWbkhmLZ;GEHWcBp^O!=V$PK!L)=$n2`2WBxrFc#jcYh~`CJQb*Oc-@ zL|#hl^z*fDeH{F50r#6C(yfb-S$*qO*&d^=c)g9yc=%@Rmj)Kb!ye|J4Ft%AqdnD> z4ZJN_vUV^evn4)RWpk@RF-g*3^7)hU>VCh!eQ{0^DO|rbaJ)U_eRGRJrm*{tpSxu& zgV!TXW5i&d?ix(so`jJzzfk>H5R_1$&9kVJ*wk*KTe*llT05#aUV+xW+7GpPBHD2P z?!$olUPNl}1OD6A1ipPYK4rhq z4yVTVwHjn{F4?B8bPLegy)81HJD-8L(mcyoebhDisl5Jv5dY7oH|M zZTBK3Ng~@dhflZ$v0<2+{94^oYS)C=($HYrH2tC52Bh)MBuWw&4BeB<<=rUEu3pbs zk1hWu(hX({%9S|l!9Ejl+Ecw}??}n|N4`+JP_*g+BF@g_T{_hX-uJDP4@k+EAsoZd z+}>U3ytMb#OV++VsUja7d$w2d2T7-;JL_t!9ueQ#;y-6yg4@rZvDCKVEVp2pSzFh_ zNjA4DzR)oSxTrRGoSt?_7k;e;ANOyg(nn3Q%CRVNZubZaRd9zo#Fcyn0g+qe^EIL? z@{A#jN?xBfRF5zA`XT8MurG9Ztwf`hs6b6O>0rv{IWa1a zmpPX3h4Elg@0MUxfxZP^HQoWiCXx+QI0q|S>1H)Y8MzsJd=GH$gJ4Q^b8 z(DU`v<{kDo0#%6W)rUpX7N>Yu&i=9&d&8O@-p$O9n1`u+%)|b)jSU#$$$1DZ^!7y7 z?2YzHlSY(_m0ZXIBx*4Ne-s?*nJV?(Sfeo$m8U+9Yft)&9B6-1T`I3b;}X@#_Z;=0 zPYwC}KK5g#&!!9-@GTXwC=Z%~=?vnoxbw%{w4>YwbiwP=WNF0340dPqL6z*e^GC1%_3tGBsxB>hKZLNuKk+Cp!R3jlw?ecrrJZ)x*u)h(o#6!-I(Mgo2SawcoSI4Yf;ehF>k z$a)-IJU;99QVX%`0(ZM}8~!X0ImcqrrsN%UvZL{05+dENy+6O7>N9%Zgl@@2EFmVA^&>WiDriFK-|z`tzuoX!rnvJ3-uSq)gY9j|(+6 zwRlmaDAS#_;Ob2S{hc+{U2N;F{IeH;A8h59{0F50u&wyplUv_4fYnfs@|!OW!2r!8 z7~=0FndMGS_IzvCYJLY77u$mw`%N0F*fncxi6AMG^$CIrF6!KQYy?`h`^+aKE-5ca z?-~dCd*b(*YO%&CiXom^@)ghZ)}A~VBx}85Q4uBrfv7;{5NTv=(nXooDU5`xO2qtm z%nz^hSQ<^Sr9Bn_;sWjUJ1Pa`QMB}aNuVco4iEo3;p zljYI@{%c@Ee!jslHQUdv^&qf_)Ne;f?jWouO{1tXlSR@#pPMcC-oTNRBUia38fA4G zTyH_Xq&eD%boCbE*W5fNF<_Bw6GB1v9Z<6xt**$KrfPp?{z8BAx`~V>;ssyaMCa6% zgUcY&1|4Q~D>Q@@lzFV1D8L{Ze!0<2H11~!1VEVQ5hDIV2X2W2pNT;nBqwo>`he=K z`xg&=w=_yAl`a0jVSlmBmYtl1-26RH6S`txEfzU)I5LUg+lT$YZhxpdpiDkdrkaJ@ zbloCaFASZ}D|(w|gqGOfHhHq{EaxL%o8=k1W`cVcCNu2Ha*pV%e=Ow6vpQTV2}?G#ZFLs+fpp=Iq!1lI;qwELLMp58<3BF|DM{4SQ-P9_HFy%846)qm)$94IO=<~1Vjw%$b__9qc+)e~&cF_kV-O+aK*Q(1a zQ0^v*KSaV;H7V5G2D8RX{D~UoKArNMFv6U>%6&3tb(z3e3h&PH<1* z8#mC$!mfQQ2iAqZgQH0*rPrE8GbEmUTRV9UD+6$s(}1>?N|`=jl}jwHP~A<$)(VdD zsMsb>vGC}U=tbWAysUlSs-78z@btMrK6IT|(>{}Cn{szXe4@GfJaM@WW(}Gt#{(n^ zcUxP)`&KLSM?+psLu0RM$UyQJ<;tK~S~1IAr^ICEtO z4L>kFS?3rI)2r;=#UyPxpLuzK{oC_5CE{l4nE%*~V@OKC{`rJ$M25 zfBf_<&onTr?hqC6P?<6Rdqc-#-fX~vK^-vUMJ2h;9FCduAQC#e!*pt@sV~ct&Pd30 zo`k8ctmt+_PJ%-1OI2u7mme}F@4M85wm!HNG7$w(z@N#Q{)s6%gEc*`i<)R9#%Pat z=fQ0{Nn41+(GZ6bPYr$9e*pnCg%e~PpPfTjl}%918256!{2@!&4V1OW=~q!)^L zUhMlYzz=?b4{_l1#G^o!HK5A-Zsq{#k-c6LcxML-D9uGuBN%MksxX3`byQBiWCiFj zb$Al_`8q=J34cQN7+WuK&8r;1$mFZ0gV)t|gC#5$sfQ|Xsc}NDD7FUk0Wjybh5jbezDB6dTlefLd$Se`$_ zlWX3zm4#|>K&ndG!S^J{7sY7!wUas$BnEMt{F$k)++29@G-|UEp}zo0r(E%*>do(F z*x_S=&?heK7oJl=h8XpQg8ppe=whZz$d1}hLUnHOD$C?T*Z6K!2VY~k~TtBgz`Gc_J&R2 z)9JwXU=rQ5bk|#ri}rS$jIDP~a|TeasKl!gQBVA#|5U@KN>G>{ASGu|*(aD5E4T$! z53v$l=qo+WvUy3D`ew)?%`yp&Lb{JyLVZ%?lsNUxK&Pyi{X&och-U-ZQerS*cJNW5 z+fDD1*vR$xuS(2i7lIzZPlKdX&n`aNz(OM5;|U={XFY@v88@Y=Bb8c}`-Kic>(A5y z*~5X->)Oqi>CrXB%D>KlJ|JIs&ZeJ9e~rimu=V6H50D5&7;5l}{0A#pDT_Q}@m$1m zz!T&n?>1tb5le(sKIz@=*;SCG2}Cx?kWljsELSC%z_Ej#;S^TyZROx?5lo>Elqh{B z;RRh0APUb9NNJIemjyvksCWj@AD!A|)n%la$P@2fP1?M422?2A2FZtuDTDzm=nUtY zqSXe8J^p3`_1%6Di0TmJEU58f7xJYv#L?1O(}z!c0vY`4o)w!$g%RiTBvBO?zje;4 zZN@U7UP40wg_D5$kWWPpA*S-j4nJQ(twupi+2?ncMjeNc#0f2Z)WK%3CLB$3Lvd2b zL_6W82fIe7JdpObAA$=CcLWZP31&znBFAkEL7fWbhvYXeJfM#om#h8pZfZX|qW)d<3(M}$>e3*?@*Zwo+7 zo2>{{>b>(GxCU?MZED)R0fkE0?by--9vv!1Bqmu8zd30uUcZnFHT-|*bnmh>DmV7I z!Ut0L^ZC!s7YNpYiuVDVqC*-64|nYrE~Szfk;C6{0=p~DdL(NAO`{eYt+>C-R3X_L zk~Dt;G$KaIMhFRzYhysFgsJQv;X%eL45?>@Br7|BWtX?!*r7JFTsmVPqymA>NNhqi z59FP6|40MHkVx1}=Z=tP5ygNSk4c|KX@j|jff8eqh}`37JZ|jYIS)1fW_mYdnf?fV zzCW#nnX?mvqX>ycJ}8$l1mDy?=TAaiw{NKwwN+=oM$th#9%zYZAxg&psf^)MEP+>@ z_(m#-!Y+aV6+b5b>bm%bkT6B=0X1{Q2Es7oa$-EWSCNi90x+2Ll}%*T@T9=X4u5 zaE2onU{JhLc;EpSf&^cS_X>9a$iheb_O6*g-sGYYv_b|;6AcMMgPKCmrmxp!X+K>&H(aA9RU z^5zoo(nNOPKyMjT5%Y&2?L(1rk!*c{1O#oczP5tMm7>Rp)GL4vl7sM%_e|=aL-N!C zI4b^-(5~=$&xY?9naIXH`^5-3^5AiRD=*SeuF%}`EL2o0!;v?@F?{(Oo9@RSraOkJ zd=CLeTVqaRP?bDdr4%Y}-H_$&VJCT)Ig4E*-3`sg z^d`^-SeT{^#67>fHunLFN@%YM&Vut+Jc6m&nvhBylAH0+MAmBnHI@$hwi92kP|HH? zWeh4!eRtBX7dnE*#)y$($rlqg z+?0mC%SX~F5IjGa!K)l;wG`?YLI>q^oDXq~J`*BZDn$Z7Jc2w_8lH-6YRNfFe)54Z zdRkPkFhX0Z${xZ(X;$`w7~lk+YCHv+1Uo~~>FJ8M$(xzsx=X2I@U_TG(V7$*sN+2+ zH)ij`5=&NwA}FcC(cUli6zple{7q|5+N`%z4nZdjC#M% zWnyw9Z|_0iD9U$iCN}^1|5>Taz?)ND38qn}6duo)hQs>-_xVzDiCOJci zgeU1Y7mxf8Q~5LEJ0T2%0Z6I*p@sxi{F*~BPPQsab~6u_b{R4Cp1qrSA>7b%nb+P4 zMclOKdg;byqRWaiEoSF9My!hX%UFTxR`d2fpwk)t>x@w(8oUR|9=+k!;WB7g4PxX4 zUJC=p{eVL5`*;V@*x3Ie?#sieT)Vg*Nh))bGDeEZRLMLQC4@xDOeG{F^JcS)P>Mn+ z}R;|b+6&KerrAVgQ97C zu_yTcXxMr#z8`}^#+aajdicz;>)MLVTcqO)NQ+y;o^^FUya*u32RtcRVRx2}dAlVj zy;Mpl=?+Hdr5>cpt{kL7L-1vmMq--g6N#( zCzZJ)Q+U6S5ck<}S4~D?%&rE2G86UGWOEAr^K($jO23gK+Lp`N(XgTO}*-YZU#&w%a_bUvCt1$*HsB`9G-{rl*lP8Pm z;kEBQplsk*#t)EKuM%N2N(LXxDh9R?YWAlroCtg;%4ZA2n03lnx7MN0tg8N7T2*ag zd3&0HJF`#hSLTGQ%x1=g?{k9i(h~f~mkRXKe*9Aig@nFuk8vwSz1_Gii-I#QmE{r; z^fV4xp7zk>zfIaD@3wRD)L(viAf0XNyv>j0hmGP{Hcc1Zw=I_``-A`J7-Lrg{(yWh zB9(DXK8=joNcO%H(IqT%bF0xqL_6*-ZLw=XBola;G8Bo_GWTMt&n1$>8$*7*y4g*w zf&Yw7g$=1r3DVXm`DQw0e#fz@mnq%c1V10}I}D{FH@-Pu+O6{u;YHfY^oS}{@S1=8 z$x{dN$cGU`U4D6xm$kkr7e0Z%mqbSt2JMBND1i|0$m{ro(a9mq=`J)zC;Gqd9j!D`9x<1XJp=x z@niCUtt+no%~!-^*7v=czokokHA1+2er=}t0!m!2%-&O^n(GZ+~f4>0>*5X)JWPT z2u?QPS(KXB#?OS1mBVy}Bw%J{%4KbV6s;L!g4XzbFk2AuP(DHx4_-R&Z+hl5#?Woh z?sF0Bp07IdLDR+Wpo||TrH4s}SwQ)^Q2L@e@zsDt>i-3gJKKJJBbHzb#W{u+rMR6& z9|aT*tOzi%ju0pf_p45SQYitXQ{|FoER_}B(kH&x#Lb{`uHe!mIQLj|q zQAq_LTd6T%1^H4Y=FjFsm7`v;z}Snss3>jda&{W%AG|&Ay>6&qw#X&5p8^U$Di2?E zoB2!Fz4c$GSJh?sHfp#DGh*J`{;FP28s5~o4nY$83HhnbjK6uT@JbtAB4Wsg{>GIQ zo=@Sq5|~#eVr^&f5^4&dgYih5c%f8V@* z&X6{LBFx`6z#f9Y%nhXC^67O3B)Xk*)sz(8Yl0N^eQ8ScdH#fUGZYD4LdQZ;GQnrUXSQeI zC*U}>F$gp(AEnS#wGpU_*N0$zaLzI=+T<&v>JE^w2|{NC1bO?|`L05JqerzSA*yA5 z))lOJ3xwf=f=-a6Je`hK>kFd0}`UT7-SfIeFF8AG2(rPMUcmRZA`^ z1bpCs5ZSjb$}?1j4JVXgD@0fIxIG$l1ZRlz1^VN!MwV%rqg@3WsV>hudO<{3WTB{js1KI4&BeVbkTPQhsq^eI>JP{@RDf6h5TV~V`?BjE-6T- z-QGiC>U!9<6RBlq=L_{e0iAFi{dVyAp8dg}F+N*FV}njVjYau*T9NhI<>}Yr%9mQ} z&vy%@NFlJ8&iw(Ag&{s>7{QtQSd}wGd=&Id^E8Xnv!Z2ARlc4UB)opd3nLtD6-zuL>i!BJ0geS!8*`(XwYi| z7qKkfgH;oTApaTm5Twn2@aEDEM{nni7pF(oDd3&DuC_Qd?xEwefypz#6$8)qWO%E` zp@ya9J-w>s6vircwhGKCWHEMMXlxOXV>Mqdi z21ux(J0MHO%dfm%ms!j&C>wC-`e;$x>S6WV%sa^`QK=UT>ZJsBWFCXUrx`69S&UzFN&hr`Lt#1u9}ys zy1MyOmj@6>9QkfPF8JkB@B>%y_<`Gxk(da-*Qu3siYWW3JpN^(l$CU9GO9OX?vmQ; z53ChaTT8@`&Dc$xlIa*;oK7-LwwpKRz*OzgGkb<;eza($lTu&}!d=e4bB(R(Sd`py zNtEE{V(`g?`k}=wGtz*b7Ajr}#(AL05B-&5V>n`!L&hGV%DfM(WK?40La9M>O0V%n z=#o3LtXQZAM#^d=tOg_BB*#EB7maZdg5>qVx}D_wr3K|t~5I#4xm=b=NM0e2hsFl|AC zp_&q1H`|zJ$UD$-am4)$-95@rn8*+gu&|-nz4cxmyRoLJW&U&;vt?7F_D4w9RDDLC z^vKj6Xa_famCz7_18s&BrYBeuSyvF^AbPA)6X;Lfpknj#RMV=tEh&7LR@%XBp?)Vq zJ#hB2ry@7kEh;WAJrTb%D66%9&Jx(Nq3aM%w%s`|J3pfa3R`{wXddF>oRRldQTE{Z zZR*A_(iy8fUNrF-TGYBroj_FajH%MBFUNPj+iR?_@hypodo<*N=24tbs5$^MuDkrQ z==L>>mPn{#gT2~#u(KNRKQkLhwX614N{aOm+tpVCA@-4mYh)4CYzUZpNlDmI#=#?G zT`9EsOec+vY60WnoZLOyR!}m_x4Z4wSZwOU!J5l2O=9+#KP)25ga6+q1~~RPRM74o zZr!JS*jVhz*rhBZ1~ctw=#94J;Ak9RhR+GqXI0r&MHhcQc}N7K_63K?!V535t2Lih zTH353C`h18Ls1*$({q-WqkVU7B=nx6Ov``%-3xGB?%2m}*Ugo&QLpd3WbKVNihOXZ z(B_=_W1nH*I0X@b;jBMrfB$n0|@=Sa;=a>90GU z7P*{H>JCE$^`5J6=vYPhj-ZR$!O9-FuirME9^UG&7gFZHP>!UPQ5f zdYxamGN+8xVY-C0y^fZX&z-7N%S-S6giP?`V#ycFlrm0p`j0Q~9L!-T06UVs-7-7P zigUtr4miP*@I3dU`IgH1(fOT9XUhFj{DSpIN*S>4ivoh;kcpRlVqJr&t|G+O^92yM zB>)3U^(trmIcpJY-4k(T3HyzM^JV~c-)=45id#Pc%l`BG)pC^o!1%1J{>p^u27{OC zX04l*InCvAV~7b)JOE)?YX?s+0$2B5fBfwdc+!v%SfIM0`GjE~Gy08CYj92;dmjSK z!j*X58_9C>pPsL$yhw~X_i~=$@MW!8~(sGRyz?jb=cVa{Z$Z55Z(^;g)o50DC(J;of;A7YG5t#Fu|WHBB@MA z(lc$Ye^MT7tRkBma~aOFP8KP6QOhp+q}-uxUPSt-19E-`Z(m#OSeMkrwi*|oYy*yq zr%6PrX6O~}_A-0IekCt27uV~OWCp27S!En7OUq(TF(hddKU*Zs8MRf4kHC~Ri zTK%x$<$Fx38{<82CY%Qwcg<4sKGc8N#PCWEp2RAp($jr-IgSD}vE5rXTF`&n_%+8k zy;=z-F!=!Du^7&rld0j*?6URn;=9-)$p~w?yDwWh&o?oYmtUgD-Wa8NyJ%`HeS#IA z6s72oKaOZ&>K~5=#%HAm-bjH_j^LO1iFVxStZRyIUlM|v4X}Jt# zIEP&W?%Hm>-%>4)FV#B}7@6txa0+UJOebT;5;ujaBbBN!pKV`-a1~nL$vxKqyQf?X zwll76kuRIL`~KGQwKV%t_NX_~aAJN>eoQ7bHG7p5)tXo)wkWAjpTV?jkgH}xAhe>M^_tit+( z{zmslj@~{!p{*?UNKa$dn>2Gz|BcMp1K?M~A@IqWcx<-uANOh{K{E%%r{L`y17GF9 zi9qKk6^p4ixU-hesTid6kGNla40sD@_UR z920TVJfl}gh3p)gPFt#+P3kX`K3V)1ul!3b-Jyka+gIKh6#p2qy~n(3%1}qI4Wb0^ z^WJdInCJ}tc?Wel>TW+))xMHnJYq}1m)7`&0p@%C^|OaE3XLMvZr>Mnvr*KD*ilhH zhZP);(OA2YC)tToci1_S!#N@uQ@sH9HPbn(R#x_zDPi!ZD8m+eKT;0sw1letm-n+%D$-JoKV=d|5yg)Q;)PJ{>o)k+?mw!* z^06pgyq-&IYQbmz*0%$e$!y>- zG>AuxYrf{x+)HQ#j6jx4v-WS_OE0P%zP-ZY)#N1wXQ{T~r=hJX0U}L4cN6Hg=NfUi zEZEFUIU)pg4FQSm&lC(u+A6;`RuCY02!%i%vaFsS!B*-^a##PgX_A|!bZ9wl-8#*C zx}3F6#7C^?xr%|CS|XDP-x-1hR4Rs?U3V~^Rd_a8xsdi{!aYgEy|)*lT3x2=%u%|# zK785%FTYmW*P9)9UQ+E%mA@0uZLW?^=F zQ_EDaqRnYsi^$sXY>?fy(&wStC#3GBN^#iuKNKMeLgUDtqa3)Rq7&n;QT{A%+&5SL z@}2T6AZ2ChXd-8EfcPqX^0)&BkfZhymoF)0K_lbjq5F6T#9Lze@3s`|6w}*ha<0G8ks2V;bp$6p^j|FFh zW{ac(D@#Cf-%#FDe{Yz?Dar zRHPt*slTxOrm?5FMj++1;=@SU?@Npg;|B% z-H-LWKv81*c4P`SGaw`1fkgKR;NscHCTT%GRs+(mxy{a$HUa8WWyKi?2X$ML_>Gl% z$0=hx8dg+qPXsiEe5x7o${(Jvr}eM9DywqdGSJW3@~R?zjHEqPu2kyYtJP-M{UT$+ z$WC9$`j=qP0{+vx8P|j%566+|QVU8`^^@oWcT!Kx@3_WcKb)AQuf9~XGUx?(maSKz zkS0P|ng~%Bp6Xk0Fo03z5Y}f0xA77>u{fp@ui}f{H*>fK`zG4l=j~aqyX(9uKWp-_ zS?ijllW#z8d;Df!^??7S_szjdb0Vjd_kJ3?+rUQAP%mNqY#(-BwVJ{)$1u|YRPOy{ z6TQJy2G83skwQ;uMjm9HbOl)ZLqFC?CBvj9H!&Hgv5V;S2#%?}3N;){U?X_?{mT5; z`Zr=;&mkq79@`18eQ2QZUPs94EFi1nRpF495jQ}T&kmJUu36C*U6F#=2Ngf+Gx7CH zyWviE&Rbq-Zt446pONOylJe`@%=9=kKFL;$F5YGxQOm|FNtQ#^sGoW0>WaO(*=60v zgzH-qWBqhGgHOhE9D2`1jEvPd76t>Pm7&bIacNd7eV92wzeZ$208jFkXxensLFE6#Am$Ci*t@EEQG!f zks6Si^Z6=}U3a(8Kt%qj(r^K|(Tf>OlPGtMkcksocjo>mHP_y|s6#V^C@?k_8ABmoc{Q!guFdkLtB@?9 z(wHbE%gzrr+>7+hYVN$1xYVPI$D!0^t}b8C+9)#{ldZXsP&$&>b-bK=t8#TlNNe-4 zMxMVAM&fqeDepi$3&wMK3r9H$p{KSXLu8Pg zhI!1LuFr;fwD6nG%%TasrD;`e^GdOw8?RRk5X3E?Klp`OZ@t(_$qLfWAAoPh#00I# zBHQvyh4FW}w`QzZ6Ijk^a7^**cqHVkWIOHPD8FPYcMzmclta*W3(YpeAA@__FhYL~ zusqkS19QgJez|PH^D(?nQ~}9qc=)hSe3P0EICz^3cd!n&oe>B!%Aewq;W*$<$o6)({vpvOw`qxe@z&|0a22BR zS09eW<2%$$bDYk5RX^H2G@Vqt5Wm{lGMi3PS$&(qM)Chx?{d+T$(M)hUlG4IQsttp z<|On(L93T)w1a)D`TJY=!FWEh~;jotA4XH9Re~pdCvE4tUM6DTsnWRvs5K+kF6$< z0=DkG3pp=V+j3<*!%y6h;g~8{>rU&k51DeEnfEIci@D%i1C0qalH9q+m)b7cCh$HD z9a-lvx_!Lp2`oZBZ4vlTxF+v{dI#)x4d3Cg0V25O8C&)@UHMi27b>|5U)R*DecP63 zd5LkaG2RQ85Wnk7#?^cC&=h;wgujd%Dubq}adU>HsimZP7ee09#LP4xcIckEQTa8e zR}WUN^j1igri*`(L7?nF>OGZ0;iQYR?d2!JzHH4ouj1l$@8*!_Mn!+7n-t5%WB0e! z0+Y4M-L5{PFd7lGz1w5lV(Cce_Dl55ANq;1_o7_IY!Ag=r}OG}$FYg) ziln0MGj!AhE8RaK#W{8CZ`uJZr7 z7kgEV80*CJCFgv%DCNn-L?e!0o^7oFGWqI4TGZa`2pMEkdAo^=X#)m9h z%nHgiCO6%+pd{@bbY1G8&PYM@a>R?dkqoZFgxnjO3anvw1RXmwI?UV(QfpN4hWwJ=3r*c+Vxr-#oDaiCSAVoO^4=yXK$oD{$oWHw;pJS_mZ9~{FI4Wd zETo@ycWINFW1KkoYvFZ)xkA+E>88e5m7A}|wr87_hf0Ts)ScS?^HpRkKkH(zE=++x z)u#KgUq%mQaS$(7L{NLoN);-o9s*^Rc~P!srcq_{{%}&+d~xZj&kl=9HM45J%ll@U zMyW>Myu)6FEmPg{7Yh_fBWbe|^FzUns#BOdeRBay*&nhNnalW<8rs1fuH7?s0VXwqHHQd#fOv=0Fj(zHAT@{7qt@)5vzSAGv(;iLF<@8gd@y@PJ zf_*1rjq*?l?lg&p~ZQ#BTLI7)Po0$cH|x}=L?mm*-VEq=8iLC zY_m>z0h4J(tyj2if94zY80if6yv;0r!O|`_ETp?bd<+k6@GF+n|>m*$1y zM=SF#AoDYy4SeH&bAwB`i{(_WqYG(nF2`{UKe1)Gq-5HtIz(^&t)VQUAb}%}(Wr86 zGscbQugpeI92pr^t6H%bcyX-0d8Yp{PPZESrd)R$dV~5T92(un=Cj$nIX0?<|A?l6 zj3?~Q7yL;BN=vyN%b(adINbYR)wQb3cfDWX^Xz=jZzf~NU9BV)R1g>u8TQ<6dcn4?mJhLdyC2N|oX` zrzlbBIawDhPxvKv?Db^*B~95g7nz)?#_&AW-YoFeSx4N&^daUwRlEaEE>L!UA@Rnv zHE-p8d2yKY1e4S1iY!ls^GDbc1dxXjXan#E)V(7cG#WQ0e@8RPVDN-dh*K2;7aqGj!JKi?gWdpH~nwA_KAyh z9n7?LJm~GH3fx6Wf^zD)>>Zv=K4VNjI|I|NPRjfh==yUL&u{kw#tIco=il6NmPze< z3>Ul>KZ=6W4aJ$U*nZT!3Q-Fq*vj1vAtCD-Sja&I5j6unrS70US8Qh=tk|W#t9med z@3A!4-^x$l>{J=<9SIs1k3!q_A%>yKLoA7VKR(^d;@i=2RqwRnFx=<2<}h zrYFt9z!>#C;FaAesGe>CrV491#%B8>v4Sy0a%x*yvc+Or65WRH)KfCu^g~bl?W4YC zQ!RS%9;|j`9d)}kEZFxq@j+!DfTofZLXI!20vumYSZv5I{+qnZhWv&x!RHTsw4&Bc zibOdDzgxNfJe0rwrK_si$&#BIWJ2JLLY0AseFjBCoTSF^WGD6W&^};*z&dQ3Mvw8_ zN1kRIfOX9G`#!<xnQ_zw&NKz2#1CE+fbn6 z{a6+Bn2|ZhH|!;!d80C*2hEqe71n;6@`HCrGx%CMS}nPWq?PZ*vd~qBx;r$GZV-2a zpc+HoFhg)6lv=`iY6pAQT}|u3s3)ctav$I5%7mcvvnle|mZV0b+pN7iMtt6RgFFbM zn7;w%VhrIVr(IMOv24#tH4gdZ*$JvK3wEjuQtf_}YNsGlnVgFoS@2e05*E~bIgMe% z;Ja2IHJnZ;>QQ~M1Mh0;>qMpq8NKpeM`S4Ntp962SY$m=03OuK8t8MBsxu|m z4LxbV|L#>_47hYx>*@MS_*y8qzFoDQaJtr4)I4w9J!?Sy z?zy&C%AVorjKOfjhR2w|uJzVy-frIMwU*I#P0hHW3|V81Nz+m#v)Qg^1us0S-F>fo zs>wE4>@N}uFHDytNa#a;iHW@ z-jtn+8QY8)g}-dk^jx2)Mz6TJ!TLtL;(Nb9y}kX)&CmJ*$-~5gS%!UB#pIpHB{^I_X`#jDXCAq%WPx`SOf_PO-4Ryz?j|q=FM%wud|{`^v1XP> z%z+hjyps;glr5(jS$TQ<9{ar2DN|n`|8TQ%@ZrgmCxT1DC*|~Z`hE;*%XodyoxsYj z%-AE4;2*5P4KX1AZS|g@IVyLUaVK_eb`R?ZmWLH|Vtah+DRI$!#QyxmX(F{J4^QW~ zi%jp3|MR4*gyKfu+K%d`>u0SKPX3Bwd12&uU=)KZSSwmuEm@9&M+*y1Gq5!1rTJTZRY0ov>{a?BY~*90py%g!T(o{4(^5Dr7=R{}#=M5zZnR zw;G%Annm#idOTy((iOa_YFrmkeDtO7S-jmZ{IHz-$a3FEPxcJETL8Pfm`m(M4I-m- zY8x7m57?dmT-3q93f0zLJ8|U9ZdGz z6>?%nohr$E_=wesk`a%1+6$qCzS0|V#ZXBXi`4fiSvseD1Mhr7UxWXX1e%R~k(-ii+<$AX^=`Hb-!A%lLn{ACM1td&3yRf&m^NM1p zgwlFUm6J9O)loT17kwOtNncJFaDQG|e8X1p_E{0>F+9(=@5A-lY~%wJkYe%KqeJ3p z)|h9ux)eyJ7Cz(1iki$`bzVu-hQGBQMg^`^- z;V;UjymCf8Q)blh))PW!GL$ka9V4=+=T$H-Rt9?CTS(D!&yi$opa`n?^b)2oYvgvtJI@hr8E#o)b=CO!A&xjL?jjzp0Vr-<8_l|Hh1wVB3)}(U~H@ zNSBxltq?tQXgA3H`3ci&LBg0-mU!gS8}K;mW4=74k{We+s*-oCStoUjiQ4}Q|3u%U z&#u)bf|n#gcG};YSpfI7?0Slmo^i&i*C+nmIzPplF~7~IYSH1=?_K~#ei+iCrk{io zQ)zBVe&4BIJkVqXa%^sdTw!ttdb}o>gQ*G0`$j=%V`p)L8kV~){weQP4 zo9R#josO3g7{uhFdOzGxCNv`;-tg@Kuk4oDLwD2`$aJ%ZdaWZY4Hz7H3I{d)EWlkX z$PlC_>q8~H_&Im8d;}{Mt#vYc{eHU8Yb)WsBWb?g!2Hfywl8Q98({Z4t4SDyhNjb# z*|?g=!g70+)?#-zE86z+RP{f8NJsx!LMnA7@9E8HYv<+o3-K@p4NbqWor16*^hHll zgwwDR!y~Gnb)S1~nlzkk|yfTBF0G4SD1Z(dk^t zYnjh6`e*YE&IiBBXqnG4yngUkjLa9I4ebwWqTIHB_%Z0E)dz6vgd-;Q zN~=jTqHZ65^tsK0gTqQ%70*mAS}H2En1fm6yeH6ITpNxSj=++#u-X7}lMdrg1SYRU@pCE<4R z!pr#=HFQ?4to;jtX$xYtchMl8(FXAaSI_h*ax9u}4S};z@2AgmHPPUsartmYnN=Gu z`@n4-SqUXo?RZe9USoSTe^ak5?KV3GT}1eC&;0hpJ;izU?v%=Kid-7{$x-yYt9Yzx zH#gps-(jmIktJT@oJHo%^qpOG%?WkWZFZ!|cWKwZbXn*iE z|FGka1aOfT>v|QWv&zOQzH_erXxPmjb(Wvpee3u)ff(Th^GWugn%zQAHx4?&IKZ>6 z(Rsdl(zzPs()&axA*C$PUAPt;Pp)^grbiYx7WG=GTOpLPDFH=%Nf9)NoZo{0mrhra z49;EJ^HqE!C)lJXm-V{u2W!iD%93-Z8|d>tL4dZhPvMx?>D6z&Q;>cm*fxcc?xS&G z;6TfpxGN%EsW@@PDYFxng%^`K&7!J8o1$~a(@dDmLR$UjHBkUN36>_l3IP<>C>TBr zvw)m-0Qx%nOasL5CirI#&g&q+oF6iJv)6k_FbpGiyT-R$acNG0ZMS#gEX`9dhsM~M zq%w3>%jZey%`Vbq=?A-qMJ(-SeLvf@X!y2L?X8+sx)XEPE!%g>rt3&-N}LC`B$~an zb{u8p-2LSlPV7d zt#D^2E>TqCX&a~FT4meskFV~(F@zWNs_$vKUX^vOqka6KxYqf*APWjiFKhji`D(?c zqOvm+)^x;Ifn@s%=e((zOVSDBQG9DLqCHwA=gj0_$XQ)RZnuIHZfIuBVX6o}j^@KEd+V_1si#`z6Z` z@r=c$V(`cQH-_TpE#JCwp2f&p-PbR-G`N!OyLT5R+)aaU14z5U?!~z%*vYD=dZc-J zdOfVnv`}RA@VL(K5#o>I-K&Q+e|q*F7%K3N2&In32RKgJBu}j39t=ENdCBioP$wk( z&c^NS&|>*`gs&+s?8f+LWj%Q>oYJm!E#jie9E0P$bZuMTNQKWcRxbQ%%drUfu+-Gi zXpoBLuz*(~_3>4eCaTK7vMJ{$1M_Qcr;G^&3@UBQlBBNW zR0;(TudEbLj2pza$!(UONZ|W%!J>t;9X7SNqNsH8=LF2nyFin*fa24&3Z3QiI>U4r zW^vxlcX?k^@Hv&Od^g97^H{0x#>vroZ>Bp4*>r2HilQF!$%H{-NIZpEBtPVqmRd0~f{SBnk0 znl^EP>#A?S=>|9%98N60#m$$lQ9v}P$49{0Pjd&i5sg{Y6)hmV%zy9;3PkEc9^|s2E@0Vj|uKw8jtB9b~0TO$F?Q=^c-(i%FOEya9l)J}mA5FY$9#-a;Fe=`!$b?<_I_En9fL-^A=&egj z2e|d-5nvnI&H~mg{56Xrtm(I3apSV2UK4J7r=+4mxYH4ew^O9=iLH`)YdjA4sav6(l!Z4=8{!XbpG};d z7NWRs$8Uxo71|T-SEucgUB7q?$(DDO(*CZSpIub3yWw z1rSy%6!p4-@ zA>PRa0COcX?5gFT-#2C%3d{&7TITv8m2O5z(gf0Sme{n*N}l93u-)g`cZ_wF-gu=b z&)5;c@K8f*9y&wp+>1>ox{VjQTJUdep5x!@1hQVgo{_l0sAZ+h&*{Ps%CWWN;-ui{ zD@&VY^$ec7+7l4Vww z_aNLsEn3{N_~fga!n&Hev+)lw!r@2A`)EBZn$eA$Ye2(_K*QoPA=y7_cEt!RCL2;G zguGw9@M`%6f9< z11oB?uw|^@p8Pq3Kn&;aJILGebR|V6u+cg1r}+M63A>vQ@bzikk)JKiUYH4wD=%!4 zVk8{RPim9|21YdlWxH9D@@2}Q&8{)Yvpg8_=2_NBaXfW8?ajI6S~8mky=qHl;MZv7 z<%J7k^zy4qW~z+DcrIUfV59t+p~|Vpug2sSTSFi4cOx8WA+_byH?0%+;l@Oj>Ytl# z`}>KTv0^_`S>l6`&ox0Gxe~eT=KG_XTc-gyM08Xfr+qRB5O9$Bp0@6UiNZVUF_FPl zEqJMpxdjm;weEo=`}d1Nrhuw`9~FBbXVQ%r+fyh8PG?drqPWeg$P)5tt2bqPm4F^s z{9ClYFCaeqvCyRx!Rt6Abun&01po@TeGo!Lsy*nZv=-=R@yVCFeE;5w11`(IF73uO zXMhkM0}>QBIOVP#yq4Wncf+JEBn-?0j<^WE8Iq0P55Wj2MJ)J;0l=3-!8Y7f7!>t6 z;Ij%zbOVR9*|;DvQxXY6$v;<2%7NLl!M|i7l|6+LN^GS>aI3B8yRlY|`3a4Zz>obt zRMP;2i${#9bIX4wgA!c{1SQJd21qa2PAN?e2)f^A5_B7a>bdMd=FR9!TXtWEe&HP4 zeDU`ONRYTO{duMZIY_tiq2rJ(GS*bI7I)K4NzM^Vr*PYFM@G>W=zksL{q1DqfbNKI z;A2saNLWFPfyG#4^R!E^%aHP)1I@8lOSA6YvtSA^oxBC+(sS&8=2EfKPR*7D3HL6# zO~SEJIR_$W;O}EQ53JNlxP05}MnjWvvml*y&)Mhog0sbn^+<+9Vrwye^ z8r-~=<$yOTEhKb3Jt19^K``+5A(G{!)~)rkY)oh-5M5$Sy9AbWLbwoFz>6zNDtmzj z`hBRzesvrIvLH;_EoRCzA{122091^~jjm&C%A!m}ECHsq4+0bZeGqb56DCSS;fiVV zh*5Axkcwl(WpsrEN@CN2lmj;L_vsixm<%h0;;Azd1{?ak<4SO|Ycr5g|D05D2+0#I z5F=WkRS*_Sbd{CMQjonD1f_gq`XnPA>*Mx3?N0QQ1hoL(srQgAQ3FR z@~>vM5+6vry)OajaL=TIw9>MjN@N#_YX@D4hE9qoJ& zRvpB+llpj2b`nI2EM==D4z|9|C-87 z3qT3SVdJ5ji4otx6%+i(u!6j);E+B?^1#A%Bb@a6Ak1cTkUe3+G$T|#>Z-AUA0Z^r zE=c*ygFyoK`&?|@C7&|Sh>J4qWcwh{z#&-xgyaMNBUTIz9%#lGv@r4~>E$uEkY-n| z)ISWKunH@O!UTb}0gVm9QkPZ}Zbhw4b7;e#n&=Da%Juq+nt$xT2~gVn#C2|%UE!Ch zS^bFE^@)wlf1ay&8~JeUh}bqSd1Tp>l4x|N|95l=;AmJDrE9w(Ea*gRhOj`^(r9!UU4JK9N8;E}nhiHD0;uLBPUN^@ z&}ZOh+P8p-L=c1@JTA^=bio)gdB2aLa&k1m);ByJ2ps$!=Euf_j;5M{v| zz2(oFGKA&Xg2)kWpfQ8&|2)MVC0 zs3GRR!^4#jh=G~6K$$%Lm%7(+QgO!NpHQHdTy}&hLYeZSogWM?C_g z&Ag9J2CG)mycRhS4U9J%1RYod8lCXZHPO#I$ZU~IaThJTc&NSM;N`)87a(ck(YH%k zo9B9 zIVAIbO>PnqAx+Zhu&+he1*{e8G>HM{t-s7 zfRw*Yj1y{a5PAORa)O;&nhQjkp2y&$d+z_Q@=tE~Tjq)ZASK0je-*9l!~Te7m>1zM zt#}8eE>44TvSPxN$x)UC+*Y|EeiQ$_2j(|6+v}lxj;RW!<_xHJ!lgAq6KNM{98ljL91a z6Vee0QB#t{pSTUf!<7o!FTq)qe3PYlj$Cw|baxaV?50DbWoo@?#xdV1EVo7R-v<*0 z0lSVzoP@aDAb<|r4Pur&2jDYONaaC70MI=D zVrNY3DU1}wePQ6M38z7ywm$`7>PDz&k&Xy|j$F$8!v?W-ZScRciFea-Xg7w)D`{v8 z6}HGO;Wm@F@v{AYfHG{--JKhf0!LW&1W=O)d}}Z*um-EEP%(j_K<=+={5oO6;SakY zH~|&V3EmpW4H6Lu>yGFyuq+WbdHL26&YTVP{Dx2<61heOW^-a37Ap&Y-bGxz^nep>74$q5mjXZ#zs?s10mL7)rW| ztUvM$ppw}t1c8tFJ){AraqCPd2mkb?gcvAb^c15x>_Kx7f>ls;_!PNRCfgY=s_Ur| z#Yfw2^Dncr3kN;@Jm>2yTpJ6y1RuEhJy4(cg@~)%BMLCFt>QFDG4YSN%)ARWOjPrT zuPX+-@7au!9Y~DC!91KnAH5Yc#nH0IqDaA9tyo(NDx3+nL_1Xdp}Oi6aZ-!sGcs#{ zggOt*vXC6YovE93K~y$6=B7CRd-=$NjOSG>Mt?&;>|Kxt(OKkRxZ~(8pd9awXTJQ2^x^BIPZ@OGh^SSqAY6t7u2WOHf~$kf%HQA1c+O54j;E7=$Ab`YTW)1)&c>&ms9TKYjq_ z{~Q(c08}?nNOaqok!!0(eK#!sIf2t&iDCfGCbr=acxOBCyC=q@%czzZwiDA-KVk@8 zE(1{{{~Rko0+jWXAsf-;f{1ko0q+R!VL3aXjs7_cBS4SDHKTu=>SrCO`mh}t{qt6Y z>j2GmL3;@}C{4(A)TXnc%LDxEzjxWro<&iFYAYRP6?r_g`pFD4mU{s7Dc(?mvB%-h zRZ!KVajIDqm8keY)<;lXu|PqOcH@ATvYn-x*GzG&^1W$7GH^YueE<6~gh2pB$wD$5 z$`qHb2WT|l0|^51`<1ZxDaVL%jhYtQ%Fzdbd2W#szt)EV_(IZJzYY1N%MPX(L?QT+ak;X?+Q%sNaDDV_nB3%*>eBO!mG=LO^Qu# zTS*I(wK<(%SH(a@Leq4ZFt_W=u$!KuPHC`mc#j;(vskIS12tYm0j94YqCTkzGw4R6 z6hp=hQWyCfl;q0gO}Po5X?0k@FU&foKUQ{$4L|bo`+PCP$>^iDssf3DTEhFw^SLC= zaU)3!i-w$eIaFaolhyX0EzW?=#JhuTj7h*|C_5mX(v0JvEI37;EZI*->wMU*DB#A0 z0s=a4m!bS}`sUGS>)eTrVU2+uhSwWo4HF|b#J`Ja8vSrqd7ZZ9cmLR19es_2;bYGU z!{%=v6Fq77_J))<1ioj8ym!RT_ZIZ< z*UQLohYx4l8_m82*7-6&>O$P(ZC!d^YkzBhI;?^UYEmg=>%tco&7sUl3j$xE_DhZh zqtOR{hYmsxz@D7b3~%>n&Nb!`hqON#;5|I<55x~%_*DXI8gr!XX$I}!H$mS9`*AM4 z1nE{w#fp_R7~y@>;>5HNt)>ZIJS1#I+2+yp@#{KMFROX_$k1+{f3ovvQR2QWgH|K` z--NxR_nA?%XCzO36dtV+QZ`+Q^ItRE%oJ3$(r1h$;B_CKmk5QQg}7*Fza!{DWUCMc z$e42)zkS6Vr4TLP$0MQL2OSmUtiX4y{jS95n6!V`y3+1|U-tYLkCS?B zmQo*A&SL=Kg=)J~D1?Vaf9pGWD@eMv1J>Regg|rz_uO-6gq>;(^&`?ziNBo$;V4{b z{oLwN<+ITPdhV_BzCLA?Ja$|%Ydn97iAw&n!xZVJ7=b&wX>FF7@yo~bHV`XOeX7UlA~F542r1=6Xlm($2wp>d?6NgLo9uEzbHHL86M% zV{~L{cKW$R4FosjF@IC6Efx~y3LCyrRQpS^IqdX9of_L_=JpROPY#bs;D90H6C$uq zVt*G|qs{0lD$#v8kk}*Qgch=Z{s{itDcYUjg>gZcvP$|bEgE9!C^C6xn4fd$yTKmLWUOx%Bz| zp6B_aSFb)F?)zHKd7t-rpL1Qe+nFz`i7mfH2gj!Iy^T?(-AuuKG70`^$A)fXvDUZ?BeHx<~&W*YdFI z;1YmU5lV8oU@R5tK9H#J9sz{T=eiwS)^dOeqsh zQ2#IUy6|Yp9nkxCW-xbt`F*1>RNsN_pPTz`w(b6kA~dxkYrXXmDe(^4C8s_h?adAK zHl9v)P>@rf)&_rL{ttq-b=ph2GfYlepBYhnx0mhPm<~e=8#D{<`z^BR>uMqpoS$bm z(8~Ki@H`Mhn#gvvA0QMWLHw2;YP*=;!Pny&KIFg=1I_n~G+)Ip@ifL!XcP&$4VMDL{cf6k(lQ~nehX$OCZJ+$ z3_!$1;5dDM!hhRIA9z#NfA%lez0LoYb}g=?=%T}*Q7+S>rQ&P?H-qyF>%fQdW=>qV zDK+f2lDW~Y6VeRNd2iWVD%W8)QSc*DY!kfG*rl&*^m=ru^IbM+K0Gko+a+uBy^K-a z&s`n6Zz-IZ`|-mykVh;REwVORWJ872>+P_}8uHXz4qUAr3D1!6`&vjD;FKzLy(S|> zZt__s%p7*#(RoG6V0)5pk5{b3)^W>~Olq{q2j~vkxV!0R#_pzD_J+_YM*71{X4HV^ zGQPR5R-c)`c=1TQcKDoTc8Zx&Wu6v-mzhS7*MuO7nHDvEmxrb>w@C`?Iis$RH4`QU zIr*ATRpef>e!3!QHiG-| z(`40ihv7wE1>;-d^EElYb!a~Q=J@y}T5xX7EMB;TI-}K)#xr(a<~=S`_>&PgTW%2L ztF?HE8t(20yk{f4C-J}cR5ebu{_da{e6VK4Se2k4zf;h(Oe%u^T?H!)mNtC*`E~qq1t_rxrbr4CmZx$tL22Mz~!6lbR z;N_~gjTpDn?qRL3j&PBIMRBq4m)anU;+axpoH!jBU!PsPvcoo}ij{>&_dPBcb-#+M zp-R^~woUWybt#QM+yLL{7W>YME)nEvptcTnP$cvqHl7v&0m`DiDecD#$}?jH=I7TL zVmQ5b4OgVQJu#rOP)xUiyjx3D;b($ehU6HeG%KUsK|QHaOt%h<;4PNmkNOm6c> zS!nX9uFcXnZ)K($IZn;Tox`!J|xJ5 zP{u|XtVFd-95O4$HqE|u0$RkvJ>biLP0H&vrbV^6V%A$&K&HpTD5J#O;!kom{UWom zJ9Dr{F4g}gxTBIREjOL#ukk3)wHsXQ;mr=CuJM<=dit?mrG>(uo@uyY_uGsxRPujA zr5gMpW-3*~e2&e|@*t z&{RNT2bBc~&ubsGdJB1J0*o&MD(@bC1{E4^(EawtXc60MUrZ-1 zp@a+i|J<%_2|+{|j^E{56fYY*jEwy3Ws`?0aNO}c=kZUKrRv5u1sa^2*pajAAX+?) zH!wOlsI0NTgLT$|r?`>D+-$FJ$9aje(5{W#AYL|71k)k=2nIB7;KL7mPjvS5>VeHm z$dB&WVpP76xQP=S8Wt$aayI(8A(&?HYtTt>=G$YQ8$#*E--q2lCsE|Vl*=;$oc6-p zbZ1YDDvt8Z^lBQM{x&2I>n$P zPrivZ9{9vKc^o{dRswRpk~g@_`&}PxaqMMx=@RPsK@|TGj}|c7#gkwq{iNNnOII@! zv~yv;gDQe%AC}fTm4kWY@opwn%r=XGc%S^Ug-#!5i>$ixcneh%nh5*gyUYRcm#94ErgoJ z7YR2=;CuAe{qw2mIzD@qQ{J^?q}!kM8FMO)kBJt+$U^_~o|EK#Mk0nbfgP51B%~lOuZe%ntjtpw+?;AuOW7sYS zgzLdwadB`Q)tR{boWNoT{)m~SQV_Cx>ePnhXi>?Idx({~d4;MLFh#s{otpUNqmeIv z`kqxn3u=f=+=G2;&{{m^p-0P$)+-n}RTCb&?RTTP?4L&U2K+$L>-%al0KDZLJ;xK- zv;zP%$h*_EdchQ&)RowsqX@)4-IQ;9@UENOM8k9X!ZQ3+7Q&Z>4H)e-8m`A|ccU8? zx`oLNtFB&MzJ>!o4?&Cg9u^THozNGR3G_v*ne)0|ine83aI39N$5b~cr?|D!C+Gf} zM~lz|!6D;aGh?++fjfpCL63SU=EiLfK2tibOYGh~IE;5kRw@yy7?C1PdmaP`bP1Q} z7@_>@gMQml{(9rPbf%sma2&V$ZLYT0K?f0qsDnkl{TIK=^S9#%QeiMhzSLeE5P~N) zJsUT7=N=wTX;Qo+7}Uhmj)!Nx{|soZhQp%`iG~en@_}Uq2(!Hg5A*@Z$3(A#THc+V za1&0;mu41!uq-Y<`la^DD5`I3q)Hw8(qt);xtA|k>qwM_@QqM9QCo`ak?SKeyI_|aI$8C?C!;iQvcv)j4t8f8J0IVqzf{`l zf)GBogDWkc#5evDY~DprW@uH^o%PiZ&!ir=7y?lkU~ka3nYV$0N0 z_suY2uUEETrwI69EvsLlY?`Z5MJuk_bBxd1I))|i_uJww&i37WJ-@p9;yx`I+N#nh zPZOC9#`26nWQ`W#{k)L4FIuGZzli)w(LJ_kTjOT!xHzSvU+D4ulgKHn069+C(V7ly zrA;1eM;Qk#dfYsZLW$F&S{IlQFDq6O@a+)f59@}4Y4BJY{{9=%$K>~83F2lnf#{GP z(Bt^2PiA`f=MuMsS$7a!QC!l@7g&t%lMRH)YySm1xUK_A>ymb~)8*WR8S(~#^bcV? zCq%k`20Z^1EcYR0ExDmtt4Pql(WPzVNo_jK)oA67=u%%PEL&un!q7D-10XzXX|D1W zYSMStykMn=eZzpIHEPHQt=^VW|_Zg-mE#^S-qBmT`S6yE%*zKbH!<9MA9b{)1@ zTp9wEllGHp;|###ehC3Rx(y$EslH18piVZ?U&*bx*2dFKUr<*V2V|n zzsxqK=E5U^GPmfTtt8EcJ}(TMir&?q5q+Gjgu)VFCgu+ti>+FKGZ-iYTsji3kmaHI zw5ek~QkJLgCazxLV%KMXvuFIJcwnxyVV?9&PD{f&#u~jC+gw~`HgK#_9^9;Kjmv^6 zG4lX^)Ko58Zz?!RD4Femh1SZPDKl@?r>O%HX3KZzioMYyvOkyj5Z&_HkwHCOzQBRa zGs80Xm;Hol~0|xcr?VokV`Vc1O zu0t^OqfoQ~r(l{O=r*ReH|2a1@k5wbP1!&=J#r($j>b!bV8kz}_>DrDmk~8QxbigJ zw~#{7w+TOJIs9u&`rDtXUh^w<4w1n*=Zk*nj-D{nE;$^1zQDr1d3CJVLz+xiBubdg zJnEoGi3-L~;Ln{5dU+XwVQ%YwvPTB#uPInZU{Yv^S<>=CWv((-zP=x&>0T>;glgC_ zqy^96de0Z!CjsAsZ=}vNE!_&5QSi$ zEJyiO(}i&ccXO6Z*52M;b#LH8yA%Va=(Pu8VI5pXJ;@Jbl6*7we{p9;<6)%!XRigJ ze{;SH5&!%eudUxc_7amrE05FVr2?maww6kymok4yO{Zkuz5Mi2Sq^8gh<1RDQQiZX zv;RHC8RN(_#&=P4rhFh9SSfOTM8l+?0WqB9U!sS; z)3SXpSsAh8v!eKRWu%JpX!HrQuK2xsp$3zwYCYR&{qBXSlK0uErB*{$>sW$(m5>&* z^{u!hp(xXrtS;7`4`_XgWu^kMRK+~CYAR$|TxgX=GDz9*%@@9%O8eP>iWLE{j8J!B z{Rzk)l>W;Y%R5kNu%0sj7bh3%vVADM5Hm+t2pa4dT>#D=S{;bANuz8#z8+~ zG-+D8@YF$Jg^8P0*V99c>^kz?_TtpUh9qQc%W{0cC8rw z^pNiqB&hHiR@gmzF7~zeXjOIJ^i616VVI}}&{-b#NX=~5Puk;n3&eLX;5N<|1KT8e zcR2`qXs+%Q@T_oBaAEa;D^4A+>#yTqXryh}lw6uC55?vC0l*k5_BX-H{sJ>s-o0Se z4zSLRExF!3yC1K{(O8yc^k?j<_kibEhyU0QyL#{$a$V?3V77dLe*Kt@ydaB(o@?0}%^(ww!p z`<8w#d*+Ndh?fHfnPcVLdP5Ht{P# zbUciA__G`$yQD&qQk?CQ3)fInABR+F+aXkku|2Jh>&HkstTzk6G_;>67hUEp3~8DF zM78wOKmKku%h#c8ksSf4?wQLBK`9u@#9L7NP`?3i20eL*2g%2i$}29|>u<2gg;c z6iI{o(8W7d<5F0g&&&8~tX9E*!U)7j-AK;NB(un8Yi50XtDdF(C!&-vT!dCv2v+Wv$~@8|0DvkKct&uE7v^=`sy0~zW8yiEQ*7D z%7nPQXP60J^lnS;obgH12JHYCTRh!m?e}bni@{3zxj$X4lH8|X)r2qS=e9Di(rymZ zQ!^fX52tlZ1TW3_O&=;KyH7BKxVZtV)^(5SD$JiLj*c6dX}8lONN@V;)WCFd1w~Q{jwfr&t?vwPmQjk|6N1tm zk1&4*;S}#7KZb-dsW_A@3Hn>LF!uqr*8+uXuGqOK?M{w}7V%2-MyW{@{74np3ju|i zdqThQ1ATz&?-nKZVeuz{AD5r~FRdqBFN-qiJCY2^!~|tt3@>{y`01{H?>;uyXhcPX z&7E>tcg=w-@apL!a}yy|wA%FCX>Ud!y>oKu!uGU`ZZo+U5pI+m41EFx>gGOV1dPC< zFxKlZXWVeb#r8N^+T#X63Kb z!PFFoj1S|$N5Ic+K;9ah#K%^@mhIacEp=!ny5o^!y*BfO>V?|^&R~0m5E#U|6e~l3 zvsyqVA#o5QMt}TYssP^{Rlo{%STIVH4bTjypOw^iJZX)0#cT5Q5eOUJ(FCMq^t{Gp z#wspI+6BuJduyX^gwv0{?>oDEoSH+=>H~C>cBgdDzPh^#a^H6C0EyF77TXB=5(3U^ zHS05GuWDmbg^%Td3Wps895aNR5*C;jc(ADElV&P-pdrzhkKIwrYBc^VG4l!H#~)Io zgG5||dbkQpy{`cUE|?^AcW!Dzry+*}M7Z@N zED&-g56{`m^uK;&nu&5q%ng+Yce&-tg9 z<<$MOIi5;nDvn~?y-lCwEd4oM(-`BD7evwi{H=m}{H1=_TFNlJm0>63-fBUu@EH}@ z*uDSbrCA6X4_f^bIjZYmH{pG7iOoY7j-JnAbFRDLRdZ-FORqmB$SW*E2$gz}y zr$_kka}yZ_if>NC<{Azyb+WUc{Fn2y+M}Oz@yFR8LTPF}@Czs4mldP`w2*fXAP6^Y zZHL2@;K&ekUqCu1F9Y6NWy|5W=K*bQRvO=Ze;ZV)tRNU%?s(|`mwa8TfW+w>O^{ax zyZe+%MQ zg&?s4Q6Mx@O3^K{!?!ELqWCgoV!*$SsX`<#7oI*Y=zdOjpni(}9QH17xOj1C|MY5O z#}?f;o?#N_!%ZESGfJ0BU0{Zc(IPut;hmjB4WkPpVboz2o>&m?;-8@1YhSpwU50A> zM>3l46E{KrDa@`DzgV)Y^Dq)JL|9Ji75>r2E`*K7z^}0^-K+$*0|Tm^2d@oyZ1)QT ziD$Mb_qOA2d*IXSy#SQes~^foRD>T)O-rojj_ZQAPIWjH_d~*;I ztj9^nK?v@fSFi9ckiJN%CNEqLs70@4--Vt)SwzM(hwnxKZ7$&H6hmd-tlOFT~?za_n z-aYM9VxqX5TqlQ6nNoNrG0hTfc?NQw^;=gnQ{)MSPH-kU5*tN zr|F%vVPkr;P3M@S5(LM7NGo-Z-pEJp8}6c+ij_@G;7~+vnd9F?w1fw_^QcU?YaUrI$`*uKIqZ zHi$w9Yj+>IJ#IcLG;MsN@Dh&f4}ij#f2VD!dThcdSn;}t;n|Q4390^| zj>7gc#P8Mp>85quf9NmU6UMc)rDGwNHl2v2T|)zx*&Ve{EQ}#zMcc zk0}Qx^6EPi=Bskjlyxx9DzZqCK4?v&*GO4KQ79muYp-;Sjm9;c>ehES7Q}bH$R^nC zndFBD#ak^P79C!fX{s1NT3pvjP}$;-B|E!6NR8wc!CIjL=hA)+G?gzp!*us+9=-g5 z|0J6)`#}~$fsud`B_G{l5>Pcg6DLgme!AF(sSf_-|F7; zolF@YW7gKz!jg`9^l-MWE#~&sEnDotd|vJmnTRzxtjSs5HJw|jxm*%4mq)KtowdRZ zM}4s}BS!egxhC?oo5F05xKo~Q*JhT8K+=nM_FG{sxXl@m*hk8scp!yGKNQ?nM;yuU96z?azsZ-=7obcn!*qzgn9myXp@4?6VBB z!&%-MJAC#G+^OVQGZH=;XX0Ny*+Q>VXJ?0$ZvSfOHLDxPOY&We1xvt~8Z&B=(yq4N zct$8^K=4bRrT;M`l8(_tz`}By9iDeh9EcH-K$$As5PisgY;yUCI(7UEI^X{)24@jh$a1IW?*?C;uJ=KY{B+y}2 z*Z1@Ti87y2o|nCPdH92%k>8EDlm^YD5EH{(kuSAYVSN={aV=3fTgD$x%~2)-8Pj?P z)dnX%d1q52)q8|f;cG&1e=fhxWxY2e`}Nl>G*5`n7XEN3$l{{Ttk91`u;qSz0S5~H zgO?LYOOcFzwmTP&+f!#2X}--Qv==ub8q>b!u)nFEe0vhQ%MgZSg2e2Aw*ZAmK<=>kT zpPFNm68~kJh60@shlxK@Dl=dWQuDAV_8`DwXLhWUrw%4kg0mvwjG&Li%w<)is9Qd!Mc z`=qJtu`jjWCrwSkyQ?Vk2Wke~)z~6s+vsp{+PdbU3ja@MEPc{kcYhHZn>1UZ?<6m; zE#%w^VCvNu!Ow%HrZWq@M&&d)BTerIY$+SIjIesX1_0+iJK^+9V%O}~ao^4Wx>m=q zi)2Subd7^q_~70ZQFn|twNS!5lAu%%F{QO`;kE(_L#3FCOSJoRh=3^^h-&A{I=`lGuIsTe|{}VkO&@=iZ*Vy&=t! zc-!D%PHvr&*pYdszx(W3)aRnU0ZZt+J+{Bc^tEgL!$0)54z+3g@99of0z-N`#)43o zq186(7u1Z8dFnhdaS3bj=cEQXpjD0~E<_6~?qKhG1d`T&^&Rp{L5Tl9a_=|nI+DOR zQwb3H0a6aQu(H)~=UyU-&3SsGuJc&p9udcZi4@l|U;kn#_#LSkXfNC&LJg!hu|rfQ z;CoXWoG}rTrgFxZ6oB&DR))g#JtA?iEya68IuhJ^leB11b%MZGfx&QCy>LHYQZ5?)vtp>HHX&=IV5d#Hk zAYACF3u!ga7t*O0O8zP|5snM<$scAFB0k%U&Vr%_uME*^E=VoCykkIy5>P!gQ5ygP z6g_|$3J8Nxns`WotN)JI%)vzqmQYH27%8sTEG3X?Q46E{b39+=b}p$tgSWDAoKA*W zc|A|JUp(v{{2Y+xRT!P=2+FG1pf(%L~~ z;AoDkJ!}i3N^MJ#oWKw0dKsKZNfOj=c1%B2f5Mr!RQ2q`-O>?V$HQA0Z2x{dYIw$_ z=rt&2n3zi`KNI2_C$m3Mze;z%pzK)$>POoLIZ(VO*kcDI!-F96xpNYzsSx#%=7CnR z=ppH8Q^+}n*WwWFp=25)$fe-_K)Tk~1U{&_D)gl`4^M~#Q0F^P7Vuk+`f87etB-li z$j}E8@0BNXQ}`uQljn4$52sUaY|@OiSxut!`V>f;7wsE=*^#E;^kc;1Z_afE^sQBUqpyISF z5H|35HDJYTS08PQSMs@hZtbGsK}X%GWl{XdTcO{Ace;p6k%swWLb8ND@n*uz^AL+-U%mB>^xfT9H2j|8AQM3$?bc!b?3H%6p#w4H@}<$o zTmAsq3mov)BR!zJ00mJ6cQ;en!Bpy^%`<}h9RzZ}(R_4|H;!vjUo|^}jXg_d)i^+9 z(c*py#nFQF_QsXi=p`hPIt2hFkpB$3<8+M)7w->=i}a%YxiSdXsTs<$;+juM-Lzhl zc7;Ge{azQJ>Q$AIG{z=1$h>*j8?~v{@_fRPA3%uW0bC^DSGRqpcW=WFM1s3|{NNBP zxQHV!fjy12?zKI02^W7>GUCdFQ7Wta0hgm2w!Ocj>(J+E;(?Zt3MMaIj(5k58UZ%S zt&nH>g3-)@w1trmHYA!^-Aw{rF_rb>piV|Y2m6$YU@UbgmGa^JjvjSDwyQ(4p(~Na zZp|CaLI+)@9Y7TUI>-6htAIjTBUT1gYFf8Lu*uycB2wHd5T^PO@XSc?-t|iW56#Ru z96xHttp)*;)lq&f-?h+l)a)uy@O~Ds8ccSufqO9rBAk&3lnkm zU`l8(R86g5N%jugS_dC{6Jht-AHovAZa`XvlarsJax6^w*zi30JNWwz4U=fsUBimU zW~!jAC-c-D=^&ti%ZR;#ljTN@1(xF_P z1c?Zg&4CTgKLGCnVS;PrXq2hZtD9wj>Xve9--rWPcDi;Tm z)2=D&1X`jx;4sGjD1BL69aQdy%=mne>L8}W2g1sTvBT1(_B+_2Ts09RE4_KDyU#}U zB)A=eBiN(r=#Dg4PUnb}*Rb9RI1*UDUCs*g6yBZuJX4#wU(*5n?Zw-p@$haInzu2m zTT;@vdE0QKS&YbqUx%ULD1H{)qUmUU1~nW6$#4Q()Yyg6>Fx>;_L9WhWUoF082j~G zJU4^Z$RwuMWSnVKRvPTfJ2T|$(9uLqyW_M&UsIMROlm@gNc3)29$Jv~j3US%ZCe;N zAxf*q+|%>s9rpf$XP>*0u>1K*h>zzTVRfCy0PUZ)G3~$&gIR^9CbdFqKZG8PEg3TC zNvyqTff&qI#yE+A2@9l(;V9q+)WMZjqN%0_OKMfp8^dpA~!iRb|G znRR)<=(!}*g`wpQai`#;mavf^2V{8yG+jHIy1{;;!N?Dkshk5jwLf6?NKXiTv5wuh z^pNXMUO-sHb`6>c<|}Q6X5$AV4bD1-A@ROal~{a<`|f)m4t6L})TK$3`;S%BFDvOe zr6CZK=PM0ZOYku>3ZS#h(Sh8V7U-m!LUY@~j`>7XzbzL20J~6r7Ix>Ara)gRGGX#l z)QvZ}5xq3z+V&UAShLi3Tg*0IWXK&UJ(6FF8;cdn} zA#Tx5)thv}R_2HnyYa4828n0x0Kfz&4vD8c`O0@ zI^?xb-nDYQJt!a+G7?cd>0->1#c>S|9|Uz+_j4BXIq*w8Fpf%l8qtSHvZU}8I!D`B zE4@|H_I(#>b5l62x)6O|vKBjiAhn|nIxJ?cj_%;mQDeGu1xN?pkqN50|z z6>YLiUjiiZd;-dDkfpcwn4nTI64p_uVFwe<6G8LG=(A#C47+~QIM-MK(iOAQ za{|U3KG;F%nrI&72_N^DHJVTa5PQkW;M?W#x+blkC#>(BjhY!BTf$rmvLuLInTd#UlvN=Vf`nzEXYomR$D*?oDK*S1-++0B(4m3k`_b9#_S+xW})u+b`#W7 zy9u@?pGIIRh7O0QmwRiW(MZQTCl2D?tL78#7!4XWFPKXisQ#HM^FZ6e9lSwa4w73I zxd}!rIRQdVD72mp9mXF96%op<6kpyyz(rxTA=3E6CnM8xPh0b{Z>5DK`>NF<1r91} z-c4^n02s(`-Oug8J#6VPWQT0g#gy4Bz;)ZW6QnvF4JVsy0nFx$Z*o!!KP}1o_aN8- zXK30F|Ct~93T^ic&$T*7L`rq9o*D?N;D(Y`%UW~5{F2Pl)nz}AqSBR#CoBvf1{H{P z>oW8Xj4X>b^MXCBD{7bIfD#P9eo%E0c@+eyxN-4QYy`4;zyPH7!MB1 zW-)39$Ar`Z(0YwrlWRUU=U_vLmEgPaqLgXTn5z@)O-3*#+ovs!m(br4EgkomL5?45 zjOZ>Lm4HPIg>j3~Wxt%&;o5=I_rLG_!RkqHx?H{~X|YVBB(5yvZD?um+t;Kd-_1=@ zh|3$Dg9Im@3Cd#fr9SU&$I{K>fF=~!GdHT!PSXeCr)lkcct&0K)@08cs9QukHeZw49~N+FQvWLYAwocg@X z$?iBhldnRay=>t0lI6~x50@s-44QqOm-;+2)+ML>3p0ERj@Kl*23#7xbdS0si3=)m zAj)7^9<;_ay@t|)iA$<)@4WzDS}Ij@6_@g2QKJqK)2rYkr}>K};DgYvPYBGuA0hLX zR>f_Y&qSl}iG%dd<>-WA@Ob`cmEb`ddg9YnLjPMp;yw+>|A)X2tOW#(Oh6D zeNfo|bG%AiX7}FRFfjV(=}FSH{13}}K@)ss5^NO+I64Xl8xD{F`&`Q} zy1aTvxYp^>iPXn-#Pck)_44ed$2DoMLhI)ao&LPA0q>wfWuID0ye#RzS9rVc-r;kL z{xBrfyp0on9PuT+s0{HB@T}k1ZeNkWlhk6EF!+WU(~9aS&-Ukl-X19HS$=Brwa<|q z(E2uW(F2Of=#K5RZ!)_*tspoElRM?&!x`OxF60_)@j-9CCM)ch1zXj7^=H1FwIL#wEa!UV_v)uvk^Z<8-Vq}r_< z+FaS$1%CeAi_r?Bxol97J>gDypRSkeuN=e3`%4f+IjBOcv)Noo>vYaF65a26#ezoX zB0U##Z*F7ZFr={kA_W|kZw&?O?YDnp92=VP z5vg*Qb@=_m)i|(2la(d6pDgm+P`{VxRCQf5IgH73BDO)W07$t3k+5(*I1DJjYH4j; zehAhcEUjWKUo`vEy=qBK*2P#Zq&jon$Yf{eU`Jpv4*V5FA%6Vs%1)uwZ>nl$T)fb! zGVfeT46+aVO=@ea_*I~jFJdy{7N*EJ}RX2E|w2qTGx zCU=bXYQ3aH4*0Ke8Yx~iW@i|%9%qi>qc?)tf}}wazjFUxMk;*wBMI8+dJ8EoUk_QO zhW+^F)(3>eX2?^x5U7A!+u{Ov9>JE&Kj(Xoj{hG!t(8;x7M~NgCl<^96mn*zL5~e4 zR(m7nbgBx$WvO#g0thv%WV|zyz(!;qQs&28?&VJMXlxb14>W=leFiTKLBMiA8Y}p& zSa})om!kEZgJAIXpXh((CR^eLd1gq|LI4mr7M^;k9mxIGb`@=s^knB@$Fk|QkuhSn zOXo#V{Iy+$CR+xJWz5Qiek-h7MfC6be_{hLxyK z2g}2Y1ECd&>W-0FQ4pg^KtaFhVq};jgWt}rG>DktPG_W&^QY$0Y3>nhF>>ki?y23g zLNyj0<8mPtcg)-_u?forQoP_N6;eJqq?@{$y@X^Zv*B!eV;M~~g6Y;Q>6BEpmdPx^ zbC>6XEvRpmDi7c2@c%NsT=@fr$Op#bOk5OeODG5qxS&_^Dda- zI~AdgUn!4L>U3mV`JLa1#g&7isQE5d4Z<1!t~TyPLe04@&Cb(Uc?Vjzlcpq!bYHIP zu`n3}-HmT4P0{(9vX^{u>>cirY7-Gfc-aMl-l1ZUjSosUT@t@cTpe!qHn9Ga-p#wG zPjR8(k{Tyid!=xV>&G_IDZ6?}N96fO^()P+p0o&>aXo2X`=xu*RQR&NhJZXc;Sknm z#Rq;L3&tI}o~(nOC6S4*fL2q)C`Kh}8XZ<*6M7)LLwFfgjj*hFQR$6!{<#s6K@~?G zW*Te=svjcp0r*Z86<;b-q-$l8?}uuzG0Yp*JKoXcV6vKgS{|?{2UQ}v(N!w!cH7_d@7s#!4* z(+eqkL>fPB^~J$ym^t>Toahdpd;jYN01PSatK&?orJ8}}(+((OUls)i-pcR;Re~z? zro)nDR3ec_S5bwKTv&b}|MT1K(hk6;gEMFFrI7N3XGb*3{a4(U#@~l;dJ2vx66-R8 zILH-IC{jR%>8q)hay9mFs^~LU7T;c!jAel);{+k=V2x|gw72KVZuXA0j-BLh(0UDL zvasrKl<~fV^a#G&7fdnRr33<7l951NUNYe#j{hEriT9a$Q@!{sy_d{j$iSgZ^!fy1 zpgQdUa?oc1OSi~#&71VY{HK}{Z_GhX@#+VpqEC&d(n9+5J%gxYtye~0_tnWlm!G0w zqEdv)B=lg!i=Hzk|AP457>J8ap;Q?Y&fq&}2=I4!+; zbKt@Zv`a1RvD_kKm72!r7LwyJd z{;6RdDaVV}GZA9_qRuzy!L8Uml}*ORdZE%5)KHSrsjyvz)>&OO2iA+D=jm3;n<6HT)Nwfv88D+6a|#+ zAd#N-ple{ksVwSvy6#BtE4^l@PLt=U8bm5NeJ&c5pVLD50imu>jSD2Jm@h3&ugtjS z`SfO-x=8dss}{kfS9+1>&^_R{p+!i0qC}>-uERGY;5cUH9sw8Y1=5*Jv^gHHQHq7H z4Ar8uN*!%>9P-({0fN-4WH!{Mt6_YMg`3%S_^IRsQRC8|DsfGD zvg23}%`u-d)r-8{WYN|knBSI)_#M<(tC~Y{>!G94*-_W(aSId>-Jdd|#H~>)fLu51 z74{WX&_)p)58oKY3z_U z0@A4%WJFF_A3z-R8FpGA4PZ@HV1~p{Uo*ZUd+u!JIAoFJ!>Ajmb#J^P@Tw9Rm{3hl zM&G{K4u1S9ELITgqwTaT9<@cUqtZ82il@B+JkpKG2&xf=^pbSSSgBMoL{^#~Xu5n* z$s>wC6gN(Nrsn{Th_@}$JlUuAyYo)#`iYGAOnuFQ{qogzNNI!x6IF49C&zk z;&LZ-G52e#%gy7r+h5f@hNhX;-{1pqjx~`1Oq=XjvwBj%kSXC zYlg}etZ)<#TSYPbtFU7}*+vR-k5;pI8024o5V^jkhY?ShzDdhsEfNee3E#$bWgoyB z0Hgh$_0G=dYeqCMh$hWddyWM_Kz;=6uiZXa$MFLPYs~&AWTm@Y`Qx7tU_7Y^$%O5Dpj>GF+%u%I zD9JKEg+^tXUQ@z#-8cBEi7bS};F16o@)^D;IYa5U7?q{-kJ^GSv=fcbNZ0HvRMEbb zjp%5(97?|?xzJeZ&{&3+PkhEpUvldhA6@uGI#v5?f8RBL3`90q;iS%iIgT0FujPDO zn|aGo9NaCBXHhM z1zP*A2*%NGDAVM*P@`UdE?SRy5lHX*U#H(z3XUw>mYy=1sk0Vkn$pmWpEzJ)Frt@7Et%t{xUn$25WH&F-AqHQ>C90(7n*8DV39CxpHtglC z*f4xT@d#E}4*LPpYh&WF5kcFT?+(=TJ8J=vFf$~;ms_Euo_8Q7G==i;C4YdGQzV4| zg^O(74hqefpa{h$?#z~gSIW5sa#7GYJ8JggpL0DmR87?hg(zd>fE#`*)*ZQ%&~%0m+H9d@f?6@l^>yuNRbg`# zFR`XgW3Z%;+Z1-|o;_4$(SFsptgmh)D!c4`!@pWT9RFESz`2NAErsv_4Luqtid2u? zn#z~VwpmZH?%%&Gkt6+8db%_kkQ%#o4JkGrAQqj?Tv=Xypg!#Ow{|pF*Xu6qCiJ*f zmwUV}+&1jWtF#4Y9b|Uk->}vfM*RQV3_Sh!+$T8%g_asu zN$Icu)9FvwZS}c1^qxcl98drXeR@dLoh+OoY;15axH%beg3vpF(}B_=cD3($UQTX^ z`Dr2MQ@e1RQz{sQD1{~)FcIbd&P|+w46d*kgvI;FVx1hJ6dr^k-6IspTK95`!j1{I zHy%h7ic=R|UFzHdd;yOyRgbwNG*o&!*7#RJc>1BmXko_r(5XX0$YdvFtMV2VG8%Xb zOpU(H(PdgKAs%P8sMA7^rBIJniMm!CXsX*aY7<|e{D4*prOtSy1ubOVIEt5>u+%`BMS&ZK7EeAHT@^C~?Eyqtb z7ptyC6P)?!%OKsGF>d~(%PLKtP=?|>W{bL3<&Q(DWi6Tjmn7-x(yE(b)dbKcRtrZo zN)4)Q!SPmXC8$cO0*3O5%4YP`q*2bhy7)G}7TOvTxVntMoc~x`5&A?u3zF3hd-$n=nftAH+if(%AbjEjWuRI;nMyz>ZGXZlaa@y z+=g4uHf%4dvs^dsR=OBw81Rf={j)#sZf2wLn_mRRco^#7v#?j+26jY!SutEYsc*l9 z5!g;07shYnDSvQoKLgJITs3=YWIJe?chRY04Ey*RY?CZ-B#ZHGlfzEFq&fommbmJZ zr|tVE-Bh2LUMPImaI1N$@X9EQx+U$SUEiFUF_qS&Yh1|mdT{Ej^_h6ao3{B=S(&aI z-@Szv2(zxru_*UV{HI4)u=y{ws>P;;0oaMH_7Ipbc_-w8*pA&@@R!814wn|%R-C3* z^hLt^hUVN_k2`11XQzF;#Ix}p<7wT(CvG=l4#ewgYSm>bT)J=_7k~BG7*<~Hnk{H^TVB+PV9u$os7>=Ego6rBu~5ndI|RlAb$Y* zyS}s~_F0S@MbpnI6&;#;;vUS~miX+KnlbC(*n<)=-RHG)2~4qk*Lfcb9#K0KV?d>8 zIN&h#GwBPica_I5+~6$-b2+ZZ7GpbZbx%$Hwf2^&W5-_JhGOR*Pazvi+=g=V*Xyr5 z{BMe$Xo~$;?7#CoOnc&Ss&vlRHvL`1%tr$A`9mX_Ij?^Ap zxq;hI(V_F}jPe7!iy~RM8y^RbnV!(px(18MgR9A6oT(f9+jP&XUykxpxmNH<=2f?& z$`1^+Q;f%W%H?Bf=cq$L-X$~hvhYRT(357^dxyLtF1MD|wX9MZ`#*xwK*UEAD_M+Hq9BCb+N>4l+VdNWVst%IcolBedX%JCd?w5*Or!a zzA1k*9+ZIZSKO)!cznH`fi)EDPP1Jnt!hHtH#P0s3&A737Z-a7Ea&$}_Azf96g<-K z{Afxj_j&LHg~;8SCI*xZJ{R(QafFk*Ui94JgQZOK^$&ja`8)(vpU=JwGk=VV5*HpN zzgT)Oykr{`+BLE2?A_<@xhp5+-Lcd-+qtME9nyqUfJbRyhoqv8`A*x58Qvw=p28}Z z^P@Bb{#rL+$LLSA87iz-PkM*U_OV?xiv~Cphn$hTB){(ocsx9ynL3e9x?w zxIfPoymn}e;afL>%n%ar?ONxJHibRn)3b%lPI41$(z!9aVe?^8uk_gJZ!LS?QTy#E zafu)}YjU0CnVP4}Vr#)N>F`aCL!ULZQ=~U{XVnqp1O6QLxe!#P5IP`u*5(8OM>1nEY@zFdto7~jWVk5e;lhT^BYH(Q3-uL5gx~M`?$}zYcV@~b!Q{>2 zrIz`KiplS4Zpw6KBpDKA-^ z?j!l4qxMPaw*l~lx-rW$Igv__d#mSUMpL~CAOg8>Hota%`S<4{@MEvSU>IIG9}?@a zJ?~&}jo`=B$D}q)MfAo+UbtUl$Dz+@%Mn!GT!y>)45e`Y}t{ zoJf|7WfvB&@mO7ewI+uZykT_;F}^7B&p%-_^Lzgd>K+X0*!cUG(+Y>M^4;5}0^+q_ z!`F!Kj3JZRvF9$!_DQn9HkF$tlgoaeIA>VjrSx{ROA;XHnWv;_HJ+lqIlP?5L{>n4 zm@Eh3@Qa5QIASHxrLK<8^lyYqeIv7PqdRI(U0mbb*L>*Lv*Wb#v-dqD>R^GSV>(nC z=LW&Z`!^#hj6FPGw0-4L#Si!%-+K%@E74n6@S1gU7uvtfOh)rPonv)1fa&`I(?e6U zdY($J$e4=j7Ur>D`P~kS=9rXRovDD8ZysuA@G1Au`c(~PVXox@HfdfezuEI~@1;Di z)e`TLZc-k54_zkH51xu$ZRRWqn2g^4&)by$c^iST^FGOPd5IAt2fynwR)?8+^yt{w z0J=8o{JQ7C_L?DNs<_~ngz|%X?wgsVZ#-_yV%$ca%R0sd=wK9pkrTjYSQggoeXA;Z zA20jIFkp-yVO4%GUreR@L>V*heeQ8!F)g|8^h2#QruXrT0Y@JB`~S1&ck5BjJYv(^ z?WmgvBMCw1Eq4vvtsZI2T>d(*D?SIPP=q1#p4|7{kk5DstH;mj>KVHC!O%;hJ< zfTI-cBuvJ89DCPsXRF16+}(r82wpyLD%+;doF|!0m@R3Yqt3EnQu>`H`%2)qz#h&$ z6Ctm(J??!yyZo#322JF231g|Z$N$6Cm&Zf>eg6*%MMI_VwwGNoQkKb9Dj^}2BwMm& z%f2&GjU;NUCHwYPvWDzaiYysX$i5HRm&pD*uaWoX`}n>7N$)c!MusPLl4?PP+{P4d`>k#ZwInJ82Y zHOPb4op5+t8_L`oW;5MJNSTNi$!O!lNm}(4DDB#`Q?zo|w4`|5ZY04+q4Z$VVBI2( zHQ6$D-(aGg_Wv>|gNp2m(tTZR_ENM*9YL=j7RtF+uX(fWK@VlVPcWckivj0G+6*EL zLcl-69kmO^S9ty*nCxQW;Vw035Z}G9``$AHwG5U+Wl}lO3FP1NS6f$K(BZ|Xy&+UN zKP*w~R$DbUk|2?P6A~H_$99OKDfcoxw+7Fa5e%Zcn)?7E4RdXJftcAI-3*xtCbtNe zhEtT5?vTsM%3Uk@$jm?+hP9k5XP4ok%$64HC*q~K{t7)pkLqZvj>F3 z2sdQFAMbyZ`{zwrajeFr8VkeMUi#Yrk|`J4S+jUtHK;6ygyKU3;L}f0G1Yh4sIZ^T z9PhKX!~+JRy{+bdK~1L!e+-3l2c=mnFGJkDYY^4#20;|>u2BXPrD)hO9YrRavjU4Z zDyQ42KNPm(FUJerp=?rl3T2a)VUwiPW?VX+4wY{7y^;p}(<1~jqj9{=#mlSiDtit9 zZ*|*MYw@bs17RttvV~~LBjD#kzrP$Un(@7~GBc8vx^+%1FPLzDN(XfdoJpixdzr`= za9AkJ?nYK(uXxwsQ7=r=0WS+K6k9CV&NG+S)j9jY%K?52q1bW^HD!ll9{deGZ{W|P zYE|m1yyG|f>^;kEw!j@#!Q?m#w>U0~z`YNd!Xk&;*r{WkJQ?vIArltRZ>qfAzD!fz z|xEw`4?M$C9XKCKZY$)N3bXd>ABTQWj5U`K7*$BP^gb)m8hi)E8WC%>SIE& z9$%^65Cg#2yNr%*>a}o8Wglu^UBZlZEhSWhFD4(4Co8DJ&BCb0^#)1=Z!SjSkxmU< zoN}50M)pm;&gN3A9)8pv_2fX&P4|l+#$A-IUfgNtH7guSxPM^vXy@@}aK0|Xr5k=V)xu+2 zLmK;iIRrkRk6@7+l1JUkh0xq$-y8NcWzqbHqB0s~=5EG?@}OVXom*_+_-BOq7=MpG zo?f^Bv1C9jNV`1cNw>8C#n?OMvA5D8mjVG`c>xQHiN{8MC6u+;mvLR{~V! zXtf*nyl%w1tFJv9jB(iuWu)!)`PsL53J%V z2#b~xEM3AP*KNU4S=9cTc8K1u)|6=0@TWm9~pB7|^ch?fDS zg5>nD;c{M!q4$~KpaZx8Z*Q5L=rmV)9~&bH34TNH#1FP*NI6RjLxFuBhquN# zqKyi(H@^4?L@wI;h9&2^l0Mb`^Ra_|v@)ZuwUy1J49p6x}XEAF|MKt0^aZa4V*QdxD{?JoX`dc>mp*%1Y~ zX`9Ub4$w*cj6%*s=rTt}KyLb={Dip%1`z-Y>OX7Eg-Uq_k@rh$(TwF2!XN}4aeyBo zn%@1NPET+iU3O&$2@bvr6h}P(AfQUf9wu*i^URF?CRBHzQ1lO0sAVq#aOK3w-dphU zk8jH?QE(K zBHRU;rbGp7@%VU3>XzAQEH0x1lBua|0o{CvlW$#v_765oqKHP|bOLY9R!FIXA*0H> zTM<8pV%rW6pre=aTv24mfT>Fg(I`D(_CZ81>t~kh*$sjOR(^WL6&sY#$-i(j_j|Cs z;kNk3?euD+EGsSmBEh8=9x#a|Yae(ylrClDr^fjG7<;?(YeQ{~Wa&p5B9|3Y+zs~H znB*HRkQStD38@F$m2t%doL)0NJA5z$KKp z(#!Y2#?HG}*#Jw0JQ(B(OUh5QHI9yVkfDua&PRa>)dLShp@zNy2V&92ckG=(WQ8q! zHNW*TCOpW3EAxUkWb~dq%O?98?yiX4VKHI`>_@4U&5OKxc zL13Q9gPZ$ri{)9)e@q!>T0f_omgY(u5?qX5s2oju;QO!CibuyfkbYtl%)JQHCjSY0 zH7~WDpm?{KYeP^yIC4lO8&?NAeN;_ve$LM~Xky1H9YsKNhu`$4aw8+P(t@UMNzoLB z2!$F#ZmOU>_mVSP-n!DhhkMk;c6~SUM>O5Zo{Jb1t>g}Wyh⋙IGJQ3P`{{Uo5Na z3H7USb1~@#p=S2j_^97igB(@}Fgyxp3K|t}3kgIVXo`#V!5q0~$UR1=*<(9$eN;P9 zjRIz|a&T_u56JXZ=S@1|zmR@W%f)w&_JeHa7lUpnbjz^g+07(CRIYpj^_hF0vnkt(N1=7GQ zs)w97Om))|-b(oh6ag9cY}0R`_8B^qNGv@6y%Vd-Yg804)6kHx>}0Zl*U*fN*Fa#g zkf#9b?ABw#AjtX0cXT(Z#_C{>vt|M3lD&~c4y2E4iqgK+cz`kSA%RSB)=a6hF8xx@ z`;mqB>r*l__=zzLE{VM_21+at94mVjaZ;ew3Jde(uWxBCo!3o!A)FM}^EkCnV1rBG zGq7>val>E;sB-kNOKb-_PpWH$;hRR?9b?-5qwdQT zn&nL=du)Dj1h;flH)2uD&9Dle+m$Ajn4-wVChR9?phWEBsLn*r7bvV>JCK9Ry!PT{zP7^xi)ymZ7j;@{g+;^* zy?Y{yo}>IbojOz}I4_8c{5H|51+XCtT7VFz7~>l@#Tq#wW+)|RfpG{5p^bl+UNhnU zpAdL-t{lsf+I4o%G5O6O#jUa(FA%nsXt~|qivwD3p9IyqQ*WAq(W1TCukSGA* z_yx<{|KU@EX)z=sPz=F!!kWLp!ZBAHS%H^d0vML&`Urh|XT)u`4wjtjaonc+2Hl@} z7=&Ik5ob1FZtCnw0vLm8xruolC2MbdrQ>VHSseJM9 z{IXZ!E(6i1${nC%K<)cLVI7-Gz&a!x@tV4^u& z6n2FW1&wrH2k6~m`nG430V*t7gCo2#2Y1{prRo5qVvfNme7SKPC_xcGmqBGm%p+J- z=jX_!Hm?`K-2A>@9fyolSB)pDAkkeyV1u1vn2lIQj7voIqJ@z}i9ar5)+_O7yakd{ z9oQc0`c1mAdO;%+7$5S~P)eKd12GqNbeFaPPzsAVnJu>z`)ESB>=zWmSq$)Fs4fy6 z=##TrRXw?oD(rOB;`1ZeSxmj@Dh7#EL64#EgbIKcxCA}@>T#Gd5@~RJHu%Lh>?6t| zJw(XE76lHTdUg>9cgpML)*pnHgb z@&VnTa)C3u-cslqs$6b+W_ez@sJ$9}Ywa$_D&3H9?m}9SA7I9hvJB0q>rGz^AWlW) zjx8Wv?C{_{VV9a}DuV-brv@HVG|dIM{s|tFmj7HazTHj};3A-L;9+FD8W8|qUn-lbHmhB7rh6%RJXX~3qSw*!CRy}kIl%>1 zQ;(%*J}`n&y88ssioG?HOlKJPOC0!T1^lw^@HG>;? zWC~TSHg@d0LNsp9r1BY%vAm2D9Ll{cgRYh(Ka^=lmL1sds^V(F z)t?D^L0E(cN(W(S%m_j(EYDg`FeOOQu$Hh19y+%1C{kK(t?cwBNWUM6w?2?oCYp3{5m;sYH7Svw7k2iSi zPfjtRe!sB;m0CpgO(0qzZwPSchW}4Lv;WV16&s95BP#(M4&}j_{P*H&;CFb9q#?S* zOMvlz0ZS2r%*v%-*ZV!ytCS$Lnh;?#lyEz%{njOl*fKmTpu*Zu2lM7KO*vXQ>%w*h z@~Y~;d!%%WGpqD*yVL|yh67Bulks5~kt~cc4`&1#ffKolXhh2x=$uNS!2@84U3iPp zI6q&JWH1^2@u%yycAq!5Ik&w!+%h^A1P{qLZA9e z3b1V#3}D=vDd2Eo3^QQ3dZq9I0tuA>|ySYEgW(Rg<7`asPu(v==j zQHR$qg5#{<7KRdybNGAS;jK}DKtGlsd2~pR`pw3PwAkbVDHVCy*-TJ(3_YxfYkqO{ z96m;Z9}?^_)^>`T5bx~xpxokI5b0Y`;kbLA%CwEQZqU)+u{CI}japVTs*1js2&Key zbrS!ELCfj9L%yP+0+BjbJl@BD$SmSq>crynZnm(GU{JE0?U%dpD`yWZ?8a?63R5I& zlE1Ts9R~2$)OX-5*rI@Pq2ycsRtLTmtw09MN$unB`A7Ba4IU^oK>giV8y&u= zB^RtaL5vzi%*u>^wjzUj$2TTNmG4=_Bl6ib>YZe85jUk=Al*hpAXO!2! zlt3T!_yw@yI2r`A%UUxi_KP{7q%RdY2H-bn73l7jUtIYarrg zkXj+v>}o|Ix6TFkrw6cJs&bPY4nXb}qXPmB!8pEXOrS92aqb#`bGDL{#o!7_e;su0 zHb)O}_##kmE55iaU@H!SZ=sISr^9K)7vW8n5g()VZNvu56A#3M;CKhNR_X`Hx{a^D zLBV{{eO^xN@*V+~MOc>BdAUi3dQ(jMVQERj_{vT23%S)kbNhCbhWMA#0%FprI6U@cWxWU% zd8?<{o}Ju}0<2~9A)BCPyY&r#(@`~qmPC{$JtecnPB)DeGM-b{{!v@K){>TbddRAy zPgQ-4e&mhQ4O>og`d%G0hl1AfMQ{Kn^C^y?yh1k5qn>FPO<@4Xa_Q}g00N(uYC8-Fs% z253XUdQ;exydx;y9s8B#3v%Gv$wl|Ya=k#V94r^&av^kIJ!WSROvZv_+kbaNSV_O3ohz7 zu!yl{kdE!U*pv#BwUtkQt%D+NHs&3`DlO0Qf&0XxePggY%JK@f4BoKT*_S{-ywgxjll<+_`v#EM{*^E@hih4 z+QK=@U9-;d(~s@m(j@Y1501H`3W|3H0XFc2AV*w~2e;`dt{8Irv^6E-D2Jw`&d&2P zPI`KIaL^#-iUfoEAQ8$u5b5ily5`k-bsQ32OU=j&1i$BtXIkDmz7x5*Z|oj($VCIR zw_ThWFU(?O6!U??2;ufsF?qH492(&IZ9H93*1S_#&itOiohZ_3-29kLR|Ac z?$>7%U^pr$)+DEX;s4ww7e5X?H!=@}6Ej=#Gg}tY)wKjRa#D>24An~uG^O|C`Be7t zJ_B|UNE9(0^xA!=7^DLV`^oaBHE_0L^+*+tof*CG8R?zcUOCkcanqb5^|Xq9=^2z& zYZr<0g$QNV{12&(JIc{Ejwam66l@(jQx4a#%X4}S&3V&2W_LycQXikOI z>qYR}Q0BP^Wu7+KmoltVrl*M&(9n@?DA%a*Vy;9OuUQTCa=dJe!)^G_rg2Fs;O^)H zR|e?-zEK_`{ePRGR<`@c!i9lu=yif^qxJ-pBz_F4@dRW;ZrJmZ82x9mA(;yY_4s*p z+*3C#16Vu%lpZ%1d97o8bb$lx0DG>MX*NexyTQ;vU3p;_@oPs~hsK)&TCk{6Fnt>E zvt~o)ZD6L9@&AuLWhU&8(rUSXks3L)fe-5PYo=K*ckmg)R@FLdKShR(;E^ z6!#rOE%r@~d6sc05EkF0YOIvmFOAqyY=@EecPh*VNfvcg6j$+&H(ty8g+<-#Ev10VSe*qgof$la97OA7$n7@JbGtV`bnOIq7 zfVK!!2v{QYF~-YW!yYtWR4KP$z@~0RRV&^kvoY73wvLP^Dr#}$%>^N4sy|G9t2v0{ z$G$o_`h*8#jAE0r&_G81AM~ToI)17g0BEzJZkm~|>^!9TytNV5vj_~1$zHn09M(SC zi*|!N;^I)kX+=3DVOsjpvJ_Umd>&j9cnfvw|2>Ayn49110F;BK}r#)^pc7}DU#if28txb+7bu)EC0ZJgRCR7*A3`?0?;( zvK&#pc}9-0Z^0$u4p{I9aP2Ng5d%gB-$Pk90!ERCcwi?U-2639XsFUd64;)C-?0AOLs_nbUZIV?!Pc3w13R5ZT+7OPROG`Kf&#eNk9X&;9goz z?!9WX83JI0*l|BJ;ckwBd`#FGgomioEYIm|H=x%~G%l6^ow!np3V{|kyVr}CS|kY5 zSqqE8_Du6QDUdwhc#3N%RVIa4S-vG-(<(TMY(-s1=3Zo zAHQ?D3c8`s)gNK^ibo~_9U~NVl-&VjJ0mSgjPxUz$%fYDFK>!ucljfJZ*<(1{LgkI z_82u^D=AhnqR2vFNAa7JpilVJQ@Uo*h0>O*G~h$8523_%w!F8- zFD|F+=`xBom6A8bYph;t^|;{)y4C|Vx)jaw%ICmqG~l`)JFzY40V3?^ur%+MfEsO5 z8Pr{G;)z4sj(}JOZw$Q`NBI=IJaSV5^5E>j^LX8Bw?DTCi7Imkc(+GDC_PL)IK)P* zfNVp(6p2USZf2g*HGV-4Y6EFeGLSpAOeam89uiLCDy9oI{e%SK9`fnYF8^+IY#Qey z8ieVB@&?Ynu-!|meFY*Scdd`31VltiFWz$`@rH-!v6D!SLCPbhImGu4ydx?b!lN6f zz;2GJ*=KpIdIQEtCemc&KE-#S)^Nk?0(b@#H{jK$sk&3ag7IK;{o|B){MBCf&#lTF zgDL57zasSgIjbsTdBd3!p24u<9B6byF_~4qXN6QfbJpo%52RqoV^Y3}^phbEG0;u7 zcLwT^+A`N(0_AyAHx2mKHp#Q6qqmY3(BJJ%{mkQNJTB>`c}B1xz1+vRu)6L7i}2Zo z+WHK)Rs~!D@UqU{W9LPxcE5tYjR|JiZb2ijk>d?$sF*998*Wz*M zyx}Kb;C-P&)`F#{HHXD?=!zr!JetehQPbY?S)Rkzg1iB0+UMHYs^>1Yv4ZpxU0(&$ zw(&d$Y5md16aS5zKjoibja{C;g*5)JbB6M&xkvnie@yXWvJWy;VvBEw#w3Fhp#gGJ zCiH)Jf7x6@4jm8Al?Hb;$Xc5Np#hIkwQOU(&=qZ>#ogzhkM?^i_0;Mu1)rg;w#9QZ@{)G-KK0C8op?mr~T*nHDhc!Vb5W2q||DmT~+!ajihS8%HWwsRu94wCKk9&)j>GBkeI*6+7d1CS5y91 zbUXNtL&JHh-b}aOcWs4L*JEsfA1Sx(YIJ0#x&U43xBR$oZ4AmWNri4u&Axfuco^qy zR&}_?63PZlHcxnD{#oWb#`ibIch9+n4SOJrEZ^)gU?M_$igs(VnN@l)FYJzQ(47O; z4`=k(vJ=nm?2fgQCOP2bau=y;aBAQeKC4rO1#Be+4!m=J7$7vWP#OvZuVP`2lb~g8s`VfPprt z^gu1_E=6S3+%Z!>UZ&HEisBdZOzJHJdEGE2|jSl0*`ZNjQDg??6P*S+v1 zs`}baFTnUgv(dS=<$k(&t1?+O3Q*V;WotJD;hW737GOm z06|x4RCwMZgj5fqLsyR8IhW#j1H?T`mz}%0Z%~nuzB0dF)?XCIOqo|m*MIfH5XgtO zJA+)nx7B0Mk+M%d&6%6gxdI((_HP3dp-<|S1~lnY$pbWm)}?HLig!&dNzPo*wM{)d zrVC-?N(2j#swn%Hq9f1ZfGhC=-u~@+BbyQTNq4h@IT9zIlC1FW!(D*Fk5^Y0?d7H8D`_KrbmoY=fhK_ll%x$4J?XV0zrnB@H`U_{+dK6AXI3=gh?_GxF$ z^+i_?o!E97l#Q+l`^Txk`v_wsq~Yz)4D`z=u7`gr9Vu)WsZ9N_^o5R$QO zZbX0g$r)0KD{4Ku_QVVRxSMn_$w+q+<1Fl?mO#%%P=ynS`}S0qW28mU@+&wk1tz^T z=(tw$iFUD9(pWxdg*qt`UMIb@=H&4zBga7j`q_|PU3mU$ujt=@P&~o-a``#vR~yqg z#_i?$wr5wY0U3oIwR_^$&CN3Ruba5sG@q7m0w4l_6#kya*|e35oh`XgL&eaRJ*5~J zwz47qpn+0>Fv*wil?oDg3$+NxQ1E}rlU)*{Pv|6#6PXZcaybkFS4!Q3xUvHAa=Q zZuf{C5RrD}=b|yDf0NIc&tX9Cx&w>v~Z>8pm7X*Z14|ugAbK?W76Qk^}Q4{D!%4S6ddP;md1K*u(CEhNNS& zEm%6{ixk%dk;iMyxM*uS!=Qz366&Na*j<&#*}pG